Patch streamgroupsidentifier — gameliftstreams

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425133268.7 KB

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.

patch/streamgroups/{Identifier}

Path parameters

Identifierstring required

An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.

Request body

Descriptionstring

A descriptive label for the stream group.

DefaultApplicationIdentifierstring

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 <code>READY</code> 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 <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html">AssociateApplications</a>. 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. Example ID: <code>a-9ZY8X7Wv6</code>.

Response

Success

Arnstring required

The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>.

Descriptionstring

A descriptive label for the stream group.

The target stream quality for the stream group. A stream class can be one of the following: <ul> <li> <code>gen6n_pro_win2022</code> (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. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6n_pro</code> (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6n_ultra_win2022</code> (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. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM </li> <li> Tenancy: Supports up to 2 concurrent stream sessions </li> </ul> </li> <li> <code>gen6n_medium</code> (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM </li> <li> Tenancy: Supports up to 4 concurrent stream sessions </li> </ul> </li> <li> <code>gen6n_small</code> (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM </li> <li> Tenancy: Supports up to 12 concurrent stream sessions </li> </ul> </li> <li> <code>gen6n_medium_win2022</code> (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6n_small_win2022</code> (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6e_pro_win2022</code> (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. Powered by NVIDIA L40S Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen6e_pro</code> (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen5n_win2022</code> (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. Powered by NVIDIA A10G Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen5n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM </li> <li> Tenancy: Supports up to 2 concurrent stream sessions </li> </ul> </li> <li> <code>gen5n_ultra</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen4n_win2022</code> (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. Powered by NVIDIA T4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> <li> <code>gen4n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM </li> <li> Tenancy: Supports up to 2 concurrent stream sessions </li> </ul> </li> <li> <code>gen4n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs. <ul> <li> Reference resolution: 1080p </li> <li> Reference frame rate: 60 fps </li> <li> Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM </li> <li> Tenancy: Supports 1 concurrent stream session </li> </ul> </li> </ul>

Idstring

A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>.

The current status of the stream group resource. Possible statuses include the following: <ul> <li> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </li> <li> <code>ACTIVE</code>: The stream group is ready to host streams. </li> <li> <code>ACTIVE_WITH_ERRORS</code>: 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. </li> <li> <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream group. </li> <li> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </li> <li> <code>EXPIRED</code>: 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 <code>ExpiresAt</code>. Create a new stream group to resume streaming capabilities. </li> <li> <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). </li> </ul>

StatusReason'internalError' | 'noAvailableInstances'

A short description of the reason that the stream group is in <code>ERROR</code> status. The possible reasons can be one of the following: <ul> <li> <code>internalError</code>: The request can't process right now because of an issue with the server. Try again later. </li> <li> <code>noAvailableInstances</code>: 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. </li> </ul>

LastUpdatedAtstring date-time

A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).

CreatedAtstring date-time

A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).

ExpiresAtstring date-time

The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (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.

AssociatedApplicationsArn[]

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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>.