Skip to content

describe_transit_gateway_connect_peers async

describe_transit_gateway_connect_peers(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_connect_peer_ids: Optional[
        TransitGatewayConnectPeerIdStringList
    ] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[TransitGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeTransitGatewayConnectPeersResult

Describes one or more Connect peers.

Parameters:

  • transit_gateway_connect_peer_ids (Optional[TransitGatewayConnectPeerIdStringList], default: None ) –

    The IDs of the Connect peers.

  • filters (Optional[FilterList], default: None ) –

    One or more filters. The possible values are:

    • state - The state of the Connect peer (pending | available | deleting | deleted).

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

    • transit-gateway-connect-peer-id - The ID of the Connect peer.

  • 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_connect_peers(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_connect_peer_ids: Optional[
        "capo_ec2.types.transit_gateway_connect_peer_id_string_list.TransitGatewayConnectPeerIdStringList"
    ] = 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_connect_peers_result.DescribeTransitGatewayConnectPeersResult":
    """<p>Describes one or more Connect peers.</p>

    Args:
        transit_gateway_connect_peer_ids: <p>The IDs of the Connect peers.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>state</code> - The state of the Connect peer (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p> </li> <li> <p> <code>transit-gateway-attachment-id</code> - The ID of the attachment.</p> </li> <li> <p> <code>transit-gateway-connect-peer-id</code> - The ID of the Connect peer.</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_connect_peers_request.DescribeTransitGatewayConnectPeersRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_transit_gateway_connect_peers_result.DescribeTransitGatewayConnectPeersResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_transit_gateway_connect_peers

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTransitGatewayConnectPeers")
    )
    input_: capo_ec2.types.describe_transit_gateway_connect_peers_request.DescribeTransitGatewayConnectPeersRequest = {}
    if transit_gateway_connect_peer_ids is not None:
        input_["transit_gateway_connect_peer_ids"] = (
            transit_gateway_connect_peer_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