Skip to content

cancel_agreement

cancel_agreement(
    agreement_id: ResourceId,
    *,
    config_overrides: Optional[MarketplaceAgreementClientConfig] = None,
) -> CancelAgreementOutput

Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.

Parameters:

  • agreement_id (ResourceId) –

    The unique identifier of the agreement.

Raises:

Source code in docs_src/capo_marketplace_agreement/_services/marketplace_agreement.py
def cancel_agreement(
    self,
    agreement_id: "capo_marketplace_agreement.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[MarketplaceAgreementClientConfig] = None,
) -> (
    "capo_marketplace_agreement.types.cancel_agreement_output.CancelAgreementOutput"
):
    """<p>Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.</p>

    Args:
        agreement_id: <p>The unique identifier of the agreement.</p>

    Raises:
        capo_marketplace_agreement.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_marketplace_agreement.errors.conflict_exception.ConflictException: <p>Request was denied due to a resource conflict.</p>
        capo_marketplace_agreement.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_marketplace_agreement.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_marketplace_agreement.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_marketplace_agreement.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_marketplace_agreement.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_marketplace_agreement.types.cancel_agreement_input.CancelAgreementInput]",
    ) -> OperationResponse[
        "capo_marketplace_agreement.types.cancel_agreement_output.CancelAgreementOutput"
    ]:
        import capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.cancel_agreement

        output, http_response = (
            capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.cancel_agreement.cancel_agreement(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelAgreement")
    )
    input_: capo_marketplace_agreement.types.cancel_agreement_input.CancelAgreementInput = {
        "agreement_id": agreement_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output