GameProperty
This key-value pair can store custom data about a game session.
For example, you might use a GameProperty to track a game session's map, level of difficulty, or remaining time.
The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"}.
You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.
For examples of working with game properties, see Create a game session with properties.
Contents
Note
In the following list, the required parameters are described first.
- Key
-
The game property identifier.
Type: String
Length Constraints: Maximum length of 32.
Required: Yes
- Value
-
The game property value.
Type: String
Length Constraints: Maximum length of 96.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
