Skip to content

CancelPipelineExecutionRequest

Source code in docs_src/capo_iotsitewise/types/cancel_pipeline_execution_request.py
class CancelPipelineExecutionRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace.</p>"""
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName"
    """<p>The name of the pipeline.</p>"""
    pipeline_execution_id: "capo_iotsitewise.types.id.ID"
    """<p>The unique identifier of the pipeline execution.</p>"""
    reason: NotRequired[
        "capo_iotsitewise.types.cancel_pipeline_execution_request_reason_string.CancelPipelineExecutionRequestReasonString"
    ]
    """<p>A message describing why the pipeline execution is being cancelled.</p>"""

pipeline_execution_id instance-attribute

pipeline_execution_id: ID

The unique identifier of the pipeline execution.

pipeline_name instance-attribute

pipeline_name: ResourceName

The name of the pipeline.

reason instance-attribute

A message describing why the pipeline execution is being cancelled.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace.