ListStages - Amazon GameSparks

Amazon GameSparks is currently in preview. Changes might be made to this service and to this documentation. We don't recommend using this service for production workloads.

ListStages

Gets a paginated list of stage summaries from the game.

Request Syntax

GET /game/GameName/stage?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

GameName

The name of the game.

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

MaxResults

The maximum number of results to return.

Use this parameter with NextToken to get results as a set of sequential pages.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S(.*\S)?$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Stages": [ { "Description": "string", "GameKey": "string", "Name": "string", "State": "string", "Tags": { "string" : "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

The token that indicates the start of the next sequential page of results.

Use this value when making the next call to this operation to continue where the last one finished.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S(.*\S)?$

Stages

A list of stage summaries. You can use the stage names in the UpdateStage and GetStage actions.

Type: Array of StageSummary objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

One of the parameters in the request is invalid.

HTTP Status Code: 400

See Also

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