IoTSiteWise / Client / cancel_pipeline_execution

cancel_pipeline_execution

IoTSiteWise.Client.cancel_pipeline_execution(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_pipeline_execution(
    workspaceName='string',
    pipelineName='string',
    pipelineExecutionId='string',
    reason='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace.

  • pipelineName (string) –

    [REQUIRED]

    The name of the pipeline.

  • pipelineExecutionId (string) –

    [REQUIRED]

    The unique identifier of the pipeline execution.

  • reason (string) – A message describing why the pipeline execution is being cancelled.

Return type:

dict

Returns:

Response Syntax

{
    'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'
}

Response Structure

  • (dict) –

    Response structure for CancelPipelineExecution operation.

    • state (string) –

      The current execution state of the pipeline. Can only be CANCELLING or CANCELLED.

Exceptions