[ aws . gamesparks ]

create-game

Description

Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-game
[--client-token <value>]
[--description <value>]
--game-name <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A client-defined token. With an active client token in the request, this action is idempotent.

--description (string)

The description of the game.

--game-name (string)

The name of the game.

--tags (map)

The list of tags to apply to the game.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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

Game -> (structure)

Details about the game that was created.

Arn -> (string)

The Amazon Resource Name (ARN) of this game.

Created -> (timestamp)

The date when the game was created.

Description -> (string)

The description of the game.

EnableTerminationProtection -> (boolean)

Determines if the game can be deleted.

LastUpdated -> (timestamp)

The date when the game was last modified.

Name -> (string)

The name of the game.

State -> (string)

The state of the game.

Tags -> (map)

The tags associated with the game.

key -> (string)

value -> (string)