Skip to content
AWS for Query.Farm

aws.iotevents.describe_input

Example SQL Queries

SELECT * FROM
aws.iotevents.describe_input
WHERE
"input_name" = 'VALUE';

Description

Describes an input.

Table Definition

Column NameColumn Data Type
input_name Required Input Column

The name of the input.

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
input

Information about the input.

STRUCT(
    "input_configuration" STRUCT(
        "input_name" VARCHAR,
        "input_description" VARCHAR,
        "input_arn" VARCHAR,
        "creation_time" TIMESTAMP_S,
        "last_update_time" TIMESTAMP_S,
        "status" VARCHAR
    ),
    "input_definition" STRUCT(
        "attributes" STRUCT(
            "json_path" VARCHAR
        )[]
    )
)
Show child fields
input.input_configuration

Information about the configuration of an input.

Show child fields
input.input_configuration.creation_time

The time the input was created.

input.input_configuration.input_arn

The ARN of the input.

input.input_configuration.input_description

A brief description of the input.

input.input_configuration.input_name

The name of the input.

input.input_configuration.last_update_time

The last time the input was updated.

input.input_configuration.status

The status of the input.

input.input_definition

The definition of the input.

Show child fields
input.input_definition.attributes[]
Show child fields
input.input_definition.attributes[].json_path

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

Syntax: <field-name>.<field-name>...