AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . gamesparks ]

create-stage

Description

Creates a new stage for stage-by-stage game development and deployment.

See also: AWS API Documentation

Synopsis

  create-stage
[--client-token <value>]
[--description <value>]
--game-name <value>
--role <value>
--stage-name <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 stage.

--game-name (string)

The name of the game.

--role (string)

The Amazon Resource Name (ARN) of the role to run the game with. This role can be a game-defined role or the default role that GameSparks created.

--stage-name (string)

The name of the stage.

--tags (map)

The list of tags to apply to the stage.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Stage -> (structure)

Properties that describe the 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)