AWS cli documentation change
Summary
Updated CLI version reference from 2.28.4 to 2.28.6, reordered parameters in syntax blocks, restructured output documentation sections, and fixed typos in status descriptions
Security assessment
Changes involve documentation formatting improvements, parameter reordering, and typo fixes (e.g., 'bcause' to 'because'). No security vulnerabilities or explicit security-related content modifications were introduced. The updates appear focused on clarity and accuracy rather than addressing security concerns.
Diff
diff --git a/cli/latest/reference/gameliftstreams/update-stream-group.md b/cli/latest/reference/gameliftstreams/update-stream-group.md index 5910befb1..65dd88550 100644 --- a//cli/latest/reference/gameliftstreams/update-stream-group.md +++ b//cli/latest/reference/gameliftstreams/update-stream-group.md @@ -15 +15 @@ - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) » @@ -76 +75,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--description <value>] @@ -78,0 +78 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli + [--description <value>] @@ -103,4 +102,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -`--description` (string) - -> A descriptive label for the stream group. - @@ -119,4 +114,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli ->> 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. ->> @@ -126,0 +119,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli +>> 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. +>> @@ -134 +130 @@ Shorthand Syntax: - AlwaysOnCapacity=integer,LocationName=string,OnDemandCapacity=integer ... + LocationName=string,AlwaysOnCapacity=integer,OnDemandCapacity=integer ... @@ -142 +137,0 @@ JSON Syntax: - "AlwaysOnCapacity": integer, @@ -143,0 +139 @@ JSON Syntax: + "AlwaysOnCapacity": integer, @@ -149,0 +146,4 @@ JSON Syntax: +`--description` (string) + +> A descriptive label for the stream group. + @@ -253,9 +253 @@ Arn -> (string) -AssociatedApplications -> (list) - -> A set of applications that this stream group is associated with. You can stream any of these applications with the 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) @@ -263 +255 @@ 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. @@ -269,4 +260,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` . -> @@ -276,12 +264,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` . @@ -306,12 +285,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. ->> @@ -322,8 +289,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. ->> @@ -342,22 +302,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. -> - +>> +>> 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). +>> +>> 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. +>> +>> 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. +>> +>> 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. @@ -403,0 +362,42 @@ StreamClass -> (string) +Id -> (string) + +> A unique ID value that is assigned to the resource when it’s created. Format example: `sg-1AB2C3De4` . + +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 because of an issue with the server. Try again later. +> * `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. +> + + +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). + +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). + +AssociatedApplications -> (list) + +> A set of applications that this stream group is associated with. You can stream any of these applications with the 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) + @@ -414 +414 @@ StreamClass -> (string) - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) »