2025/12/17 - Amazon GameLift Streams - 9 updated api methods
Changes Added new stream group operation parameters for scale-on-demand capacity with automatic prewarming. Added new Gen6 stream classes based on the EC2 G6 instance family. Added new StartStreamSession parameter for exposure of real-time performance stats to clients.
{'LocationConfigurations': {'MaximumCapacity': 'integer',
'TargetIdleCapacity': 'integer'}}
Response {'Locations': {'MaximumCapacity': 'integer', 'TargetIdleCapacity': 'integer'}}
Add locations that can host stream sessions. To add a location, the stream group must be in ACTIVE status. 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=[
{
'LocationName': 'string',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123
},
]
)
string
[REQUIRED]
A stream group to add the specified locations to.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
list
[REQUIRED]
A set of one or more locations and the streaming capacity for each location.
(dict) --
Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations.
LocationName (string) -- [REQUIRED]
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
OnDemandCapacity (integer) --
This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
dict
Response Syntax
{
'Identifier': 'string',
'Locations': [
{
'LocationName': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123,
'RequestedCapacity': 123,
'AllocatedCapacity': 123,
'IdleCapacity': 123
},
]
}
Response Structure
(dict) --
Identifier (string) --
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
Locations (list) --
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
(dict) --
Represents a location and its corresponding stream capacity and status.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Status (string) --
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
RequestedCapacity (integer) --
This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.
AllocatedCapacity (integer) --
This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. When target-idle capacity is configured, the idle resources include the capacity buffer maintained beyond ongoing sessions. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.
IdleCapacity (integer) --
This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's ability to respond immediately to new stream requests with near-instant startup time.
{'LocationConfigurations': {'MaximumCapacity': 'integer',
'TargetIdleCapacity': 'integer'},
'StreamClass': {'gen6n_high',
'gen6n_medium',
'gen6n_pro',
'gen6n_pro_win2022',
'gen6n_small',
'gen6n_ultra',
'gen6n_ultra_win2022'}}
Response {'LocationStates': {'MaximumCapacity': 'integer',
'TargetIdleCapacity': 'integer'},
'StreamClass': {'gen6n_high',
'gen6n_medium',
'gen6n_pro',
'gen6n_pro_win2022',
'gen6n_small',
'gen6n_ultra',
'gen6n_ultra_win2022'}}
Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.
Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. The following capacity settings are available:
Always-on capacity: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
Maximum capacity: This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
Target-idle capacity: This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.
To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.
If the CreateStreamGroup request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be ACTIVE and you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.
Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the ExpiresAt field.
See also: AWS API Documentation
Request Syntax
client.create_stream_group(
Description='string',
StreamClass='gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'|'gen6n_small'|'gen6n_medium'|'gen6n_high'|'gen6n_ultra'|'gen6n_ultra_win2022'|'gen6n_pro'|'gen6n_pro_win2022',
DefaultApplicationIdentifier='string',
LocationConfigurations=[
{
'LocationName': 'string',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123
},
],
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
A descriptive label for the stream group.
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:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core 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
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core 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
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core 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
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core 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 Core 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 Core 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
string
The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.
If you do not link an application when you create a stream group, you will need to link one later, before you can start streaming, using AssociateApplications.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
list
A set of one or more locations and the streaming capacity for each location.
(dict) --
Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations.
LocationName (string) -- [REQUIRED]
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
OnDemandCapacity (integer) --
This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
dict
A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
(string) --
(string) --
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.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'DefaultApplication': {
'Id': 'string',
'Arn': 'string'
},
'LocationStates': [
{
'LocationName': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123,
'RequestedCapacity': 123,
'AllocatedCapacity': 123,
'IdleCapacity': 123
},
],
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'|'gen6n_small'|'gen6n_medium'|'gen6n_high'|'gen6n_ultra'|'gen6n_ultra_win2022'|'gen6n_pro'|'gen6n_pro_win2022',
'Id': 'string',
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING'|'EXPIRED',
'StatusReason': 'internalError'|'noAvailableInstances',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'AssociatedApplications': [
'string',
]
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
Description (string) --
A descriptive label for the stream group.
DefaultApplication (dict) --
The default Amazon GameLift Streams application that is associated with this stream group.
Id (string) --
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
LocationStates (list) --
This value is the set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
(dict) --
Represents a location and its corresponding stream capacity and status.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Status (string) --
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
RequestedCapacity (integer) --
This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.
AllocatedCapacity (integer) --
This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. When target-idle capacity is configured, the idle resources include the capacity buffer maintained beyond ongoing sessions. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.
IdleCapacity (integer) --
This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's ability to respond immediately to new stream requests with near-instant startup time.
StreamClass (string) --
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core 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
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core 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
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core 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
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
Id (string) --
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
Status (string) --
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
StatusReason (string) --
A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:
internalError: The request can't process right now because of an issue with the server. Try again later.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ExpiresAt (datetime) --
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
AssociatedApplications (list) --
A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
(string) --
{'LocationStates': {'MaximumCapacity': 'integer',
'TargetIdleCapacity': 'integer'},
'StreamClass': {'gen6n_high',
'gen6n_medium',
'gen6n_pro',
'gen6n_pro_win2022',
'gen6n_small',
'gen6n_ultra',
'gen6n_ultra_win2022'}}
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]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'DefaultApplication': {
'Id': 'string',
'Arn': 'string'
},
'LocationStates': [
{
'LocationName': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123,
'RequestedCapacity': 123,
'AllocatedCapacity': 123,
'IdleCapacity': 123
},
],
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'|'gen6n_small'|'gen6n_medium'|'gen6n_high'|'gen6n_ultra'|'gen6n_ultra_win2022'|'gen6n_pro'|'gen6n_pro_win2022',
'Id': 'string',
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING'|'EXPIRED',
'StatusReason': 'internalError'|'noAvailableInstances',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'AssociatedApplications': [
'string',
]
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
Description (string) --
A descriptive label for the stream group.
DefaultApplication (dict) --
The default Amazon GameLift Streams application that is associated with this stream group.
Id (string) --
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
LocationStates (list) --
This value is the set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
(dict) --
Represents a location and its corresponding stream capacity and status.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Status (string) --
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
RequestedCapacity (integer) --
This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.
AllocatedCapacity (integer) --
This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. When target-idle capacity is configured, the idle resources include the capacity buffer maintained beyond ongoing sessions. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.
IdleCapacity (integer) --
This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's ability to respond immediately to new stream requests with near-instant startup time.
StreamClass (string) --
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core 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
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core 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
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core 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
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
Id (string) --
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
Status (string) --
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
StatusReason (string) --
A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:
internalError: The request can't process right now because of an issue with the server. Try again later.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ExpiresAt (datetime) --
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
AssociatedApplications (list) --
A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
(string) --
{'PerformanceStatsConfiguration': {'SharedWithClient': 'boolean'}}
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. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'StreamGroupId': 'string',
'UserId': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError'|'applicationExit'|'connectionTimeout'|'reconnectionTimeout'|'maxSessionLengthTimeout'|'idleTimeout'|'apiTerminated',
'Protocol': 'WebRTC',
'Location': 'string',
'SignalRequest': 'string',
'SignalResponse': 'string',
'ConnectionTimeoutSeconds': 123,
'SessionLengthSeconds': 123,
'AdditionalLaunchArgs': [
'string',
],
'AdditionalEnvironmentVariables': {
'string': 'string'
},
'PerformanceStatsConfiguration': {
'SharedWithClient': True|False
},
'LogFileLocationUri': 'string',
'WebSdkProtocolUrl': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ApplicationArn': 'string',
'ExportFilesMetadata': {
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string',
'OutputUri': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID].
Description (string) --
A human-readable label for the stream session. You can update this value at any time.
StreamGroupId (string) --
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
Status (string) --
The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.
ACTIVATING: The stream session is starting and preparing to stream.
ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.
CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.
ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.
PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.
RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.
TERMINATING: The stream session is ending.
TERMINATED: The stream session has ended.
StatusReason (string) --
A short description of the reason the stream session is in ERROR status or TERMINATED status.
ERROR status reasons:
applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.
internalError: An internal service error occurred. Start a new stream session to continue streaming.
invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.
placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.
TERMINATED status reasons:
apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.
applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.
connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.
idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.
maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.
reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.
Protocol (string) --
The data transfer protocol in use with the stream session.
Location (string) --
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
SignalRequest (string) --
The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
SignalResponse (string) --
The WebRTC answer string that the stream server generates in response to the SignalRequest.
ConnectionTimeoutSeconds (integer) --
The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
SessionLengthSeconds (integer) --
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.
AdditionalLaunchArgs (list) --
A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
AdditionalEnvironmentVariables (dict) --
A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
(string) --
PerformanceStatsConfiguration (dict) --
The performance stats configuration for the stream session
SharedWithClient (boolean) --
Performance stats for the session are streamed to the client when set to true. Defaults to false.
LogFileLocationUri (string) --
Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
WebSdkProtocolUrl (string) --
The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ApplicationArn (string) --
The application streaming in this session.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
OutputUri (string) --
The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.
Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
{'Items': {'StreamClass': {'gen6n_high',
'gen6n_medium',
'gen6n_pro',
'gen6n_pro_win2022',
'gen6n_small',
'gen6n_ultra',
'gen6n_ultra_win2022'}}}
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(
NextToken='string',
MaxResults=123
)
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.
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'Id': 'string',
'Description': 'string',
'DefaultApplication': {
'Id': 'string',
'Arn': 'string'
},
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'|'gen6n_small'|'gen6n_medium'|'gen6n_high'|'gen6n_ultra'|'gen6n_ultra_win2022'|'gen6n_pro'|'gen6n_pro_win2022',
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING'|'EXPIRED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and status, but doesn't include capacity information.
(dict) --
Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
Id (string) --
An ID that uniquely identifies the stream group resource. Example ID: sg-1AB2C3De4.
Description (string) --
A descriptive label for the stream group.
DefaultApplication (dict) --
Object that identifies the Amazon GameLift Streams application to stream with this stream group.
Id (string) --
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
StreamClass (string) --
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core 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
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core 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
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core 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
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
Status (string) --
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ExpiresAt (datetime) --
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
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.
{'Items': {'StatusReason': 'internalError | invalidSignalRequest | '
'placementTimeout | '
'applicationLogS3DestinationError | applicationExit '
'| connectionTimeout | reconnectionTimeout | '
'maxSessionLengthTimeout | idleTimeout | '
'apiTerminated'}}
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(
Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING',
NextToken='string',
MaxResults=123,
Identifier='string'
)
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.
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 an S3 bucket.
FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the files to S3.
PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.
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.
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
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).
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'UserId': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError'|'applicationExit'|'connectionTimeout'|'reconnectionTimeout'|'maxSessionLengthTimeout'|'idleTimeout'|'apiTerminated',
'Protocol': 'WebRTC',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ApplicationArn': 'string',
'ExportFilesMetadata': {
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string',
'OutputUri': 'string'
},
'Location': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status.
(dict) --
Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
Status (string) --
The current status of the stream session resource.
ACTIVATING: The stream session is starting and preparing to stream.
ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.
CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.
ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.
PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.
RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.
TERMINATING: The stream session is ending.
TERMINATED: The stream session has ended.
StatusReason (string) --
A short description of the reason the stream session is in ERROR status or TERMINATED status.
ERROR status reasons:
applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.
internalError: An internal service error occurred. Start a new stream session to continue streaming.
invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.
placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.
TERMINATED status reasons:
apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.
applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.
connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.
idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.
maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.
reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.
Protocol (string) --
The data transfer protocol in use with the stream session.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ApplicationArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
OutputUri (string) --
The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.
Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Location (string) --
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
NextToken (string) --
A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list.
{'Items': {'StatusReason': 'internalError | invalidSignalRequest | '
'placementTimeout | '
'applicationLogS3DestinationError | applicationExit '
'| connectionTimeout | reconnectionTimeout | '
'maxSessionLengthTimeout | idleTimeout | '
'apiTerminated'}}
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(
Status='ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
ExportFilesStatus='SUCCEEDED'|'FAILED'|'PENDING',
NextToken='string',
MaxResults=123
)
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.
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.
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.
integer
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'UserId': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError'|'applicationExit'|'connectionTimeout'|'reconnectionTimeout'|'maxSessionLengthTimeout'|'idleTimeout'|'apiTerminated',
'Protocol': 'WebRTC',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ApplicationArn': 'string',
'ExportFilesMetadata': {
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string',
'OutputUri': 'string'
},
'Location': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status.
(dict) --
Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
Status (string) --
The current status of the stream session resource.
ACTIVATING: The stream session is starting and preparing to stream.
ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.
CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.
ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.
PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.
RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.
TERMINATING: The stream session is ending.
TERMINATED: The stream session has ended.
StatusReason (string) --
A short description of the reason the stream session is in ERROR status or TERMINATED status.
ERROR status reasons:
applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.
internalError: An internal service error occurred. Start a new stream session to continue streaming.
invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.
placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.
TERMINATED status reasons:
apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.
applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.
connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.
idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.
maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.
reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.
Protocol (string) --
The data transfer protocol in use with the stream session.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ApplicationArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
OutputUri (string) --
The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.
Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Location (string) --
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
NextToken (string) --
A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list.
{'PerformanceStatsConfiguration': {'SharedWithClient': 'boolean'}}
This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows:
Prerequisites:
You must have a stream group in ACTIVE status
You must have idle or on-demand capacity in a stream group in the location you want to stream from
You must have at least one application associated to the stream group (use AssociateApplications if needed)
Start stream request:
Your backend server calls StartStreamSession to initiate connection
Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream
Session transitions to ACTIVATING status
Placement completion:
If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to ACTIVE status and StartStreamSession returns stream connection information
If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to ERROR status and StartStreamSession returns a StatusReason of placementTimeout
Connection completion:
Provide the new connection information to the requesting client
Client must establish connection within ConnectionTimeoutSeconds (specified in StartStreamSession parameters)
Session terminates automatically if client fails to connect in time
For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.
Timeouts to be aware of that affect a stream session:
Placement timeout: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:
Always-on capacity: 75 seconds
On-demand capacity:
Linux/Proton runtimes: 90 seconds
Windows runtime: 10 minutes
Connection timeout: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in ACTIVE status, or reconnect to a stream session in PENDING_CLIENT_RECONNECTION status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by ConnectionTimeoutSeconds in the StartStreamSession parameters.
Idle timeout: A stream session will be terminated if no user input has been received for 60 minutes.
Maximum session length: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by SessionLengthSeconds in the StartStreamSession parameters.
To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.
For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.
To reconnect to a stream session after a client disconnects or loses connection, use CreateStreamSessionConnection.
See also: AWS API Documentation
Request Syntax
client.start_stream_session(
ClientToken='string',
Description='string',
Identifier='string',
Protocol='WebRTC',
SignalRequest='string',
ApplicationIdentifier='string',
UserId='string',
Locations=[
'string',
],
ConnectionTimeoutSeconds=123,
SessionLengthSeconds=123,
AdditionalLaunchArgs=[
'string',
],
AdditionalEnvironmentVariables={
'string': 'string'
},
PerformanceStatsConfiguration={
'SharedWithClient': True|False
}
)
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
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. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
string
[REQUIRED]
The data transport protocol to use for the stream session.
string
[REQUIRED]
A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes.
Amazon GameLift Streams also supports setting the field to "NO_CLIENT_CONNECTION". This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using CreateStreamSessionConnection.
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
string
An opaque, unique identifier for an end-user, defined by the developer.
list
A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. For example, us-east-1. 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.
For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
(string) --
integer
Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. Applies to both connection and reconnection scenarios. This time span starts when the stream session reaches ACTIVE state. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. Default value is 120.
integer
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections. Default value is 43200 (12 hours).
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) --
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) --
dict
Configuration settings for sharing the stream session's performance stats with the client
SharedWithClient (boolean) --
Performance stats for the session are streamed to the client when set to true. Defaults to false.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'StreamGroupId': 'string',
'UserId': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError'|'applicationExit'|'connectionTimeout'|'reconnectionTimeout'|'maxSessionLengthTimeout'|'idleTimeout'|'apiTerminated',
'Protocol': 'WebRTC',
'Location': 'string',
'SignalRequest': 'string',
'SignalResponse': 'string',
'ConnectionTimeoutSeconds': 123,
'SessionLengthSeconds': 123,
'AdditionalLaunchArgs': [
'string',
],
'AdditionalEnvironmentVariables': {
'string': 'string'
},
'PerformanceStatsConfiguration': {
'SharedWithClient': True|False
},
'LogFileLocationUri': 'string',
'WebSdkProtocolUrl': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ApplicationArn': 'string',
'ExportFilesMetadata': {
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string',
'OutputUri': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID].
Description (string) --
A human-readable label for the stream session. You can update this value at any time.
StreamGroupId (string) --
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
Status (string) --
The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.
ACTIVATING: The stream session is starting and preparing to stream.
ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.
CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.
ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.
PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.
RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.
TERMINATING: The stream session is ending.
TERMINATED: The stream session has ended.
StatusReason (string) --
A short description of the reason the stream session is in ERROR status or TERMINATED status.
ERROR status reasons:
applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.
internalError: An internal service error occurred. Start a new stream session to continue streaming.
invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.
placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.
TERMINATED status reasons:
apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.
applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.
connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.
idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.
maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.
reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.
Protocol (string) --
The data transfer protocol in use with the stream session.
Location (string) --
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
SignalRequest (string) --
The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
SignalResponse (string) --
The WebRTC answer string that the stream server generates in response to the SignalRequest.
ConnectionTimeoutSeconds (integer) --
The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
SessionLengthSeconds (integer) --
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.
AdditionalLaunchArgs (list) --
A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
AdditionalEnvironmentVariables (dict) --
A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
(string) --
PerformanceStatsConfiguration (dict) --
The performance stats configuration for the stream session
SharedWithClient (boolean) --
Performance stats for the session are streamed to the client when set to true. Defaults to false.
LogFileLocationUri (string) --
Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
WebSdkProtocolUrl (string) --
The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ApplicationArn (string) --
The application streaming in this session.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
OutputUri (string) --
The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.
Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
{'LocationConfigurations': {'MaximumCapacity': 'integer',
'TargetIdleCapacity': 'integer'}}
Response {'LocationStates': {'MaximumCapacity': 'integer',
'TargetIdleCapacity': 'integer'},
'StreamClass': {'gen6n_high',
'gen6n_medium',
'gen6n_pro',
'gen6n_pro_win2022',
'gen6n_small',
'gen6n_ultra',
'gen6n_ultra_win2022'}}
Updates the configuration settings for an Amazon GameLift Streams stream group resource. To update a stream group, it must be in ACTIVE status. 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. The following capacity settings are available:
Always-on capacity: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
Maximum capacity: This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
Target-idle capacity: This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.
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. Expired stream groups cannot be updated.
See also: AWS API Documentation
Request Syntax
client.update_stream_group(
Identifier='string',
LocationConfigurations=[
{
'LocationName': 'string',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123
},
],
Description='string',
DefaultApplicationIdentifier='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
list
A set of one or more locations and the streaming capacity for each location.
(dict) --
Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations.
LocationName (string) -- [REQUIRED]
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
OnDemandCapacity (integer) --
This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
string
A descriptive label for the stream group.
string
The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.
Note that this parameter only sets the default application in a stream group. To associate a new application to an existing stream group, you must use AssociateApplications.
When you switch default applications in a stream group, it can take up to a few hours for the new default application to be pre-cached.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'DefaultApplication': {
'Id': 'string',
'Arn': 'string'
},
'LocationStates': [
{
'LocationName': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING',
'AlwaysOnCapacity': 123,
'OnDemandCapacity': 123,
'TargetIdleCapacity': 123,
'MaximumCapacity': 123,
'RequestedCapacity': 123,
'AllocatedCapacity': 123,
'IdleCapacity': 123
},
],
'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'|'gen6n_small'|'gen6n_medium'|'gen6n_high'|'gen6n_ultra'|'gen6n_ultra_win2022'|'gen6n_pro'|'gen6n_pro_win2022',
'Id': 'string',
'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING'|'EXPIRED',
'StatusReason': 'internalError'|'noAvailableInstances',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ExpiresAt': datetime(2015, 1, 1),
'AssociatedApplications': [
'string',
]
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
Description (string) --
A descriptive label for the stream group.
DefaultApplication (dict) --
The default Amazon GameLift Streams application that is associated with this stream group.
Id (string) --
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
LocationStates (list) --
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
(dict) --
Represents a location and its corresponding stream capacity and status.
LocationName (string) --
A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Status (string) --
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
AlwaysOnCapacity (integer) --
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
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). Default is 0 when creating a stream group or adding a location.
TargetIdleCapacity (integer) --
This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
MaximumCapacity (integer) --
This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
RequestedCapacity (integer) --
This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.
AllocatedCapacity (integer) --
This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. When target-idle capacity is configured, the idle resources include the capacity buffer maintained beyond ongoing sessions. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.
IdleCapacity (integer) --
This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's ability to respond immediately to new stream requests with near-instant startup time.
StreamClass (string) --
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Uses dedicated NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA L4 Tensor Core 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
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA L4 Tensor Core 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
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA L4 Tensor Core 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
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Uses NVIDIA L4 Tensor Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor Core 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 Core 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 Core GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
Id (string) --
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
Status (string) --
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
StatusReason (string) --
A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:
internalError: The request can't process right now because of an issue with the server. Try again later.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ExpiresAt (datetime) --
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
AssociatedApplications (list) --
A set of applications that this stream group is associated with. You can stream any of these applications with the stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
(string) --