Skip to content
AWS for Query.Farm

aws.chime.list_channel_messages

Example SQL Queries

SELECT * FROM
aws.chime.list_channel_messages
WHERE
"channel_arn" = 'VALUE';

Description

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Table Definition

Column NameColumn Data Type
channel_arn Required Input Column

The ARN of the channel containing the requested messages.

VARCHAR
chime_bearer Input Column

The AppInstanceUserArn of the user that makes the API call.

VARCHAR
max_results Input Column

The maximum number of messages that you want returned.

BIGINT
next_token Input Column

The token passed by previous API calls until all requested messages are returned.

VARCHAR
not_after Input Column

The final or ending time stamp for your requested messages.

TIMESTAMP_S
not_before Input Column

The initial or starting time stamp for your requested messages.

TIMESTAMP_S
sort_order Input Column

The order in which you want messages sorted. Default is Descending, based on time created.

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.

channel_messages

The information about, and content of, each requested message.

STRUCT(
    "message_id" VARCHAR,
    "content" VARCHAR,
    "metadata" VARCHAR,
    "type" VARCHAR,
    "created_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S,
    "last_edited_timestamp" TIMESTAMP_S,
    "sender" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR
    ),
    "redacted" BOOLEAN
)[]
Show child fields
channel_messages[]
Show child fields
channel_messages[].content

The content of the message.

channel_messages[].created_timestamp

The time at which the message summary was created.

channel_messages[].last_edited_timestamp

The time at which a message was last edited.

channel_messages[].last_updated_timestamp

The time at which a message was last updated.

channel_messages[].message_id

The ID of the message.

channel_messages[].metadata

The metadata of the message.

channel_messages[].redacted

Indicates whether a message was redacted.

channel_messages[].sender

The message sender.

Show child fields
channel_messages[].sender.arn

The ARN in an Identity.

channel_messages[].sender.name

The name in an Identity.

channel_messages[].type

The type of message.