Skip to content
AWS for Query.Farm

aws.iotanalytics.describe_channel

Example SQL Queries

SELECT * FROM
aws.iotanalytics.describe_channel
WHERE
"channel_name" = 'VALUE';

Description

Retrieves information about a channel.

Table Definition

Column NameColumn Data Type
channel_name Required Input Column

The name of the channel whose information is retrieved.

VARCHAR
include_statistics Input Column

If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.

BOOLEAN
_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

An object that contains information about the channel.

STRUCT(
    "name" VARCHAR,
    "storage" STRUCT(
        "service_managed_s3" BOOLEAN,
        "customer_managed_s3" STRUCT(
            "bucket" VARCHAR,
            "key_prefix" VARCHAR,
            "role_arn" VARCHAR
        )
    ),
    "arn" VARCHAR,
    "status" VARCHAR,
    "retention_period" STRUCT(
        "unlimited" BOOLEAN,
        "number_of_days" BIGINT
    ),
    "creation_time" TIMESTAMP_S,
    "last_update_time" TIMESTAMP_S,
    "last_message_arrival_time" TIMESTAMP_S
)
Show child fields
channel.arn

The ARN of the channel.

channel.creation_time

When the channel was created.

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

channel.last_update_time

When the channel was last updated.

channel.name

The name of the channel.

channel.retention_period

How long, in days, message data is kept for the channel.

Show child fields
channel.retention_period.number_of_days

The number of days that message data is kept. The unlimited parameter must be false.

channel.retention_period.unlimited

If true, message data is kept indefinitely.

channel.status

The status of the channel.

channel.storage

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

Show child fields
channel.storage.customer_managed_s3

Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.

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 in 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. You can't change the choice of S3 storage after the data store is created.

statistics

Statistics about the channel. Included if the includeStatistics parameter is set to true in the request.

STRUCT(
    "size" STRUCT(
        "estimated_size_in_bytes" DOUBLE,
        "estimated_on" TIMESTAMP_S
    )
)
Show child fields
statistics.size

The estimated size of the channel.

Show child fields
statistics.size.estimated_on

The time when the estimate of the size of the resource was made.

statistics.size.estimated_size_in_bytes

The estimated size of the resource, in bytes.