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.
GetStageDeployment
Gets information about a stage deployment.
Request Syntax
GET /game/GameName
/stage/StageName
/deployment?DeploymentId=DeploymentId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DeploymentId
-
The identifier of the stage deployment.
StartStageDeployment
returns the identifier that you use here.Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^\S(.*\S)?$
- 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 does not have a request body.
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 provide details of 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
- 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: