cancel_pipeline_execution async ¶

async def cancel_pipeline_execution(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName",
    pipeline_execution_id: "capo_iotsitewise.types.id.ID",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    reason: Optional[
        "capo_iotsitewise.types.cancel_pipeline_execution_request_reason_string.CancelPipelineExecutionRequestReasonString"
    ] = None,
) -> "capo_iotsitewise.types.cancel_pipeline_execution_response.CancelPipelineExecutionResponse":
    """<p>Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>
        pipeline_name: <p>The name of the pipeline.</p>
        pipeline_execution_id: <p>The unique identifier of the pipeline execution.</p>
        reason: <p>A message describing why the pipeline execution is being cancelled.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.cancel_pipeline_execution_request.CancelPipelineExecutionRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.cancel_pipeline_execution_response.CancelPipelineExecutionResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.cancel_pipeline_execution

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.cancel_pipeline_execution.async_cancel_pipeline_execution(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelPipelineExecution")
    )
    input_: capo_iotsitewise.types.cancel_pipeline_execution_request.CancelPipelineExecutionRequest = {
        "workspace_name": workspace_name,
        "pipeline_name": pipeline_name,
        "pipeline_execution_id": pipeline_execution_id,
    }
    if reason is not None:
        input_["reason"] = reason

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output