UpdateGameSession
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
-
UpdateGameSession
-
Game session placements
Request Syntax
{
"GameSessionId": "string
",
"MaximumPlayerSessionCount": number
,
"Name": "string
",
"PlayerSessionCreationPolicy": "string
",
"ProtectionPolicy": "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.
In the following list, the required parameters are described first.
- GameSessionId
-
A unique identifier for the game session to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9:/-]+
Required: Yes
- MaximumPlayerSessionCount
-
The maximum number of players that can be connected simultaneously to the game session.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- Name
-
A descriptive label that is associated with a game session. Session names do not need to be unique.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- PlayerSessionCreationPolicy
-
Policy determining whether or not the game session accepts new players.
Type: String
Valid Values:
ACCEPT_ALL | DENY_ALL
Required: No
- ProtectionPolicy
-
Game session protection policy to apply to this game session only.
-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
Type: String
Valid Values:
NoProtection | FullProtection
Required: No
-
Response Syntax
{
"GameSession": {
"CreationTime": number,
"CreatorId": "string",
"CurrentPlayerSessionCount": number,
"DnsName": "string",
"FleetArn": "string",
"FleetId": "string",
"GameProperties": [
{
"Key": "string",
"Value": "string"
}
],
"GameSessionData": "string",
"GameSessionId": "string",
"IpAddress": "string",
"MatchmakerData": "string",
"MaximumPlayerSessionCount": number,
"Name": "string",
"PlayerSessionCreationPolicy": "string",
"Port": number,
"Status": "string",
"StatusReason": "string",
"TerminationTime": number
}
}
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.
- GameSession
-
The updated game session metadata.
Type: GameSession object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
HTTP Status Code: 400
- 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
- InvalidGameSessionStatusException
-
The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
HTTP Status Code: 400
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
A service resource associated with the request could not be found. Clients should not retry such requests.
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: