[ aws . gamesparks ]

start-generated-code-job

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-generated-code-job
--game-name <value>
--generator <value>
--snapshot-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--game-name (string)

The name of the game.

--generator (structure)

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.

Shorthand Syntax:

GameSdkVersion=string,Language=string,TargetPlatform=string

JSON Syntax:

{
  "GameSdkVersion": "string",
  "Language": "string",
  "TargetPlatform": "string"
}

--snapshot-id (string)

The identifier of the snapshot for which to generate code.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

GeneratedCodeJobId -> (string)

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