GameLiftStreams / Client / list_applications

list_applications#

GameLiftStreams.Client.list_applications(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    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) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'LastUpdatedAt': datetime(2015, 1, 1),
            'RuntimeEnvironment': {
                'Type': 'PROTON'|'WINDOWS'|'UBUNTU',
                'Version': 'string'
            },
            'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      A collection of Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. Each item includes application metadata and status.

      • (dict) –

        Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication.

        • Arn (string) –

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

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

        • Description (string) –

          A human-readable label for the application. You can edit this value.

        • Id (string) –

          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.

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

        • RuntimeEnvironment (dict) –

          A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers and other drivers.

          A runtime environment can be one of the following:

          • For Linux applications

            • Ubuntu 22.04 LTS( Type=UBUNTU, Version=22_04_LTS)

          • For Windows applications

            • Microsoft Windows Server 2022 Base ( Type=WINDOWS, Version=2022)

            • Proton 8.0-5 ( Type=PROTON, Version=20241007)

            • Proton 8.0-2c ( Type=PROTON, Version=20230704)

          • Type (string) –

            The operating system and other drivers. For Proton, this also includes the Proton compatibility layer.

          • Version (string) –

            Versioned container environment for the application operating system.

        • Status (string) –

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

          • INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.

          • PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.

          • READY: The application is ready to deploy in a stream group.

          • ERROR: An error occurred when setting up the application. See StatusReason for more information.

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

    • 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