AgreementService / Client / cancel_agreement

cancel_agreement

AgreementService.Client.cancel_agreement(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_agreement(
    agreementId='string'
)

Parameters:

agreementId (string) –

[REQUIRED]

The unique identifier of the agreement.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• AgreementService.Client.exceptions.AccessDeniedException

• AgreementService.Client.exceptions.ValidationException

• AgreementService.Client.exceptions.ResourceNotFoundException

• AgreementService.Client.exceptions.ThrottlingException

• AgreementService.Client.exceptions.InternalServerException

• AgreementService.Client.exceptions.ConflictException