Class: Aws::IoTSiteWise::Types::EventDetection

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Overview

<p>Configuration for event detection enrichment on video time-series data.</p> <p>Event detection generates embeddings from video data enabling natural language similarity search on events. This allows customers to:</p> <ul> <li>Query video events using semantic search after enrichment completes</li> <li>Find relevant video segments through natural language queries</li> <li>Search across video time-series data stored in IoT SiteWise</li> </ul> <p>You must specify the dataset, exactly one time-series identifier (timeSeriesId OR propertyAlias), and trim settings defining the video time window to process.</p>

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_id ⇒ String

<p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>

Returns:

  • (String) 


8732
8733
8734
8735
8736
8737
8738
8739
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8732

class EventDetection < Struct.new(
  :dataset_id,
  :time_series_id,
  :property_alias,
  :trim_settings)
  SENSITIVE = []
  include Aws::Structure
end

#property_alias ⇒ String

<p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>

Returns:

  • (String) 


8732
8733
8734
8735
8736
8737
8738
8739
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8732

class EventDetection < Struct.new(
  :dataset_id,
  :time_series_id,
  :property_alias,
  :trim_settings)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_id ⇒ String

<p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>

Returns:

  • (String) 


8732
8733
8734
8735
8736
8737
8738
8739
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8732

class EventDetection < Struct.new(
  :dataset_id,
  :time_series_id,
  :property_alias,
  :trim_settings)
  SENSITIVE = []
  include Aws::Structure
end

#trim_settings ⇒ Types::EnrichmentTrimSettings

<p>Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.</p>

Returns:



8732
8733
8734
8735
8736
8737
8738
8739
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8732

class EventDetection < Struct.new(
  :dataset_id,
  :time_series_id,
  :property_alias,
  :trim_settings)
  SENSITIVE = []
  include Aws::Structure
end