GetStreamGroup - Amazon GameLift Streams

Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetStreamGroup

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.

Request Syntax


GET /streamgroups/Identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

The unique ID value of the stream group resource to retrieve. Format example: sg-1AB2C3De4.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "AssociatedApplications": [ "string" ],
   "CreatedAt": number,
   "DefaultApplication": { 
      "Arn": "string",
      "Id": "string"
   },
   "Description": "string",
   "Id": "string",
   "LastUpdatedAt": number,
   "LocationStates": [ 
      { 
         "AllocatedCapacity": number,
         "AlwaysOnCapacity": number,
         "IdleCapacity": number,
         "LocationName": "string",
         "OnDemandCapacity": number,
         "RequestedCapacity": number,
         "Status": "string"
      }
   ],
   "Status": "string",
   "StatusReason": "string",
   "StreamClass": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all AWS Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)$

AssociatedApplications

A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.

This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$

CreatedAt

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).

Type: Timestamp

DefaultApplication

The default Amazon GameLift Streams application that is associated with this stream group.

Type: DefaultApplication object

Description

A descriptive label for the stream group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: ^[a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*$

Id

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-zA-Z0-9-]+$

LastUpdatedAt

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).

Type: Timestamp

LocationStates

This value is the set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

Type: Array of LocationState objects

Status

The current status of the stream group resource. Possible statuses include the following:

ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
ERROR: An error occurred when the stream group deployed. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

Type: String

StatusReason

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

Type: String

Valid Values: internalError | noAvailableInstances

StreamClass

The target stream quality for the stream group.

A stream class can be one of the following:

gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
- Reference resolution: 1080p
- Reference frame rate: 60 fps
- Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
- Tenancy: Supports 1 concurrent stream session
gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.
- Reference resolution: 1080p
- Reference frame rate: 60 fps
- Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
- Tenancy: Supports up to 2 concurrent stream sessions
gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.
- Reference resolution: 1080p
- Reference frame rate: 60 fps
- Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
- Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
- Reference resolution: 1080p
- Reference frame rate: 60 fps
- Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
- Tenancy: Supports 1 concurrent stream session
gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.
- Reference resolution: 1080p
- Reference frame rate: 60 fps
- Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
- Tenancy: Supports up to 2 concurrent stream sessions
gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.
- Reference resolution: 1080p
- Reference frame rate: 60 fps
- Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
- Tenancy: Supports 1 concurrent stream session

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request was not found. Correct the request before you try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. Retry the request after the suggested wait time.

HTTP Status Code: 429

ValidationException

One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.

HTTP Status Code: 400

Examples

CLI Example

The following example shows how to use the AWS CLI to retrieve metadata for a stream group by specifying the stream group's ARN value.

Sample Request


aws gameliftstreams get-stream-group \
  --identifier arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Unable to save cookie preferences

GetStreamGroup

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

CLI Example

Sample Request

See Also

Did this page help you?

Next topic:

Previous topic:

Need help?