2025/03/05 - Amazon GameLift Streams - 24 new api methods
Changes New Service: Amazon GameLift Streams delivers low-latency game streaming from AWS global infrastructure to virtually any device with a browser at up to 1080p resolution and 60 fps.
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
client.list_stream_groups(
MaxResults=123,
NextToken='string'
)
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
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.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DefaultApplication': {
'Arn': 'string',
'Id': 'string'
},
'Description': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING',
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'
},
],
'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) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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).
DefaultApplication (dict) --
Object that identifies the Amazon GameLift Streams application to stream with this stream group.
Arn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
Id (string) --
The default application of the stream group.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
Description (string) --
A descriptive label for the stream group.
Id (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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).
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).
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 most Unreal Engine 5.x builds, 32-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 most Unreal Engine 5.2 and 5.3 builds, 32-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
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.
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
client.add_stream_group_locations(
Identifier='string',
LocationConfigurations=[
{
'AlwaysOnCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123
},
]
)
string
[REQUIRED]
A stream group to add the specified locations to.
This value is a Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: 1AB2C3De4.
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.
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.
LocationName (string) -- [REQUIRED]
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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).
dict
Response Syntax
{
'Identifier': 'string',
'Locations': [
{
'AllocatedCapacity': 123,
'AlwaysOnCapacity': 123,
'IdleCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123,
'RequestedCapacity': 123,
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING'
},
]
}
Response Structure
(dict) --
Identifier (string) --
This value is the Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: 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.
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.
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.
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.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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.
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.
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
client.get_application(
Identifier='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
dict
Response Syntax
{
'ApplicationLogOutputUri': 'string',
'ApplicationLogPaths': [
'string',
],
'ApplicationSourceUri': 'string',
'Arn': 'string',
'AssociatedStreamGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'ExecutablePath': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'ReplicationStatuses': [
{
'Location': 'string',
'Status': 'REPLICATING'|'COMPLETED'
},
],
'RuntimeEnvironment': {
'Type': 'PROTON'|'WINDOWS'|'UBUNTU',
'Version': 'string'
},
'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR',
'StatusReason': 'internalError'|'accessDenied'
}
Response Structure
(dict) --
ApplicationLogOutputUri (string) --
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix]. Required if you specify one or more LogPaths.
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) --
ApplicationSourceUri (string) --
The original Amazon S3 location of uploaded stream content for the application.
Arn (string) --
An 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].
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. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4.
(string) --
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).
Description (string) --
A human-readable label for the application. You can edit this value.
ExecutablePath (string) --
The path and file name of the executable file that launches the content for streaming.
Id (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
Status (string) --
The current status of the replication process.
RuntimeEnvironment (dict) --
A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers 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 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.
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.
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
client.delete_stream_group(
Identifier='string'
)
string
[REQUIRED]
The unique ID value of the stream group resource to delete. Format example: 1AB2C3De4.
None
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
client.update_application(
ApplicationLogOutputUri='string',
ApplicationLogPaths=[
'string',
],
Description='string',
Identifier='string'
)
string
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix]. Required if you specify one or more LogPaths.
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 locations. 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) --
string
A human-readable label for the application.
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
dict
Response Syntax
{
'ApplicationLogOutputUri': 'string',
'ApplicationLogPaths': [
'string',
],
'ApplicationSourceUri': 'string',
'Arn': 'string',
'AssociatedStreamGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'ExecutablePath': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'ReplicationStatuses': [
{
'Location': 'string',
'Status': 'REPLICATING'|'COMPLETED'
},
],
'RuntimeEnvironment': {
'Type': 'PROTON'|'WINDOWS'|'UBUNTU',
'Version': 'string'
},
'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR',
'StatusReason': 'internalError'|'accessDenied'
}
Response Structure
(dict) --
ApplicationLogOutputUri (string) --
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix]. Required if you specify one or more LogPaths.
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) --
ApplicationSourceUri (string) --
The original Amazon S3 location of uploaded stream content for the application.
Arn (string) --
An 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].
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. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4.
(string) --
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).
Description (string) --
A human-readable label for the application. You can edit this value.
ExecutablePath (string) --
The path and file name of the executable file that launches the content for streaming.
Id (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
Status (string) --
The current status of the replication process.
RuntimeEnvironment (dict) --
A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers 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 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.
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.
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
client.get_stream_group(
Identifier='string'
)
string
[REQUIRED]
The unique ID value of the stream group resource to retrieve. Format example: 1AB2C3De4.
dict
Response Syntax
{
'Arn': 'string',
'AssociatedApplications': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'DefaultApplication': {
'Arn': 'string',
'Id': 'string'
},
'Description': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'LocationStates': [
{
'AllocatedCapacity': 123,
'AlwaysOnCapacity': 123,
'IdleCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123,
'RequestedCapacity': 123,
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING'
},
],
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING',
'StatusReason': 'internalError'|'noAvailableInstances',
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'
}
Response Structure
(dict) --
Arn (string) --
An 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].
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. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6.
(string) --
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).
DefaultApplication (dict) --
The Amazon GameLift Streams application that is associated with this stream group.
Arn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
Id (string) --
The default application of the stream group.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
Description (string) --
A descriptive label for the stream group.
Id (string) --
A unique ID value that is assigned to the resource when it's created. Format example: 1AB2C3De4.
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).
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.
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.
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.
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.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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.
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.
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 bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.
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.
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 most Unreal Engine 5.x builds, 32-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 most Unreal Engine 5.2 and 5.3 builds, 32-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
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
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to apply tags to.
dict
[REQUIRED]
A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.export_stream_session_files(
Identifier='string',
OutputUri='string',
StreamSessionIdentifier='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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://MyBucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://MyBucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Format example: 1AB2C3De4.
dict
Response Syntax
{}
Response Structure
(dict) --
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, or stream capacity, 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 by setting Locations. 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 can result to 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
client.start_stream_session(
AdditionalEnvironmentVariables={
'string': 'string'
},
AdditionalLaunchArgs=[
'string',
],
ApplicationIdentifier='string',
ClientToken='string',
ConnectionTimeoutSeconds=123,
Description='string',
Identifier='string',
Locations=[
'string',
],
Protocol='WebRTC',
SessionLengthSeconds=123,
SignalRequest='string',
UserId='string'
)
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.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
(string) --
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) --
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
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.
integer
Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect 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.
string
A human-readable label for the stream session. You can update this value later.
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. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide . </p>
(string) --
string
[REQUIRED]
The data transport protocol to use for the stream session.
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.
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.
string
An opaque, unique identifier for an end-user, defined by the developer.
dict
Response Syntax
{
'AdditionalEnvironmentVariables': {
'string': 'string'
},
'AdditionalLaunchArgs': [
'string',
],
'ApplicationArn': 'string',
'Arn': 'string',
'ConnectionTimeoutSeconds': 123,
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'ExportFilesMetadata': {
'OutputUri': 'string',
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string'
},
'LastUpdatedAt': datetime(2015, 1, 1),
'Location': 'string',
'LogFileLocationUri': 'string',
'Protocol': 'WebRTC',
'SessionLengthSeconds': 123,
'SignalRequest': 'string',
'SignalResponse': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError',
'StreamGroupId': 'string',
'UserId': 'string',
'WebSdkProtocolUrl': 'string'
}
Response Structure
(dict) --
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.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
(string) --
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) --
ApplicationArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6.
Arn (string) --
The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group ARN, this value uniquely identifies it across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID].
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.
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).
Description (string) --
A human-readable label for the stream session. You can update this value at any time.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
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://MyBucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://MyBucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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.
Protocol (string) --
The data transfer protocol in use with the stream session.
SessionLengthSeconds (integer) --
The length of time that Amazon GameLift Streams keeps the game session open.
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.
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.
StreamGroupId (string) --
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
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.
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.
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
client.create_application(
ApplicationLogOutputUri='string',
ApplicationLogPaths=[
'string',
],
ApplicationSourceUri='string',
ClientToken='string',
Description='string',
ExecutablePath='string',
RuntimeEnvironment={
'Type': 'PROTON'|'WINDOWS'|'UBUNTU',
'Version': 'string'
},
Tags={
'string': 'string'
}
)
string
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix]. Required if you specify one or more LogPaths.
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 locations. 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) --
string
[REQUIRED]
The location of the content that you want to stream. Enter the URI of an Amazon S3 location (bucket name and prefixes) that contains your content. Use the following format for the URI: s3://[bucket name]/[prefix]. 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.
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.
string
[REQUIRED]
A human-readable label for the application. You can update this value later.
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.
dict
[REQUIRED]
A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers 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 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.
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. The maximum tag limit might be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
(string) --
(string) --
dict
Response Syntax
{
'ApplicationLogOutputUri': 'string',
'ApplicationLogPaths': [
'string',
],
'ApplicationSourceUri': 'string',
'Arn': 'string',
'AssociatedStreamGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'ExecutablePath': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'ReplicationStatuses': [
{
'Location': 'string',
'Status': 'REPLICATING'|'COMPLETED'
},
],
'RuntimeEnvironment': {
'Type': 'PROTON'|'WINDOWS'|'UBUNTU',
'Version': 'string'
},
'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR',
'StatusReason': 'internalError'|'accessDenied'
}
Response Structure
(dict) --
ApplicationLogOutputUri (string) --
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Use the following format for the URI: s3://[bucket name]/[prefix]. Required if you specify one or more LogPaths.
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) --
ApplicationSourceUri (string) --
The original Amazon S3 location of uploaded stream content for the application.
Arn (string) --
An 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].
AssociatedStreamGroups (list) --
A newly created application is not associated to any stream groups. This value is empty.
(string) --
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).
Description (string) --
A human-readable label for the application. You can edit this value.
ExecutablePath (string) --
The path and file name of the executable file that launches the content for streaming.
Id (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
Status (string) --
The current status of the replication process.
RuntimeEnvironment (dict) --
A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers 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 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.
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.
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
client.list_stream_sessions_by_account(
ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING',
MaxResults=123,
NextToken='string',
Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR'
)
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.
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
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.
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.
dict
Response Syntax
{
'Items': [
{
'ApplicationArn': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ExportFilesMetadata': {
'OutputUri': 'string',
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string'
},
'LastUpdatedAt': datetime(2015, 1, 1),
'Location': 'string',
'Protocol': 'WebRTC',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'UserId': '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.
ApplicationArn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4. .
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).
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
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://MyBucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://MyBucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
Protocol (string) --
The data transfer protocol in use with the stream session.
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.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
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.
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
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The ( Amazon Resource Name (ARN) that you want to retrieve tags for. To get a Amazon GameLift Streams resource ARN, call a List or Get operation for the resource.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
A collection of tags that have been assigned to the specified resource.
(string) --
(string) --
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
client.get_stream_session(
Identifier='string',
StreamSessionIdentifier='string'
)
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. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
string
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4.
dict
Response Syntax
{
'AdditionalEnvironmentVariables': {
'string': 'string'
},
'AdditionalLaunchArgs': [
'string',
],
'ApplicationArn': 'string',
'Arn': 'string',
'ConnectionTimeoutSeconds': 123,
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'ExportFilesMetadata': {
'OutputUri': 'string',
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string'
},
'LastUpdatedAt': datetime(2015, 1, 1),
'Location': 'string',
'LogFileLocationUri': 'string',
'Protocol': 'WebRTC',
'SessionLengthSeconds': 123,
'SignalRequest': 'string',
'SignalResponse': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError',
'StreamGroupId': 'string',
'UserId': 'string',
'WebSdkProtocolUrl': 'string'
}
Response Structure
(dict) --
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.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
(string) --
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) --
ApplicationArn (string) --
The application streaming in this session.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6.
Arn (string) --
The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group ARN, this value uniquely identifies it across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID].
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.
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).
Description (string) --
A human-readable label for the stream session. You can update this value at any time.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
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://MyBucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://MyBucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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.
Protocol (string) --
The data transfer protocol in use with the stream session.
SessionLengthSeconds (integer) --
The length of time that Amazon GameLift Streams keeps the game session open.
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.
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.
StreamGroupId (string) --
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
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.
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
client.associate_applications(
ApplicationIdentifiers=[
'string',
],
Identifier='string'
)
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. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
(string) --
string
[REQUIRED]
A stream group to associate to the applications.
This value is a Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
dict
Response Syntax
{
'ApplicationArns': [
'string',
],
'Arn': 'string'
}
Response Structure
(dict) --
ApplicationArns (list) --
A set of applications that are associated to the stream group.
This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
(string) --
Arn (string) --
A stream group that is associated to the applications.
This value is a Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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
client.remove_stream_group_locations(
Identifier='string',
Locations=[
'string',
]
)
string
[REQUIRED]
A stream group to remove the specified locations from.
This value is a Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: 1AB2C3De4. </p>
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide . </p>
(string) --
None
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
client.terminate_stream_session(
Identifier='string',
StreamSessionIdentifier='string'
)
string
[REQUIRED]
Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
The stream group that runs this stream session.
string
[REQUIRED]
Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4.
None
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. </p> </li> <li> <p> <b>On-demand</b>: 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). </p> </li> </ul> <p>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.</p>
See also: AWS API Documentation
Request Syntax
client.update_stream_group(
Description='string',
Identifier='string',
LocationConfigurations=[
{
'AlwaysOnCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123
},
]
)
string
A descriptive label for the stream group.
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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.
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.
LocationName (string) -- [REQUIRED]
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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).
dict
Response Syntax
{
'Arn': 'string',
'AssociatedApplications': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'DefaultApplication': {
'Arn': 'string',
'Id': 'string'
},
'Description': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'LocationStates': [
{
'AllocatedCapacity': 123,
'AlwaysOnCapacity': 123,
'IdleCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123,
'RequestedCapacity': 123,
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING'
},
],
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING',
'StatusReason': 'internalError'|'noAvailableInstances',
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'
}
Response Structure
(dict) --
Arn (string) --
An 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].
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. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6.
(string) --
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).
DefaultApplication (dict) --
The Amazon GameLift Streams application that is associated with this stream group.
Arn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
Id (string) --
The default application of the stream group.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
Description (string) --
A descriptive label for the stream group.
Id (string) --
A unique ID value that is assigned to the resource when it's created. Format example: 1AB2C3De4.
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).
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.
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.
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.
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.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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.
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.
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 bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.
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.
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 most Unreal Engine 5.x builds, 32-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 most Unreal Engine 5.2 and 5.3 builds, 32-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
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
client.list_stream_sessions(
ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING',
Identifier='string',
MaxResults=123,
NextToken='string',
Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR'
)
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.
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).
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
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.
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.
dict
Response Syntax
{
'Items': [
{
'ApplicationArn': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ExportFilesMetadata': {
'OutputUri': 'string',
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string'
},
'LastUpdatedAt': datetime(2015, 1, 1),
'Location': 'string',
'Protocol': 'WebRTC',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'UserId': '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.
ApplicationArn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4. .
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).
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
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://MyBucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://MyBucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
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).
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, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
Protocol (string) --
The data transfer protocol in use with the stream session.
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.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
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.
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
client.disassociate_applications(
ApplicationIdentifiers=[
'string',
],
Identifier='string'
)
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. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
(string) --
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. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
dict
Response Syntax
{
'ApplicationArns': [
'string',
],
'Arn': 'string'
}
Response Structure
(dict) --
ApplicationArns (list) --
A set of applications that are disassociated from this stream group.
This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
(string) --
Arn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
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
client.list_applications(
MaxResults=123,
NextToken='string'
)
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
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.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'RuntimeEnvironment': {
'Type': 'PROTON'|'WINDOWS'|'UBUNTU',
'Version': 'string'
},
'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR'
},
],
'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].
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).
Description (string) --
A human-readable label for the application. You can edit this value.
Id (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
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) --
A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers 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 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.
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.
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.
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
client.create_stream_session_connection(
ClientToken='string',
Identifier='string',
SignalRequest='string',
StreamSessionIdentifier='string'
)
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.
string
[REQUIRED]
Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 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.
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.
string
[REQUIRED]
Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4. The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.
dict
Response Syntax
{
'SignalResponse': 'string'
}
Response Structure
(dict) --
SignalResponse (string) --
The WebRTC answer string that the stream server generates in response to the SignalRequest.
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
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to remove tags from.
list
[REQUIRED]
A list of tag keys to remove from the specified Amazon GameLift Streams resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.delete_application(
Identifier='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
None
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. </p> </li> <li> <p> <b>On-demand</b>: 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). </p> </li> </ul> <p> To adjust the capacity of any <code>ACTIVE</code> stream group, call <a>UpdateStreamGroup</a>. </p> <p> 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 <code>ACTIVATING</code>. When the stream group reaches <code>ACTIVE</code> status, you can start stream sessions by using <a>StartStreamSession</a>. To check the stream group's status, call <a>GetStreamGroup</a>. </p>
See also: AWS API Documentation
Request Syntax
client.create_stream_group(
ClientToken='string',
DefaultApplicationIdentifier='string',
Description='string',
LocationConfigurations=[
{
'AlwaysOnCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123
},
],
StreamClass='gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022',
Tags={
'string': 'string'
}
)
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.
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.
string
[REQUIRED]
A descriptive label for the stream group.
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.
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.
LocationName (string) -- [REQUIRED]
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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).
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 most Unreal Engine 5.x builds, 32-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 most Unreal Engine 5.2 and 5.3 builds, 32-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
dict
A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. It is useful to tag Amazon Web Services resources 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, UntagResource, and ListTagsForResource to add, remove, and view tags on existing resources. The maximum tag limit might be lower than stated. See the Amazon Web Services for actual tagging limits.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'AssociatedApplications': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'DefaultApplication': {
'Arn': 'string',
'Id': 'string'
},
'Description': 'string',
'Id': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'LocationStates': [
{
'AllocatedCapacity': 123,
'AlwaysOnCapacity': 123,
'IdleCapacity': 123,
'LocationName': 'string',
'OnDemandCapacity': 123,
'RequestedCapacity': 123,
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING'
},
],
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING',
'StatusReason': 'internalError'|'noAvailableInstances',
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'
}
Response Structure
(dict) --
Arn (string) --
An 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].
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. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6.
(string) --
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).
DefaultApplication (dict) --
The Amazon GameLift Streams application that is associated with this stream group.
Arn (string) --
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.
Id (string) --
The default application of the stream group.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.
Description (string) --
A descriptive label for the stream group.
Id (string) --
A unique ID value that is assigned to the resource when it's created. Format example: 1AB2C3De4.
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).
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.
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.
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.
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.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .
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.
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.
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 bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.
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.
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 most Unreal Engine 5.x builds, 32-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 most Unreal Engine 5.2 and 5.3 builds, 32-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