ListScripts - Amazon GameLift Service

ListScripts

Retrieves script records for all Realtime scripts that are associated with the AWS account in use.

Learn more

Amazon GameLift Realtime Servers

Related operations

Request Syntax

{ "Limit": number, "NextToken": "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.

Limit

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "NextToken": "string", "Scripts": [ { "CreationTime": number, "Name": "string", "ScriptArn": "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.

NextToken

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Type: String

Length Constraints: Minimum length of 1.

Scripts

A set of properties describing the requested script.

Type: Array of Script objects

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

UnauthorizedException

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

HTTP Status Code: 400

Example

Retrieve all scripts

This example retrieves the Realtime scripts in the current Region. The example illustrates using the pagination parameters to retrieve the results in sequential sets. This sample request uses a NextToken value that was returned in a previous ListScripts request. The response shows two script records; the first script was uploaded from an Amazon S3 bucket, and the second script was uploaded from a local zip file.

Sample Request

{ "Limit": 2, "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC00NDRlZjQxZS1hM2I1LTQ2NDYtODJmMy0zYzI4ZTgxNjVjEXAMPLE=" } CLI syntax: aws gamelift list-scripts -limit 2 -next-token "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC00NDRlZjQxZS1hM2I1LTQ2NDYtODJmMy0zYzI4ZTgxNjVjEXAMPLE="

Sample Response

{ "Scripts": { "CreationTime": 1496708916.18, "Name": "My_Realtime_Script_2", "ScriptArn": "arn:aws:gamelift:us-west-2::script/script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", "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" }, { "CreationTime": 1495528748.555, "Name": "My_Realtime_Script_1", "ScriptArn": "arn:aws:gamelift:us-west-2::script/script-3333cccc-44dd-55ee-66ff-7777aaaa88bb", "ScriptId": "script-3333cccc-44dd-55ee-66ff-7777aaaa88bb", "SizeOnDisk": 9000, "StorageLocation": { "Bucket": "prod-gamescale-scripts-us-west-2", "Key": "123456789012/script-1111aaaa-22bb-33cc-44dd-5555eeee66ff" }, "Version": "1.0.1" } "NextToken": "kyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE=" }

See Also

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