GameSparks / Client / start_generated_code_job

start_generated_code_job#

GameSparks.Client.start_generated_code_job(**kwargs)#

Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.

Request Syntax

response = client.start_generated_code_job(
    GameName='string',
    Generator={
        'GameSdkVersion': 'string',
        'Language': 'string',
        'TargetPlatform': 'string'
    },
    SnapshotId='string'
)

Parameters:

GameName (string) –
[REQUIRED]

The name of the game.
Generator (dict) –
[REQUIRED]

Properties of the generator to use for the job.
- GameSdkVersion (string) –
  
  The target version of the GameSparks Game SDK.
- Language (string) –
  
  The programming language for the generated code.
  
  Not all languages are supported for each platform. For cases where multiple languages are supported, this parameter specifies the language to be used. If this value is omitted, the default language for the target platform will be used.
- TargetPlatform (string) –
  
  The platform that will be used to run the generated code.
SnapshotId (string) –
[REQUIRED]

The identifier of the snapshot for which to generate code.

Return type:

dict

Returns:

Response Syntax

{
    'GeneratedCodeJobId': 'string'
}

Response Structure

(dict) –
- GeneratedCodeJobId (string) –
  
  The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

Exceptions

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