View a markdown version of this page

EnrichmentTrimSettings - AWS IoT SiteWise

EnrichmentTrimSettings

Time range settings for extracting a specific window of video time-series data to process.

Trim settings define the time bounds for enrichment and must satisfy:

  • Start and end times must be within the dataset's time bounds

  • Trim settings retrieve fully contained data segments within the specified time range

  • endTime must be greater than startTime

  • Both times should represent valid data ranges in the dataset

Trim settings are required to:

  • Prevent accidentally analyzing unbounded datasets

  • Ensure predictable processing time and costs

  • Allow focused analysis on specific time periods of interest

Contents

endTime

End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset's time bounds.

Type: TimeInNanos object

Required: Yes

startTime

Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset's time bounds.

Example (JavaScript): Date.parse('2024-01-01T00:00:00Z') * 1000000 Example (Python): int(datetime.timestamp() * 1e9)

Type: TimeInNanos object

Required: Yes

See Also

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