AWS cli documentation change
Summary
Reorganized parameter order and documentation structure for create-stream-group command. Updated CLI version reference from 2.28.4 to 2.28.6. Restructured output field descriptions and error messages.
Security assessment
Changes involve documentation restructuring, parameter reordering, and typo fixes (e.g., 'bcause' to 'because'). No security vulnerabilities or explicit security-related content modifications were identified. The client-token parameter (idempotency token) documentation remains unchanged in content though moved in position, which is a standard API practice rather than a security fix.
Diff
diff --git a/cli/latest/reference/gameliftstreams/create-stream-group.md b/cli/latest/reference/gameliftstreams/create-stream-group.md index 1f6d7366c..7accd1bf2 100644 --- a//cli/latest/reference/gameliftstreams/create-stream-group.md +++ b//cli/latest/reference/gameliftstreams/create-stream-group.md @@ -15 +15 @@ - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) » @@ -78,2 +77,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--client-token <value>] - [--default-application-identifier <value>] @@ -81 +78,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--location-configurations <value>] @@ -82,0 +80,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli + [--default-application-identifier <value>] + [--location-configurations <value>] @@ -83,0 +83 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli + [--client-token <value>] @@ -108,10 +107,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -`--client-token` (string) - -> A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. - -`--default-application-identifier` (string) - -> The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in `READY` status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming. -> -> This value is an [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the application resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6` . Example ID: `a-9ZY8X7Wv6` . - @@ -122,39 +111,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -`--location-configurations` (list) - -> A set of one or more locations and the streaming capacity for each location. -> -> (structure) -> ->> Configuration settings that define a stream group’s stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call [UpdateStreamGroup](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html) . To add a new location and specify its capacity, call [AddStreamGroupLocations](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AddStreamGroupLocations.html) . ->> ->> AlwaysOnCapacity -> (integer) ->> ->>> The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session. ->> ->> LocationName -> (string) ->> ->>> A location’s name. For example, `us-east-1` . For a complete list of locations that Amazon GameLift Streams supports, refer to [Regions, quotas, and limitations](https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html) in the _Amazon GameLift Streams Developer Guide_ . ->> ->> OnDemandCapacity -> (integer) ->> ->>> The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). - -Shorthand Syntax: - - - AlwaysOnCapacity=integer,LocationName=string,OnDemandCapacity=integer ... - - -JSON Syntax: - - - [ - { - "AlwaysOnCapacity": integer, - "LocationName": "string", - "OnDemandCapacity": integer - } - ... - ] - - @@ -210,0 +162,45 @@ JSON Syntax: +`--default-application-identifier` (string) + +> The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in `READY` status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming. +> +> This value is an [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) or ID that uniquely identifies the application resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6` . Example ID: `a-9ZY8X7Wv6` . + +`--location-configurations` (list) + +> A set of one or more locations and the streaming capacity for each location. +> +> (structure) +> +>> Configuration settings that define a stream group’s stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call [UpdateStreamGroup](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html) . To add a new location and specify its capacity, call [AddStreamGroupLocations](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AddStreamGroupLocations.html) . +>> +>> LocationName -> (string) +>> +>>> A location’s name. For example, `us-east-1` . For a complete list of locations that Amazon GameLift Streams supports, refer to [Regions, quotas, and limitations](https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html) in the _Amazon GameLift Streams Developer Guide_ . +>> +>> AlwaysOnCapacity -> (integer) +>> +>>> The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session. +>> +>> OnDemandCapacity -> (integer) +>> +>>> The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). + +Shorthand Syntax: + + + LocationName=string,AlwaysOnCapacity=integer,OnDemandCapacity=integer ... + + +JSON Syntax: + + + [ + { + "LocationName": "string", + "AlwaysOnCapacity": integer, + "OnDemandCapacity": integer + } + ... + ] + + @@ -231,0 +228,4 @@ JSON Syntax: +`--client-token` (string) + +> A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. + @@ -335,9 +335 @@ Arn -> (string) -AssociatedApplications -> (list) - -> A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. -> -> This value is a set of [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identify application resources. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6` . -> -> (string) - -CreatedAt -> (timestamp) +Description -> (string) @@ -345 +337 @@ CreatedAt -> (timestamp) -> A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: `2022-12-27T22:29:40+00:00` (UTC). +> A descriptive label for the stream group. @@ -351,4 +342,0 @@ DefaultApplication -> (structure) -> Arn -> (string) -> ->> An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identifies the application resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6` . -> @@ -358,12 +346,4 @@ DefaultApplication -> (structure) - -Description -> (string) - -> A descriptive label for the stream group. - -Id -> (string) - -> A unique ID value that is assigned to the resource when it’s created. Format example: `sg-1AB2C3De4` . - -LastUpdatedAt -> (timestamp) - -> A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: `2022-12-27T22:29:40+00:00` (UTC). +> +> Arn -> (string) +> +>> An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identifies the application resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6` . @@ -388,12 +367,0 @@ LocationStates -> (list) ->> AllocatedCapacity -> (integer) ->> ->>> This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. ->> ->> AlwaysOnCapacity -> (integer) ->> ->>> The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it’s in use or not. Best for quickest time from streaming request to streaming session. ->> ->> IdleCapacity -> (integer) ->> ->>> This value is the amount of allocated capacity that is not currently streaming. It represents the stream group’s availability to respond to new stream requests, but not including on-demand capacity. ->> @@ -404,8 +371,0 @@ LocationStates -> (list) ->> OnDemandCapacity -> (integer) ->> ->>> The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). ->> ->> RequestedCapacity -> (integer) ->> ->>> This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group. ->> @@ -424,22 +384,20 @@ LocationStates -> (list) - -Status -> (string) - -> The current status of the stream group resource. Possible statuses include the following: -> -> * `ACTIVATING` : The stream group is deploying and isn’t ready to host streams. -> * `ACTIVE` : The stream group is ready to host streams. -> * `ACTIVE_WITH_ERRORS` : One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. -> * `ERROR` : An error occurred when the stream group deployed. See `StatusReason` for more information. -> * `DELETING` : Amazon GameLift Streams is in the process of deleting the stream group. -> * `UPDATING_LOCATIONS` : One or more locations in the stream group are in the process of updating (either activating or deleting). -> - - -StatusReason -> (string) - -> A short description of the reason that the stream group is in `ERROR` status. The possible reasons can be one of the following: -> -> * `internalError` : The request can’t process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help. -> * `noAvailableInstances` : Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region. -> -