[ aws . gamesparks ]

update-stage

Description

Updates the metadata of a stage.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-stage
[--description <value>]
--game-name <value>
[--role <value>]
--stage-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--description (string)

The description of the stage.

--game-name (string)

The name of the game.

--role (string)

The Amazon Resource Name (ARN) of the role to use for the game snapshots deployed to this stage.

--stage-name (string)

The name of the stage.

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

See ‘aws help’ for descriptions of global parameters.

Output

Stage -> (structure)

Properties that provide details of the updated stage.

Arn -> (string)

The Amazon Resource Name (ARN) of the stage.

Created -> (timestamp)

The timestamp of when the stage was created.

Description -> (string)

The description of the stage.

GameKey -> (string)

The game key associated with the stage.

The game key is a unique identifier that the game client uses to connect to the GameSparks backend.

LastUpdated -> (timestamp)

The timestamp of when the stage was last updated.

LogGroup -> (string)

The Amazon CloudWatch log group for game runtimes deployed to the stage.

Name -> (string)

The name of the stage.

Role -> (string)

The Amazon Resource Name (ARN) of the role used to run the game runtimes deployed to the stage.

State -> (string)

The state of the stage.

Tags -> (map)

The tags associated with the stage.

key -> (string)

value -> (string)