GameLift / Paginator / ListBuilds

ListBuilds#

class GameLift.Paginator.ListBuilds#
paginator = client.get_paginator('list_builds')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GameLift.Client.list_builds().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Status='INITIALIZED'|'READY'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • Status (string) –

    Build status to filter results by. To retrieve all builds, leave this parameter empty.

    Possible build statuses include the following:

    • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

    • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

    • FAILED – The game build upload failed. You cannot create new fleets for this build.

  • 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

{
    'Builds': [
        {
            'BuildId': 'string',
            'BuildArn': 'string',
            'Name': 'string',
            'Version': 'string',
            'Status': 'INITIALIZED'|'READY'|'FAILED',
            'SizeOnDisk': 123,
            'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
            'CreationTime': datetime(2015, 1, 1),
            'ServerSdkVersion': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • Builds (list) –

      A collection of build resources that match the request.

      • (dict) –

        Properties describing a custom game build.

        All APIs by task

        • BuildId (string) –

          A unique identifier for the build.

        • BuildArn (string) –

          The Amazon Resource Name ( ARN) assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

        • Name (string) –

          A descriptive label associated with a build. Build names don’t need to be unique. It can be set using CreateBuild or UpdateBuild.

        • Version (string) –

          Version information associated with a build or script. Version strings don’t need to be unique.

        • Status (string) –

          Current status of the build.

          Possible build statuses include the following:

          • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

          • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

          • FAILED – The game build upload failed. You cannot create new fleets for this build.

        • SizeOnDisk (integer) –

          File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED or when using a custom Amazon S3 storage location, this value is 0.

        • OperatingSystem (string) –

          Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

        • CreationTime (datetime) –

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • ServerSdkVersion (string) –

          The Amazon GameLift Server SDK version used to develop your game server.