AWS cli documentation change
Summary
Restructured documentation fields, moved parameter descriptions, updated CLI version reference from 2.28.4 to 2.28.6
Security assessment
Changes involve documentation reorganization and version updates without any explicit security vulnerability fixes or new security-related parameters. The note about debugging in local environments is a best practice recommendation but doesn't address a specific security flaw.
Diff
diff --git a/cli/latest/reference/gameliftstreams/get-stream-session.md b/cli/latest/reference/gameliftstreams/get-stream-session.md index 4f7b77930..308343ca5 100644 --- a//cli/latest/reference/gameliftstreams/get-stream-session.md +++ b//cli/latest/reference/gameliftstreams/get-stream-session.md @@ -15 +15 @@ - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) » @@ -202,28 +201,0 @@ Disable automatically prompt for CLI input parameters. -AdditionalEnvironmentVariables -> (map) - -> A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. -> -> ### Note -> ->> If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. -> -> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. -> -> key -> (string) -> -> value -> (string) - -AdditionalLaunchArgs -> (list) - -> A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. -> ->> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. -> -> (string) - -ApplicationArn -> (string) - -> The application streaming in this session. -> -> This value is 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` . - @@ -234,8 +205,0 @@ Arn -> (string) -ConnectionTimeoutSeconds -> (integer) - -> The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. - -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). - @@ -246 +210 @@ Description -> (string) -ExportFilesMetadata -> (structure) +StreamGroupId -> (string) @@ -248,17 +212 @@ ExportFilesMetadata -> (structure) -> Provides details about the stream session’s exported files. -> -> OutputUri -> (string) -> ->> The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a `.zip` file extension. ->> ->> Example 1: If you provide an S3 URI called `s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip` , then Amazon GameLift Streams will save the files at that location. ->> ->> Example 2: If you provide an S3 URI called `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/` , then Amazon GameLift Streams will save the files at `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip` or another similar name. -> -> Status -> (string) -> ->> The result of the [ExportStreamSessionFiles](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ExportStreamSessionFiles.html) operation. -> -> StatusReason -> (string) -> ->> A short description of the reason the export is in `FAILED` status. +> The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: `sg-1AB2C3De4` . @@ -266 +214 @@ ExportFilesMetadata -> (structure) -LastUpdatedAt -> (timestamp) +UserId -> (string) @@ -268 +216 @@ 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). +> An opaque, unique identifier for an end-user, defined by the developer. @@ -270 +218 @@ LastUpdatedAt -> (timestamp) -Location -> (string) +Status -> (string) @@ -272,3 +220 @@ Location -> (string) -> The location where Amazon GameLift Streams is hosting the stream session. -> -> 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_ . +> The current status of the stream session. A stream session can host clients when in `ACTIVE` status. @@ -276 +222 @@ Location -> (string) -LogFileLocationUri -> (string) +StatusReason -> (string) @@ -278 +224 @@ LogFileLocationUri -> (string) -> Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload. +> A short description of the reason the stream session is in `ERROR` status. @@ -284 +230 @@ Protocol -> (string) -SessionLengthSeconds -> (integer) +Location -> (string) @@ -286 +232,3 @@ SessionLengthSeconds -> (integer) -> The length of time that Amazon GameLift Streams keeps the game session open. +> The location where Amazon GameLift Streams is hosting the stream session. +> +> 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_ . @@ -296 +244 @@ SignalResponse -> (string) -Status -> (string) +ConnectionTimeoutSeconds -> (integer) @@ -298 +246 @@ Status -> (string) -> The current status of the stream session. A stream session can host clients when in `ACTIVE` status. +> The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. @@ -300 +248 @@ Status -> (string) -StatusReason -> (string) +SessionLengthSeconds -> (integer) @@ -302 +250 @@ StatusReason -> (string) -> A short description of the reason the stream session is in `ERROR` status. +> The length of time that Amazon GameLift Streams keeps the game session open. @@ -304 +252 @@ StatusReason -> (string) -StreamGroupId -> (string) +AdditionalLaunchArgs -> (list) @@ -306 +254,5 @@ StreamGroupId -> (string) -> The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: `sg-1AB2C3De4` . +> A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. +> +>> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. +> +> (string) @@ -308 +260 @@ StreamGroupId -> (string) -UserId -> (string) +AdditionalEnvironmentVariables -> (map) @@ -310 +262,15 @@ UserId -> (string) -> An opaque, unique identifier for an end-user, defined by the developer. +> A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. +> +> ### Note +> +>> If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. +> +> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. +> +> key -> (string) +> +> value -> (string) + +LogFileLocationUri -> (string) + +> Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload. @@ -315,0 +282,34 @@ WebSdkProtocolUrl -> (string) +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). + +ApplicationArn -> (string) + +> The application streaming in this session. +> +> This value is 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` . + +ExportFilesMetadata -> (structure) + +> Provides details about the stream session’s exported files. +> +> Status -> (string) +> +>> The result of the [ExportStreamSessionFiles](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ExportStreamSessionFiles.html) operation. +> +> StatusReason -> (string) +> +>> A short description of the reason the export is in `FAILED` status. +> +> OutputUri -> (string) +> +>> The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a `.zip` file extension. +>> +>> Example 1: If you provide an S3 URI called `s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip` , then Amazon GameLift Streams will save the files at that location. +>> +>> Example 2: If you provide an S3 URI called `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/` , then Amazon GameLift Streams will save the files at `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip` or another similar name. + @@ -326 +326 @@ WebSdkProtocolUrl -> (string) - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) »