AWS cli documentation change
Summary
Updated AWS CLI version reference, reordered parameters, modified parameter descriptions (including authentication requirements), adjusted validation patterns, and changed output field descriptions.
Security assessment
Changes include parameter reordering, documentation clarifications about authentication methods (Secrets Manager/temporary credentials), and pattern validation updates. While authentication-related, there's no evidence these changes address a specific security vulnerability or weakness. The modifications appear to be documentation improvements rather than security fixes.
Diff
diff --git a/cli/latest/reference/redshift-data/batch-execute-statement.md b/cli/latest/reference/redshift-data/batch-execute-statement.md index a47e15123..b6881bfde 100644 --- a//cli/latest/reference/redshift-data/batch-execute-statement.md +++ b//cli/latest/reference/redshift-data/batch-execute-statement.md @@ -15 +15 @@ - * [AWS CLI 2.31.39 Command Reference](../../index.html) » + * [AWS CLI 2.32.3 Command Reference](../../index.html) » @@ -77 +77 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi - [--client-token <value>] + --sqls <value> @@ -79,3 +78,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi - [--database <value>] - [--db-user <value>] - [--result-format <value>] @@ -83,4 +80,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi - [--session-id <value>] - [--session-keep-alive-seconds <value>] - --sqls <value> - [--statement-name <value>] + [--db-user <value>] + [--database <value>] @@ -87,0 +83 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi + [--statement-name <value>] @@ -88,0 +85,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi + [--client-token <value>] + [--result-format <value>] + [--session-keep-alive-seconds <value>] + [--session-id <value>] @@ -113 +113 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--client-token` (string) +`--sqls` (list) [required] @@ -115 +115 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. +> One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don’t start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back. @@ -120 +120 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> * max: `64` +> * max: `40` @@ -122,0 +123,8 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi +> +> (string) + +Syntax: + + + "string" "string" ... + @@ -131,0 +140 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi +> * pattern: `[a-z][a-z0-9]*(-[a-z0-9]+)*` @@ -135 +144 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--database` (string) +`--secret-arn` (string) @@ -137 +146 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. +> The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. @@ -143,9 +152 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--result-format` (string) - -> The data format of the result of the SQL statement. If no format is specified, the default is JSON. -> -> Possible values: -> -> * `JSON` -> * `CSV` -> +`--database` (string) @@ -152,0 +154 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi +> The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. @@ -154 +156 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--secret-arn` (string) +`--with-event` | `--no-with-event` (boolean) @@ -156 +158 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. +> A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. @@ -158 +160 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--session-id` (string) +`--statement-name` (string) @@ -160 +162 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> The session identifier of the query. +> The name of the SQL statements. You can name the SQL statements when you create them to identify the query. @@ -164 +166,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> * pattern: `^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$` +> * min: `0` +> * max: `2048` @@ -168 +171 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--session-keep-alive-seconds` (integer) +`--workgroup-name` (string) @@ -170 +173 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated. +> The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials. @@ -174,2 +177,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> * min: `0` -> * max: `86400` +> * min: `3` +> * max: `128` +> * pattern: `.*((^[a-z0-9-]{3,63}$)|^(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov|(-iso[a-z]?))?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))` @@ -179 +183 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -`--sqls` (list) [required] +`--client-token` (string) @@ -181 +185 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> One or more SQL statements to run. `The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>` +> A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. @@ -186,3 +190 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> * max: `40` -> - +> * max: `64` @@ -190 +191,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -> (string) @@ -192 +192,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/redshi -Syntax: @@ -193,0 +194 @@ Syntax: +`--result-format` (string) @@ -195 +196,7 @@ Syntax: - "string" "string" ... +> The data format of the result of the SQL statement. If no format is specified, the default is JSON. +> +> Possible values: +> +> * `JSON` +> * `CSV` +> @@ -198 +205 @@ Syntax: -`--statement-name` (string) +`--session-keep-alive-seconds` (integer) @@ -200 +207 @@ Syntax: -> The name of the SQL statements. You can name the SQL statements when you create them to identify the query. +> The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated. @@ -205 +212 @@ Syntax: -> * max: `500` +> * max: `86400` @@ -209,5 +216 @@ Syntax: -`--with-event` | `--no-with-event` (boolean) - -> A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. - -`--workgroup-name` (string) +`--session-id` (string) @@ -215 +218 @@ Syntax: -> The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials. +> The session identifier of the query. @@ -219,3 +222 @@ Syntax: -> * min: `3` -> * max: `128` -> * pattern: `^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov|(-iso[a-z]?))?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$` +> * pattern: `[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d{0,2})?` @@ -324 +325 @@ Disable automatically prompt for CLI input parameters. -ClusterIdentifier -> (string) +Id -> (string) @@ -326 +327 @@ ClusterIdentifier -> (string) -> The cluster identifier. This element is not returned when connecting to a serverless workgroup. +> The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by `BatchExecuteStatment` . @@ -330,2 +331 @@ ClusterIdentifier -> (string) -> * min: `1` -> * max: `63` +> * pattern: `[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d{0,2})?` @@ -339,5 +339 @@ CreatedAt -> (timestamp) -Database -> (string) - -> The name of the database. - -DbGroups -> (list) +ClusterIdentifier -> (string) @@ -345 +341 @@ DbGroups -> (list) -> A list of colon (:) separated names of database groups. +> The cluster identifier. This element is not returned when connecting to a serverless workgroup. @@ -347 +343,7 @@ DbGroups -> (list) -> (string) +> Constraints: +> +> * min: `1` +> * max: `63` +> * pattern: `[a-z][a-z0-9]*(-[a-z0-9]+)*` +> + @@ -353 +355 @@ DbUser -> (string) -Id -> (string) +DbGroups -> (list) @@ -355,5 +357 @@ Id -> (string) -> The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by `BatchExecuteStatment` . -> -> Constraints: -> -> * pattern: `^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$` +> A list of colon (:) separated names of database groups. @@ -360,0 +359 @@ Id -> (string) +> (string) @@ -361,0 +361,3 @@ Id -> (string) +Database -> (string) + +> The name of the database. @@ -367 +369 @@ SecretArn -> (string) -SessionId -> (string) +WorkgroupName -> (string) @@ -369 +371 @@ SessionId -> (string) -> The session identifier of the query. +> The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster. @@ -373 +375,3 @@ SessionId -> (string) -> * pattern: `^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$` +> * min: `3` +> * max: `128`