GameLiftStreams *************** Client ====== class GameLiftStreams.Client A low-level client representing Amazon GameLift Streams Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand. This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS. See the *Amazon GameLift Streams Developer Guide* for more information on how Amazon GameLift Streams works and how to work with it. import boto3 client = boto3.client('gameliftstreams') These are the available methods: * add_stream_group_locations * associate_applications * can_paginate * close * create_application * create_stream_group * create_stream_session_connection * delete_application * delete_stream_group * disassociate_applications * export_stream_session_files * get_application * get_paginator * get_stream_group * get_stream_session * get_waiter * list_applications * list_stream_groups * list_stream_sessions * list_stream_sessions_by_account * list_tags_for_resource * remove_stream_group_locations * start_stream_session * tag_resource * terminate_stream_session * untag_resource * update_application * update_stream_group Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplications * ListStreamGroups * ListStreamSessions * ListStreamSessionsByAccount Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * ApplicationDeleted * ApplicationReady * StreamGroupActive * StreamGroupDeleted * StreamSessionActive GameLiftStreams / Waiter / ApplicationReady ApplicationReady **************** class GameLiftStreams.Waiter.ApplicationReady waiter = client.get_waiter('application_ready') wait(**kwargs) Polls "GameLiftStreams.Client.get_application()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Identifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None GameLiftStreams / Waiter / StreamGroupDeleted StreamGroupDeleted ****************** class GameLiftStreams.Waiter.StreamGroupDeleted waiter = client.get_waiter('stream_group_deleted') wait(**kwargs) Polls "GameLiftStreams.Client.get_stream_group()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Identifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None GameLiftStreams / Waiter / StreamGroupActive StreamGroupActive ***************** class GameLiftStreams.Waiter.StreamGroupActive waiter = client.get_waiter('stream_group_active') wait(**kwargs) Polls "GameLiftStreams.Client.get_stream_group()" every 30 seconds until a successful state is reached. An error is raised after 120 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Identifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 120 Returns: None GameLiftStreams / Waiter / StreamSessionActive StreamSessionActive ******************* class GameLiftStreams.Waiter.StreamSessionActive waiter = client.get_waiter('stream_session_active') wait(**kwargs) Polls "GameLiftStreams.Client.get_stream_session()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Identifier='string', StreamSessionIdentifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The stream group that runs this stream session. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **StreamSessionIdentifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". Example ID: "ABC123def4567". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None GameLiftStreams / Waiter / ApplicationDeleted ApplicationDeleted ****************** class GameLiftStreams.Waiter.ApplicationDeleted waiter = client.get_waiter('application_deleted') wait(**kwargs) Polls "GameLiftStreams.Client.get_application()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Identifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None GameLiftStreams / Paginator / ListStreamSessions ListStreamSessions ****************** class GameLiftStreams.Paginator.ListStreamSessions paginator = client.get_paginator('list_stream_sessions') paginate(**kwargs) Creates an iterator that will paginate through responses from "GameLiftStreams.Client.list_stream_sessions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING', Identifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Status** (*string*) -- Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status. * **ExportFilesStatus** (*string*) -- Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status. Exported files can be in one of the following states: * **SUCCEEDED**: The exported files are successfully stored in S3 bucket. * **FAILED**: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3. * **PENDING**: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress. * **Identifier** (*string*) -- **[REQUIRED]** The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the Amazon Resource Name (ARN). * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'UserId': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', 'Protocol': 'WebRTC', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'ApplicationArn': 'string', 'ExportFilesMetadata': { 'Status': 'SUCCEEDED'|'FAILED'|'PENDING', 'StatusReason': 'string', 'OutputUri': 'string' }, 'Location': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status. * *(dict) --* Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession. * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". * **UserId** *(string) --* An opaque, unique identifier for an end-user, defined by the developer. * **Status** *(string) --* The current status of the stream session resource. Possible statuses include the following: * "ACTIVATING": The stream session is starting and preparing to stream. * "ACTIVE": The stream session is ready to accept client connections. * "CONNECTED": The stream session has a connected client. * "PENDING_CLIENT_RECONNECTION": A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to "TERMINATED". * "TERMINATING": The stream session is ending. * "TERMINATED": The stream session has ended. * "ERROR": The stream session failed to activate. * **Protocol** *(string) --* The data transfer protocol in use with the stream session. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **ApplicationArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **ExportFilesMetadata** *(dict) --* Provides details about the stream session's exported files. * **Status** *(string) --* The result of the ExportStreamSessionFiles operation. * **StatusReason** *(string) --* A short description of the reason the export is in "FAILED" status. * **OutputUri** *(string) --* 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. * **Location** *(string) --* The location where Amazon GameLift Streams is hosting the stream session. A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. GameLiftStreams / Paginator / ListStreamSessionsByAccount ListStreamSessionsByAccount *************************** class GameLiftStreams.Paginator.ListStreamSessionsByAccount paginator = client.get_paginator('list_stream_sessions_by_account') paginate(**kwargs) Creates an iterator that will paginate through responses from "GameLiftStreams.Client.list_stream_sessions_by_account()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Status** (*string*) -- Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status. * **ExportFilesStatus** (*string*) -- Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'UserId': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', 'Protocol': 'WebRTC', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'ApplicationArn': 'string', 'ExportFilesMetadata': { 'Status': 'SUCCEEDED'|'FAILED'|'PENDING', 'StatusReason': 'string', 'OutputUri': 'string' }, 'Location': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status. * *(dict) --* Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession. * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". * **UserId** *(string) --* An opaque, unique identifier for an end-user, defined by the developer. * **Status** *(string) --* The current status of the stream session resource. Possible statuses include the following: * "ACTIVATING": The stream session is starting and preparing to stream. * "ACTIVE": The stream session is ready to accept client connections. * "CONNECTED": The stream session has a connected client. * "PENDING_CLIENT_RECONNECTION": A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to "TERMINATED". * "TERMINATING": The stream session is ending. * "TERMINATED": The stream session has ended. * "ERROR": The stream session failed to activate. * **Protocol** *(string) --* The data transfer protocol in use with the stream session. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **ApplicationArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **ExportFilesMetadata** *(dict) --* Provides details about the stream session's exported files. * **Status** *(string) --* The result of the ExportStreamSessionFiles operation. * **StatusReason** *(string) --* A short description of the reason the export is in "FAILED" status. * **OutputUri** *(string) --* 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. * **Location** *(string) --* The location where Amazon GameLift Streams is hosting the stream session. A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. GameLiftStreams / Paginator / ListStreamGroups ListStreamGroups **************** class GameLiftStreams.Paginator.ListStreamGroups paginator = client.get_paginator('list_stream_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "GameLiftStreams.Client.list_stream_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'Id': 'string', 'Description': 'string', 'DefaultApplication': { 'Id': 'string', 'Arn': 'string' }, 'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022', 'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and status, but doesn't include capacity information. * *(dict) --* Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup. * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamgroup/sg-1AB2C3De4". * **Id** *(string) --* An ID that uniquely identifies the stream group resource. Example ID: "sg-1AB2C3De4". * **Description** *(string) --* A descriptive label for the stream group. * **DefaultApplication** *(dict) --* Object that identifies the Amazon GameLift Streams application to stream with this stream group. * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **StreamClass** *(string) --* The target stream quality for the stream group. A stream class can be one of the following: * "gen5n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen5n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen5n_ultra" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen4n_ultra" (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * **Status** *(string) --* The current status of the stream group resource. Possible statuses include the following: * "ACTIVATING": The stream group is deploying and isn't ready to host streams. * "ACTIVE": The stream group is ready to host streams. * "ACTIVE_WITH_ERRORS": One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * "ERROR": An error occurred when the stream group deployed. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the stream group. * "UPDATING_LOCATIONS": One or more locations in the stream group are in the process of updating (either activating or deleting). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). GameLiftStreams / Paginator / ListApplications ListApplications **************** class GameLiftStreams.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "GameLiftStreams.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'Id': 'string', 'Description': 'string', 'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'RuntimeEnvironment': { 'Type': 'PROTON'|'WINDOWS'|'UBUNTU', 'Version': 'string' } }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. Each item includes application metadata and status. * *(dict) --* Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication. * **Arn** *(string) --* An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]". * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Description** *(string) --* A human-readable label for the application. You can edit this value. * **Status** *(string) --* The current status of the application resource. Possible statuses include the following: * "INITIALIZED": Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * "PROCESSING": The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group. * "READY": The application is ready to deploy in a stream group. * "ERROR": An error occurred when setting up the application. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the application. * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **RuntimeEnvironment** *(dict) --* Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. A runtime environment can be one of the following: * For Linux applications * Ubuntu 22.04 LTS ( "Type=UBUNTU, Version=22_04_LTS") * For Windows applications * Microsoft Windows Server 2022 Base ( "Type=WINDOWS, Version=2022") * Proton 9.0-2 ( "Type=PROTON, Version=20250516") * Proton 8.0-5 ( "Type=PROTON, Version=20241007") * Proton 8.0-2c ( "Type=PROTON, Version=20230704") * **Type** *(string) --* The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * **Version** *(string) --* Versioned container environment for the application operating system. GameLiftStreams / Client / get_stream_group get_stream_group **************** GameLiftStreams.Client.get_stream_group(**kwargs) Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group. See also: AWS API Documentation **Request Syntax** response = client.get_stream_group( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamgroup/sg-1AB2C3De4". Example ID: "sg- 1AB2C3De4". Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'DefaultApplication': { 'Id': 'string', 'Arn': 'string' }, 'LocationStates': [ { 'LocationName': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123, 'RequestedCapacity': 123, 'AllocatedCapacity': 123, 'IdleCapacity': 123 }, ], 'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022', 'Id': 'string', 'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING', 'StatusReason': 'internalError'|'noAvailableInstances', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'AssociatedApplications': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]". * **Description** *(string) --* A descriptive label for the stream group. * **DefaultApplication** *(dict) --* The default Amazon GameLift Streams application that is associated with this stream group. * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **LocationStates** *(list) --* This value is the set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * *(dict) --* Represents a location and its corresponding stream capacity and status. * **LocationName** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). * **RequestedCapacity** *(integer) --* This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group. * **AllocatedCapacity** *(integer) --* This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. * **IdleCapacity** *(integer) --* This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity. * **StreamClass** *(string) --* The target stream quality for the stream group. A stream class can be one of the following: * "gen5n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen5n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen5n_ultra" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen4n_ultra" (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * **Id** *(string) --* A unique ID value that is assigned to the resource when it's created. Format example: "sg-1AB2C3De4". * **Status** *(string) --* The current status of the stream group resource. Possible statuses include the following: * "ACTIVATING": The stream group is deploying and isn't ready to host streams. * "ACTIVE": The stream group is ready to host streams. * "ACTIVE_WITH_ERRORS": One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * "ERROR": An error occurred when the stream group deployed. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the stream group. * "UPDATING_LOCATIONS": One or more locations in the stream group are in the process of updating (either activating or deleting). * **StatusReason** *(string) --* A short description of the reason that the stream group is in "ERROR" status. The possible reasons can be one of the following: * "internalError": The request can't process right now because of an issue with the server. Try again later. * "noAvailableInstances": Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **AssociatedApplications** *(list) --* A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / list_applications list_applications ***************** GameLiftStreams.Client.list_applications(**kwargs) Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed. See also: AWS API Documentation **Request Syntax** response = client.list_applications( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. * **MaxResults** (*integer*) -- The number of results to return. Use this parameter with "NextToken" to return results in sequential pages. Default value is "25". Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'Id': 'string', 'Description': 'string', 'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'RuntimeEnvironment': { 'Type': 'PROTON'|'WINDOWS'|'UBUNTU', 'Version': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. Each item includes application metadata and status. * *(dict) --* Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication. * **Arn** *(string) --* An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]". * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Description** *(string) --* A human-readable label for the application. You can edit this value. * **Status** *(string) --* The current status of the application resource. Possible statuses include the following: * "INITIALIZED": Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * "PROCESSING": The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group. * "READY": The application is ready to deploy in a stream group. * "ERROR": An error occurred when setting up the application. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the application. * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **RuntimeEnvironment** *(dict) --* Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. A runtime environment can be one of the following: * For Linux applications * Ubuntu 22.04 LTS ( "Type=UBUNTU, Version=22_04_LTS") * For Windows applications * Microsoft Windows Server 2022 Base ( "Type=WINDOWS, Version=2022") * Proton 9.0-2 ( "Type=PROTON, Version=20250516") * Proton 8.0-5 ( "Type=PROTON, Version=20241007") * Proton 8.0-2c ( "Type=PROTON, Version=20230704") * **Type** *(string) --* The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * **Version** *(string) --* Versioned container environment for the application operating system. * **NextToken** *(string) --* A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / get_paginator get_paginator ************* GameLiftStreams.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. GameLiftStreams / Client / create_stream_group create_stream_group ******************* GameLiftStreams.Client.create_stream_group(**kwargs) Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations. Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on- demand: * **Always-on**: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **On-demand**: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). To adjust the capacity of any "ACTIVE" stream group, call UpdateStreamGroup. If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to "ACTIVATING". When the stream group reaches "ACTIVE" status, you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup. See also: AWS API Documentation **Request Syntax** response = client.create_stream_group( Description='string', StreamClass='gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022', DefaultApplicationIdentifier='string', LocationConfigurations=[ { 'LocationName': 'string', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123 }, ], Tags={ 'string': 'string' }, ClientToken='string' ) Parameters: * **Description** (*string*) -- **[REQUIRED]** A descriptive label for the stream group. * **StreamClass** (*string*) -- **[REQUIRED]** The target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of content that you're streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The following options are available: A stream class can be one of the following: * "gen5n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen5n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen5n_ultra" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen4n_ultra" (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * **DefaultApplicationIdentifier** (*string*) -- The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in "READY" status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * **LocationConfigurations** (*list*) -- A set of one or more locations and the streaming capacity for each location. * *(dict) --* Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations. * **LocationName** *(string) --* **[REQUIRED]** A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). * **Tags** (*dict*) -- A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the *Amazon Web Services General Reference*. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'DefaultApplication': { 'Id': 'string', 'Arn': 'string' }, 'LocationStates': [ { 'LocationName': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123, 'RequestedCapacity': 123, 'AllocatedCapacity': 123, 'IdleCapacity': 123 }, ], 'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022', 'Id': 'string', 'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING', 'StatusReason': 'internalError'|'noAvailableInstances', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'AssociatedApplications': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]". * **Description** *(string) --* A descriptive label for the stream group. * **DefaultApplication** *(dict) --* The default Amazon GameLift Streams application that is associated with this stream group. * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **LocationStates** *(list) --* This value is the set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * *(dict) --* Represents a location and its corresponding stream capacity and status. * **LocationName** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). * **RequestedCapacity** *(integer) --* This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group. * **AllocatedCapacity** *(integer) --* This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. * **IdleCapacity** *(integer) --* This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity. * **StreamClass** *(string) --* The target stream quality for the stream group. A stream class can be one of the following: * "gen5n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen5n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen5n_ultra" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen4n_ultra" (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * **Id** *(string) --* A unique ID value that is assigned to the resource when it's created. Format example: "sg-1AB2C3De4". * **Status** *(string) --* The current status of the stream group resource. Possible statuses include the following: * "ACTIVATING": The stream group is deploying and isn't ready to host streams. * "ACTIVE": The stream group is ready to host streams. * "ACTIVE_WITH_ERRORS": One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * "ERROR": An error occurred when the stream group deployed. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the stream group. * "UPDATING_LOCATIONS": One or more locations in the stream group are in the process of updating (either activating or deleting). * **StatusReason** *(string) --* A short description of the reason that the stream group is in "ERROR" status. The possible reasons can be one of the following: * "internalError": The request can't process right now because of an issue with the server. Try again later. * "noAvailableInstances": Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **AssociatedApplications** *(list) --* A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" * "GameLiftStreams.Client.exceptions.ServiceQuotaExceededException" GameLiftStreams / Client / terminate_stream_session terminate_stream_session ************************ GameLiftStreams.Client.terminate_stream_session(**kwargs) Permanently terminates an active stream session. When called, the stream session status changes to "TERMINATING". You can terminate a stream session in any status except "ACTIVATING". If the stream session is in "ACTIVATING" status, an exception is thrown. See also: AWS API Documentation **Request Syntax** response = client.terminate_stream_session( Identifier='string', StreamSessionIdentifier='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams :us-west-2:111122223333:streamgroup/sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". The stream group that runs this stream session. * **StreamSessionIdentifier** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams :us-west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". Example ID: "ABC123def4567". Returns: None **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / can_paginate can_paginate ************ GameLiftStreams.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. GameLiftStreams / Client / export_stream_session_files export_stream_session_files *************************** GameLiftStreams.Client.export_stream_session_files(**kwargs) Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output. You can only call this action on a stream session that is in progress, specifically in one of the following statuses "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", and "RECONNECTING". You must provide an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your security credentials to authenticate and authorize access to your Amazon S3 bucket. Amazon GameLift Streams collects the following generated and modified files. Find them in the corresponding folders in the ".zip" archive. * "application/": The folder where your application or game is stored. * "profile/": The user profile folder. * "temp/": The system temp folder. To verify the status of the exported files, use GetStreamSession. To delete the files, delete the object in the S3 bucket. See also: AWS API Documentation **Request Syntax** response = client.export_stream_session_files( Identifier='string', StreamSessionIdentifier='string', OutputUri='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **StreamSessionIdentifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamsession /sg-1AB2C3De4/ABC123def4567". Example ID: "ABC123def4567". * **OutputUri** (*string*) -- **[REQUIRED]** 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 ".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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / list_stream_sessions list_stream_sessions ******************** GameLiftStreams.Client.list_stream_sessions(**kwargs) Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting. To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed. This operation returns the requested stream sessions in no particular order. See also: AWS API Documentation **Request Syntax** response = client.list_stream_sessions( Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING', NextToken='string', MaxResults=123, Identifier='string' ) Parameters: * **Status** (*string*) -- Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status. * **ExportFilesStatus** (*string*) -- Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status. Exported files can be in one of the following states: * **SUCCEEDED**: The exported files are successfully stored in S3 bucket. * **FAILED**: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3. * **PENDING**: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress. * **NextToken** (*string*) -- The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. * **MaxResults** (*integer*) -- The number of results to return. Use this parameter with "NextToken" to return results in sequential pages. Default value is "25". * **Identifier** (*string*) -- **[REQUIRED]** The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the Amazon Resource Name (ARN). Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'UserId': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', 'Protocol': 'WebRTC', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'ApplicationArn': 'string', 'ExportFilesMetadata': { 'Status': 'SUCCEEDED'|'FAILED'|'PENDING', 'StatusReason': 'string', 'OutputUri': 'string' }, 'Location': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status. * *(dict) --* Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession. * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". * **UserId** *(string) --* An opaque, unique identifier for an end-user, defined by the developer. * **Status** *(string) --* The current status of the stream session resource. Possible statuses include the following: * "ACTIVATING": The stream session is starting and preparing to stream. * "ACTIVE": The stream session is ready to accept client connections. * "CONNECTED": The stream session has a connected client. * "PENDING_CLIENT_RECONNECTION": A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to "TERMINATED". * "TERMINATING": The stream session is ending. * "TERMINATED": The stream session has ended. * "ERROR": The stream session failed to activate. * **Protocol** *(string) --* The data transfer protocol in use with the stream session. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **ApplicationArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **ExportFilesMetadata** *(dict) --* Provides details about the stream session's exported files. * **Status** *(string) --* The result of the ExportStreamSessionFiles operation. * **StatusReason** *(string) --* A short description of the reason the export is in "FAILED" status. * **OutputUri** *(string) --* 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. * **Location** *(string) --* The location where Amazon GameLift Streams is hosting the stream session. A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **NextToken** *(string) --* A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / update_stream_group update_stream_group ******************* GameLiftStreams.Client.update_stream_group(**kwargs) Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group. Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on- demand: * **Always-on**: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **On-demand**: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group. See also: AWS API Documentation **Request Syntax** response = client.update_stream_group( Identifier='string', LocationConfigurations=[ { 'LocationName': 'string', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123 }, ], Description='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **LocationConfigurations** (*list*) -- A set of one or more locations and the streaming capacity for each location. * *(dict) --* Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations. * **LocationName** *(string) --* **[REQUIRED]** A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). * **Description** (*string*) -- A descriptive label for the stream group. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'DefaultApplication': { 'Id': 'string', 'Arn': 'string' }, 'LocationStates': [ { 'LocationName': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123, 'RequestedCapacity': 123, 'AllocatedCapacity': 123, 'IdleCapacity': 123 }, ], 'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022', 'Id': 'string', 'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING', 'StatusReason': 'internalError'|'noAvailableInstances', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'AssociatedApplications': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]". * **Description** *(string) --* A descriptive label for the stream group. * **DefaultApplication** *(dict) --* The default Amazon GameLift Streams application that is associated with this stream group. * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **LocationStates** *(list) --* This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * *(dict) --* Represents a location and its corresponding stream capacity and status. * **LocationName** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). * **RequestedCapacity** *(integer) --* This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group. * **AllocatedCapacity** *(integer) --* This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. * **IdleCapacity** *(integer) --* This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity. * **StreamClass** *(string) --* The target stream quality for the stream group. A stream class can be one of the following: * "gen5n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen5n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen5n_ultra" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen4n_ultra" (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * **Id** *(string) --* A unique ID value that is assigned to the resource when it's created. Format example: "sg-1AB2C3De4". * **Status** *(string) --* The current status of the stream group resource. Possible statuses include the following: * "ACTIVATING": The stream group is deploying and isn't ready to host streams. * "ACTIVE": The stream group is ready to host streams. * "ACTIVE_WITH_ERRORS": One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * "ERROR": An error occurred when the stream group deployed. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the stream group. * "UPDATING_LOCATIONS": One or more locations in the stream group are in the process of updating (either activating or deleting). * **StatusReason** *(string) --* A short description of the reason that the stream group is in "ERROR" status. The possible reasons can be one of the following: * "internalError": The request can't process right now because of an issue with the server. Try again later. * "noAvailableInstances": Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **AssociatedApplications** *(list) --* A set of applications that this stream group is associated with. You can stream any of these applications with the stream group. This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" * "GameLiftStreams.Client.exceptions.ServiceQuotaExceededException" GameLiftStreams / Client / list_tags_for_resource list_tags_for_resource ********************** GameLiftStreams.Client.list_tags_for_resource(**kwargs) Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource. **Learn more** Tagging Amazon Web Services Resources in the *Amazon Web Services General Reference* Amazon Web Services Tagging Strategies See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that you want to retrieve tags for. To get an Amazon GameLift Streams resource ARN, call a List or Get operation for the resource. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* A collection of tags that have been assigned to the specified resource. * *(string) --* * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / untag_resource untag_resource ************** GameLiftStreams.Client.untag_resource(**kwargs) Removes one or more tags from a Amazon GameLift Streams resource. To remove tags, specify the Amazon GameLift Streams resource and a list of one or more tags to remove. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to remove tags from. * **TagKeys** (*list*) -- **[REQUIRED]** A list of tag keys to remove from the specified Amazon GameLift Streams resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / remove_stream_group_locations remove_stream_group_locations ***************************** GameLiftStreams.Client.remove_stream_group_locations(**kwargs) Removes a set of remote locations from this stream group. Amazon GameLift Streams works to release allocated compute resources in these location. Thus, stream sessions can no longer start from these locations by using this stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal S3 bucket at this location. You cannot remove the region where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero. See also: AWS API Documentation **Request Syntax** response = client.remove_stream_group_locations( Identifier='string', Locations=[ 'string', ] ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** A stream group to remove the specified locations from. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **Locations** (*list*) -- **[REQUIRED]** A set of locations to remove this stream group. A set of location names. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * *(string) --* Returns: None **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / get_waiter get_waiter ********** GameLiftStreams.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" GameLiftStreams / Client / list_stream_groups list_stream_groups ****************** GameLiftStreams.Client.list_stream_groups(**kwargs) Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed. See also: AWS API Documentation **Request Syntax** response = client.list_stream_groups( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- A token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. * **MaxResults** (*integer*) -- The number of results to return. Use this parameter with "NextToken" to return results in sequential pages. Default value is "25". Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'Id': 'string', 'Description': 'string', 'DefaultApplication': { 'Id': 'string', 'Arn': 'string' }, 'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022', 'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and status, but doesn't include capacity information. * *(dict) --* Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup. * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamgroup/sg-1AB2C3De4". * **Id** *(string) --* An ID that uniquely identifies the stream group resource. Example ID: "sg-1AB2C3De4". * **Description** *(string) --* A descriptive label for the stream group. * **DefaultApplication** *(dict) --* Object that identifies the Amazon GameLift Streams application to stream with this stream group. * **Id** *(string) --* An ID that uniquely identifies the application resource. Example ID: "a-9ZY8X7Wv6". * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **StreamClass** *(string) --* The target stream quality for the stream group. A stream class can be one of the following: * "gen5n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen5n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen5n_ultra" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_win2022" (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * "gen4n_high" (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * Tenancy: Supports up to 2 concurrent stream sessions * "gen4n_ultra" (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU. * Reference resolution: 1080p * Reference frame rate: 60 fps * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * Tenancy: Supports 1 concurrent stream session * **Status** *(string) --* The current status of the stream group resource. Possible statuses include the following: * "ACTIVATING": The stream group is deploying and isn't ready to host streams. * "ACTIVE": The stream group is ready to host streams. * "ACTIVE_WITH_ERRORS": One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * "ERROR": An error occurred when the stream group deployed. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the stream group. * "UPDATING_LOCATIONS": One or more locations in the stream group are in the process of updating (either activating or deleting). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **NextToken** *(string) --* A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / start_stream_session start_stream_session ******************** GameLiftStreams.Client.start_stream_session(**kwargs) This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using AssociateApplications. For stream groups that have multiple locations, provide a set of locations ordered by priority using a "Locations" parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating in a remote location before the remote location can host a stream. If the request is successful, Amazon GameLift Streams begins to prepare the stream. Amazon GameLift Streams assigns an Amazon Resource Name (ARN) value to the stream session resource and sets the status to "ACTIVATING". During the stream preparation process, Amazon GameLift Streams queues the request and searches for available stream capacity to run the stream. This results in one of the following: * Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to "ACTIVE" and includes stream connection information. Provide the connection information to the requesting client to join the stream session. * Amazon GameLift Streams doesn't identify an available resource within a certain time, set by "ClientToken". In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes to "ERROR" with status reason "placementTimeout". See also: AWS API Documentation **Request Syntax** response = client.start_stream_session( ClientToken='string', Description='string', Identifier='string', Protocol='WebRTC', SignalRequest='string', ApplicationIdentifier='string', UserId='string', Locations=[ 'string', ], ConnectionTimeoutSeconds=123, SessionLengthSeconds=123, AdditionalLaunchArgs=[ 'string', ], AdditionalEnvironmentVariables={ 'string': 'string' } ) Parameters: * **ClientToken** (*string*) -- A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. This field is autopopulated if not provided. * **Description** (*string*) -- A human-readable label for the stream session. You can update this value later. * **Identifier** (*string*) -- **[REQUIRED]** The stream group to run this stream session with. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **Protocol** (*string*) -- **[REQUIRED]** The data transport protocol to use for the stream session. * **SignalRequest** (*string*) -- **[REQUIRED]** A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes. Amazon GameLift Streams also supports setting the field to "NO_CLIENT_CONNECTION". This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using CreateStreamSessionConnection. * **ApplicationIdentifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * **UserId** (*string*) -- An opaque, unique identifier for an end-user, defined by the developer. * **Locations** (*list*) -- A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location. This value is A set of location names. For example, "us- east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * *(string) --* * **ConnectionTimeoutSeconds** (*integer*) -- Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches "ACTIVE" status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of "TERMINATED". Default value is 120. * **SessionLengthSeconds** (*integer*) -- The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. Default value is 43200. * **AdditionalLaunchArgs** (*list*) -- A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. "AdditionalEnvironmentVariables" and "AdditionalLaunchArgs" have similar purposes. "AdditionalEnvironmentVariables" passes data using environment variables; while "AdditionalLaunchArgs" passes data using command-line arguments. * *(string) --* * **AdditionalEnvironmentVariables** (*dict*) -- A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. Note: If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. "AdditionalEnvironmentVariables" and "AdditionalLaunchArgs" have similar purposes. "AdditionalEnvironmentVariables" passes data using environment variables; while "AdditionalLaunchArgs" passes data using command-line arguments. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'StreamGroupId': 'string', 'UserId': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', 'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError', 'Protocol': 'WebRTC', 'Location': 'string', 'SignalRequest': 'string', 'SignalResponse': 'string', 'ConnectionTimeoutSeconds': 123, 'SessionLengthSeconds': 123, 'AdditionalLaunchArgs': [ 'string', ], 'AdditionalEnvironmentVariables': { 'string': 'string' }, 'LogFileLocationUri': 'string', 'WebSdkProtocolUrl': 'string', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'ApplicationArn': 'string', 'ExportFilesMetadata': { 'Status': 'SUCCEEDED'|'FAILED'|'PENDING', 'StatusReason': 'string', 'OutputUri': 'string' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID]". * **Description** *(string) --* A human-readable label for the stream session. You can update this value at any time. * **StreamGroupId** *(string) --* The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: "sg-1AB2C3De4". * **UserId** *(string) --* An opaque, unique identifier for an end-user, defined by the developer. * **Status** *(string) --* The current status of the stream session. A stream session can host clients when in "ACTIVE" status. * **StatusReason** *(string) --* A short description of the reason the stream session is in "ERROR" status. * **Protocol** *(string) --* The data transfer protocol in use with the stream session. * **Location** *(string) --* The location where Amazon GameLift Streams is streaming your application from. A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **SignalRequest** *(string) --* The WebRTC ICE offer string that a client generates to initiate a connection to the stream session. * **SignalResponse** *(string) --* The WebRTC answer string that the stream server generates in response to the "SignalRequest". * **ConnectionTimeoutSeconds** *(integer) --* The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. * **SessionLengthSeconds** *(integer) --* The length of time that Amazon GameLift Streams keeps the game session open. * **AdditionalLaunchArgs** *(list) --* A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. "AdditionalEnvironmentVariables" and "AdditionalLaunchArgs" have similar purposes. "AdditionalEnvironmentVariables" passes data using environment variables; while "AdditionalLaunchArgs" passes data using command-line arguments. * *(string) --* * **AdditionalEnvironmentVariables** *(dict) --* A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. Note: If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. "AdditionalEnvironmentVariables" and "AdditionalLaunchArgs" have similar purposes. "AdditionalEnvironmentVariables" passes data using environment variables; while "AdditionalLaunchArgs" passes data using command-line arguments. * *(string) --* * *(string) --* * **LogFileLocationUri** *(string) --* Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload. * **WebSdkProtocolUrl** *(string) --* The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **ApplicationArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams :us-west-2:111122223333:application/a-9ZY8X7Wv6". * **ExportFilesMetadata** *(dict) --* Provides details about the stream session's exported files. * **Status** *(string) --* The result of the ExportStreamSessionFiles operation. * **StatusReason** *(string) --* A short description of the reason the export is in "FAILED" status. * **OutputUri** *(string) --* 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. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / add_stream_group_locations add_stream_group_locations ************************** GameLiftStreams.Client.add_stream_group_locations(**kwargs) Add locations that can host stream sessions. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality. This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions. See also: AWS API Documentation **Request Syntax** response = client.add_stream_group_locations( Identifier='string', LocationConfigurations=[ { 'LocationName': 'string', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123 }, ] ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** A stream group to add the specified locations to. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **LocationConfigurations** (*list*) -- **[REQUIRED]** A set of one or more locations and the streaming capacity for each location. * *(dict) --* Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations. * **LocationName** *(string) --* **[REQUIRED]** A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Return type: dict Returns: **Response Syntax** { 'Identifier': 'string', 'Locations': [ { 'LocationName': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING', 'AlwaysOnCapacity': 123, 'OnDemandCapacity': 123, 'RequestedCapacity': 123, 'AllocatedCapacity': 123, 'IdleCapacity': 123 }, ] } **Response Structure** * *(dict) --* * **Identifier** *(string) --* This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **Locations** *(list) --* This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * *(dict) --* Represents a location and its corresponding stream capacity and status. * **LocationName** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* This value is set of locations, including their name, current status, and capacities. A location can be in one of the following states: * **ACTIVATING**: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * **ACTIVE**: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * **ERROR**: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * **REMOVING**: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * **AlwaysOnCapacity** *(integer) --* The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. * **OnDemandCapacity** *(integer) --* The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de- allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). * **RequestedCapacity** *(integer) --* This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group. * **AllocatedCapacity** *(integer) --* This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. * **IdleCapacity** *(integer) --* This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" * "GameLiftStreams.Client.exceptions.ServiceQuotaExceededException" GameLiftStreams / Client / update_application update_application ****************** GameLiftStreams.Client.update_application(**kwargs) Updates the mutable configuration settings for a Amazon GameLift Streams application resource. You can change the "Description", "ApplicationLogOutputUri", and "ApplicationLogPaths". To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application. See also: AWS API Documentation **Request Syntax** response = client.update_application( Identifier='string', Description='string', ApplicationLogPaths=[ 'string', ], ApplicationLogOutputUri='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * **Description** (*string*) -- A human-readable label for the application. * **ApplicationLogPaths** (*list*) -- Locations of log files that your content generates during a stream session. Enter path values that are relative to the "ApplicationSourceUri" location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in "ApplicationLogOutputUri" at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the "LogFileLocationUri". * *(string) --* * **ApplicationLogOutputUri** (*string*) -- An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more "ApplicationLogPaths". Note: The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the *Amazon GameLift Streams Developer Guide*. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'RuntimeEnvironment': { 'Type': 'PROTON'|'WINDOWS'|'UBUNTU', 'Version': 'string' }, 'ExecutablePath': 'string', 'ApplicationLogPaths': [ 'string', ], 'ApplicationLogOutputUri': 'string', 'ApplicationSourceUri': 'string', 'Id': 'string', 'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR', 'StatusReason': 'internalError'|'accessDenied', 'ReplicationStatuses': [ { 'Location': 'string', 'Status': 'REPLICATING'|'COMPLETED' }, ], 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AssociatedStreamGroups': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]". * **Description** *(string) --* A human-readable label for the application. You can edit this value. * **RuntimeEnvironment** *(dict) --* Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. A runtime environment can be one of the following: * For Linux applications * Ubuntu 22.04 LTS ( "Type=UBUNTU, Version=22_04_LTS") * For Windows applications * Microsoft Windows Server 2022 Base ( "Type=WINDOWS, Version=2022") * Proton 9.0-2 ( "Type=PROTON, Version=20250516") * Proton 8.0-5 ( "Type=PROTON, Version=20241007") * Proton 8.0-2c ( "Type=PROTON, Version=20230704") * **Type** *(string) --* The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * **Version** *(string) --* Versioned container environment for the application operating system. * **ExecutablePath** *(string) --* The path and file name of the executable file that launches the content for streaming. * **ApplicationLogPaths** *(list) --* Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in "ApplicationLogOutputUri" at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the "LogFileLocationUri". * *(string) --* * **ApplicationLogOutputUri** *(string) --* An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more "ApplicationLogPaths". * **ApplicationSourceUri** *(string) --* The original Amazon S3 location of uploaded stream content for the application. * **Id** *(string) --* A unique ID value that is assigned to the resource when it's created. Format example: "a-9ZY8X7Wv6". * **Status** *(string) --* The current status of the application resource. Possible statuses include the following: * "INITIALIZED": Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * "PROCESSING": The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group. * "READY": The application is ready to deploy in a stream group. * "ERROR": An error occurred when setting up the application. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the application. * **StatusReason** *(string) --* A short description of the status reason when the application is in "ERROR" status. * **ReplicationStatuses** *(list) --* A set of replication statuses for each location. * *(dict) --* Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there. * **Location** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* The current status of the replication process. * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **AssociatedStreamGroups** *(list) --* A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application. This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / close close ***** GameLiftStreams.Client.close() Closes underlying endpoint connections. GameLiftStreams / Client / delete_stream_group delete_stream_group ******************* GameLiftStreams.Client.delete_stream_group(**kwargs) Permanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream group identifier. During the deletion process, the stream group's status is "DELETING". This operation stops streams in progress and prevents new streams from starting. As a best practice, before deleting the stream group, call ListStreamSessions to check for streams in progress and take action to stop them. When you delete a stream group, any application associations referring to that stream group are automatically removed. See also: AWS API Documentation **Request Syntax** response = client.delete_stream_group( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamgroup/sg-1AB2C3De4". Example ID: "sg- 1AB2C3De4". Returns: None **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / create_stream_session_connection create_stream_session_connection ******************************** GameLiftStreams.Client.create_stream_session_connection(**kwargs) Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session. A client can reconnect to a stream session that's in "PENDING_CLIENT_RECONNECTION" or "ACTIVE" status. In the stream session life cycle, when the client disconnects from the stream session, the stream session transitions from "CONNECTED" to "PENDING_CLIENT_RECONNECTION" status. When a client requests to reconnect by calling "CreateStreamSessionConnection", the stream session transitions to "RECONNECTING" status. When the reconnection is successful, the stream session transitions to "ACTIVE" status. After a stream session is disconnected for longer than "ConnectionTimeoutSeconds", the stream session transitions to the "TERMINATED" status. To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream. "ConnectionTimeoutSeconds" defines the amount of time after the stream session disconnects that a reconnection is allowed. If a client is disconnected from the stream for longer than "ConnectionTimeoutSeconds", the stream session ends. See also: AWS API Documentation **Request Syntax** response = client.create_stream_session_connection( ClientToken='string', Identifier='string', StreamSessionIdentifier='string', SignalRequest='string' ) Parameters: * **ClientToken** (*string*) -- A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. This field is autopopulated if not provided. * **Identifier** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams :us-west-2:111122223333:streamgroup/sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". The stream group that you want to run this stream session with. The stream group must be in "ACTIVE" status and have idle stream capacity. * **StreamSessionIdentifier** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams :us-west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". Example ID: "ABC123def4567". The stream session must be in "PENDING_CLIENT_RECONNECTION" or "ACTIVE" status. * **SignalRequest** (*string*) -- **[REQUIRED]** A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to "StartStreamSession". Return type: dict Returns: **Response Syntax** { 'SignalResponse': 'string' } **Response Structure** * *(dict) --* * **SignalResponse** *(string) --* The WebRTC answer string that the stream server generates in response to the "SignalRequest". **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / associate_applications associate_applications ********************** GameLiftStreams.Client.associate_applications(**kwargs) When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in "ACTIVE" status. You can reverse this action by using DisassociateApplications. See also: AWS API Documentation **Request Syntax** response = client.associate_applications( Identifier='string', ApplicationIdentifiers=[ 'string', ] ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** A stream group to associate to the applications. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **ApplicationIdentifiers** (*list*) -- **[REQUIRED]** A set of applications to associate with the stream group. This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ApplicationArns': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* A stream group that is associated to the applications. This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". * **ApplicationArns** *(list) --* A set of applications that are associated to the stream group. This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" * "GameLiftStreams.Client.exceptions.ServiceQuotaExceededException" GameLiftStreams / Client / delete_application delete_application ****************** GameLiftStreams.Client.delete_application(**kwargs) Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket. You can only delete an application that meets the following conditions: * The application is in "READY" or "ERROR" status. You cannot delete an application that's in "PROCESSING" or "INITIALIZED" status. * The application is not the default application of any stream groups. You must first delete the stream group by using DeleteStreamGroup. * The application is not linked to any stream groups. You must first unlink the stream group by using DisassociateApplications. * An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call TerminateStreamSession to end the stream. If any active stream groups exist for this application, this request returns a "ValidationException". See also: AWS API Documentation **Request Syntax** response = client.delete_application( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". Returns: None **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / create_application create_application ****************** GameLiftStreams.Client.create_application(**kwargs) Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it. Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see **Getting Started** in the Amazon GameLift Streams Developer Guide. Warning: Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application. If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to "INITIALIZED". When an application reaches "READY" status, you can use the application to set up stream groups and start streams. To track application status, call GetApplication. See also: AWS API Documentation **Request Syntax** response = client.create_application( Description='string', RuntimeEnvironment={ 'Type': 'PROTON'|'WINDOWS'|'UBUNTU', 'Version': 'string' }, ExecutablePath='string', ApplicationSourceUri='string', ApplicationLogPaths=[ 'string', ], ApplicationLogOutputUri='string', Tags={ 'string': 'string' }, ClientToken='string' ) Parameters: * **Description** (*string*) -- **[REQUIRED]** A human-readable label for the application. You can update this value later. * **RuntimeEnvironment** (*dict*) -- **[REQUIRED]** Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. A runtime environment can be one of the following: * For Linux applications * Ubuntu 22.04 LTS ( "Type=UBUNTU, Version=22_04_LTS") * For Windows applications * Microsoft Windows Server 2022 Base ( "Type=WINDOWS, Version=2022") * Proton 9.0-2 ( "Type=PROTON, Version=20250516") * Proton 8.0-5 ( "Type=PROTON, Version=20241007") * Proton 8.0-2c ( "Type=PROTON, Version=20230704") * **Type** *(string) --* **[REQUIRED]** The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * **Version** *(string) --* **[REQUIRED]** Versioned container environment for the application operating system. * **ExecutablePath** (*string*) -- **[REQUIRED]** The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in "ApplicationSourceUri". * **ApplicationSourceUri** (*string*) -- **[REQUIRED]** The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location. This value is immutable. To designate a different content location, create a new application. Note: The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region. * **ApplicationLogPaths** (*list*) -- Locations of log files that your content generates during a stream session. Enter path values that are relative to the "ApplicationSourceUri" location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in "ApplicationLogOutputUri" at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the "LogFileLocationUri". * *(string) --* * **ApplicationLogOutputUri** (*string*) -- An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more "ApplicationLogPaths". Note: The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the *Amazon GameLift Streams Developer Guide*. * **Tags** (*dict*) -- A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the *Amazon Web Services General Reference*. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'RuntimeEnvironment': { 'Type': 'PROTON'|'WINDOWS'|'UBUNTU', 'Version': 'string' }, 'ExecutablePath': 'string', 'ApplicationLogPaths': [ 'string', ], 'ApplicationLogOutputUri': 'string', 'ApplicationSourceUri': 'string', 'Id': 'string', 'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR', 'StatusReason': 'internalError'|'accessDenied', 'ReplicationStatuses': [ { 'Location': 'string', 'Status': 'REPLICATING'|'COMPLETED' }, ], 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AssociatedStreamGroups': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]". * **Description** *(string) --* A human-readable label for the application. You can edit this value. * **RuntimeEnvironment** *(dict) --* Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. A runtime environment can be one of the following: * For Linux applications * Ubuntu 22.04 LTS ( "Type=UBUNTU, Version=22_04_LTS") * For Windows applications * Microsoft Windows Server 2022 Base ( "Type=WINDOWS, Version=2022") * Proton 9.0-2 ( "Type=PROTON, Version=20250516") * Proton 8.0-5 ( "Type=PROTON, Version=20241007") * Proton 8.0-2c ( "Type=PROTON, Version=20230704") * **Type** *(string) --* The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * **Version** *(string) --* Versioned container environment for the application operating system. * **ExecutablePath** *(string) --* The path and file name of the executable file that launches the content for streaming. * **ApplicationLogPaths** *(list) --* Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in "ApplicationLogOutputUri" at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the "LogFileLocationUri". * *(string) --* * **ApplicationLogOutputUri** *(string) --* An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more "ApplicationLogPaths". * **ApplicationSourceUri** *(string) --* The original Amazon S3 location of uploaded stream content for the application. * **Id** *(string) --* A unique ID value that is assigned to the resource when it's created. Format example: "a-9ZY8X7Wv6". * **Status** *(string) --* The current status of the application resource. Possible statuses include the following: * "INITIALIZED": Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * "PROCESSING": The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group. * "READY": The application is ready to deploy in a stream group. * "ERROR": An error occurred when setting up the application. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the application. * **StatusReason** *(string) --* A short description of the status reason when the application is in "ERROR" status. * **ReplicationStatuses** *(list) --* A set of replication statuses for each location. * *(dict) --* Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there. * **Location** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* The current status of the replication process. * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **AssociatedStreamGroups** *(list) --* A newly created application is not associated to any stream groups. This value is empty. * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ConflictException" * "GameLiftStreams.Client.exceptions.ValidationException" * "GameLiftStreams.Client.exceptions.ServiceQuotaExceededException" GameLiftStreams / Client / tag_resource tag_resource ************ GameLiftStreams.Client.tag_resource(**kwargs) Assigns one or more tags to a Amazon GameLift Streams resource. Use tags to organize Amazon Web Services resources for a range of purposes. You can assign tags to the following Amazon GameLift Streams resource types: * Application * StreamGroup **Learn more** Tagging Amazon Web Services Resources in the *Amazon Web Services General Reference* Amazon Web Services Tagging Strategies See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to apply tags to. * **Tags** (*dict*) -- **[REQUIRED]** A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / get_stream_session get_stream_session ****************** GameLiftStreams.Client.get_stream_session(**kwargs) Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource. See also: AWS API Documentation **Request Syntax** response = client.get_stream_session( Identifier='string', StreamSessionIdentifier='string' ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** The stream group that runs this stream session. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **StreamSessionIdentifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamsession /sg-1AB2C3De4/ABC123def4567". Example ID: "ABC123def4567". Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'StreamGroupId': 'string', 'UserId': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', 'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError', 'Protocol': 'WebRTC', 'Location': 'string', 'SignalRequest': 'string', 'SignalResponse': 'string', 'ConnectionTimeoutSeconds': 123, 'SessionLengthSeconds': 123, 'AdditionalLaunchArgs': [ 'string', ], 'AdditionalEnvironmentVariables': { 'string': 'string' }, 'LogFileLocationUri': 'string', 'WebSdkProtocolUrl': 'string', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'ApplicationArn': 'string', 'ExportFilesMetadata': { 'Status': 'SUCCEEDED'|'FAILED'|'PENDING', 'StatusReason': 'string', 'OutputUri': 'string' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID]". * **Description** *(string) --* A human-readable label for the stream session. You can update this value at any time. * **StreamGroupId** *(string) --* The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: "sg-1AB2C3De4". * **UserId** *(string) --* An opaque, unique identifier for an end-user, defined by the developer. * **Status** *(string) --* The current status of the stream session. A stream session can host clients when in "ACTIVE" status. * **StatusReason** *(string) --* A short description of the reason the stream session is in "ERROR" status. * **Protocol** *(string) --* The data transfer protocol in use with the stream session. * **Location** *(string) --* The location where Amazon GameLift Streams is hosting the stream session. A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **SignalRequest** *(string) --* The WebRTC ICE offer string that a client generates to initiate a connection to the stream session. * **SignalResponse** *(string) --* The WebRTC answer string that the stream server generates in response to the "SignalRequest". * **ConnectionTimeoutSeconds** *(integer) --* The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. * **SessionLengthSeconds** *(integer) --* The length of time that Amazon GameLift Streams keeps the game session open. * **AdditionalLaunchArgs** *(list) --* A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. "AdditionalEnvironmentVariables" and "AdditionalLaunchArgs" have similar purposes. "AdditionalEnvironmentVariables" passes data using environment variables; while "AdditionalLaunchArgs" passes data using command-line arguments. * *(string) --* * **AdditionalEnvironmentVariables** *(dict) --* A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. Note: If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. "AdditionalEnvironmentVariables" and "AdditionalLaunchArgs" have similar purposes. "AdditionalEnvironmentVariables" passes data using environment variables; while "AdditionalLaunchArgs" passes data using command-line arguments. * *(string) --* * *(string) --* * **LogFileLocationUri** *(string) --* Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload. * **WebSdkProtocolUrl** *(string) --* The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **ApplicationArn** *(string) --* The application streaming in this session. This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **ExportFilesMetadata** *(dict) --* Provides details about the stream session's exported files. * **Status** *(string) --* The result of the ExportStreamSessionFiles operation. * **StatusReason** *(string) --* A short description of the reason the export is in "FAILED" status. * **OutputUri** *(string) --* 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. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / disassociate_applications disassociate_applications ************************* GameLiftStreams.Client.disassociate_applications(**kwargs) When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group. You can only disassociate an application if it's not a default application of the stream group. Check "DefaultApplicationIdentifier" by calling GetStreamGroup. See also: AWS API Documentation **Request Syntax** response = client.disassociate_applications( Identifier='string', ApplicationIdentifiers=[ 'string', ] ) Parameters: * **Identifier** (*string*) -- **[REQUIRED]** A stream group to disassociate these applications from. This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". Example ID: "sg-1AB2C3De4". * **ApplicationIdentifiers** (*list*) -- **[REQUIRED]** A set of applications that you want to disassociate from the stream group. This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ApplicationArns': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: "arn:aws:gameliftstreams :us-west-2:111122223333:streamgroup/sg-1AB2C3De4". * **ApplicationArns** *(list) --* A set of applications that are disassociated from this stream group. This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / list_stream_sessions_by_account list_stream_sessions_by_account ******************************* GameLiftStreams.Client.list_stream_sessions_by_account(**kwargs) Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to. In the returned list of stream sessions, the "ExportFilesMetadata" property only shows the "Status" value. To get the "OutpurUri" and "StatusReason" values, use GetStreamSession. We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use GetStreamSession. See also: AWS API Documentation **Request Syntax** response = client.list_stream_sessions_by_account( Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING', NextToken='string', MaxResults=123 ) Parameters: * **Status** (*string*) -- Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status. * **ExportFilesStatus** (*string*) -- Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status. * **NextToken** (*string*) -- The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. * **MaxResults** (*integer*) -- The number of results to return. Use this parameter with "NextToken" to return results in sequential pages. Default value is "25". Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'UserId': 'string', 'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR', 'Protocol': 'WebRTC', 'LastUpdatedAt': datetime(2015, 1, 1), 'CreatedAt': datetime(2015, 1, 1), 'ApplicationArn': 'string', 'ExportFilesMetadata': { 'Status': 'SUCCEEDED'|'FAILED'|'PENDING', 'StatusReason': 'string', 'OutputUri': 'string' }, 'Location': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status. * *(dict) --* Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession. * **Arn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:streamsession/sg- 1AB2C3De4/ABC123def4567". * **UserId** *(string) --* An opaque, unique identifier for an end-user, defined by the developer. * **Status** *(string) --* The current status of the stream session resource. Possible statuses include the following: * "ACTIVATING": The stream session is starting and preparing to stream. * "ACTIVE": The stream session is ready to accept client connections. * "CONNECTED": The stream session has a connected client. * "PENDING_CLIENT_RECONNECTION": A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to "TERMINATED". * "TERMINATING": The stream session is ending. * "TERMINATED": The stream session has ended. * "ERROR": The stream session failed to activate. * **Protocol** *(string) --* The data transfer protocol in use with the stream session. * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **ApplicationArn** *(string) --* An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". * **ExportFilesMetadata** *(dict) --* Provides details about the stream session's exported files. * **Status** *(string) --* The result of the ExportStreamSessionFiles operation. * **StatusReason** *(string) --* A short description of the reason the export is in "FAILED" status. * **OutputUri** *(string) --* 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. * **Location** *(string) --* The location where Amazon GameLift Streams is hosting the stream session. A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **NextToken** *(string) --* A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list. **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException" GameLiftStreams / Client / get_application get_application *************** GameLiftStreams.Client.get_application(**kwargs) Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application. See also: AWS API Documentation **Request Syntax** response = client.get_application( Identifier='string' ) Parameters: **Identifier** (*string*) -- **[REQUIRED]** An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: "arn:aws:gameliftstreams:us- west-2:111122223333:application/a-9ZY8X7Wv6". Example ID: "a-9ZY8X7Wv6". Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Description': 'string', 'RuntimeEnvironment': { 'Type': 'PROTON'|'WINDOWS'|'UBUNTU', 'Version': 'string' }, 'ExecutablePath': 'string', 'ApplicationLogPaths': [ 'string', ], 'ApplicationLogOutputUri': 'string', 'ApplicationSourceUri': 'string', 'Id': 'string', 'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR', 'StatusReason': 'internalError'|'accessDenied', 'ReplicationStatuses': [ { 'Location': 'string', 'Status': 'REPLICATING'|'COMPLETED' }, ], 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AssociatedStreamGroups': [ 'string', ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is "arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]". * **Description** *(string) --* A human-readable label for the application. You can edit this value. * **RuntimeEnvironment** *(dict) --* Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers. A runtime environment can be one of the following: * For Linux applications * Ubuntu 22.04 LTS ( "Type=UBUNTU, Version=22_04_LTS") * For Windows applications * Microsoft Windows Server 2022 Base ( "Type=WINDOWS, Version=2022") * Proton 9.0-2 ( "Type=PROTON, Version=20250516") * Proton 8.0-5 ( "Type=PROTON, Version=20241007") * Proton 8.0-2c ( "Type=PROTON, Version=20230704") * **Type** *(string) --* The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * **Version** *(string) --* Versioned container environment for the application operating system. * **ExecutablePath** *(string) --* The path and file name of the executable file that launches the content for streaming. * **ApplicationLogPaths** *(list) --* Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in "ApplicationLogOutputUri" at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the "LogFileLocationUri". * *(string) --* * **ApplicationLogOutputUri** *(string) --* An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more "ApplicationLogPaths". * **ApplicationSourceUri** *(string) --* The original Amazon S3 location of uploaded stream content for the application. * **Id** *(string) --* A unique ID value that is assigned to the resource when it's created. Format example: "a-9ZY8X7Wv6". * **Status** *(string) --* The current status of the application resource. Possible statuses include the following: * "INITIALIZED": Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * "PROCESSING": The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group. * "READY": The application is ready to deploy in a stream group. * "ERROR": An error occurred when setting up the application. See "StatusReason" for more information. * "DELETING": Amazon GameLift Streams is in the process of deleting the application. * **StatusReason** *(string) --* A short description of the status reason when the application is in "ERROR" status. * **ReplicationStatuses** *(list) --* A set of replication statuses for each location. * *(dict) --* Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there. * **Location** *(string) --* A location's name. For example, "us-east-1". For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the *Amazon GameLift Streams Developer Guide*. * **Status** *(string) --* The current status of the replication process. * **CreatedAt** *(datetime) --* A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **LastUpdatedAt** *(datetime) --* A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: "2022-12-27T22:29:40+00:00" (UTC). * **AssociatedStreamGroups** *(list) --* A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application. This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: "arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup /sg-1AB2C3De4". * *(string) --* **Exceptions** * "GameLiftStreams.Client.exceptions.AccessDeniedException" * "GameLiftStreams.Client.exceptions.ResourceNotFoundException" * "GameLiftStreams.Client.exceptions.ThrottlingException" * "GameLiftStreams.Client.exceptions.InternalServerException" * "GameLiftStreams.Client.exceptions.ValidationException"