View a markdown version of this page

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

DataSegmentSummary

Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status.

Contents

alias

The alias of the time series.

Type: String

Length Constraints: Minimum length of 1.

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

Required: Yes

dataType

The data type of the time series.

Type: String

Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT | VIDEO | ANNOTATION | JSON

Required: Yes

endTimestamp

The nanosecond-precision end time of the data segment.

Type: TimeInNanos object

Required: Yes

sourceDatasetId

The ID of the source dataset that contains the data segment.

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

startTimestamp

The nanosecond-precision start time of the data segment.

Type: TimeInNanos object

Required: Yes

timeSeriesId

The ID of the time series.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 73.

Required: Yes

enrichment

The enrichment information for the data segment.

Type: DataSegmentEnrichment object

Required: No

See Also

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