Skip to content

cancel_channel_handshake async

cancel_channel_handshake(
    catalog: Catalog,
    identifier: ChannelHandshakeIdentifier,
    *,
    config_overrides: Optional[AsyncPartnerCentralChannelClientConfig] = None,
) -> CancelChannelHandshakeResponse

Cancels a pending channel handshake request.

Parameters:

  • catalog (Catalog) –

    The catalog identifier for the handshake request.

  • identifier (ChannelHandshakeIdentifier) –

    The unique identifier of the channel handshake to cancel.

Raises:

Examples:

Example for CancelChannelHandshake

>>> await client.cancel_channel_handshake(catalog='AWS', identifier='ch-4fj3bd2o3vb91')
Source code in docs_src/capo_partnercentral_channel/_services/async_partner_central_channel.py
async def cancel_channel_handshake(
    self,
    catalog: "capo_partnercentral_channel.types.catalog.Catalog",
    identifier: "capo_partnercentral_channel.types.channel_handshake_identifier.ChannelHandshakeIdentifier",
    *,
    config_overrides: Optional[AsyncPartnerCentralChannelClientConfig] = None,
) -> "capo_partnercentral_channel.types.cancel_channel_handshake_response.CancelChannelHandshakeResponse":
    """<p>Cancels a pending channel handshake request.</p>

    Args:
        catalog: <p>The catalog identifier for the handshake request.</p>
        identifier: <p>The unique identifier of the channel handshake to cancel.</p>

    Raises:
        capo_partnercentral_channel.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions.</p>
        capo_partnercentral_channel.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request.</p>
        capo_partnercentral_channel.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_partnercentral_channel.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period.</p>
        capo_partnercentral_channel.errors.validation_exception.ValidationException: <p>The request failed validation due to invalid input parameters.</p>
        capo_partnercentral_channel.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Example for CancelChannelHandshake

        >>> await client.cancel_channel_handshake(catalog='AWS', identifier='ch-4fj3bd2o3vb91')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_partnercentral_channel.types.cancel_channel_handshake_request.CancelChannelHandshakeRequest]",
    ) -> AsyncOperationResponse[
        "capo_partnercentral_channel.types.cancel_channel_handshake_response.CancelChannelHandshakeResponse"
    ]:
        import capo_partnercentral_channel._operations.partner_central_channel.cancel_channel_handshake

        (
            output,
            http_response,
        ) = await capo_partnercentral_channel._operations.partner_central_channel.cancel_channel_handshake.async_cancel_channel_handshake(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelChannelHandshake")
    )
    input_: capo_partnercentral_channel.types.cancel_channel_handshake_request.CancelChannelHandshakeRequest = {
        "catalog": catalog,
        "identifier": identifier,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output