IoTSiteWise / Client / delete_pipeline

delete_pipeline

IoTSiteWise.Client.delete_pipeline(**kwargs)

Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.

See also: AWS API Documentation

Request Syntax

response = client.delete_pipeline(
    workspaceName='string',
    pipelineName='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace.

  • pipelineName (string) –

    [REQUIRED]

    The name of the pipeline to delete.

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        },
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
    }
}

Response Structure

  • (dict) –

    Response structure for DeletePipeline operation.

    • status (dict) –

      The current lifecycle status of the pipeline.

      • error (dict) –

        Contains associated error information, if any.

        • code (string) –

          The error code.

        • message (string) –

          The error message.

      • state (string) –

        The current status of the resource.

Exceptions