Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.get_channel_message

Example SQL Queries

SELECT * FROM
aws.chime_sdk_messaging.get_channel_message
WHERE
"channel_arn" = 'VALUE'
AND "message_id" = 'VALUE'
AND "chime_bearer" = 'VALUE';

Description

Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Table Definition

Column NameColumn Data Type
channel_arn Required Input Column

The ARN of the channel.

VARCHAR
chime_bearer Required Input Column

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

VARCHAR
message_id Required Input Column

The ID of the message.

VARCHAR
sub_channel_id Input Column

The ID of the SubChannel in the request.

Only required when getting messages in a SubChannel that the user belongs to.

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_message

The details of and content in the message.

STRUCT(
    "channel_arn" VARCHAR,
    "message_id" VARCHAR,
    "content" VARCHAR,
    "metadata" VARCHAR,
    "type" VARCHAR,
    "created_timestamp" TIMESTAMP_S,
    "last_edited_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S,
    "sender" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR
    ),
    "redacted" BOOLEAN,
    "persistence" VARCHAR,
    "status" STRUCT(
        "value" VARCHAR,
        "detail" VARCHAR
    ),
    "message_attributes" MAP(VARCHAR, STRUCT(
            "string_values" VARCHAR[]
        )),
    "sub_channel_id" VARCHAR,
    "content_type" VARCHAR,
    "target" STRUCT(
        "member_arn" VARCHAR
    )[]
)
Show child fields
channel_message.channel_arn

The ARN of the channel.

channel_message.content

The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

channel_message.content_type

The content type of the channel message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

channel_message.created_timestamp

The time at which the message was created.

channel_message.last_edited_timestamp

The time at which a message was edited.

channel_message.last_updated_timestamp

The time at which a message was updated.

channel_message.message_attributes

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

channel_message.message_id

The ID of a message.

channel_message.metadata

The message metadata.

channel_message.persistence

The persistence setting for a channel message.

channel_message.redacted

Hides the content of a message.

channel_message.sender

The message sender.

Show child fields
channel_message.sender.arn

The ARN in an Identity.

channel_message.sender.name

The name in an Identity.

channel_message.status

The status of the channel message.

Show child fields
channel_message.status.detail

Contains more details about the message status.

channel_message.status.value

The message status value.

channel_message.sub_channel_id

The ID of the SubChannel.

channel_message.target[]
Show child fields
channel_message.target[].member_arn

The ARN of the target channel member.

channel_message.type

The message type.