Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartStageDeployment

Deploys a snapshot to the stage and creates a new game runtime.

After you call this operation, you can check the deployment status by using GetStageDeployment.

If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.

Request Syntax


POST /game/GameName/stage/StageName/deployment HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "SnapshotId": "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

StageName

The name of the stage to deploy the snapshot onto.

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

SnapshotId

The identifier of the snapshot to deploy.

Type: String

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

Pattern: ^Snapshot_\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3,6}Z$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "StageDeployment": { 
      "Created": number,
      "DeploymentAction": "string",
      "DeploymentId": "string",
      "DeploymentResult": { 
         "Message": "string",
         "ResultCode": "string"
      },
      "DeploymentState": "string",
      "LastUpdated": number,
      "SnapshotId": "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.

StageDeployment

Properties that describe the stage deployment.

Type: StageDeploymentDetails object

Errors

For information about the errors that are common to all actions, see Common 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