Skip to content

cancel_resource_request

cancel_resource_request(
    request_token: RequestToken,
    *,
    config_overrides: Optional[CloudControlClientConfig] = None,
) -> CancelResourceRequestOutput

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can be canceled.

Parameters:

  • request_token (RequestToken) –

    The RequestToken of the ProgressEvent object returned by the resource operation request.

Raises:

Source code in docs_src/capo_cloudcontrol/_services/cloud_control.py
def cancel_resource_request(
    self,
    request_token: "capo_cloudcontrol.types.request_token.RequestToken",
    *,
    config_overrides: Optional[CloudControlClientConfig] = None,
) -> "capo_cloudcontrol.types.cancel_resource_request_output.CancelResourceRequestOutput":
    """<p>Cancels the specified resource operation request. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel">Canceling resource operation requests</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>Only resource operations requests with a status of <code>PENDING</code> or <code>IN_PROGRESS</code> can be canceled.</p>

    Args:
        request_token: <p>The <code>RequestToken</code> of the <code>ProgressEvent</code> object returned by the resource operation request.</p>

    Raises:
        capo_cloudcontrol.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The resource is currently being modified by another operation.</p>
        capo_cloudcontrol.errors.request_token_not_found_exception.RequestTokenNotFoundException: <p>A resource operation with the specified request token can't be found.</p>
        capo_cloudcontrol.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudcontrol.types.cancel_resource_request_input.CancelResourceRequestInput]",
    ) -> OperationResponse[
        "capo_cloudcontrol.types.cancel_resource_request_output.CancelResourceRequestOutput"
    ]:
        import capo_cloudcontrol._operations.cloud_api_service.cancel_resource_request

        output, http_response = (
            capo_cloudcontrol._operations.cloud_api_service.cancel_resource_request.cancel_resource_request(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_cloudcontrol.types.cancel_resource_request_output.CancelResourceRequestOutput",
    ) -> dict[str, Any]:
        import capo_cloudcontrol.types.cancel_resource_request_output

        return (
            capo_cloudcontrol.types.cancel_resource_request_output.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CancelResourceRequest", redact_output=_redact_output),
    )
    input_: capo_cloudcontrol.types.cancel_resource_request_input.CancelResourceRequestInput = {
        "request_token": request_token
    }

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