SignalInformation - AWS IoT FleetWise

SignalInformation

Information about a signal.

Contents

name

The name of the signal.

Type: String

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

Pattern: [\w|*|-]+(\.[\w|*|-]+)*

Required: Yes

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.

Note

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

Important

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide.

Type: String

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

Pattern: [a-zA-Z0-9]+

Required: No

maxSampleCount

The maximum number of samples to collect.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 4294967295.

Required: No

minimumSamplingIntervalMs

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

Note

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

Type: Long

Valid Range: Minimum value of 0. Maximum value of 4294967295.

Required: No

See Also

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