Skip to content

delete_transit_gateway_connect_peer

delete_transit_gateway_connect_peer(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_connect_peer_id: Optional[TransitGatewayConnectPeerId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteTransitGatewayConnectPeerResult

Deletes the specified Connect peer.

Parameters:

  • transit_gateway_connect_peer_id (Optional[TransitGatewayConnectPeerId], default: None ) –

    The ID of the Connect peer.

  • 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 delete_transit_gateway_connect_peer(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_connect_peer_id: Optional[
        "capo_ec2.types.transit_gateway_connect_peer_id.TransitGatewayConnectPeerId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_transit_gateway_connect_peer_result.DeleteTransitGatewayConnectPeerResult":
    """<p>Deletes the specified Connect peer.</p>

    Args:
        transit_gateway_connect_peer_id: <p>The ID of the Connect peer.</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.delete_transit_gateway_connect_peer_request.DeleteTransitGatewayConnectPeerRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_transit_gateway_connect_peer_result.DeleteTransitGatewayConnectPeerResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_transit_gateway_connect_peer

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTransitGatewayConnectPeer")
    )
    input_: capo_ec2.types.delete_transit_gateway_connect_peer_request.DeleteTransitGatewayConnectPeerRequest = {}
    if transit_gateway_connect_peer_id is not None:
        input_["transit_gateway_connect_peer_id"] = transit_gateway_connect_peer_id
    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