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:
Raises:
Examples:
Cancel a cancellation request
>>> 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/marketplace_agreement.py
| def cancel_agreement_cancellation_request(
self,
agreement_id: "capo_marketplace_agreement.types.agreement_id.AgreementId",
agreement_cancellation_request_id: "capo_marketplace_agreement.types.agreement_cancellation_request_id.AgreementCancellationRequestId",
cancellation_reason: "capo_marketplace_agreement.types.agreement_cancellation_request_cancellation_reason.AgreementCancellationRequestCancellationReason",
*,
config_overrides: Optional[MarketplaceAgreementClientConfig] = None,
) -> "capo_marketplace_agreement.types.cancel_agreement_cancellation_request_output.CancelAgreementCancellationRequestOutput":
"""<p>Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to <code>CANCELLED</code> status and can no longer be approved or rejected by the buyer.</p> <note> <p>Only cancellation requests in <code>PENDING_APPROVAL</code> status can be cancelled. A <code>ConflictException</code> is thrown if the cancellation request is in any other status.</p> </note>
Args:
agreement_id: <p>The unique identifier of the agreement associated with the cancellation request.</p>
agreement_cancellation_request_id: <p>The unique identifier of the cancellation request to cancel.</p>
cancellation_reason: <p>A required message explaining why the cancellation request is being withdrawn (1-2000 characters).</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.
Examples:
Cancel a cancellation request
>>> client.cancel_agreement_cancellation_request(agreement_cancellation_request_id='acr-752jqvg74yo7k4h56cakk6396', agreement_id='agmt-752jqvg74yo7k4h56cakk6396', cancellation_reason='Requested agreement cancellation by mistake')
"""
def _handler(
req: "OperationRequest[capo_marketplace_agreement.types.cancel_agreement_cancellation_request_input.CancelAgreementCancellationRequestInput]",
) -> OperationResponse[
"capo_marketplace_agreement.types.cancel_agreement_cancellation_request_output.CancelAgreementCancellationRequestOutput"
]:
import capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.cancel_agreement_cancellation_request
output, http_response = (
capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.cancel_agreement_cancellation_request.cancel_agreement_cancellation_request(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
def _redact_input(
input_: "capo_marketplace_agreement.types.cancel_agreement_cancellation_request_input.CancelAgreementCancellationRequestInput",
) -> dict[str, Any]:
import capo_marketplace_agreement.types.cancel_agreement_cancellation_request_input
return capo_marketplace_agreement.types.cancel_agreement_cancellation_request_input.redact_sensitive(
input_
)
def _redact_output(
output: "capo_marketplace_agreement.types.cancel_agreement_cancellation_request_output.CancelAgreementCancellationRequestOutput",
) -> dict[str, Any]:
import capo_marketplace_agreement.types.cancel_agreement_cancellation_request_output
return capo_marketplace_agreement.types.cancel_agreement_cancellation_request_output.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging(
"CancelAgreementCancellationRequest",
redact_input=_redact_input,
redact_output=_redact_output,
),
)
input_: capo_marketplace_agreement.types.cancel_agreement_cancellation_request_input.CancelAgreementCancellationRequestInput = {
"agreement_id": agreement_id,
"agreement_cancellation_request_id": agreement_cancellation_request_id,
"cancellation_reason": cancellation_reason,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|