Class: Aws::IoTEvents::Types::AnalysisResult

Inherits:

Struct

• Object
• Struct
• Aws::IoTEvents::Types::AnalysisResult

Includes:

Structure

Defined in:

lib/aws-sdk-iotevents/types.rb

Overview

Contains the result of the analysis.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #level ⇒ String

  The severity level of the analysis result.

• #locations ⇒ Array<Types::AnalysisResultLocation>

  Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

• #message ⇒ String

  Contains additional information about the analysis result.

• #type ⇒ String

  The type of the analysis result.

Instance Attribute Details

#level ⇒ String

The severity level of the analysis result. Analysis results fall into three general categories based on the severity level:

• ‘INFO` - An information result informs you about a significant field in your detector model. This type of result usually doesn’t require immediate action.

• ‘WARNING` - A warning result draws special attention to fields that are potentially damaging to your detector model. We recommend that you review warnings and take necessary actions before you use your detetor model in production environments. Otherwise, the detector model may not fully function as expected.

• ‘ERROR` - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.

Returns:

• (String)

# File 'lib/aws-sdk-iotevents/types.rb', line 284

class AnalysisResult < Struct.new(
  :type,
  :level,
  :message,
  :locations)
  SENSITIVE = []
  include Aws::Structure
end

#locations ⇒ Array<Types::AnalysisResultLocation>

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

Returns:

• (Array<Types::AnalysisResultLocation>)

# File 'lib/aws-sdk-iotevents/types.rb', line 284

class AnalysisResult < Struct.new(
  :type,
  :level,
  :message,
  :locations)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Contains additional information about the analysis result.

Returns:

• (String)

# File 'lib/aws-sdk-iotevents/types.rb', line 284

class AnalysisResult < Struct.new(
  :type,
  :level,
  :message,
  :locations)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:

• ‘supported-actions` - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.

• ‘service-limits` - Resources or operations can’t exceed service limits. Update your detector model or request a limit adjust.

• ‘structure` - The detector model must follow a structure that AWS IoT Events supports.

• ‘expression-syntax` - Your expression must follow the required syntax.

• ‘data-type` - Data types referenced in the detector model must be compatible.

• ‘referenced-data` - You must define the data referenced in your detector model before you can use the data.

• ‘referenced-resource` - Resources that the detector model uses must be available.

For more information, see [Running detector model analyses] in the *AWS IoT Events Developer Guide*.

[1]: docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html

Returns:

• (String)

# File 'lib/aws-sdk-iotevents/types.rb', line 284

class AnalysisResult < Struct.new(
  :type,
  :level,
  :message,
  :locations)
  SENSITIVE = []
  include Aws::Structure
end