Skip to content

ExportFilesMetadata

Source code in docs_src/capo_gameliftstreams/types/export_files_metadata.py 
13
14
15
16
17
18
19
20
21
22
23
class ExportFilesMetadata(TypedDict, closed=True):
    status: NotRequired[
        "capo_gameliftstreams.types.export_files_status.ExportFilesStatus"
    ]
    """<p>The result of the <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ExportStreamSessionFiles.html">ExportStreamSessionFiles</a> operation.</p>"""
    status_reason: NotRequired[
        "capo_gameliftstreams.types.export_files_reason.ExportFilesReason"
    ]
    """<p>A short description of the reason the export is in <code>FAILED</code> status.</p>"""
    output_uri: NotRequired["capo_gameliftstreams.types.output_uri.OutputUri"]
    """<p> The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a 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>"""

output_uri instance-attribute 

output_uri: NotRequired[OutputUri]

The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a 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 .zip file extension.

Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.

Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.

status instance-attribute 

status: NotRequired[ExportFilesStatus]

The result of the ExportStreamSessionFiles operation.

status_reason instance-attribute 

status_reason: NotRequired[ExportFilesReason]

A short description of the reason the export is in FAILED status.