Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.describe_channel_flow

Example SQL Queries

SELECT * FROM
aws.chime_sdk_messaging.describe_channel_flow
WHERE
"channel_flow_arn" = 'VALUE';

Description

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

Table Definition

Column NameColumn Data Type
channel_flow_arn Required Input Column

The ARN of the channel flow.

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_flow

The channel flow details.

STRUCT(
    "channel_flow_arn" VARCHAR,
    "processors" STRUCT(
        "name" VARCHAR,
        "configuration" STRUCT(
            "lambda" STRUCT(
                "resource_arn" VARCHAR,
                "invocation_type" VARCHAR
            )
        ),
        "execution_order" BIGINT,
        "fallback_action" VARCHAR
    )[],
    "name" VARCHAR,
    "created_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S
)
Show child fields
channel_flow.channel_flow_arn

The ARN of the channel flow.

channel_flow.created_timestamp

The time at which the channel flow was created.

channel_flow.last_updated_timestamp

The time at which a channel flow was updated.

channel_flow.name

The name of the channel flow.

channel_flow.processors[]
Show child fields
channel_flow.processors[].configuration

The information about the type of processor and its identifier.

Show child fields
channel_flow.processors[].configuration.lambda

Indicates that the processor is of type Lambda.

Show child fields
channel_flow.processors[].configuration.lambda.invocation_type

Controls how the Lambda function is invoked.

channel_flow.processors[].configuration.lambda.resource_arn

The ARN of the Lambda message processing function.

channel_flow.processors[].execution_order

The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.

channel_flow.processors[].fallback_action

Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.

channel_flow.processors[].name

The name of the channel flow.