Skip to content

describe_transit_gateway_attachments

describe_transit_gateway_attachments(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_attachment_ids: Optional[
        TransitGatewayAttachmentIdStringList
    ] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[TransitGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeTransitGatewayAttachmentsResult

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:

  • transit_gateway_attachment_ids (Optional[TransitGatewayAttachmentIdStringList], default: None ) –

    The IDs of the attachments.

  • filters (Optional[FilterList], default: 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 are vpc | vpn | direct-connect-gateway | peering | connect.

    • state - The state of the attachment. Valid values are available | 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 (Optional[TransitGatewayMaxResults], default: 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.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_transit_gateway_attachments(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_attachment_ids: Optional[
        "capo_ec2.types.transit_gateway_attachment_id_string_list.TransitGatewayAttachmentIdStringList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.transit_gateway_max_results.TransitGatewayMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_transit_gateway_attachments_result.DescribeTransitGatewayAttachmentsResult":
    """<p>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.</p>

    Args:
        transit_gateway_attachment_ids: <p>The IDs of the attachments.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>association.state</code> - The state of the association (<code>associating</code> | <code>associated</code> | <code>disassociating</code>).</p> </li> <li> <p> <code>association.transit-gateway-route-table-id</code> - The ID of the route table for the transit gateway.</p> </li> <li> <p> <code>resource-id</code> - The ID of the resource.</p> </li> <li> <p> <code>resource-owner-id</code> - The ID of the Amazon Web Services account that owns the resource.</p> </li> <li> <p> <code>resource-type</code> - The resource type. Valid values are <code>vpc</code> | <code>vpn</code> | <code>direct-connect-gateway</code> | <code>peering</code> | <code>connect</code>.</p> </li> <li> <p> <code>state</code> - The state of the attachment. Valid values are <code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>failed</code> | <code>failing</code> | <code>initiatingRequest</code> | <code>modifying</code> | <code>pendingAcceptance</code> | <code>pending</code> | <code>rollingBack</code> | <code>rejected</code> | <code>rejecting</code>.</p> </li> <li> <p> <code>transit-gateway-attachment-id</code> - The ID of the attachment.</p> </li> <li> <p> <code>transit-gateway-id</code> - The ID of the transit gateway.</p> </li> <li> <p> <code>transit-gateway-owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway.</p> </li> </ul>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_transit_gateway_attachments_request.DescribeTransitGatewayAttachmentsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_transit_gateway_attachments_result.DescribeTransitGatewayAttachmentsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_transit_gateway_attachments

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_transit_gateway_attachments.describe_transit_gateway_attachments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTransitGatewayAttachments")
    )
    input_: capo_ec2.types.describe_transit_gateway_attachments_request.DescribeTransitGatewayAttachmentsRequest = {}
    if transit_gateway_attachment_ids is not None:
        input_["transit_gateway_attachment_ids"] = transit_gateway_attachment_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output