Class: Aws::IoTFleetWise::Types::SignalInformation

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::SignalInformation

Includes:

Structure

Defined in:

lib/aws-sdk-iotfleetwise/types.rb

Overview

Information about a signal.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_partition_id ⇒ String

  The ID of the data partition this signal is associated with.

• #max_sample_count ⇒ Integer

  The maximum number of samples to collect.

• #minimum_sampling_interval_ms ⇒ Integer

  The minimum duration of time (in milliseconds) between two triggering events to collect data.

• #name ⇒ String

  The name of the signal.

Instance Attribute Details

#data_partition_id ⇒ String

The ID of the data partition this signal is associated with.

The ID must match one of the IDs provided in ‘dataPartitions`. This is accomplished either by specifying a particular data partition ID or by using `default` for an established default partition. You can establish a default partition in the `DataPartition` data type.

<note markdown=“1”> If you upload a signal as a condition for a campaign’s data partition, the same signal must be included in ‘signalsToCollect`.

</note>

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see [Amazon Web Services Region and feature availability] in the *Amazon Web Services IoT FleetWise Developer Guide*.

[1]: docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4205

class SignalInformation < Struct.new(
  :name,
  :max_sample_count,
  :minimum_sampling_interval_ms,
  :data_partition_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_sample_count ⇒ Integer

The maximum number of samples to collect.

Returns:

• (Integer)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4205

class SignalInformation < Struct.new(
  :name,
  :max_sample_count,
  :minimum_sampling_interval_ms,
  :data_partition_id)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_sampling_interval_ms ⇒ Integer

The minimum duration of time (in milliseconds) between two triggering events to collect data.

<note markdown=“1”> If a signal changes often, you might want to collect data at a slower rate.

</note>

Returns:

• (Integer)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4205

class SignalInformation < Struct.new(
  :name,
  :max_sample_count,
  :minimum_sampling_interval_ms,
  :data_partition_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the signal.

Returns:

• (String)

# File 'lib/aws-sdk-iotfleetwise/types.rb', line 4205

class SignalInformation < Struct.new(
  :name,
  :max_sample_count,
  :minimum_sampling_interval_ms,
  :data_partition_id)
  SENSITIVE = []
  include Aws::Structure
end