GameSparks / Paginator / ListGeneratedCodeJobs

ListGeneratedCodeJobs#

class GameSparks.Paginator.ListGeneratedCodeJobs#
paginator = client.get_paginator('list_generated_code_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GameSparks.Client.list_generated_code_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GameName='string',
    SnapshotId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • GameName (string) –

    [REQUIRED]

    The name of the game.

  • SnapshotId (string) –

    [REQUIRED]

    The identifier of the snapshot.

  • 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

{
    'GeneratedCodeJobs': [
        {
            'Description': 'string',
            'ExpirationTime': datetime(2015, 1, 1),
            'GeneratedCodeJobId': 'string',
            'S3Url': 'string',
            'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PENDING'
        },
    ],

}

Response Structure

  • (dict) –

    • GeneratedCodeJobs (list) –

      The list of generated code jobs.

      • (dict) –

        Details about a generated code job.

        • Description (string) –

          The description of the generated code job.

        • ExpirationTime (datetime) –

          The expiration date and time for the download URL.

          The download URL us guaranteed to be available until at least this time.

        • GeneratedCodeJobId (string) –

          The identifier for the generated code job.

        • S3Url (string) –

          A presigned URL that can be used to download the generated code.

        • Status (string) –

          The status of the generated code job