AWS cli documentation change
Summary
Added pagination documentation and parameters while removing --max-results
Security assessment
Changes focus on pagination implementation (--starting-token, --page-size etc.) and dry-run functionality. No security vulnerabilities addressed or security features documented. The dry-run parameter is for permission checks, but doesn't represent new security documentation.
Diff
diff --git a/cli/latest/reference/ec2/search-transit-gateway-routes.md b/cli/latest/reference/ec2/search-transit-gateway-routes.md index 5879abb0e..1fd2c1fa1 100644 --- a//cli/latest/reference/ec2/search-transit-gateway-routes.md +++ b//cli/latest/reference/ec2/search-transit-gateway-routes.md @@ -15 +15 @@ - * [AWS CLI 2.33.8 Command Reference](../../index.html) » + * [AWS CLI 2.33.12 Command Reference](../../index.html) » @@ -63,0 +64,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ec2-20 +`search-transit-gateway-routes` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `Routes` + @@ -70 +71,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ec2-20 - [--max-results <value>] @@ -72,0 +74,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ec2-20 + [--starting-token <value>] + [--page-size <value>] + [--max-items <value>] @@ -153 +157 @@ JSON Syntax: -`--max-results` (integer) +`--dry-run` | `--no-dry-run` (boolean) @@ -155,6 +159,7 @@ JSON Syntax: -> The maximum number of routes to return. If a value is not provided, the default is 1000. -> -> Constraints: -> -> * min: `5` -> * max: `1000` +> Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation` . Otherwise, it is `UnauthorizedOperation` . + +`--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. + +`--starting-token` (string) + +> A token to specify where to start paginating. This is the `NextToken` from a previously truncated response. @@ -161,0 +167 @@ JSON Syntax: +> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the _AWS Command Line Interface User Guide_ . @@ -162,0 +169 @@ JSON Syntax: +`--page-size` (integer) @@ -164 +171,3 @@ JSON Syntax: -`--dry-run` | `--no-dry-run` (boolean) +> The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out. +> +> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the _AWS Command Line Interface User Guide_ . @@ -166 +175 @@ JSON Syntax: -> Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation` . Otherwise, it is `UnauthorizedOperation` . +`--max-items` (integer) @@ -168 +177,3 @@ JSON Syntax: -`--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. +> The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI. +> +> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the _AWS Command Line Interface User Guide_ . @@ -402,0 +414,4 @@ AdditionalRoutesAvailable -> (boolean) +NextToken -> (string) + +> The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. + @@ -413 +428 @@ AdditionalRoutesAvailable -> (boolean) - * [AWS CLI 2.33.8 Command Reference](../../index.html) » + * [AWS CLI 2.33.12 Command Reference](../../index.html) »