Skip to content
AWS for Query.Farm

aws.iotevents_data.describe_detector

Example SQL Queries

SELECT * FROM
aws.iotevents_data.describe_detector
WHERE
"detector_model_name" = 'VALUE';

Description

Returns information about the specified detector (instance).

Table Definition

Column NameColumn Data Type
detector_model_name Required Input Column

The name of the detector model whose detectors (instances) you want information about.

VARCHAR
key_value Input Column

A filter used to limit results to detectors (instances) created because of the given key ID.

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.

detector

Information about the detector (instance).

STRUCT(
    "detector_model_name" VARCHAR,
    "key_value" VARCHAR,
    "detector_model_version" VARCHAR,
    "state" STRUCT(
        "state_name" VARCHAR,
        "variables" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR
        )[],
        "timers" STRUCT(
            "name" VARCHAR,
            "timestamp" TIMESTAMP_S
        )[]
    ),
    "creation_time" TIMESTAMP_S,
    "last_update_time" TIMESTAMP_S
)
Show child fields
detector.creation_time

The time the detector (instance) was created.

detector.detector_model_name

The name of the detector model that created this detector (instance).

detector.detector_model_version

The version of the detector model that created this detector (instance).

detector.key_value

The value of the key (identifying the device or system) that caused the creation of this detector (instance).

detector.last_update_time

The time the detector (instance) was last updated.

detector.state

The current state of the detector (instance).

Show child fields
detector.state.state_name

The name of the state.

detector.state.timers[]
Show child fields
detector.state.timers[].name

The name of the timer.

detector.state.timers[].timestamp

The expiration time for the timer.

detector.state.variables[]
Show child fields
detector.state.variables[].name

The name of the variable.

detector.state.variables[].value

The current value of the variable.