cancel_agreement_cancellation_request
async
¶
cancel_agreement_cancellation_request(
agreement_id: AgreementId,
agreement_cancellation_request_id: AgreementCancellationRequestId,
cancellation_reason: AgreementCancellationRequestCancellationReason,
*,
config_overrides: Optional[AsyncMarketplaceAgreementClientConfig] = None,
) -> CancelAgreementCancellationRequestOutput
Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to CANCELLED status and can no longer be approved or rejected by the buyer.
Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the cancellation request is in any other status.
Parameters:
-
agreement_id(AgreementId) –The unique identifier of the agreement associated with the cancellation request.
-
agreement_cancellation_request_id(AgreementCancellationRequestId) –The unique identifier of the cancellation request to cancel.
-
cancellation_reason(AgreementCancellationRequestCancellationReason) –A required message explaining why the cancellation request is being withdrawn (1-2000 characters).
Raises:
-
AccessDeniedException–User does not have sufficient access to perform this action.
-
ConflictException–Request was denied due to a resource conflict.
-
InternalServerException–Unexpected error during processing of request.
-
ResourceNotFoundException–Request references a resource which does not exist.
-
ThrottlingException–Request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by the service.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
Cancel a cancellation request
>>> await client.cancel_agreement_cancellation_request(agreement_cancellation_request_id='acr-752jqvg74yo7k4h56cakk6396', agreement_id='agmt-752jqvg74yo7k4h56cakk6396', cancellation_reason='Requested agreement cancellation by mistake')
Source code in docs_src/capo_marketplace_agreement/_services/async_marketplace_agreement.py
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 | |