StartGeneratedCodeJob - Amazon GameSparks

Amazon GameSparks is currently in preview. Changes might be made to this service and to this documentation. We don't recommend using this service for production workloads.

StartGeneratedCodeJob

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

POST /game/GameName/snapshot/SnapshotId/generated-sdk-code-job HTTP/1.1 Content-type: application/json { "Generator": { "GameSdkVersion": "string", "Language": "string", "TargetPlatform": "string" } }

URI Request Parameters

The request uses the following URI parameters.

GameName

The name of the game.

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

SnapshotId

The identifier of the snapshot for which to generate code.

Length Constraints: Minimum length of 33. Maximum length of 36.

Pattern: ^Snapshot_\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3,6}Z$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Generator

Properties of the generator to use for the job.

Type: Generator object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "GeneratedCodeJobId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GeneratedCodeJobId

The identifier of the code generation job. You can use this identifier in the GetGeneratedCodeJob operation.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Errors

For information about the errors that are common to all actions, see Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

One of the parameters in the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: