GameLiftStreams / Paginator / ListApplications

ListApplications

class GameLiftStreams.Paginator.ListApplications

paginator = client.get_paginator('list_applications')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GameLiftStreams.Client.list_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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/a-9ZY8X7Wv6 or ID- a-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) –

        Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer 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.