Skip to content

SignalInformation

Source code in docs_src/capo_iotfleetwise/types/signal_information.py
class SignalInformation(TypedDict, closed=True):
    name: "capo_iotfleetwise.types.wildcard_signal_name.wildcardSignalName"
    """<p>The name of the signal.</p>"""
    max_sample_count: NotRequired[
        "capo_iotfleetwise.types.max_sample_count.maxSampleCount"
    ]
    """<p>The maximum number of samples to collect.</p>"""
    minimum_sampling_interval_ms: NotRequired["capo_iotfleetwise.types.uint32.uint32"]
    """<p>The minimum duration of time (in milliseconds) between two triggering events to collect data.</p> <note> <p>If a signal changes often, you might want to collect data at a slower rate.</p> </note>"""
    data_partition_id: NotRequired[
        "capo_iotfleetwise.types.data_partition_id.DataPartitionId"
    ]
    """<p>The ID of the data partition this signal is associated with.</p> <p>The ID must match one of the IDs provided in <code>dataPartitions</code>. This is accomplished either by specifying a particular data partition ID or by using <code>default</code> for an established default partition. You can establish a default partition in the <code>DataPartition</code> data type.</p> <note> <p>If you upload a signal as a condition for a campaign's data partition, the same signal must be included in <code>signalsToCollect</code>.</p> </note> <important> <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p> </important>"""

data_partition_id instance-attribute

data_partition_id: NotRequired[DataPartitionId]

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.

If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

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.

max_sample_count instance-attribute

max_sample_count: NotRequired[maxSampleCount]

The maximum number of samples to collect.

minimum_sampling_interval_ms instance-attribute

minimum_sampling_interval_ms: NotRequired[uint32]

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

If a signal changes often, you might want to collect data at a slower rate.

name instance-attribute

The name of the signal.