Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.search_channels

Example SQL Queries

SELECT * FROM
aws.chime_sdk_messaging.search_channels
WHERE
"fields" = 'VALUE';

Description

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

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
fields Required Input Column

A list of the Field objects in the channel being searched.

STRUCT(
    "key" VARCHAR,
    "values" VARCHAR[],
    "operator" VARCHAR
)[]
Show child fields
fields[]
Show child fields
fields[].key

An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.

fields[].operator

The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.

fields[].values[]
chime_bearer Input Column

The AppInstanceUserArn of the user making the API call.

VARCHAR
max_results Input Column

The maximum number of channels that you want returned.

BIGINT
next_token Input Column

The token returned from previous API responses until the number of channels is reached.

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.

channels

A list of the channels in the request.

STRUCT(
    "name" VARCHAR,
    "channel_arn" VARCHAR,
    "mode" VARCHAR,
    "privacy" VARCHAR,
    "metadata" VARCHAR,
    "last_message_timestamp" TIMESTAMP_S
)[]
Show child fields
channels[]
Show child fields
channels[].channel_arn

The ARN of the channel.

channels[].last_message_timestamp

The time at which the last persistent message visible to the caller in a channel was sent.

channels[].metadata

The metadata of the channel.

channels[].mode

The mode of the channel.

channels[].name

The name of the channel.

channels[].privacy

The privacy setting of the channel.