Skip to content
AWS for Query.Farm

aws.iot.get_topic_rule_destination

Example SQL Queries

SELECT * FROM
aws.iot.get_topic_rule_destination
WHERE
"arn" = 'VALUE';

Description

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

Table Definition

Column NameColumn Data Type
arn Required Input Column

The ARN of the topic rule destination.

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
topic_rule_destination

The topic rule destination.

STRUCT(
    "arn" VARCHAR,
    "status" VARCHAR,
    "created_at" TIMESTAMP_S,
    "last_updated_at" TIMESTAMP_S,
    "status_reason" VARCHAR,
    "http_url_properties" STRUCT(
        "confirmation_url" VARCHAR
    ),
    "vpc_properties" STRUCT(
        "subnet_ids" VARCHAR[],
        "security_groups" VARCHAR[],
        "vpc_id" VARCHAR,
        "role_arn" VARCHAR
    )
)
Show child fields
topic_rule_destination.arn

The topic rule destination URL.

topic_rule_destination.created_at

The date and time when the topic rule destination was created.

topic_rule_destination.http_url_properties

Properties of the HTTP URL.

Show child fields
topic_rule_destination.http_url_properties.confirmation_url

The URL used to confirm the HTTP topic rule destination URL.

topic_rule_destination.last_updated_at

The date and time when the topic rule destination was last updated.

topic_rule_destination.status

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

topic_rule_destination.status_reason

Additional details or reason why the topic rule destination is in the current status.

topic_rule_destination.vpc_properties

Properties of the virtual private cloud (VPC) connection.

Show child fields
topic_rule_destination.vpc_properties.role_arn

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

topic_rule_destination.vpc_properties.security_groups[]
topic_rule_destination.vpc_properties.subnet_ids[]
topic_rule_destination.vpc_properties.vpc_id

The ID of the VPC.