AWS Chatbot

2024/05/22 - AWS Chatbot - 3 new 10 updated api methods

Changes  This change adds support for tagging Chatbot configurations.

TagResource (new) Link ¶

Applies the supplied tags to a configuration.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)
type ResourceARN

string

param ResourceARN

[REQUIRED] The ARN of the configuration.

type Tags

list

param Tags

[REQUIRED] A list of tags to apply to the configuration.

  • (dict) -- A tag applied to the configuration.

    • TagKey (string) -- [REQUIRED] The tag key.

    • TagValue (string) -- [REQUIRED] The tag value.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UntagResource (new) Link ¶

Removes the supplied tags from a configuration

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
type ResourceARN

string

param ResourceARN

[REQUIRED] The ARN of the configuration.

type TagKeys

list

param TagKeys

[REQUIRED] A list of tag keys to remove from the configuration.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

Retrieves the list of tags applied to a configuration.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)
type ResourceARN

string

param ResourceARN

[REQUIRED] The ARN of the configuration.

rtype

dict

returns

Response Syntax

{
    'Tags': [
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Tags (list) -- A list of tags applied to the configuration.

      • (dict) -- A tag applied to the configuration.

        • TagKey (string) -- The tag key.

        • TagValue (string) -- The tag value.

CreateChimeWebhookConfiguration (updated) Link ¶
Changes (request, response)
Request
{'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}
Response
{'WebhookConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Creates Chime Webhook Configuration

See also: AWS API Documentation

Request Syntax

client.create_chime_webhook_configuration(
    WebhookDescription='string',
    WebhookUrl='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)
type WebhookDescription

string

param WebhookDescription

[REQUIRED] Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.

type WebhookUrl

string

param WebhookUrl

[REQUIRED] URL for the Chime webhook.

type SnsTopicArns

list

param SnsTopicArns

[REQUIRED] The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • (string) --

type IamRoleArn

string

param IamRoleArn

[REQUIRED] 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.

type ConfigurationName

string

param ConfigurationName

[REQUIRED] The name of the configuration.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR, INFO, or NONE.

type Tags

list

param Tags

A list of tags to apply to the configuration.

  • (dict) -- A tag applied to the configuration.

    • TagKey (string) -- [REQUIRED] The tag key.

    • TagValue (string) -- [REQUIRED] The tag value.

rtype

dict

returns

Response Syntax

{
    'WebhookConfiguration': {
        'WebhookDescription': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • WebhookConfiguration (dict) -- Chime webhook configuration.

      • WebhookDescription (string) -- Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.

      • ChatConfigurationArn (string) -- The ARN of the ChimeWebhookConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.

CreateMicrosoftTeamsChannelConfiguration (updated) Link ¶
Changes (request, response)
Request
{'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}
Response
{'ChannelConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Creates MS Teams Channel Configuration

See also: AWS API Documentation

Request Syntax

client.create_microsoft_teams_channel_configuration(
    ChannelId='string',
    ChannelName='string',
    TeamId='string',
    TeamName='string',
    TenantId='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)
type ChannelId

string

param ChannelId

[REQUIRED] The ID of the Microsoft Teams channel.

type ChannelName

string

param ChannelName

The name of the Microsoft Teams channel.

type TeamId

string

param TeamId

[REQUIRED] 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.

type TeamName

string

param TeamName

The name of the Microsoft Teams Team.

type TenantId

string

param TenantId

[REQUIRED] The ID of the Microsoft Teams tenant.

type SnsTopicArns

list

param SnsTopicArns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • (string) --

type IamRoleArn

string

param IamRoleArn

[REQUIRED] 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.

type ConfigurationName

string

param ConfigurationName

[REQUIRED] The name of the configuration.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR, INFO, or NONE.

type GuardrailPolicyArns

list

param GuardrailPolicyArns

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

  • (string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

type Tags

list

param Tags

A list of tags to apply to the configuration.

  • (dict) -- A tag applied to the configuration.

    • TagKey (string) -- [REQUIRED] The tag key.

    • TagValue (string) -- [REQUIRED] The tag value.

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ChannelConfiguration (dict) -- The configuration for a Microsoft Teams channel configured with AWS Chatbot.

      • ChannelId (string) -- The ID of the Microsoft Teams channel.

      • ChannelName (string) -- The name of the Microsoft Teams channel.

      • TeamId (string) -- 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.

      • TeamName (string) -- The name of the Microsoft Teams Team.

      • TenantId (string) -- The ID of the Microsoft Teams tenant.

      • ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

      • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

        • (string) --

      • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.

CreateSlackChannelConfiguration (updated) Link ¶
Changes (request, response)
Request
{'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}
Response
{'ChannelConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Creates Slack Channel Configuration

See also: AWS API Documentation

Request Syntax

client.create_slack_channel_configuration(
    SlackTeamId='string',
    SlackChannelId='string',
    SlackChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)
type SlackTeamId

string

param SlackTeamId

[REQUIRED] The ID of the Slack workspace authorized with AWS Chatbot.

type SlackChannelId

string

param SlackChannelId

[REQUIRED] The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

type SlackChannelName

string

param SlackChannelName

The name of the Slack Channel.

type SnsTopicArns

list

param SnsTopicArns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • (string) --

type IamRoleArn

string

param IamRoleArn

[REQUIRED] 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.

type ConfigurationName

string

param ConfigurationName

[REQUIRED] The name of the configuration.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR, INFO, or NONE.

type GuardrailPolicyArns

list

param GuardrailPolicyArns

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

  • (string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

type Tags

list

param Tags

A list of tags to apply to the configuration.

  • (dict) -- A tag applied to the configuration.

    • TagKey (string) -- [REQUIRED] The tag key.

    • TagValue (string) -- [REQUIRED] The tag value.

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'SlackTeamName': 'string',
        'SlackTeamId': 'string',
        'SlackChannelId': 'string',
        'SlackChannelName': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ChannelConfiguration (dict) -- The configuration for a Slack channel configured with AWS Chatbot.

      • SlackTeamName (string) -- Name of the Slack Workspace.

      • SlackTeamId (string) -- The ID of the Slack workspace authorized with AWS Chatbot.

      • SlackChannelId (string) -- The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

      • SlackChannelName (string) -- The name of the Slack Channel.

      • ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

      • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

        • (string) --

      • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.

DescribeChimeWebhookConfigurations (updated) Link ¶
Changes (response)
{'WebhookConfigurations': {'Tags': [{'TagKey': 'string',
                                     'TagValue': 'string'}]}}

Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn

See also: AWS API Documentation

Request Syntax

client.describe_chime_webhook_configurations(
    MaxResults=123,
    NextToken='string',
    ChatConfigurationArn='string'
)
type MaxResults

integer

param MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type NextToken

string

param NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

type ChatConfigurationArn

string

param ChatConfigurationArn

An optional ARN of a ChimeWebhookConfiguration to describe.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'WebhookConfigurations': [
        {
            'WebhookDescription': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string',
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • WebhookConfigurations (list) -- A list of Chime webhooks associated with the account.

      • (dict) -- An AWS Chatbot configuration for Amazon Chime.

        • WebhookDescription (string) -- Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.

        • ChatConfigurationArn (string) -- The ARN of the ChimeWebhookConfiguration.

        • IamRoleArn (string) -- 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.

        • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

          • (string) --

        • ConfigurationName (string) -- The name of the configuration.

        • LoggingLevel (string) -- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

        • Tags (list) -- A list of tags applied to the configuration.

          • (dict) -- A tag applied to the configuration.

            • TagKey (string) -- The tag key.

            • TagValue (string) -- The tag value.

DescribeSlackChannelConfigurations (updated) Link ¶
Changes (response)
{'SlackChannelConfigurations': {'Tags': [{'TagKey': 'string',
                                          'TagValue': 'string'}]}}

Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn

See also: AWS API Documentation

Request Syntax

client.describe_slack_channel_configurations(
    MaxResults=123,
    NextToken='string',
    ChatConfigurationArn='string'
)
type MaxResults

integer

param MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type NextToken

string

param NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

type ChatConfigurationArn

string

param ChatConfigurationArn

An optional ARN of a SlackChannelConfiguration to describe.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'SlackChannelConfigurations': [
        {
            'SlackTeamName': 'string',
            'SlackTeamId': 'string',
            'SlackChannelId': 'string',
            'SlackChannelName': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string',
            'GuardrailPolicyArns': [
                'string',
            ],
            'UserAuthorizationRequired': True|False,
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • SlackChannelConfigurations (list) -- A list of Slack channel configurations.

      • (dict) -- An AWS Chatbot configuration for Slack.

        • SlackTeamName (string) -- Name of the Slack Workspace.

        • SlackTeamId (string) -- The ID of the Slack workspace authorized with AWS Chatbot.

        • SlackChannelId (string) -- The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

        • SlackChannelName (string) -- The name of the Slack Channel.

        • ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration.

        • IamRoleArn (string) -- 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.

        • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

          • (string) --

        • ConfigurationName (string) -- The name of the configuration.

        • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

        • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

          • (string) --

        • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

        • Tags (list) -- A list of tags applied to the configuration.

          • (dict) -- A tag applied to the configuration.

            • TagKey (string) -- The tag key.

            • TagValue (string) -- The tag value.

GetMicrosoftTeamsChannelConfiguration (updated) Link ¶
Changes (response)
{'ChannelConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Get a single MS Teams Channel Configurations

See also: AWS API Documentation

Request Syntax

client.get_microsoft_teams_channel_configuration(
    ChatConfigurationArn='string'
)
type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED] The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ChannelConfiguration (dict) -- The configuration for a Microsoft Teams channel configured with AWS Chatbot.

      • ChannelId (string) -- The ID of the Microsoft Teams channel.

      • ChannelName (string) -- The name of the Microsoft Teams channel.

      • TeamId (string) -- 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.

      • TeamName (string) -- The name of the Microsoft Teams Team.

      • TenantId (string) -- The ID of the Microsoft Teams tenant.

      • ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

      • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

        • (string) --

      • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.

ListMicrosoftTeamsChannelConfigurations (updated) Link ¶
Changes (response)
{'TeamChannelConfigurations': {'Tags': [{'TagKey': 'string',
                                         'TagValue': 'string'}]}}

Lists MS Teams Channel Configurations optionally filtered by TeamId

See also: AWS API Documentation

Request Syntax

client.list_microsoft_teams_channel_configurations(
    MaxResults=123,
    NextToken='string',
    TeamId='string'
)
type MaxResults

integer

param MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type NextToken

string

param NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

type TeamId

string

param TeamId

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.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'TeamChannelConfigurations': [
        {
            'ChannelId': 'string',
            'ChannelName': 'string',
            'TeamId': 'string',
            'TeamName': 'string',
            'TenantId': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string',
            'GuardrailPolicyArns': [
                'string',
            ],
            'UserAuthorizationRequired': True|False,
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • TeamChannelConfigurations (list) -- A list of AWS Chatbot channel configurations for Microsoft Teams.

      • (dict) -- An AWS Chatbot configuration for Microsoft Teams.

        • ChannelId (string) -- The ID of the Microsoft Teams channel.

        • ChannelName (string) -- The name of the Microsoft Teams channel.

        • TeamId (string) -- 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.

        • TeamName (string) -- The name of the Microsoft Teams Team.

        • TenantId (string) -- The ID of the Microsoft Teams tenant.

        • ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.

        • IamRoleArn (string) -- 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.

        • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

          • (string) --

        • ConfigurationName (string) -- The name of the configuration.

        • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

        • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

          • (string) --

        • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

        • Tags (list) -- A list of tags applied to the configuration.

          • (dict) -- A tag applied to the configuration.

            • TagKey (string) -- The tag key.

            • TagValue (string) -- The tag value.

UpdateChimeWebhookConfiguration (updated) Link ¶
Changes (response)
{'WebhookConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Updates a Chime Webhook Configuration

See also: AWS API Documentation

Request Syntax

client.update_chime_webhook_configuration(
    ChatConfigurationArn='string',
    WebhookDescription='string',
    WebhookUrl='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string'
)
type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED] The ARN of the ChimeWebhookConfiguration to update.

type WebhookDescription

string

param WebhookDescription

Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.

type WebhookUrl

string

param WebhookUrl

URL for the Chime webhook.

type SnsTopicArns

list

param SnsTopicArns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • (string) --

type IamRoleArn

string

param IamRoleArn

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.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR, INFO, or NONE.

rtype

dict

returns

Response Syntax

{
    'WebhookConfiguration': {
        'WebhookDescription': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • WebhookConfiguration (dict) -- Chime webhook configuration.

      • WebhookDescription (string) -- Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.

      • ChatConfigurationArn (string) -- The ARN of the ChimeWebhookConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.

UpdateMicrosoftTeamsChannelConfiguration (updated) Link ¶
Changes (response)
{'ChannelConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Updates MS Teams Channel Configuration

See also: AWS API Documentation

Request Syntax

client.update_microsoft_teams_channel_configuration(
    ChatConfigurationArn='string',
    ChannelId='string',
    ChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False
)
type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED] The ARN of the MicrosoftTeamsChannelConfiguration to update.

type ChannelId

string

param ChannelId

[REQUIRED] The ID of the Microsoft Teams channel.

type ChannelName

string

param ChannelName

The name of the Microsoft Teams channel.

type SnsTopicArns

list

param SnsTopicArns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • (string) --

type IamRoleArn

string

param IamRoleArn

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.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR, INFO, or NONE.

type GuardrailPolicyArns

list

param GuardrailPolicyArns

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

  • (string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ChannelConfiguration (dict) -- The configuration for a Microsoft Teams channel configured with AWS Chatbot.

      • ChannelId (string) -- The ID of the Microsoft Teams channel.

      • ChannelName (string) -- The name of the Microsoft Teams channel.

      • TeamId (string) -- 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.

      • TeamName (string) -- The name of the Microsoft Teams Team.

      • TenantId (string) -- The ID of the Microsoft Teams tenant.

      • ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

      • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

        • (string) --

      • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.

UpdateSlackChannelConfiguration (updated) Link ¶
Changes (response)
{'ChannelConfiguration': {'Tags': [{'TagKey': 'string', 'TagValue': 'string'}]}}

Updates Slack Channel Configuration

See also: AWS API Documentation

Request Syntax

client.update_slack_channel_configuration(
    ChatConfigurationArn='string',
    SlackChannelId='string',
    SlackChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False
)
type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED] The ARN of the SlackChannelConfiguration to update.

type SlackChannelId

string

param SlackChannelId

[REQUIRED] The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

type SlackChannelName

string

param SlackChannelName

The name of the Slack Channel.

type SnsTopicArns

list

param SnsTopicArns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

  • (string) --

type IamRoleArn

string

param IamRoleArn

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.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR, INFO, or NONE.

type GuardrailPolicyArns

list

param GuardrailPolicyArns

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

  • (string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'SlackTeamName': 'string',
        'SlackTeamId': 'string',
        'SlackChannelId': 'string',
        'SlackChannelName': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ChannelConfiguration (dict) -- The configuration for a Slack channel configured with AWS Chatbot.

      • SlackTeamName (string) -- Name of the Slack Workspace.

      • SlackTeamId (string) -- The ID of the Slack workspace authorized with AWS Chatbot.

      • SlackChannelId (string) -- The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

      • SlackChannelName (string) -- The name of the Slack Channel.

      • ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration.

      • IamRoleArn (string) -- 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.

      • SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) --

      • ConfigurationName (string) -- The name of the configuration.

      • LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.

      • GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.

        • (string) --

      • UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.

      • Tags (list) -- A list of tags applied to the configuration.

        • (dict) -- A tag applied to the configuration.

          • TagKey (string) -- The tag key.

          • TagValue (string) -- The tag value.