Updates the mutable properties of a game session.
To update a game session, specify the game session ID and the values you want to change.
If successful, the updated GameSession object is returned.
Request Syntax
{
"GameProperties": [
{
"Key": "string",
"Value": "string"
}
],
"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.
Note
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 512.
Pattern:
[a-zA-Z0-9:/-]+Required: Yes
- GameProperties
-
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.Type: Array of GameProperty objects
Array Members: Maximum number of 16 items.
Required: No
- 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
-
A policy that determines whether the game session is accepting new players.
Type: String
Valid Values:
ACCEPT_ALL | DENY_ALLRequired: 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 anACTIVEstatus, it cannot be terminated during a scale-down event.
Type: String
Valid Values:
NoProtection | FullProtectionRequired: 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",
"Location": "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 properties.
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
-
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:
