describe_transit_gateway_attachments¶
Operation¶
describe_transit_gateway_attachments
¶
describe_transit_gateway_attachments(request: DescribeTransitGatewayAttachmentsInput | DescribeTransitGatewayAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayAttachmentsInputDict]) -> DescribeTransitGatewayAttachmentsOutput
Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTransitGatewayAttachmentsInput | DescribeTransitGatewayAttachmentsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeTransitGatewayAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewayAttachmentsOutput
|
An instance of |
describe_transit_gateway_attachments
async
¶
describe_transit_gateway_attachments(request: DescribeTransitGatewayAttachmentsInput | DescribeTransitGatewayAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayAttachmentsInputDict]) -> DescribeTransitGatewayAttachmentsOutput
Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTransitGatewayAttachmentsInput | DescribeTransitGatewayAttachmentsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeTransitGatewayAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewayAttachmentsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeTransitGatewayAttachmentsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeTransitGatewayAttachmentsInput.
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:
-
association.state- The state of the association (associating|associated|disassociating). -
association.transit-gateway-route-table-id- The ID of the route table for the transit gateway. -
resource-id- The ID of the resource. -
resource-owner-id- The ID of the Amazon Web Services account that owns the resource. -
resource-type- The resource type. Valid values arevpc|vpn|direct-connect-gateway|peering|connect. -
state- The state of the attachment. Valid values areavailable|deleted|deleting|failed|failing|initiatingRequest|modifying|pendingAcceptance|pending|rollingBack|rejected|rejecting. -
transit-gateway-attachment-id- The ID of the attachment. -
transit-gateway-id- The ID of the transit gateway. -
transit-gateway-owner-id- The ID of the Amazon Web Services account that owns the transit gateway.
DescribeTransitGatewayAttachmentsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewayAttachmentsInput 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:
-
association.state- The state of the association (associating|associated|disassociating). -
association.transit-gateway-route-table-id- The ID of the route table for the transit gateway. -
resource-id- The ID of the resource. -
resource-owner-id- The ID of the Amazon Web Services account that owns the resource. -
resource-type- The resource type. Valid values arevpc|vpn|direct-connect-gateway|peering|connect. -
state- The state of the attachment. Valid values areavailable|deleted|deleting|failed|failing|initiatingRequest|modifying|pendingAcceptance|pending|rollingBack|rejected|rejecting. -
transit-gateway-attachment-id- The ID of the attachment. -
transit-gateway-id- The ID of the transit gateway. -
transit-gateway-owner-id- The ID of the Amazon Web Services account that owns the transit gateway.
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.
Output¶
DescribeTransitGatewayAttachmentsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewayAttachmentsOutput 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_gateway_attachments
class-attribute
instance-attribute
¶
transit_gateway_attachments: list[TransitGatewayAttachment] | None = ...
Information about the attachments.