GameSparks / Client / list_generated_code_jobs

list_generated_code_jobs#

GameSparks.Client.list_generated_code_jobs(**kwargs)#

Gets a paginated list of code generation jobs for a snapshot.

Request Syntax

response = client.list_generated_code_jobs(
    GameName='string',
    MaxResults=123,
    NextToken='string',
    SnapshotId='string'
)

Parameters:

GameName (string) –
[REQUIRED]

The name of the game.
MaxResults (integer) –
The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.
NextToken (string) –
The token that indicates the start of the next sequential page of results.

Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
SnapshotId (string) –
[REQUIRED]

The identifier of the snapshot.

Return type:

dict

Returns:

Response Syntax

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

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
- NextToken (string) –
  
  The token that indicates the start of the next sequential page of results.
  
  Use this value when making the next call to this operation to continue where the last one finished.

Exceptions

GameSparks.Client.exceptions.ValidationException
GameSparks.Client.exceptions.AccessDeniedException
GameSparks.Client.exceptions.ThrottlingException
GameSparks.Client.exceptions.ResourceNotFoundException
GameSparks.Client.exceptions.InternalServerException