Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . gamelift ]

describe-script

Description

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Realtime Servers

Related operations

  • CreateScript
  • ListScripts
  • DescribeScript
  • UpdateScript
  • DeleteScript

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-script
--script-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--script-id (string)

Unique identifier for a Realtime script to retrieve properties for.

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

Script -> (structure)

Set of properties describing the requested script.

ScriptId -> (string)

Unique identifier for a Realtime script

Name -> (string)

Descriptive label that is associated with a script. Script names do not need to be unique.

Version -> (string)

Version that is associated with a build or script. Version strings do not need to be unique.

SizeOnDisk -> (long)

File size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".

CreationTime -> (timestamp)

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

StorageLocation -> (structure)

Location in Amazon Simple Storage Service (Amazon S3) where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild , CreateScript , and UpdateScript requests.

Bucket -> (string)

Amazon S3 bucket identifier. This is the name of the S3 bucket.

Key -> (string)

Name of the zip file containing the build files or script files.

RoleArn -> (string)

Amazon Resource Name (ARN ) for an IAM role that allows Amazon GameLift to access the S3 bucket.

ObjectVersion -> (string)

Version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file; if not set, the latest version of the file is retrieved.