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

CreateStage

Creates a new stage for stage-by-stage game development and deployment.

Request Syntax

POST /game/GameName/stage HTTP/1.1 Content-type: application/json { "ClientToken": "string", "Description": "string", "Role": "string", "StageName": "string", "Tags": { "string" : "string" } }

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

Request Body

The request accepts the following data in JSON format.

ClientToken

A client-defined token. With an active client token in the request, this action is idempotent.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 126.

Required: No

Description

The description of the stage.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 250.

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

Required: No

Role

The Amazon Resource Name (ARN) of the role to run the game with. This role can be a game-defined role or the default role that GameSparks created.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/.+$

Required: Yes

StageName

The name of the stage.

Type: String

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

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

Required: Yes

Tags

The list of tags to apply to the stage.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[\s\w+-=\.:/@]*$

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Stage": { "Arn": "string", "Created": number, "Description": "string", "GameKey": "string", "LastUpdated": number, "LogGroup": "string", "Name": "string", "Role": "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.

Stage

Properties that describe the stage.

Type: StageDetails object

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

ConflictException

The resource already exists, or another operation is in progress.

HTTP Status Code: 409

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: