describe_transit_gateways¶
Operation¶
describe_transit_gateways
async
¶
describe_transit_gateways(request: DescribeTransitGatewaysInput | DescribeTransitGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeTransitGatewaysOutput
describe_transit_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewaysInputDict]) -> DescribeTransitGatewaysOutput
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewaysOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeTransitGatewaysInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewaysInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
filters
class-attribute
instance-attribute
¶
One or more filters. The possible values are:
-
options.propagation-default-route-table-id- The ID of the default propagation route table. -
options.amazon-side-asn- The private ASN for the Amazon side of a BGP session. -
options.association-default-route-table-id- The ID of the default association route table. -
options.auto-accept-shared-attachments- Indicates whether there is automatic acceptance of attachment requests (enable|disable). -
options.default-route-table-association- Indicates whether resource attachments are automatically associated with the default association route table (enable|disable). -
options.default-route-table-propagation- Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable|disable). -
options.dns-support- Indicates whether DNS support is enabled (enable|disable). -
options.vpn-ecmp-support- Indicates whether Equal Cost Multipath Protocol support is enabled (enable|disable). -
owner-id- The ID of the Amazon Web Services account that owns the transit gateway. -
state- The state of the transit gateway (available|deleted|deleting|modifying|pending). -
transit-gateway-id- The ID of the transit gateway. -
tag-key- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
Dictionaries¶
DescribeTransitGatewaysInputDict
¶
Bases: TypedDict
Dictionary form of DescribeTransitGatewaysInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
One or more filters. The possible values are:
-
options.propagation-default-route-table-id- The ID of the default propagation route table. -
options.amazon-side-asn- The private ASN for the Amazon side of a BGP session. -
options.association-default-route-table-id- The ID of the default association route table. -
options.auto-accept-shared-attachments- Indicates whether there is automatic acceptance of attachment requests (enable|disable). -
options.default-route-table-association- Indicates whether resource attachments are automatically associated with the default association route table (enable|disable). -
options.default-route-table-propagation- Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable|disable). -
options.dns-support- Indicates whether DNS support is enabled (enable|disable). -
options.vpn-ecmp-support- Indicates whether Equal Cost Multipath Protocol support is enabled (enable|disable). -
owner-id- The ID of the Amazon Web Services account that owns the transit gateway. -
state- The state of the transit gateway (available|deleted|deleting|modifying|pending). -
transit-gateway-id- The ID of the transit gateway. -
tag-key- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.
Output¶
DescribeTransitGatewaysOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewaysOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
transit_gateways
class-attribute
instance-attribute
¶
transit_gateways: list[TransitGateway] | None = ...
Information about the transit gateways.