AWS IoT Service Tables
The AWS IoT Service integration uses the following tables
Tables
AWSIoTAlertTargets
| Name | Type | Description |
|---|---|---|
| ARN | string | The Amazon Resource Name (ARN) of the notification target to which alerts are sent. |
| BatchDate | datetime | The date when the data was collected or processed. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| RoleARN | string | The ARN of the role that grants permission to send alerts to the notification target. |
AWSIoTAuditChecks
| Name | Type | Description |
|---|---|---|
| Compliant | bit | Indicates whether the audit check is compliant (true) or non-compliant (false). |
| RunStatus | string | The status of the audit check execution. Possible values include IN_PROGRESS, WAITING_FOR_DATA_COLLECTION, CANCELED, COMPLETED_COMPLIANT, COMPLETED_NON_COMPLIANT, FAILED, and STOPPED. |
| ErrorCode | string | The error code returned if the audit check execution fails. |
| Message | string | A message providing additional information about the audit check execution or failure. |
| AuditName | string | The name assigned to the specific audit. |
| NonCompliantResourcesCount | bigint | The number of resources that were found non-compliant during the audit check. |
| SuppressedNonCompliantResourcesCount | bigint | The number of non-compliant resources for which findings have been suppressed. |
| TotalResourcesCount | bigint | The total number of resources that were evaluated during the audit check. |
| BatchDate | datetime | The date when the data was collected or processed. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| ID | integer | A unique identifier for the audit check instance. |
AWSIoTAuditFindings
| Name | Type | Description |
|---|---|---|
| AWSIoTAuditCheckConfigID | integer | An identifier linking the audit finding to a specific AWS IoT audit check configuration. |
| AWSIoTNonCompliantResourceConfigID | integer | An identifier linking the audit finding to a specific non-compliant resource configuration in AWS IoT. |
| Time | datetime | The time the result (finding) was discovered. |
| IsSuppressed | bit | Indicates whether the audit finding was suppressed during reporting. |
| ReasonForNonCompliance | string | The reason the resource was noncompliant. |
| ReasonForNonComplianceCode | string | A code that indicates the reason that the resource was noncompliant. |
| Severity | string | The severity of the result (finding). Valid values are CRITICAL, HIGH, MEDIUM, and LOW. |
| AuditStartTime | datetime | The time the audit started. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| BatchDate | datetime | The date when the data was collected or processed. |
| AuditID | string | The ID of the audit that generated this result (finding). |
| AWSIoTAuditCheckID | integer | A unique identifier for the specific AWS IoT audit check. |
| AWSIoTNonCompliantResourceID | integer | A unique identifier for the non-compliant resource associated with the audit finding. |
| ID | string | A unique identifier for the audit finding instance. |
AWSIoTBehaviors
| Name | Type | Description |
|---|---|---|
| AWSIoTMetricConfigID | integer | An identifier linking the behavior to a specific AWS IoT metric configuration. |
| AWSIoTSecurityProfileConfigID | integer | An identifier linking the behavior to a specific AWS IoT Security Profile configuration. |
| AWSIoTSecurityProfileARN | string | The Amazon Resource Name (ARN) of the AWS IoT Security Profile associated with the behavior. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Name | string | The name of the behavior. |
| CriteriaMetricValueNumbersJson | string | JSON representation of the numeric metric values used in the behavior's criteria. |
| CriteriaMetricValuePortsJson | string | JSON representation of the port metric values used in the behavior's criteria. |
| CriteriaMetricValueStringsJson | string | JSON representation of the string metric values used in the behavior's criteria. |
| CriteriaMetricValueCount | bigint | The count of metric values used in the behavior's criteria. |
| CriteriaMetricValueNumber | float | A specific numeric metric value used in the behavior's criteria. |
| SuppressAlerts | bit | Indicates whether alerts for this behavior are suppressed. |
| Export | bit | Indicates whether the behavior's metrics are exported. |
| CriteriaComparisonOperator | string | The operator used to compare the metric value to the threshold. Possible values include less-than, less-than-equals, greater-than, and greater-than-equals. |
| CriteriaDatapointsToAlarm | integer | The number of consecutive datapoints that must be outside the threshold for the alarm to be triggered. |
| CriteriaDatapointsToClear | integer | The number of consecutive datapoints that must be within the threshold for the alarm to be cleared. |
| CriteriaDurationSeconds | integer | The duration (in seconds) over which the behavior is evaluated. |
| CriteriaStatisticalThresholdStatistic | string | The percentile that resolves to a threshold value by which compliance with a behavior is determined. Possible values include p50, p90, p99 |
| BatchDate | datetime | The date when the data was collected or processed. |
| CriteriaMachineLearningDetectionConfigConfidenceLevel | string | The confidence level of the machine learning model used to detect anomalies. Possible values include high, medium, and low. |
| AWSIoTMetricID | integer | A unique identifier for the AWS IoT metric associated with the behavior. |
| CriteriaMetricValueCidrsJson | string | JSON representation of the CIDR metric values used in the behavior's criteria. |
| ID | integer | A unique identifier for the behavior instance. |
AWSIoTMetrics
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Metric | string | The name of the metric. For example, in the context of AWS IoT Device Defender, this could refer to predefined metrics like MessagesSent or custom metrics defined for monitoring specific behaviors. |
| Export | bit | Indicates whether the metric is configured to be exported. |
| DimensionName | string | The name of the dimension associated with the metric. Dimensions are attributes that can be used to filter metrics. For example, a dimension could be ThingType to filter metrics by the type of device. |
| Operator | string | Defines how the dimensionValues of a dimension are interpreted. Valid values are IN and NOT_IN. For example, with the IN operator, a metric is included only if it matches one of the specified dimension values. |
| BatchDate | datetime | The date when the data was collected or processed. |
| ID | integer | A unique identifier for the metric instance. |
AWSIoTResources
| Name | Type | Description |
|---|---|---|
| AWSIoTAuditFindingConfigID | integer | An identifier linking the resource to a specific AWS IoT audit finding configuration. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Account | string | The account with which the resource is associated. |
| Type | string | The type or category of the resource. |
| IssuerCertificateSerialNumber | string | The serial number of the issuer certificate. |
| IssuerCertificateSubject | string | The subject of the issuer certificate. |
| PolicyVersionName | string | The name of the policy associated with the resource. |
| BatchDate | datetime | The date when the data was collected or processed. |
| DeviceCertificateARN | string | The ARN of the identified device certificate. |
| IAMRoleARN | string | The ARN of the IAM role that has overly permissive actions. |
| AWSIoTAuditFindingID | string | A unique identifier for the AWS IoT audit finding associated with the resource. |
| CACertificateID | string | The ID of the CA certificate used to authorize the certificate. |
| ClientID | string | The client ID. |
| CognitoIdentityPoolID | string | The ID of the Amazon Cognito identity pool. |
| DeviceCertificateID | string | The ID of the certificate attached to the resource. |
| ID | integer | A unique identifier for the resource instance. |
| IssuerCertificateIssuerID | string | The issuer ID of the issuer certificate. |
| PolicyVersionID | string | The ID of the version of the policy associated with the resource. |
| RoleAliasARN | string | The ARN of the role alias that has overly permissive actions. |
AWSIoTSecurityProfiles
| Name | Type | Description |
|---|---|---|
| ARN | string | The Amazon Resource Name (ARN) of the security profile. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Name | string | The name you've given to the security profile. |
| CreationDate | datetime | The date and time when the security profile was created. |
| LastModifiedDate | datetime | The date and time when the security profile was last modified. |
| BatchDate | datetime | The date when the data was collected or processed. |
AWSIoTThingAttributes
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Name | string | The name of the attribute. In AWS IoT, attributes are key-value pairs associated with a thing. The attribute name can be up to 128 characters long and can include letters, numbers, and the following special characters:_ . , @ / : # -. |
| Value | string | The value of the attribute. The attribute value can be up to 800 characters long and can include letters, numbers, and the following special characters: _ . , @ / : # = [ ] -. |
| BatchDate | datetime | The date when the data was collected or processed. |
AWSIoTThings
| Name | Type | Description |
|---|---|---|
| ARN | string | The Amazon Resource Name (ARN) of the thing. |
| AWSIoTThingTypeConfigID | integer | An identifier linking the thing to a specific AWS IoT Thing Type configuration. |
| AWSIoTThingTypeARN | string | The ARN of the thing type associated with the thing. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Name | string | The name of the thing. |
| Version | bigint | The version of the thing record in the registry. |
| BatchDate | datetime | The date when the data was collected or processed. |
AWSIoTThingTypes
| Name | Type | Description |
|---|---|---|
| ARN | string | The Amazon Resource Name (ARN) of the thing type. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| Name | string | The name of the thing type. |
| Description | string | The description of the thing type. |
| CreationDate | datetime | The date and time when the thing type was created. |
| DeprecationDate | datetime | The date and time when the thing type was deprecated. |
| Deprecated | bit | Indicates whether the thing type is deprecated. |
| BatchDate | datetime | The date when the data was collected or processed. |
AWSIoTViolationEvents
| Name | Type | Description |
|---|---|---|
| AWSIoTBehaviorConfigID | integer | An identifier linking the violation event to a specific AWS IoT behavior configuration. |
| AWSIoTSecurityProfileConfigID | integer | An identifier linking the violation event to a specific AWS IoT security profile configuration. |
| AWSIoTThingConfigID | integer | An identifier linking the violation event to a specific AWS IoT thing configuration. |
| AWSIoTSecurityProfileARN | string | The Amazon Resource Name (ARN) of the security profile. |
| AWSIoTThingARN | string | The ARN of the thing resource. |
| ConfigID | integer | An identifier for the specific configuration or data snapshot. |
| MetricValueNumbersJson | string | JSON representation of metric values that are numbers. |
| MetricValuePortsJson | string | JSON representation of metric values that are port numbers. |
| MetricValueStringsJson | string | JSON representation of metric values that are strings. |
| MetricValueCount | bigint | Count of metric values. |
| MetricValueNumber | float | A single numeric metric value. |
| VerificationState | string | The verification state of the violation (detect alarm). Valid values are FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, and UNKNOWN. |
| VerificationStateDescription | string | The description of the verification state of the violation. |
| ViolationEventTime | datetime | The time the violation event occurred. |
| ViolationEventType | string | The type of violation event. Valid values are in-alarm, alarm-cleared, and alarm-invalidated. |
| BatchDate | datetime | The date when the data was collected or processed. |
| AWSIoTBehaviorID | integer | An identifier linking the violation event to a specific AWS IoT behavior. |
| ConfidenceLevel | string | The confidence level of the violation detection. |
| ID | string | A unique identifier for the violation event instance. |
| MetricValueCidrsJson | string | JSON representation of metric values that are CIDR blocks. |
Bridge Tables
AWSIoTAlertTargets_AWSIoTSecurityProfiles
| Name | Type | Description |
|---|---|---|
| AWSIoTAlertTargetConfigID | integer | An identifier for the specific configuration or data snapshot for the alert target. |
| AWSIoTSecurityProfileConfigID | integer | An identifier for the specific configuration or data snapshot for the security profile. |
| AWSIoTAlertTargetARN | string | The Amazon Resource Name (ARN) of the notification target to which alerts are sent. |
| AWSIoTSecurityProfileARN | string | The Amazon Resource Name (ARN) of the security profile. |
AWSIoTAuditFindings_AWSIoTRelatedResources
| Name | Type | Description |
|---|---|---|
| AWSIoTAuditFindingConfigID | integer | An identifier for the specific configuration or data snapshot. |
| AWSIoTRelatedResourceConfigID | integer | An identifier for the specific configuration or data snapshot. |
| AWSIoTAuditFindingID | string | A unique identifier for the audit finding instance. |
| AWSIoTRelatedResourceID | integer | A unique identifier for the resource instance. |
AWSIoTMetrics_AWSIoTSecurityProfiles
| Name | Type | Description |
|---|---|---|
| AWSIoTMetricConfigID | integer | An identifier for the specific configuration or data snapshot. |
| AWSIoTSecurityProfileConfigID | integer | An identifier for the specific configuration or data snapshot for the security profile. |
| AWSIoTSecurityProfileARN | string | The Amazon Resource Name (ARN) of the security profile. |
| AWSIoTMetricID | integer | A unique identifier for the metric instance. |
AWSIoTThings_AWSIoTThingAttributes
| Name | Type | Description |
|---|---|---|
| AWSIoTThingAttributeConfigID | integer | An identifier for the specific configuration or data snapshot. |
| AWSIoTThingConfigID | integer | An identifier for the specific configuration or data snapshot. |
| AWSIoTThingARN | string | The Amazon Resource Name (ARN) of the thing. |
| AWSIoTThingAttributeName | string | The name of the attribute. In AWS IoT, attributes are key-value pairs associated with a thing. The attribute name can be up to 128 characters long and can include letters, numbers, and the following special characters: _ . , @ / : # -. |
| AWSIoTThingAttributeValue | string | The value of the attribute. The attribute value can be up to 800 characters long and can include letters, numbers, and the following special characters: _ . , @ / : # = [ ] -. |
Updated over 1 year ago
Learn more...
Did this page help you?