AWS cli documentation change
Summary
Updated documentation with event-based placement guidance reference, added API limit warnings for game properties, and added PlayerGatewayStatus documentation
Security assessment
The changes add operational guidance about API usage limits (500 game property keys) and link to implementation patterns, but do not address vulnerabilities or security controls. The PlayerGatewayStatus documentation describes feature availability rather than security controls.
Diff
diff --git a/cli/latest/reference/gamelift/describe-game-session-placement.md b/cli/latest/reference/gamelift/describe-game-session-placement.md index fea755252..753bda5e8 100644 --- a//cli/latest/reference/gamelift/describe-game-session-placement.md +++ b//cli/latest/reference/gamelift/describe-game-session-placement.md @@ -15 +15 @@ - * [AWS CLI 2.34.1 Command Reference](../../index.html) » + * [AWS CLI 2.34.4 Command Reference](../../index.html) » @@ -65 +65 @@ To get game session placement details, specify the placement ID. -This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with `DescribeGameSessionPlacement` should only be used for games in development with low game session usage. +This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with `DescribeGameSessionPlacement` should only be used for games in development with low game session usage. For a reference implementation of event-based game session placement tracking, see [Event-based game session placement guidance](https://github.com/amazon-gamelift/amazon-gamelift-toolkit/tree/main/event-based-session-placement) in the Amazon GameLift Toolkit. @@ -280 +280,4 @@ GameSessionPlacement -> (structure) ->> Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations. +>> * Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations. +>> * If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results. +>> + @@ -302 +305,4 @@ GameSessionPlacement -> (structure) ->>>> Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations. +>>>> * Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations. +>>>> * If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results. +>>>> + @@ -540,0 +547,18 @@ GameSessionPlacement -> (structure) +> +> PlayerGatewayStatus -> (string) +> +>> The current status of player gateway for the game session placement. Note, even if a fleet has PlayerGatewayMode configured as `ENABLED` , player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/gamelift-regions.html) . +>> +>> Possible values include: +>> +>> * `ENABLED` – Player gateway is available for this game session placement. +>> * `DISABLED` – Player gateway is not available for this game session placement. +>> + +>> +>> Possible values: +>> +>> * `DISABLED` +>> * `ENABLED` +>> + @@ -552 +576 @@ GameSessionPlacement -> (structure) - * [AWS CLI 2.34.1 Command Reference](../../index.html) » + * [AWS CLI 2.34.4 Command Reference](../../index.html) »