describe_transit_gateway_peering_attachments¶
Operation¶
describe_transit_gateway_peering_attachments
¶
describe_transit_gateway_peering_attachments(request: DescribeTransitGatewayPeeringAttachmentsInput | DescribeTransitGatewayPeeringAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayPeeringAttachmentsInputDict]) -> DescribeTransitGatewayPeeringAttachmentsOutput
Describes your transit gateway peering attachments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTransitGatewayPeeringAttachmentsInput | DescribeTransitGatewayPeeringAttachmentsInputDict | 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[DescribeTransitGatewayPeeringAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewayPeeringAttachmentsOutput
|
An instance of |
describe_transit_gateway_peering_attachments
async
¶
describe_transit_gateway_peering_attachments(request: DescribeTransitGatewayPeeringAttachmentsInput | DescribeTransitGatewayPeeringAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayPeeringAttachmentsInputDict]) -> DescribeTransitGatewayPeeringAttachmentsOutput
Describes your transit gateway peering attachments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTransitGatewayPeeringAttachmentsInput | DescribeTransitGatewayPeeringAttachmentsInputDict | 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[DescribeTransitGatewayPeeringAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTransitGatewayPeeringAttachmentsOutput
|
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.
DescribeTransitGatewayPeeringAttachmentsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeTransitGatewayPeeringAttachmentsInput.
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:
-
transit-gateway-attachment-id- The ID of the transit gateway attachment. -
local-owner-id- The ID of your Amazon Web Services account. -
remote-owner-id- The ID of the Amazon Web Services account in the remote Region that owns the transit gateway. -
state- The state of the peering attachment. Valid values areavailable|deleted|deleting|failed|failing|initiatingRequest|modifying|pendingAcceptance|pending|rollingBack|rejected|rejecting). -
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. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. -
transit-gateway-id- The ID of the transit gateway.
DescribeTransitGatewayPeeringAttachmentsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewayPeeringAttachmentsInput 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:
-
transit-gateway-attachment-id- The ID of the transit gateway attachment. -
local-owner-id- The ID of your Amazon Web Services account. -
remote-owner-id- The ID of the Amazon Web Services account in the remote Region that owns the transit gateway. -
state- The state of the peering attachment. Valid values areavailable|deleted|deleting|failed|failing|initiatingRequest|modifying|pendingAcceptance|pending|rollingBack|rejected|rejecting). -
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. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. -
transit-gateway-id- The ID of 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¶
DescribeTransitGatewayPeeringAttachmentsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTransitGatewayPeeringAttachmentsOutput 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_peering_attachments
class-attribute
instance-attribute
¶
transit_gateway_peering_attachments: list[TransitGatewayPeeringAttachment] | None = ...
The transit gateway peering attachments.