View a markdown version of this page

PipelineExecutionSummary - 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).

PipelineExecutionSummary

Contains summary information about a pipeline execution.

Contents

pipelineExecutionId

The unique identifier of the pipeline execution.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

pipelineVersion

The pipeline version this execution ran against.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: ^(0|([1-9]{1}\d*))$

Required: Yes

status

The current execution status of the pipeline.

Type: PipelineExecutionStatus object

Required: Yes

endTime

The time the pipeline execution completed, in Unix epoch time.

Type: Timestamp

Required: No

executionPriority

Scheduling priority for the execution. When not specified, defaults to lowest priority.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

Required: No

startTime

The time the pipeline execution started, in Unix epoch time.

Type: Timestamp

Required: No

See Also

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