Skip to content

cancel_connection_invitation async

cancel_connection_invitation(
    catalog: Catalog,
    identifier: ConnectionInvitationId,
    client_token: ClientToken,
    *,
    config_overrides: Optional[AsyncPartnerCentralAccountClientConfig] = None,
) -> CancelConnectionInvitationResponse

Cancels a pending connection invitation before it has been accepted or rejected.

Parameters:

  • catalog (Catalog) –

    The catalog identifier where the connection invitation exists.

  • identifier (ConnectionInvitationId) –

    The unique identifier of the connection invitation to cancel.

  • client_token (ClientToken) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Raises:

  • AccessDeniedException –

    The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.

  • ConflictException –

    The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.

  • InternalServerException –

    An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.

  • ResourceNotFoundException –

    The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.

  • ThrottlingException –

    The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.

  • ValidationException –

    The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_partnercentral_account/_services/async_partner_central_account.py
async def cancel_connection_invitation(
    self,
    catalog: "capo_partnercentral_account.types.catalog.Catalog",
    identifier: "capo_partnercentral_account.types.connection_invitation_id.ConnectionInvitationId",
    client_token: "capo_partnercentral_account.types.client_token.ClientToken",
    *,
    config_overrides: Optional[AsyncPartnerCentralAccountClientConfig] = None,
) -> "capo_partnercentral_account.types.cancel_connection_invitation_response.CancelConnectionInvitationResponse":
    """<p>Cancels a pending connection invitation before it has been accepted or rejected.</p>

    Args:
        catalog: <p>The catalog identifier where the connection invitation exists.</p>
        identifier: <p>The unique identifier of the connection invitation to cancel.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>

    Raises:
        capo_partnercentral_account.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.</p>
        capo_partnercentral_account.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.</p>
        capo_partnercentral_account.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.</p>
        capo_partnercentral_account.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.</p>
        capo_partnercentral_account.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.</p>
        capo_partnercentral_account.errors.validation_exception.ValidationException: <p>The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.</p>
        capo_partnercentral_account.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_partnercentral_account.types.cancel_connection_invitation_request.CancelConnectionInvitationRequest]",
    ) -> AsyncOperationResponse[
        "capo_partnercentral_account.types.cancel_connection_invitation_response.CancelConnectionInvitationResponse"
    ]:
        import capo_partnercentral_account._operations.partner_central_account.cancel_connection_invitation

        (
            output,
            http_response,
        ) = await capo_partnercentral_account._operations.partner_central_account.cancel_connection_invitation.async_cancel_connection_invitation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_partnercentral_account.types.cancel_connection_invitation_response.CancelConnectionInvitationResponse",
    ) -> dict[str, Any]:
        import capo_partnercentral_account.types.cancel_connection_invitation_response

        return capo_partnercentral_account.types.cancel_connection_invitation_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CancelConnectionInvitation", redact_output=_redact_output
        ),
    )
    input_: capo_partnercentral_account.types.cancel_connection_invitation_request.CancelConnectionInvitationRequest = {
        "catalog": catalog,
        "identifier": identifier,
        "client_token": client_token,
    }

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