AWS cli documentation change
Summary
Updated CLI version reference, reordered parameters, modified parameter descriptions (including log output URI permissions note), and restructured output fields.
Security assessment
The change adds/retains documentation about required S3 bucket permissions for application logs ('The log bucket must have permissions that give Amazon GameLift Streams access'), which is security-related guidance. However, there is no evidence of addressing a specific vulnerability or incident.
Diff
diff --git a/cli/latest/reference/gameliftstreams/update-application.md b/cli/latest/reference/gameliftstreams/update-application.md index 0a406a15b..bca693c5d 100644 --- a//cli/latest/reference/gameliftstreams/update-application.md +++ b//cli/latest/reference/gameliftstreams/update-application.md @@ -15 +15 @@ - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) » @@ -69,3 +68,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--application-log-output-uri <value>] - [--application-log-paths <value>] - [--description <value>] @@ -72,0 +70,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli + [--description <value>] + [--application-log-paths <value>] + [--application-log-output-uri <value>] @@ -97 +97 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -`--application-log-output-uri` (string) +`--identifier` (string) @@ -99,5 +99,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -> An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more `ApplicationLogPaths` . -> -> ### Note -> -> The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see [Application log bucket permission policy](https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template) in the _Amazon GameLift Streams Developer Guide_ . +> 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` . + +`--description` (string) + +> A human-readable label for the application. @@ -117,5 +117 @@ Syntax: -`--description` (string) - -> A human-readable label for the application. - -`--identifier` (string) +`--application-log-output-uri` (string) @@ -123 +119,5 @@ Syntax: -> 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` . +> An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more `ApplicationLogPaths` . +> +> ### Note +> +> The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see [Application log bucket permission policy](https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template) in the _Amazon GameLift Streams Developer Guide_ . @@ -224,14 +223,0 @@ Disable automatically prompt for CLI input parameters. -ApplicationLogOutputUri -> (string) - -> An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more `ApplicationLogPaths` . - -ApplicationLogPaths -> (list) - -> Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in `ApplicationLogOutputUri` at the end of a stream session. To retrieve stored log files, call [GetStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html) and get the `LogFileLocationUri` . -> -> (string) - -ApplicationSourceUri -> (string) - -> The original Amazon S3 location of uploaded stream content for the application. - @@ -242,12 +227,0 @@ Arn -> (string) -AssociatedStreamGroups -> (list) - -> A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application. -> -> This value is a set of [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identify stream group resources. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4` . -> -> (string) - -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). - @@ -258,28 +231,0 @@ Description -> (string) -ExecutablePath -> (string) - -> The path and file name of the executable file that launches the content for streaming. - -Id -> (string) - -> A unique ID value that is assigned to the resource when it’s created. Format example: `a-9ZY8X7Wv6` . - -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). - -ReplicationStatuses -> (list) - -> A set of replication statuses for each location. -> -> (structure) -> ->> Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there. ->> ->> Location -> (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_ . ->> ->> Status -> (string) ->> ->>> The current status of the replication process. - @@ -295,0 +242 @@ RuntimeEnvironment -> (structure) +> * Proton 9.0-2 (`Type=PROTON, Version=20250516` ) @@ -308,0 +256,22 @@ RuntimeEnvironment -> (structure) +ExecutablePath -> (string) + +> The path and file name of the executable file that launches the content for streaming. + +ApplicationLogPaths -> (list) + +> Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in `ApplicationLogOutputUri` at the end of a stream session. To retrieve stored log files, call [GetStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html) and get the `LogFileLocationUri` . +> +> (string) + +ApplicationLogOutputUri -> (string) + +> An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more `ApplicationLogPaths` . + +ApplicationSourceUri -> (string) + +> The original Amazon S3 location of uploaded stream content for the application. + +Id -> (string) + +> A unique ID value that is assigned to the resource when it’s created. Format example: `a-9ZY8X7Wv6` . + @@ -324,0 +294,32 @@ StatusReason -> (string) +ReplicationStatuses -> (list) + +> A set of replication statuses for each location. +> +> (structure) +> +>> Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there. +>> +>> Location -> (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_ . +>> +>> Status -> (string) +>> +>>> The current status of the replication process. + +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). + +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). + +AssociatedStreamGroups -> (list) + +> A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application. +> +> This value is a set of [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identify stream group resources. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4` . +> +> (string) + @@ -335 +336 @@ StatusReason -> (string) - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) »