Skip to content
AWS for Query.Farm

aws.iotanalytics.list_channels

Example SQL Queries

SELECT * FROM
aws.iotanalytics.list_channels;

Description

Retrieves a list of channels.

Table Definition

Column NameColumn Data Type
_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
channel_name

The name of the channel.

VARCHAR
channel_storage

Where channel data is stored.

STRUCT(
    "service_managed_s3" BOOLEAN,
    "customer_managed_s3" STRUCT(
        "bucket" VARCHAR,
        "key_prefix" VARCHAR,
        "role_arn" VARCHAR
    )
)
Show child fields
channel_storage.customer_managed_s3

Used to store channel data in an S3 bucket that you manage.

Show child fields
channel_storage.customer_managed_s3.bucket

The name of the S3 bucket in which channel data is stored.

channel_storage.customer_managed_s3.key_prefix

(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

channel_storage.customer_managed_s3.role_arn

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

channel_storage.service_managed_s3

Used to store channel data in an S3 bucket managed by IoT Analytics.

creation_time

When the channel was created.

TIMESTAMP_S
last_message_arrival_time

The last time when a new message arrived in the channel.

IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020. 

TIMESTAMP_S
last_update_time

The last time the channel was updated.

TIMESTAMP_S
status

The status of the channel.

VARCHAR