AWS cli documentation change
Summary
Updated AWS CLI version reference, reordered parameters, added new parameters (client-token, description, identifier, protocol), modified parameter descriptions, and reorganized output fields
Security assessment
The changes primarily reorganize parameters and update descriptions without addressing specific security vulnerabilities. The added client-token parameter documentation describes idempotency which is a reliability feature rather than a security fix. No evidence of patching vulnerabilities or addressing security incidents exists in the diff.
Diff
diff --git a/cli/latest/reference/gameliftstreams/start-stream-session.md b/cli/latest/reference/gameliftstreams/start-stream-session.md index 4a42c91e9..f0e9f613e 100644 --- a//cli/latest/reference/gameliftstreams/start-stream-session.md +++ b//cli/latest/reference/gameliftstreams/start-stream-session.md @@ -15 +15 @@ - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) » @@ -78,3 +77,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--additional-environment-variables <value>] - [--additional-launch-args <value>] - --application-identifier <value> @@ -82 +78,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--connection-timeout-seconds <value>] @@ -85 +80,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--locations <value>] @@ -87 +81,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli - [--session-length-seconds <value>] @@ -88,0 +83 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli + --application-identifier <value> @@ -89,0 +85,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli + [--locations <value>] + [--connection-timeout-seconds <value>] + [--session-length-seconds <value>] + [--additional-launch-args <value>] + [--additional-environment-variables <value>] @@ -114 +114 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -`--additional-environment-variables` (map) +`--client-token` (string) @@ -116,3 +116,9 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -> 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 +> 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. + +`--description` (string) + +> A human-readable label for the stream session. You can update this value later. + +`--identifier` (string) + +> The stream group to run this stream session with. @@ -120 +126,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli ->> 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. +> 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 stream group resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4` . Example ID: `sg-1AB2C3De4` . + +`--protocol` (string) + +> The data transport protocol to use for the stream session. @@ -122 +132 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. +> Possible values: @@ -124 +134 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -> key -> (string) +> * `WebRTC` @@ -126,3 +135,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gameli -> value -> (string) - -Shorthand Syntax: @@ -131 +138 @@ Shorthand Syntax: - KeyName1=string,KeyName2=string +`--signal-request` (string) @@ -132,0 +140,3 @@ Shorthand Syntax: +> A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes. +> +> Amazon GameLift Streams also supports setting the field to “NO_CLIENT_CONNECTION”. This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using [CreateStreamSessionConnection](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html) . @@ -134 +144 @@ Shorthand Syntax: -JSON Syntax: +`--application-identifier` (string) @@ -135,0 +146 @@ JSON 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` . @@ -137,2 +148 @@ JSON Syntax: - {"string": "string" - ...} +`--user-id` (string) @@ -139,0 +150 @@ JSON Syntax: +> An opaque, unique identifier for an end-user, defined by the developer. @@ -141 +152 @@ JSON Syntax: -`--additional-launch-args` (list) +`--locations` (list) @@ -143 +154 @@ JSON Syntax: -> 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. +> A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location. @@ -145 +156 @@ JSON Syntax: ->> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. +> This value is A set of location names. 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_ . @@ -155,8 +165,0 @@ Syntax: -`--application-identifier` (string) - -> 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` . - -`--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. - @@ -165,5 +168 @@ Syntax: -> Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the stream session. This time span starts when the stream session reaches `ACTIVE` status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of `TERMINATED` . Default value is 120. - -`--description` (string) - -> A human-readable label for the stream session. You can update this value later. +> Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches `ACTIVE` status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of `TERMINATED` . Default value is 120. @@ -171 +170 @@ Syntax: -`--identifier` (string) +`--session-length-seconds` (integer) @@ -173,3 +172 @@ Syntax: -> The stream group to run this stream session with. -> -> 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 stream group resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4` . Example ID: `sg-1AB2C3De4` . +> 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. Default value is 43200. @@ -177 +174 @@ Syntax: -`--locations` (list) +`--additional-launch-args` (list) @@ -179 +176 @@ Syntax: -> A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location. +> 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. @@ -181 +178 @@ Syntax: -> This value is A set of location names. 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_ . +>> `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have similar purposes. `AdditionalEnvironmentVariables` passes data using environment variables; while `AdditionalLaunchArgs` passes data using command-line arguments. @@ -191 +188 @@ Syntax: -`--protocol` (string) +`--additional-environment-variables` (map) @@ -193 +190 @@ Syntax: -> The data transport protocol to use for the stream session. +> 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. @@ -195 +192 @@ Syntax: -> Possible values: +> ### Note @@ -197 +194,5 @@ Syntax: -> * `WebRTC` +>> 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) @@ -198,0 +200 @@ Syntax: +> value -> (string) @@ -199,0 +202 @@ Syntax: +Shorthand Syntax: @@ -201 +203,0 @@ Syntax: -`--session-length-seconds` (integer) @@ -203 +205 @@ Syntax: -> 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. Default value is 43200. + KeyName1=string,KeyName2=string @@ -205 +206,0 @@ Syntax: -`--signal-request` (string) @@ -207,3 +208 @@ Syntax: -> A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes. -> -> Amazon GameLift Streams also supports setting the field to “NO_CLIENT_CONNECTION”. This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using [CreateStreamSessionConnection](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html) . +JSON Syntax: @@ -211 +209,0 @@ Syntax: -`--user-id` (string) @@ -213 +211,3 @@ Syntax: -> An opaque, unique identifier for an end-user, defined by the developer. + {"string": "string" + ...} + @@ -314,26 +313,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) - -> 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` . - @@ -344,8 +317,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). - @@ -356 +322 @@ Description -> (string) -ExportFilesMetadata -> (structure) +StreamGroupId -> (string) @@ -358,17 +324 @@ ExportFilesMetadata -> (structure) -> Provides details about the stream session’s exported files. -> -> OutputUri -> (string)