Skip to content
AWS for Query.Farm

aws.chatbot.get_microsoft_teams_channel_configuration

Example SQL Queries

SELECT * FROM
aws.chatbot.get_microsoft_teams_channel_configuration
WHERE
"chat_configuration_arn" = 'VALUE';

Description

Get a single MS Teams Channel Configurations

Table Definition

Column NameColumn Data Type
chat_configuration_arn Required Input Column

The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.

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_configuration

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

STRUCT(
    "channel_id" VARCHAR,
    "channel_name" VARCHAR,
    "team_id" VARCHAR,
    "team_name" VARCHAR,
    "tenant_id" VARCHAR,
    "chat_configuration_arn" VARCHAR,
    "iam_role_arn" VARCHAR,
    "sns_topic_arns" VARCHAR[],
    "configuration_name" VARCHAR,
    "logging_level" VARCHAR,
    "guardrail_policy_arns" VARCHAR[],
    "user_authorization_required" BOOLEAN,
    "tags" STRUCT(
        "tag_key" VARCHAR,
        "tag_value" VARCHAR
    )[]
)
Show child fields
channel_configuration.channel_id

The ID of the Microsoft Teams channel.

channel_configuration.channel_name

The name of the Microsoft Teams channel.

channel_configuration.chat_configuration_arn

The ARN of the MicrosoftTeamsChannelConfiguration.

channel_configuration.configuration_name

The name of the configuration.

channel_configuration.guardrail_policy_arns[]
channel_configuration.iam_role_arn

The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

channel_configuration.logging_level

Logging levels include ERROR, INFO, or NONE.

channel_configuration.sns_topic_arns[]
channel_configuration.tags[]
Show child fields
channel_configuration.tags[].tag_key

The tag key.

channel_configuration.tags[].tag_value

The tag value.

channel_configuration.team_id

The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.

channel_configuration.team_name

The name of the Microsoft Teams Team.

channel_configuration.tenant_id

The ID of the Microsoft Teams tenant.

channel_configuration.user_authorization_required

Enables use of a user role requirement in your chat configuration.