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

UpdateStage

Updates the metadata of a stage.

Request Syntax


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

{
   "Description": "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.

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.

Description

The description of the stage.

Type: String

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

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

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 provide details of the updated 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

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