GameLiftStreams / Client / list_stream_groups

list_stream_groups#

GameLiftStreams.Client.list_stream_groups(**kwargs)#

Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.

See also: AWS API Documentation

Request Syntax

response = client.list_stream_groups(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.

  • NextToken (string) – A token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'DefaultApplication': {
                'Arn': 'string',
                'Id': 'string'
            },
            'Description': 'string',
            'Id': 'string',
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING',
            'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and status, but doesn’t include capacity information.

      • (dict) –

        Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup.

        • Arn (string) –

          An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.

        • CreatedAt (datetime) –

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

        • DefaultApplication (dict) –

          Object that identifies the Amazon GameLift Streams application to stream with this stream group.

          • Arn (string) –

            An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.

          • Id (string) –

            The default application of the stream group.

            This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6 or ID- 9ZY8X7Wv6.

        • Description (string) –

          A descriptive label for the stream group.

        • Id (string) –

          An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4 or ID- 1AB2C3De4.

        • LastUpdatedAt (datetime) –

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

        • Status (string) –

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

          • ACTIVATING: The stream group is deploying and isn’t ready to host streams.

          • ACTIVE: The stream group is ready to host streams.

          • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

          • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

          • DELETING: Amazon GameLift Streams is in the process of deleting the stream group.

          • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

        • StreamClass (string) –

          The target stream quality for the stream group.

          A stream class can be one of the following:

          • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with most Unreal Engine 5.x builds, 32-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

            • Reference resolution: 1080p

            • Reference frame rate: 60 fps

            • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

            • Tenancy: Supports 1 concurrent stream session

          • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

            • Reference resolution: 1080p

            • Reference frame rate: 60 fps

            • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

            • Tenancy: Supports up to 2 concurrent stream sessions

          • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

            • Reference resolution: 1080p

            • Reference frame rate: 60 fps

            • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

            • Tenancy: Supports 1 concurrent stream session

          • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with most Unreal Engine 5.2 and 5.3 builds, 32-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

            • Reference resolution: 1080p

            • Reference frame rate: 60 fps

            • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

            • Tenancy: Supports 1 concurrent stream session

          • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

            • Reference resolution: 1080p

            • Reference frame rate: 60 fps

            • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

            • Tenancy: Supports up to 2 concurrent stream sessions

          • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

            • Reference resolution: 1080p

            • Reference frame rate: 60 fps

            • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

            • Tenancy: Supports 1 concurrent stream session

    • NextToken (string) –

      A token that marks the start of the next sequential page of results. If an operation doesn’t return a token, you’ve reached the end of the list.

Exceptions