Amazon GameLift Service
API Reference (API Version 2015-10-01)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

DescribeScript

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

Request Syntax

{ "ScriptId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

ScriptId

A unique identifier for a Realtime script to retrieve properties for.

Type: String

Pattern: ^script-\S+|^arn:.*script-\S+

Required: Yes

Response Syntax

{ "Script": { "CreationTime": number, "Name": "string", "ScriptId": "string", "SizeOnDisk": number, "StorageLocation": { "Bucket": "string", "Key": "string", "ObjectVersion": "string", "RoleArn": "string" }, "Version": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Script

A set of properties describing the requested script.

Type: Script object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

Example

View a script record

Sample Request

POST /2015-03-31/functions HTTP/1.1 Content-type: application/json { "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff" } CLI syntax: aws gamelift describe-script --script-id "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff"

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: b34f8665-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 351 Date: Thu, 06 Apr 2017 00:48:07 GMT { "Script": { "CreationTime": 1496708916.18, "Name": "My_Realtime_Script_2", "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "SizeOnDisk": 0, "StorageLocation": { "Bucket": "my_realtime_script_files", "Key": "myRealtimeScript.zip" "RoleArn": "arn:aws:iam::111122223333:role/GameLiftAccess" "ObjectVersion": null }, "Version": "12345.678" } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: