View a markdown version of this page

PipelineExecutionStatus - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PipelineExecutionStatus

Current execution status of a pipeline.

Contents

state

Current state of the pipeline execution.

Type: String

Valid Values: NOT_STARTED | RUNNING | SUCCEEDED | FAILED | CANCELLING | CANCELLED

Required: Yes

stateDetails

Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).

Type: PipelineExecutionStateDetails object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: