Skip to content

describe_transit_gateway_connects async

describe_transit_gateway_connects(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = 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,
) -> DescribeTransitGatewayConnectsResult

Describes one or more Connect attachments.

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:

    • options.protocol - The tunnel protocol (gre).

    • state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).

    • transit-gateway-attachment-id - The ID of the Connect attachment.

    • transit-gateway-id - The ID of the transit gateway.

    • transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.

  • 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/async_ec2.py
async def describe_transit_gateway_connects(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = 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_connects_result.DescribeTransitGatewayConnectsResult":
    """<p>Describes one or more Connect attachments.</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>options.protocol</code> - The tunnel protocol (<code>gre</code>).</p> </li> <li> <p> <code>state</code> - The state of the attachment (<code>initiating</code> | <code>initiatingRequest</code> | <code>pendingAcceptance</code> | <code>rollingBack</code> | <code>pending</code> | <code>available</code> | <code>modifying</code> | <code>deleting</code> | <code>deleted</code> | <code>failed</code> | <code>rejected</code> | <code>rejecting</code> | <code>failing</code>).</p> </li> <li> <p> <code>transit-gateway-attachment-id</code> - The ID of the Connect attachment.</p> </li> <li> <p> <code>transit-gateway-id</code> - The ID of the transit gateway.</p> </li> <li> <p> <code>transport-transit-gateway-attachment-id</code> - The ID of the transit gateway attachment from which the Connect attachment was created.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_transit_gateway_connects_request.DescribeTransitGatewayConnectsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_transit_gateway_connects_result.DescribeTransitGatewayConnectsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_transit_gateway_connects

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_transit_gateway_connects.async_describe_transit_gateway_connects(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTransitGatewayConnects")
    )
    input_: capo_ec2.types.describe_transit_gateway_connects_request.DescribeTransitGatewayConnectsRequest = {}
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output