View a markdown version of this page

TimeseriesItem - AWS IoT SiteWise

TimeseriesItem

A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.

Contents

formatSettings

The optional format settings for the output.

Type: FormatSettings object

Required: No

propertyAlias

The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.

Type: String

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

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

Required: No

timeSeriesId

The unique identifier for the timeseries. Mutually exclusive with propertyAlias.

Type: String

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

Required: No

trimSettings

The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.

Type: TrimSettings object

Required: No

See Also

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