Cancels a game session placement that's in PENDING status. To stop a
placement, provide the placement ID value.
Results
If successful, this operation removes the placement request from the queue and moves
the GameSessionPlacement to CANCELLED status.
This operation results in an InvalidRequestExecption (400) error if a
game session has already been created for this placement. You can clean up an unneeded
game session by calling TerminateGameSession.
Request Syntax
{
"PlacementId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- PlacementId
-
A unique identifier for a game session placement to stop.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9-]+Required: Yes
Response Syntax
{
"GameSessionPlacement": {
"DnsName": "string",
"EndTime": number,
"GameProperties": [
{
"Key": "string",
"Value": "string"
}
],
"GameSessionArn": "string",
"GameSessionData": "string",
"GameSessionId": "string",
"GameSessionName": "string",
"GameSessionQueueName": "string",
"GameSessionRegion": "string",
"IpAddress": "string",
"MatchmakerData": "string",
"MaximumPlayerSessionCount": number,
"PlacedPlayerSessions": [
{
"PlayerId": "string",
"PlayerSessionId": "string"
}
],
"PlacementId": "string",
"PlayerLatencies": [
{
"LatencyInMilliseconds": number,
"PlayerId": "string",
"RegionIdentifier": "string"
}
],
"Port": number,
"PriorityConfigurationOverride": {
"LocationOrder": [ "string" ],
"PlacementFallbackStrategy": "string"
},
"StartTime": number,
"Status": "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.
- GameSessionPlacement
-
Object that describes the canceled game session placement, with
CANCELLEDstatus and an end time stamp.Type: GameSessionPlacement object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
