Gets information about the prefix list references in a specified transit gateway route table.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-transit-gateway-prefix-list-references
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: TransitGatewayPrefixListReferences
get-transit-gateway-prefix-list-references
--transit-gateway-route-table-id <value>
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--transit-gateway-route-table-id
(string)
The ID of the transit gateway route table.
--filters
(list)
One or more filters. The possible values are:
attachment.resource-id
- The ID of the resource for the attachment.
attachment.resource-type
- The type of resource for the attachment. Valid values arevpc
|vpn
|direct-connect-gateway
|peering
.
attachment.transit-gateway-attachment-id
- The ID of the attachment.
is-blackhole
- Whether traffic matching the route is blocked (true
|false
).
prefix-list-id
- The ID of the prefix list.
prefix-list-owner-id
- The ID of the owner of the prefix list.
state
- The state of the prefix list reference (pending
|available
|modifying
|deleting
).(structure)
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
Name -> (string)
The name of the filter. Filter names are case-sensitive.
Values -> (list)
The filter values. Filter values are case-sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--dry-run
| --no-dry-run
(boolean)
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 isUnauthorizedOperation
.
--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.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
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 in the AWS Command Line Interface User Guide .
--max-items
(integer)
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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To get prefix list references in a transit gateway route table
The following get-transit-gateway-prefix-list-references
example gets the prefix list references for the specified transit gateway route table, and filters by the ID of a specific prefix list.
aws ec2 get-transit-gateway-prefix-list-references \
--transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \
--filters Name=prefix-list-id,Values=pl-11111122222222333
Output:
{
"TransitGatewayPrefixListReferences": [
{
"TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123",
"PrefixListId": "pl-11111122222222333",
"PrefixListOwnerId": "123456789012",
"State": "available",
"Blackhole": false,
"TransitGatewayAttachment": {
"TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab",
"ResourceType": "vpc",
"ResourceId": "vpc-112233445566aabbc"
}
}
]
}
For more information, see Prefix list references in the Transit Gateways Guide.
TransitGatewayPrefixListReferences -> (list)
Information about the prefix list references.
(structure)
Describes a prefix list reference.
TransitGatewayRouteTableId -> (string)
The ID of the transit gateway route table.
PrefixListId -> (string)
The ID of the prefix list.
PrefixListOwnerId -> (string)
The ID of the prefix list owner.
State -> (string)
The state of the prefix list reference.
Blackhole -> (boolean)
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment -> (structure)
Information about the transit gateway attachment.
TransitGatewayAttachmentId -> (string)
The ID of the attachment.
ResourceType -> (string)
The resource type. Note that the
tgw-peering
resource type has been deprecated.ResourceId -> (string)
The ID of the resource.
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.