describe_transit_gateway_vpc_attachments¶
Operation¶
describe_transit_gateway_vpc_attachments
¶
describe_transit_gateway_vpc_attachments(request: DescribeTransitGatewayVpcAttachmentsInput | DescribeTransitGatewayVpcAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayVpcAttachmentsInputDict]) -> DescribeTransitGatewayVpcAttachmentsOutput
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTransitGatewayVpcAttachmentsInput | DescribeTransitGatewayVpcAttachmentsInputDict | 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[DescribeTransitGatewayVpcAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewayVpcAttachmentsOutput
|
An instance of |
describe_transit_gateway_vpc_attachments
async
¶
describe_transit_gateway_vpc_attachments(request: DescribeTransitGatewayVpcAttachmentsInput | DescribeTransitGatewayVpcAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayVpcAttachmentsInputDict]) -> DescribeTransitGatewayVpcAttachmentsOutput
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTransitGatewayVpcAttachmentsInput | DescribeTransitGatewayVpcAttachmentsInputDict | 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[DescribeTransitGatewayVpcAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewayVpcAttachmentsOutput
|
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.
DescribeTransitGatewayVpcAttachmentsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeTransitGatewayVpcAttachmentsInput.
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:
-
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. -
vpc-id- The ID of the VPC.
DescribeTransitGatewayVpcAttachmentsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewayVpcAttachmentsInput 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:
-
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. -
vpc-id- The ID of the VPC.
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¶
DescribeTransitGatewayVpcAttachmentsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewayVpcAttachmentsOutput 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_vpc_attachments
class-attribute
instance-attribute
¶
transit_gateway_vpc_attachments: list[TransitGatewayVpcAttachment] | None = ...
Information about the VPC attachments.