get_generated_code_job

GameSparks.Client.get_generated_code_job(**kwargs)

Gets details about a job that is generating code for a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_generated_code_job(
    GameName='string',
    JobId='string',
    SnapshotId='string'
)
Parameters
  • GameName (string) --

    [REQUIRED]

    The name of the game.

  • JobId (string) --

    [REQUIRED]

    The identifier of the code generation job.

  • SnapshotId (string) --

    [REQUIRED]

    The identifier of the snapshot for the code generation job.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • GeneratedCodeJob (dict) --

      Details about the 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

Exceptions

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