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 ]

get-snapshot

Description

Gets a copy of the game configuration in a snapshot.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-snapshot uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  get-snapshot
--game-name <value>
[--sections <value>]
--snapshot-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--game-name (string)

The name of the game.

--sections (list)

The list of game configuration sections to be described.

(string)

Syntax:

"string" "string" ...

--snapshot-id (string)

The identifier of the snapshot.

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

See 'aws help' for descriptions of global parameters.

Output

Snapshot -> (structure)

Properties that provide details of the snapshot.

Created -> (timestamp)

The timestamp of when the snapshot was created.

Description -> (string)

The description of the snapshot.

Id -> (string)

The identifier of the snapshot.

LastUpdated -> (timestamp)

The timestamp of when the snapshot was last updated.

Sections -> (map)

The sections in the snapshot.

key -> (string)

value -> (structure)

The configuration section.

Attributes -> (document)

The content of a configuration section.

Name -> (string)

The name of the section.

Size -> (integer)

The size, in bytes, of the section contents.