View a markdown version of this page

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

PipelineSummary

Contains summary information about a pipeline.

Contents

createdAt

The time the pipeline was created, in Unix epoch time.

Type: Timestamp

Required: Yes

pipelineArn

The ARN of the pipeline.

Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: Yes

pipelineName

The name of the pipeline.

Type: String

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

status

The current lifecycle status of the pipeline.

Type: ResourceStatus object

Required: Yes

updatedAt

The time the pipeline was last updated, in Unix epoch time.

Type: Timestamp

Required: Yes

version

The version of the pipeline.

Type: String

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

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

Required: Yes

description

The description of the pipeline.

Type: String

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

Pattern: [^\u0000-\u001F\u007F]+

Required: No

See Also

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