aws_sdk_gameliftstreams/client/

export_stream_session_files.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ExportStreamSessionFiles`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`identifier(impl Into<String>)`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::set_identifier):<br>required: **true**<br><p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p><br>
    ///   - [`stream_session_identifier(impl Into<String>)`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::stream_session_identifier) / [`set_stream_session_identifier(Option<String>)`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::set_stream_session_identifier):<br>required: **true**<br><p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</code>. Example ID: <code>ABC123def4567</code>.</p><br>
    ///   - [`output_uri(impl Into<String>)`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::output_uri) / [`set_output_uri(Option<String>)`](crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::set_output_uri):<br>required: **true**<br><p>The S3 bucket URI where Amazon GameLift Streams uploads the set of compressed exported files for this stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a <code>.zip</code> file extension.</p> <p>Example 1: If you provide an S3 URI called <code>s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip</code>, then Amazon GameLift Streams will save the files at that location.</p> <p>Example 2: If you provide an S3 URI called <code>s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/</code>, then Amazon GameLift Streams will save the files at <code>s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip</code> or another similar name.</p><br>
    /// - On success, responds with [`ExportStreamSessionFilesOutput`](crate::operation::export_stream_session_files::ExportStreamSessionFilesOutput)
    /// - On failure, responds with [`SdkError<ExportStreamSessionFilesError>`](crate::operation::export_stream_session_files::ExportStreamSessionFilesError)
    pub fn export_stream_session_files(&self) -> crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder {
        crate::operation::export_stream_session_files::builders::ExportStreamSessionFilesFluentBuilder::new(self.handle.clone())
    }
}