GameLiftStreams / Client / create_stream_group

create_stream_group#

GameLiftStreams.Client.create_stream_group(**kwargs)#

Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity: always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session. </p> </li> <li> <p> <b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). </p> </li> </ul> <p> To adjust the capacity of any <code>ACTIVE</code> stream group, call <a>UpdateStreamGroup</a>. </p> <p> If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to <code>ACTIVATING</code>. When the stream group reaches <code>ACTIVE</code> status, you can start stream sessions by using <a>StartStreamSession</a>. To check the stream group's status, call <a>GetStreamGroup</a>. </p>

See also: AWS API Documentation

Request Syntax

response = client.create_stream_group(
    ClientToken='string',
    DefaultApplicationIdentifier='string',
    Description='string',
    LocationConfigurations=[
        {
            'AlwaysOnCapacity': 123,
            'LocationName': 'string',
            'OnDemandCapacity': 123
        },
    ],
    StreamClass='gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ClientToken (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.

  • DefaultApplicationIdentifier (string) – The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in READY status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming.

  • Description (string) –

    [REQUIRED]

    A descriptive label for the stream group.

  • LocationConfigurations (list) –

    A set of one or more locations and the streaming capacity for each location.

    • (dict) –

      Configuration settings that define a stream group’s stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations.

      • AlwaysOnCapacity (integer) –

        The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session.

      • LocationName (string) – [REQUIRED]

        A location’s name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .

      • OnDemandCapacity (integer) –

        The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

  • StreamClass (string) –

    [REQUIRED]

    The target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of content that you’re streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The following options are available:

    A stream class can be one of the following:

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

      • Reference resolution: 1080p

      • Reference frame rate: 60 fps

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

      • Tenancy: Supports 1 concurrent stream session

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

      • Reference resolution: 1080p

      • Reference frame rate: 60 fps

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

      • Tenancy: Supports up to 2 concurrent stream sessions

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

      • Reference resolution: 1080p

      • Reference frame rate: 60 fps

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

      • Tenancy: Supports 1 concurrent stream session

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

      • Reference resolution: 1080p

      • Reference frame rate: 60 fps

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

      • Tenancy: Supports 1 concurrent stream session

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

      • Reference resolution: 1080p

      • Reference frame rate: 60 fps

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

      • Tenancy: Supports up to 2 concurrent stream sessions

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

      • Reference resolution: 1080p

      • Reference frame rate: 60 fps

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

      • Tenancy: Supports 1 concurrent stream session

  • Tags (dict) –

    A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. It is useful to tag Amazon Web Services resources for resource management, access management, and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags on existing resources. The maximum tag limit might be lower than stated. See the Amazon Web Services for actual tagging limits.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AssociatedApplications': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'DefaultApplication': {
        'Arn': 'string',
        'Id': 'string'
    },
    'Description': 'string',
    'Id': 'string',
    'LastUpdatedAt': datetime(2015, 1, 1),
    'LocationStates': [
        {
            'AllocatedCapacity': 123,
            'AlwaysOnCapacity': 123,
            'IdleCapacity': 123,
            'LocationName': 'string',
            'OnDemandCapacity': 123,
            'RequestedCapacity': 123,
            'Status': 'ACTIVATING'|'ACTIVE'|'ERROR'|'REMOVING'
        },
    ],
    'Status': 'ACTIVATING'|'UPDATING_LOCATIONS'|'ACTIVE'|'ACTIVE_WITH_ERRORS'|'ERROR'|'DELETING',
    'StatusReason': 'internalError'|'noAvailableInstances',
    'StreamClass': 'gen4n_high'|'gen4n_ultra'|'gen4n_win2022'|'gen5n_high'|'gen5n_ultra'|'gen5n_win2022'
}

Response Structure

  • (dict) –

    • Arn (string) –

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

    • AssociatedApplications (list) –

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

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

      • (string) –

    • CreatedAt (datetime) –

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

    • DefaultApplication (dict) –

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

      • Arn (string) –

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

      • Id (string) –

        The default application of the stream group.

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

    • Description (string) –

      A descriptive label for the stream group.

    • Id (string) –

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

    • LastUpdatedAt (datetime) –

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

    • LocationStates (list) –

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

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      • (dict) –

        Represents a location and its corresponding stream capacity and status.

        • AllocatedCapacity (integer) –

          This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests.

        • AlwaysOnCapacity (integer) –

          The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session.

        • IdleCapacity (integer) –

          This value is the amount of allocated capacity that is not currently streaming. It represents the stream group’s availability to respond to new stream requests, but not including on-demand capacity.

        • LocationName (string) –

          A location’s name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, see the Regions and quotas section in the Amazon GameLift Streams Developer Guide .

        • OnDemandCapacity (integer) –

          The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

        • RequestedCapacity (integer) –

          This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group.

        • Status (string) –

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

          A location can be in one of the following states:

          • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

          • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

          • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

          • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

    • Status (string) –

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

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

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

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

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

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

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

    • StatusReason (string) –

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

      • internalError: The request can’t process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

    • StreamClass (string) –

      The target stream quality for the stream group.

      A stream class can be one of the following:

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

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

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

        • Tenancy: Supports 1 concurrent stream session

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

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

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

        • Tenancy: Supports up to 2 concurrent stream sessions

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

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

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

        • Tenancy: Supports 1 concurrent stream session

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

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

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

        • Tenancy: Supports 1 concurrent stream session

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

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

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

        • Tenancy: Supports up to 2 concurrent stream sessions

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

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

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

        • Tenancy: Supports 1 concurrent stream session

Exceptions