Skip to content
AWS for Query.Farm

aws.iotevents.get_detector_model_analysis_results

Example SQL Queries

SELECT * FROM
aws.iotevents.get_detector_model_analysis_results
WHERE
"analysis_id" = 'VALUE';

Description

Retrieves one or more analysis results of the detector model.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Table Definition

Column NameColumn Data Type
analysis_id Required Input Column

The ID of the analysis result that you want to retrieve.

VARCHAR
max_results Input Column

The maximum number of results to be returned per request.

BIGINT
next_token Input Column

The token that you can use to return the next set of results, or null if there are no more results.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
analysis_results

Contains information about one or more analysis results.

STRUCT(
    "type" VARCHAR,
    "level" VARCHAR,
    "message" VARCHAR,
    "locations" STRUCT(
        "path" VARCHAR
    )[]
)[]
Show child fields
analysis_results[]
Show child fields
analysis_results[].level

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

  • INFO - An information result tells 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 might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work 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.

analysis_results[].locations[]
Show child fields
analysis_results[].locations[].path

A JsonPath expression that identifies the error field in your detector model.

analysis_results[].message

Contains additional information about the analysis result.

analysis_results[].type

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 API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.

  • 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.