Chatbot ******* Client ====== class Chatbot.Client A low-level client representing AWS Chatbot The *AWS Chatbot API Reference* provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions. AWS Chatbot APIs are currently available in the following Regions: * US East (Ohio) - "us-east-2" * US West (Oregon) - "us-west-2" * Asia Pacific (Singapore) - "ap-southeast-1" * Europe (Ireland) - "eu-west-1" The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions. Note: Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default. import boto3 client = boto3.client('chatbot') These are the available methods: * associate_to_configuration * can_paginate * close * create_chime_webhook_configuration * create_custom_action * create_microsoft_teams_channel_configuration * create_slack_channel_configuration * delete_chime_webhook_configuration * delete_custom_action * delete_microsoft_teams_channel_configuration * delete_microsoft_teams_configured_team * delete_microsoft_teams_user_identity * delete_slack_channel_configuration * delete_slack_user_identity * delete_slack_workspace_authorization * describe_chime_webhook_configurations * describe_slack_channel_configurations * describe_slack_user_identities * describe_slack_workspaces * disassociate_from_configuration * get_account_preferences * get_custom_action * get_microsoft_teams_channel_configuration * get_paginator * get_waiter * list_associations * list_custom_actions * list_microsoft_teams_channel_configurations * list_microsoft_teams_configured_teams * list_microsoft_teams_user_identities * list_tags_for_resource * tag_resource * untag_resource * update_account_preferences * update_chime_webhook_configuration * update_custom_action * update_microsoft_teams_channel_configuration * update_slack_channel_configuration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeChimeWebhookConfigurations * DescribeSlackChannelConfigurations * DescribeSlackUserIdentities * DescribeSlackWorkspaces * ListAssociations * ListCustomActions * ListMicrosoftTeamsChannelConfigurations * ListMicrosoftTeamsConfiguredTeams * ListMicrosoftTeamsUserIdentities Chatbot / Paginator / ListMicrosoftTeamsConfiguredTeams ListMicrosoftTeamsConfiguredTeams ********************************* class Chatbot.Paginator.ListMicrosoftTeamsConfiguredTeams paginator = client.get_paginator('list_microsoft_teams_configured_teams') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.list_microsoft_teams_configured_teams()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConfiguredTeams': [ { 'TenantId': 'string', 'TeamId': 'string', 'TeamName': 'string', 'State': 'string', 'StateReason': 'string' }, ], } **Response Structure** * *(dict) --* * **ConfiguredTeams** *(list) --* A list of teams in Microsoft Teams that are configured with AWS Chatbot. * *(dict) --* A Microsoft Teams team that is authorized with AWS Chatbot. * **TenantId** *(string) --* The ID of the Microsoft Teams tenant. * **TeamId** *(string) --* The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. * **TeamName** *(string) --* The name of the Microsoft Teams Team. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. Chatbot / Paginator / DescribeSlackUserIdentities DescribeSlackUserIdentities *************************** class Chatbot.Paginator.DescribeSlackUserIdentities paginator = client.get_paginator('describe_slack_user_identities') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.describe_slack_user_identities()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChatConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChatConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identities to describe. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SlackUserIdentities': [ { 'IamRoleArn': 'string', 'ChatConfigurationArn': 'string', 'SlackTeamId': 'string', 'SlackUserId': 'string', 'AwsUserIdentity': 'string' }, ], } **Response Structure** * *(dict) --* * **SlackUserIdentities** *(list) --* A list of Slack User Identities. * *(dict) --* Identifes a user level permission for a channel configuration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identity to delete. * **SlackTeamId** *(string) --* The ID of the Slack workspace authorized with AWS Chatbot. * **SlackUserId** *(string) --* The ID of the user in Slack * **AwsUserIdentity** *(string) --* The AWS user identity ARN used to associate a Slack user ID with an IAM Role. Chatbot / Paginator / ListAssociations ListAssociations **************** class Chatbot.Paginator.ListAssociations paginator = client.get_paginator('list_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.list_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChatConfiguration='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChatConfiguration** (*string*) -- **[REQUIRED]** The channel configuration to list associations for. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Associations': [ { 'Resource': 'string' }, ], } **Response Structure** * *(dict) --* * **Associations** *(list) --* The resources associated with this channel configuration. * *(dict) --* A listing of an association with a channel configuration. * **Resource** *(string) --* The Amazon Resource Name (ARN) of the resource (for example, a custom action). Chatbot / Paginator / ListMicrosoftTeamsUserIdentities ListMicrosoftTeamsUserIdentities ******************************** class Chatbot.Paginator.ListMicrosoftTeamsUserIdentities paginator = client.get_paginator('list_microsoft_teams_user_identities') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.list_microsoft_teams_user_identities()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChatConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChatConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TeamsUserIdentities': [ { 'IamRoleArn': 'string', 'ChatConfigurationArn': 'string', 'TeamId': 'string', 'UserId': 'string', 'AwsUserIdentity': 'string', 'TeamsChannelId': 'string', 'TeamsTenantId': 'string' }, ], } **Response Structure** * *(dict) --* * **TeamsUserIdentities** *(list) --* User level permissions associated to a channel configuration. * *(dict) --* Identifes a user level permission for a channel configuration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **TeamId** *(string) --* The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. * **UserId** *(string) --* The Microsoft Teams user ID. * **AwsUserIdentity** *(string) --* The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role. * **TeamsChannelId** *(string) --* The ID of the Microsoft Teams channel. * **TeamsTenantId** *(string) --* The ID of the Microsoft Teams tenant. Chatbot / Paginator / DescribeSlackWorkspaces DescribeSlackWorkspaces *********************** class Chatbot.Paginator.DescribeSlackWorkspaces paginator = client.get_paginator('describe_slack_workspaces') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.describe_slack_workspaces()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SlackWorkspaces': [ { 'SlackTeamId': 'string', 'SlackTeamName': 'string', 'State': 'string', 'StateReason': 'string' }, ], } **Response Structure** * *(dict) --* * **SlackWorkspaces** *(list) --* A list of Slack workspaces registered with AWS Chatbot. * *(dict) --* A Slack workspace. * **SlackTeamId** *(string) --* The ID of the Slack workspace authorized with AWS Chatbot. * **SlackTeamName** *(string) --* The name of the Slack workspace. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. Chatbot / Paginator / ListMicrosoftTeamsChannelConfigurations ListMicrosoftTeamsChannelConfigurations *************************************** class Chatbot.Paginator.ListMicrosoftTeamsChannelConfigurations paginator = client.get_paginator('list_microsoft_teams_channel_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.list_microsoft_teams_channel_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TeamId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TeamId** (*string*) -- The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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' }, ], 'State': 'string', 'StateReason': 'string' }, ] } **Response Structure** * *(dict) --* * **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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. Chatbot / Paginator / DescribeSlackChannelConfigurations DescribeSlackChannelConfigurations ********************************** class Chatbot.Paginator.DescribeSlackChannelConfigurations paginator = client.get_paginator('describe_slack_channel_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.describe_slack_channel_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChatConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChatConfigurationArn** (*string*) -- An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration to describe. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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' }, ], 'State': 'string', 'StateReason': 'string' }, ] } **Response Structure** * *(dict) --* * **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 Amazon Chime. * **SlackChannelId** *(string) --* The ID of the Slack channel. To get this 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 Amazon Resource Name (ARN) of the SlackChannelConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. Chatbot / Paginator / DescribeChimeWebhookConfigurations DescribeChimeWebhookConfigurations ********************************** class Chatbot.Paginator.DescribeChimeWebhookConfigurations paginator = client.get_paginator('describe_chime_webhook_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.describe_chime_webhook_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChatConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChatConfigurationArn** (*string*) -- An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'WebhookConfigurations': [ { 'WebhookDescription': 'string', 'ChatConfigurationArn': 'string', 'IamRoleArn': 'string', 'SnsTopicArns': [ 'string', ], 'ConfigurationName': 'string', 'LoggingLevel': 'string', 'Tags': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'State': 'string', 'StateReason': 'string' }, ] } **Response Structure** * *(dict) --* * **WebhookConfigurations** *(list) --* A list of Amazon Chime webhooks associated with the account. * *(dict) --* An AWS Chatbot configuration for Amazon Chime. * **WebhookDescription** *(string) --* A description of the webhook. We recommend using the convention "RoomName/WebhookName". For more information, see Tutorial: Get started with Amazon Chime in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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". * **Tags** *(list) --* A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. Chatbot / Paginator / ListCustomActions ListCustomActions ***************** class Chatbot.Paginator.ListCustomActions paginator = client.get_paginator('list_custom_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chatbot.Client.list_custom_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CustomActions': [ 'string', ], } **Response Structure** * *(dict) --* * **CustomActions** *(list) --* A list of custom actions. * *(string) --* Chatbot / Client / get_paginator get_paginator ************* Chatbot.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Chatbot / Client / create_custom_action create_custom_action ******************** Chatbot.Client.create_custom_action(**kwargs) Creates a custom action that can be invoked as an alias or as a button on a notification. See also: AWS API Documentation **Request Syntax** response = client.create_custom_action( Definition={ 'CommandText': 'string' }, AliasName='string', Attachments=[ { 'NotificationType': 'string', 'ButtonText': 'string', 'Criteria': [ { 'Operator': 'HAS_VALUE'|'EQUALS', 'VariableName': 'string', 'Value': 'string' }, ], 'Variables': { 'string': 'string' } }, ], Tags=[ { 'TagKey': 'string', 'TagValue': 'string' }, ], ClientToken='string', ActionName='string' ) Parameters: * **Definition** (*dict*) -- **[REQUIRED]** The definition of the command to run when invoked as an alias or as an action button. * **CommandText** *(string) --* **[REQUIRED]** The command string to run which may include variables by prefixing with a dollar sign ($). * **AliasName** (*string*) -- The name used to invoke this action in a chat channel. For example, "@aws run my-alias". * **Attachments** (*list*) -- Defines when this custom action button should be attached to a notification. * *(dict) --* Defines when a custom action button should be attached to a notification. * **NotificationType** *(string) --* The type of notification that the custom action should be attached to. * **ButtonText** *(string) --* The text of the button that appears on the notification. * **Criteria** *(list) --* The criteria for when a button should be shown based on values in the notification. * *(dict) --* A criteria for when a button should be shown based on values in the notification * **Operator** *(string) --* **[REQUIRED]** The operation to perform on the named variable. * **VariableName** *(string) --* **[REQUIRED]** The name of the variable to operate on. * **Value** *(string) --* A value that is compared with the actual value of the variable based on the behavior of the operator. * **Variables** *(dict) --* The variables to extract from the notification. * *(string) --* * *(string) --* * **Tags** (*list*) -- A map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* **[REQUIRED]** The key of the tag. * **TagValue** *(string) --* **[REQUIRED]** The value of the tag. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the SDK. This field is autopopulated if not provided. * **ActionName** (*string*) -- **[REQUIRED]** The name of the custom action. This name is included in the Amazon Resource Name (ARN). Return type: dict Returns: **Response Syntax** { 'CustomActionArn': 'string' } **Response Structure** * *(dict) --* * **CustomActionArn** *(string) --* The fully defined ARN of the custom action. **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.LimitExceededException" * "Chatbot.Client.exceptions.ConflictException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / disassociate_from_configuration disassociate_from_configuration ******************************* Chatbot.Client.disassociate_from_configuration(**kwargs) Unlink a resource, for example a custom action, from a channel configuration. See also: AWS API Documentation **Request Syntax** response = client.disassociate_from_configuration( Resource='string', ChatConfiguration='string' ) Parameters: * **Resource** (*string*) -- **[REQUIRED]** The resource (for example, a custom action) Amazon Resource Name (ARN) to unlink. * **ChatConfiguration** (*string*) -- **[REQUIRED]** The channel configuration the resource is being disassociated from. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / can_paginate can_paginate ************ Chatbot.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Chatbot / Client / list_custom_actions list_custom_actions ******************* Chatbot.Client.list_custom_actions(**kwargs) Lists custom actions defined in this account. See also: AWS API Documentation **Request Syntax** response = client.list_custom_actions( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- 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. * **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. Return type: dict Returns: **Response Syntax** { 'CustomActions': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CustomActions** *(list) --* A list of custom actions. * *(string) --* * **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. **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / delete_slack_user_identity delete_slack_user_identity ************************** Chatbot.Client.delete_slack_user_identity(**kwargs) Deletes a user level permission for a Slack channel configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_slack_user_identity( ChatConfigurationArn='string', SlackTeamId='string', SlackUserId='string' ) Parameters: * **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The ARN of the SlackChannelConfiguration associated with the user identity to delete. * **SlackTeamId** (*string*) -- **[REQUIRED]** The ID of the Slack workspace authorized with AWS Chatbot. * **SlackUserId** (*string*) -- **[REQUIRED]** The ID of the user in Slack Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.DeleteSlackUserIdentityException" * "Chatbot.Client.exceptions.ResourceNotFoundException" Chatbot / Client / list_microsoft_teams_configured_teams list_microsoft_teams_configured_teams ************************************* Chatbot.Client.list_microsoft_teams_configured_teams(**kwargs) Lists all authorized Microsoft Teams for an AWS Account See also: AWS API Documentation **Request Syntax** response = client.list_microsoft_teams_configured_teams( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- 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. * **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. Return type: dict Returns: **Response Syntax** { 'ConfiguredTeams': [ { 'TenantId': 'string', 'TeamId': 'string', 'TeamName': 'string', 'State': 'string', 'StateReason': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ConfiguredTeams** *(list) --* A list of teams in Microsoft Teams that are configured with AWS Chatbot. * *(dict) --* A Microsoft Teams team that is authorized with AWS Chatbot. * **TenantId** *(string) --* The ID of the Microsoft Teams tenant. * **TeamId** *(string) --* The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. * **TeamName** *(string) --* The name of the Microsoft Teams Team. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. * **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. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ListMicrosoftTeamsConfiguredTeamsExce ption" Chatbot / Client / update_chime_webhook_configuration update_chime_webhook_configuration ********************************** Chatbot.Client.update_chime_webhook_configuration(**kwargs) Updates a Amazon Chime webhook configuration. See also: AWS API Documentation **Request Syntax** response = client.update_chime_webhook_configuration( ChatConfigurationArn='string', WebhookDescription='string', WebhookUrl='string', SnsTopicArns=[ 'string', ], IamRoleArn='string', LoggingLevel='string' ) Parameters: * **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to update. * **WebhookDescription** (*string*) -- A description of the webhook. We recommend using the convention "RoomName/WebhookName". For more information, see Tutorial: Get started with Amazon Chime in the *AWS Chatbot Administrator Guide*. * **WebhookUrl** (*string*) -- The URL for the Amazon Chime webhook. * **SnsTopicArns** (*list*) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot. * *(string) --* * **IamRoleArn** (*string*) -- A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **LoggingLevel** (*string*) -- Logging levels include "ERROR", "INFO", or "NONE". Return type: dict Returns: **Response Syntax** { 'WebhookConfiguration': { 'WebhookDescription': 'string', 'ChatConfigurationArn': 'string', 'IamRoleArn': 'string', 'SnsTopicArns': [ 'string', ], 'ConfigurationName': 'string', 'LoggingLevel': 'string', 'Tags': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'State': 'string', 'StateReason': 'string' } } **Response Structure** * *(dict) --* * **WebhookConfiguration** *(dict) --* A Amazon Chime webhook configuration. * **WebhookDescription** *(string) --* A description of the webhook. We recommend using the convention "RoomName/WebhookName". For more information, see Tutorial: Get started with Amazon Chime in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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". * **Tags** *(list) --* A map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.UpdateChimeWebhookConfigurationExcept ion" * "Chatbot.Client.exceptions.ResourceNotFoundException" Chatbot / Client / delete_slack_workspace_authorization delete_slack_workspace_authorization ************************************ Chatbot.Client.delete_slack_workspace_authorization(**kwargs) Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted. See also: AWS API Documentation **Request Syntax** response = client.delete_slack_workspace_authorization( SlackTeamId='string' ) Parameters: **SlackTeamId** (*string*) -- **[REQUIRED]** The ID of the Slack workspace authorized with AWS Chatbot. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.DeleteSlackWorkspaceAuthorizationFaul t" Chatbot / Client / list_tags_for_resource list_tags_for_resource ********************** Chatbot.Client.list_tags_for_resource(**kwargs) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceARN='string' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource to list tags for. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'TagKey': 'string', 'TagValue': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. **Exceptions** * "Chatbot.Client.exceptions.ServiceUnavailableException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.InternalServiceError" Chatbot / Client / delete_microsoft_teams_user_identity delete_microsoft_teams_user_identity ************************************ Chatbot.Client.delete_microsoft_teams_user_identity(**kwargs) Identifes a user level permission for a channel configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_microsoft_teams_user_identity( ChatConfigurationArn='string', UserId='string' ) Parameters: * **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **UserId** (*string*) -- **[REQUIRED]** The Microsoft Teams user ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.DeleteMicrosoftTeamsUserIdentityExcep tion" Chatbot / Client / get_account_preferences get_account_preferences *********************** Chatbot.Client.get_account_preferences() Returns AWS Chatbot account preferences. See also: AWS API Documentation **Request Syntax** response = client.get_account_preferences() Return type: dict Returns: **Response Syntax** { 'AccountPreferences': { 'UserAuthorizationRequired': True|False, 'TrainingDataCollectionEnabled': True|False } } **Response Structure** * *(dict) --* * **AccountPreferences** *(dict) --* The preferences related to AWS Chatbot usage in the calling AWS account. * **UserAuthorizationRequired** *(boolean) --* Enables use of a user role requirement in your chat configuration. * **TrainingDataCollectionEnabled** *(boolean) --* Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot. **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.GetAccountPreferencesException" Chatbot / Client / create_slack_channel_configuration create_slack_channel_configuration ********************************** Chatbot.Client.create_slack_channel_configuration(**kwargs) Creates an AWS Chatbot confugration for Slack. See also: AWS API Documentation **Request Syntax** response = 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' }, ] ) Parameters: * **SlackTeamId** (*string*) -- **[REQUIRED]** The ID of the Slack workspace authorized with AWS Chatbot. * **SlackChannelId** (*string*) -- **[REQUIRED]** The ID of the Slack channel. To get this 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. * **SnsTopicArns** (*list*) -- The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. * *(string) --* * **IamRoleArn** (*string*) -- **[REQUIRED]** A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ConfigurationName** (*string*) -- **[REQUIRED]** 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 map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* **[REQUIRED]** The key of the tag. * **TagValue** *(string) --* **[REQUIRED]** The value of the tag. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Amazon Chime. * **SlackChannelId** *(string) --* The ID of the Slack channel. To get this 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 Amazon Resource Name (ARN) of the SlackChannelConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ConflictException" * "Chatbot.Client.exceptions.LimitExceededException" * "Chatbot.Client.exceptions.CreateSlackChannelConfigurationExcept ion" Chatbot / Client / untag_resource untag_resource ************** Chatbot.Client.untag_resource(**kwargs) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role. * **TagKeys** (*list*) -- **[REQUIRED]** TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.ServiceUnavailableException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.InternalServiceError" Chatbot / Client / get_waiter get_waiter ********** Chatbot.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Chatbot / Client / describe_slack_workspaces describe_slack_workspaces ************************* Chatbot.Client.describe_slack_workspaces(**kwargs) List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot. See also: AWS API Documentation **Request Syntax** response = client.describe_slack_workspaces( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- 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. * **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. Return type: dict Returns: **Response Syntax** { 'SlackWorkspaces': [ { 'SlackTeamId': 'string', 'SlackTeamName': 'string', 'State': 'string', 'StateReason': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SlackWorkspaces** *(list) --* A list of Slack workspaces registered with AWS Chatbot. * *(dict) --* A Slack workspace. * **SlackTeamId** *(string) --* The ID of the Slack workspace authorized with AWS Chatbot. * **SlackTeamName** *(string) --* The name of the Slack workspace. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. * **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. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.DescribeSlackWorkspacesException" * "Chatbot.Client.exceptions.InvalidRequestException" Chatbot / Client / delete_slack_channel_configuration delete_slack_channel_configuration ********************************** Chatbot.Client.delete_slack_channel_configuration(**kwargs) Deletes a Slack channel configuration for AWS Chatbot See also: AWS API Documentation **Request Syntax** response = client.delete_slack_channel_configuration( ChatConfigurationArn='string' ) Parameters: **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.DeleteSlackChannelConfigurationExcept ion" * "Chatbot.Client.exceptions.ResourceNotFoundException" Chatbot / Client / delete_chime_webhook_configuration delete_chime_webhook_configuration ********************************** Chatbot.Client.delete_chime_webhook_configuration(**kwargs) Deletes a Amazon Chime webhook configuration for AWS Chatbot. See also: AWS API Documentation **Request Syntax** response = client.delete_chime_webhook_configuration( ChatConfigurationArn='string' ) Parameters: **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.DeleteChimeWebhookConfigurationExcept ion" Chatbot / Client / update_custom_action update_custom_action ******************** Chatbot.Client.update_custom_action(**kwargs) Updates a custom action. See also: AWS API Documentation **Request Syntax** response = client.update_custom_action( CustomActionArn='string', Definition={ 'CommandText': 'string' }, AliasName='string', Attachments=[ { 'NotificationType': 'string', 'ButtonText': 'string', 'Criteria': [ { 'Operator': 'HAS_VALUE'|'EQUALS', 'VariableName': 'string', 'Value': 'string' }, ], 'Variables': { 'string': 'string' } }, ] ) Parameters: * **CustomActionArn** (*string*) -- **[REQUIRED]** The fully defined Amazon Resource Name (ARN) of the custom action. * **Definition** (*dict*) -- **[REQUIRED]** The definition of the command to run when invoked as an alias or as an action button. * **CommandText** *(string) --* **[REQUIRED]** The command string to run which may include variables by prefixing with a dollar sign ($). * **AliasName** (*string*) -- The name used to invoke this action in the chat channel. For example, "@aws run my-alias". * **Attachments** (*list*) -- Defines when this custom action button should be attached to a notification. * *(dict) --* Defines when a custom action button should be attached to a notification. * **NotificationType** *(string) --* The type of notification that the custom action should be attached to. * **ButtonText** *(string) --* The text of the button that appears on the notification. * **Criteria** *(list) --* The criteria for when a button should be shown based on values in the notification. * *(dict) --* A criteria for when a button should be shown based on values in the notification * **Operator** *(string) --* **[REQUIRED]** The operation to perform on the named variable. * **VariableName** *(string) --* **[REQUIRED]** The name of the variable to operate on. * **Value** *(string) --* A value that is compared with the actual value of the variable based on the behavior of the operator. * **Variables** *(dict) --* The variables to extract from the notification. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'CustomActionArn': 'string' } **Response Structure** * *(dict) --* * **CustomActionArn** *(string) --* The fully defined ARN of the custom action. **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / list_associations list_associations ***************** Chatbot.Client.list_associations(**kwargs) Lists resources associated with a channel configuration. See also: AWS API Documentation **Request Syntax** response = client.list_associations( ChatConfiguration='string', MaxResults=123, NextToken='string' ) Parameters: * **ChatConfiguration** (*string*) -- **[REQUIRED]** The channel configuration to list associations for. * **MaxResults** (*integer*) -- 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. * **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. Return type: dict Returns: **Response Syntax** { 'Associations': [ { 'Resource': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Associations** *(list) --* The resources associated with this channel configuration. * *(dict) --* A listing of an association with a channel configuration. * **Resource** *(string) --* The Amazon Resource Name (ARN) of the resource (for example, a custom action). * **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. Chatbot / Client / describe_slack_user_identities describe_slack_user_identities ****************************** Chatbot.Client.describe_slack_user_identities(**kwargs) Lists all Slack user identities with a mapped role. See also: AWS API Documentation **Request Syntax** response = client.describe_slack_user_identities( ChatConfigurationArn='string', NextToken='string', MaxResults=123 ) Parameters: * **ChatConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identities to describe. * **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. * **MaxResults** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'SlackUserIdentities': [ { 'IamRoleArn': 'string', 'ChatConfigurationArn': 'string', 'SlackTeamId': 'string', 'SlackUserId': 'string', 'AwsUserIdentity': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SlackUserIdentities** *(list) --* A list of Slack User Identities. * *(dict) --* Identifes a user level permission for a channel configuration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identity to delete. * **SlackTeamId** *(string) --* The ID of the Slack workspace authorized with AWS Chatbot. * **SlackUserId** *(string) --* The ID of the user in Slack * **AwsUserIdentity** *(string) --* The AWS user identity ARN used to associate a Slack user ID with an IAM Role. * **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. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.DescribeSlackUserIdentitiesException" Chatbot / Client / create_microsoft_teams_channel_configuration create_microsoft_teams_channel_configuration ******************************************** Chatbot.Client.create_microsoft_teams_channel_configuration(**kwargs) Creates an AWS Chatbot configuration for Microsoft Teams. See also: AWS API Documentation **Request Syntax** response = 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' }, ] ) Parameters: * **ChannelId** (*string*) -- **[REQUIRED]** The ID of the Microsoft Teams channel. * **ChannelName** (*string*) -- The name of the Microsoft Teams channel. * **TeamId** (*string*) -- **[REQUIRED]** The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. * **TeamName** (*string*) -- The name of the Microsoft Teams Team. * **TenantId** (*string*) -- **[REQUIRED]** The ID of the Microsoft Teams tenant. * **SnsTopicArns** (*list*) -- The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. * *(string) --* * **IamRoleArn** (*string*) -- **[REQUIRED]** A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ConfigurationName** (*string*) -- **[REQUIRED]** 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 map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* **[REQUIRED]** The key of the tag. * **TagValue** *(string) --* **[REQUIRED]** The value of the tag. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ConflictException" * "Chatbot.Client.exceptions.LimitExceededException" * "Chatbot.Client.exceptions.CreateTeamsChannelConfigurationExcept ion" Chatbot / Client / create_chime_webhook_configuration create_chime_webhook_configuration ********************************** Chatbot.Client.create_chime_webhook_configuration(**kwargs) Creates an AWS Chatbot configuration for Amazon Chime. See also: AWS API Documentation **Request Syntax** response = client.create_chime_webhook_configuration( WebhookDescription='string', WebhookUrl='string', SnsTopicArns=[ 'string', ], IamRoleArn='string', ConfigurationName='string', LoggingLevel='string', Tags=[ { 'TagKey': 'string', 'TagValue': 'string' }, ] ) Parameters: * **WebhookDescription** (*string*) -- **[REQUIRED]** A description of the webhook. We recommend using the convention "RoomName/WebhookName". For more information, see Tutorial: Get started with Amazon Chime in the *AWS Chatbot Administrator Guide*. * **WebhookUrl** (*string*) -- **[REQUIRED]** The URL for the Amazon Chime webhook. * **SnsTopicArns** (*list*) -- **[REQUIRED]** The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. * *(string) --* * **IamRoleArn** (*string*) -- **[REQUIRED]** A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ConfigurationName** (*string*) -- **[REQUIRED]** The name of the configuration. * **LoggingLevel** (*string*) -- Logging levels include "ERROR", "INFO", or "NONE". * **Tags** (*list*) -- A map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* **[REQUIRED]** The key of the tag. * **TagValue** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'WebhookConfiguration': { 'WebhookDescription': 'string', 'ChatConfigurationArn': 'string', 'IamRoleArn': 'string', 'SnsTopicArns': [ 'string', ], 'ConfigurationName': 'string', 'LoggingLevel': 'string', 'Tags': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'State': 'string', 'StateReason': 'string' } } **Response Structure** * *(dict) --* * **WebhookConfiguration** *(dict) --* An Amazon Chime webhook configuration. * **WebhookDescription** *(string) --* A description of the webhook. We recommend using the convention "RoomName/WebhookName". For more information, see Tutorial: Get started with Amazon Chime in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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". * **Tags** *(list) --* A map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ConflictException" * "Chatbot.Client.exceptions.LimitExceededException" * "Chatbot.Client.exceptions.CreateChimeWebhookConfigurationExcept ion" Chatbot / Client / close close ***** Chatbot.Client.close() Closes underlying endpoint connections. Chatbot / Client / update_slack_channel_configuration update_slack_channel_configuration ********************************** Chatbot.Client.update_slack_channel_configuration(**kwargs) Updates a Slack channel configuration. See also: AWS API Documentation **Request Syntax** response = client.update_slack_channel_configuration( ChatConfigurationArn='string', SlackChannelId='string', SlackChannelName='string', SnsTopicArns=[ 'string', ], IamRoleArn='string', LoggingLevel='string', GuardrailPolicyArns=[ 'string', ], UserAuthorizationRequired=True|False ) Parameters: * **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the SlackChannelConfiguration to update. * **SlackChannelId** (*string*) -- **[REQUIRED]** The ID of the Slack channel. To get this 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. * **SnsTopicArns** (*list*) -- The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. * *(string) --* * **IamRoleArn** (*string*) -- A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **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. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Amazon Chime. * **SlackChannelId** *(string) --* The ID of the Slack channel. To get this 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 Amazon Resource Name (ARN) of the SlackChannelConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.UpdateSlackChannelConfigurationExcept ion" Chatbot / Client / delete_custom_action delete_custom_action ******************** Chatbot.Client.delete_custom_action(**kwargs) Deletes a custom action. See also: AWS API Documentation **Request Syntax** response = client.delete_custom_action( CustomActionArn='string' ) Parameters: **CustomActionArn** (*string*) -- **[REQUIRED]** The fully defined ARN of the custom action. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / describe_slack_channel_configurations describe_slack_channel_configurations ************************************* Chatbot.Client.describe_slack_channel_configurations(**kwargs) Lists Slack channel configurations optionally filtered by ChatConfigurationArn See also: AWS API Documentation **Request Syntax** response = client.describe_slack_channel_configurations( MaxResults=123, NextToken='string', ChatConfigurationArn='string' ) Parameters: * **MaxResults** (*integer*) -- 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. * **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. * **ChatConfigurationArn** (*string*) -- An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration to describe. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Amazon Chime. * **SlackChannelId** *(string) --* The ID of the Slack channel. To get this 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 Amazon Resource Name (ARN) of the SlackChannelConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.DescribeSlackChannelConfigurationsExc eption" Chatbot / Client / tag_resource tag_resource ************ Chatbot.Client.tag_resource(**kwargs) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceARN='string', Tags=[ { 'TagKey': 'string', 'TagValue': 'string' }, ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the configuration. * **Tags** (*list*) -- **[REQUIRED]** A list of tags to apply to the configuration. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* **[REQUIRED]** The key of the tag. * **TagValue** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.ServiceUnavailableException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.TooManyTagsException" Chatbot / Client / update_microsoft_teams_channel_configuration update_microsoft_teams_channel_configuration ******************************************** Chatbot.Client.update_microsoft_teams_channel_configuration(**kwargs) Updates an Microsoft Teams channel configuration. See also: AWS API Documentation **Request Syntax** response = client.update_microsoft_teams_channel_configuration( ChatConfigurationArn='string', ChannelId='string', ChannelName='string', SnsTopicArns=[ 'string', ], IamRoleArn='string', LoggingLevel='string', GuardrailPolicyArns=[ 'string', ], UserAuthorizationRequired=True|False ) Parameters: * **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the TeamsChannelConfiguration to update. * **ChannelId** (*string*) -- **[REQUIRED]** The ID of the Microsoft Teams channel. * **ChannelName** (*string*) -- The name of the Microsoft Teams channel. * **SnsTopicArns** (*list*) -- The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. * *(string) --* * **IamRoleArn** (*string*) -- A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **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. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.UpdateTeamsChannelConfigurationExcept ion" Chatbot / Client / update_account_preferences update_account_preferences ************************** Chatbot.Client.update_account_preferences(**kwargs) Updates AWS Chatbot account preferences. See also: AWS API Documentation **Request Syntax** response = client.update_account_preferences( UserAuthorizationRequired=True|False, TrainingDataCollectionEnabled=True|False ) Parameters: * **UserAuthorizationRequired** (*boolean*) -- Enables use of a user role requirement in your chat configuration. * **TrainingDataCollectionEnabled** (*boolean*) -- Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot. Return type: dict Returns: **Response Syntax** { 'AccountPreferences': { 'UserAuthorizationRequired': True|False, 'TrainingDataCollectionEnabled': True|False } } **Response Structure** * *(dict) --* * **AccountPreferences** *(dict) --* Preferences related to AWS Chatbot usage in the calling AWS account. * **UserAuthorizationRequired** *(boolean) --* Enables use of a user role requirement in your chat configuration. * **TrainingDataCollectionEnabled** *(boolean) --* Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.UpdateAccountPreferencesException" Chatbot / Client / associate_to_configuration associate_to_configuration ************************** Chatbot.Client.associate_to_configuration(**kwargs) Links a resource (for example, a custom action) to a channel configuration. See also: AWS API Documentation **Request Syntax** response = client.associate_to_configuration( Resource='string', ChatConfiguration='string' ) Parameters: * **Resource** (*string*) -- **[REQUIRED]** The resource Amazon Resource Name (ARN) to link. * **ChatConfiguration** (*string*) -- **[REQUIRED]** The channel configuration to associate with the resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / get_custom_action get_custom_action ***************** Chatbot.Client.get_custom_action(**kwargs) Returns a custom action. See also: AWS API Documentation **Request Syntax** response = client.get_custom_action( CustomActionArn='string' ) Parameters: **CustomActionArn** (*string*) -- **[REQUIRED]** Returns the fully defined Amazon Resource Name (ARN) of the custom action. Return type: dict Returns: **Response Syntax** { 'CustomAction': { 'CustomActionArn': 'string', 'Definition': { 'CommandText': 'string' }, 'AliasName': 'string', 'Attachments': [ { 'NotificationType': 'string', 'ButtonText': 'string', 'Criteria': [ { 'Operator': 'HAS_VALUE'|'EQUALS', 'VariableName': 'string', 'Value': 'string' }, ], 'Variables': { 'string': 'string' } }, ], 'ActionName': 'string' } } **Response Structure** * *(dict) --* * **CustomAction** *(dict) --* Returns the custom action. * **CustomActionArn** *(string) --* The fully defined Amazon Resource Name (ARN) of the custom action. * **Definition** *(dict) --* The definition of the command to run when invoked an alias or as an action button. * **CommandText** *(string) --* The command string to run which may include variables by prefixing with a dollar sign ($). * **AliasName** *(string) --* The name used to invoke this action in the chat channel. For example, "@aws run my-alias". * **Attachments** *(list) --* Defines when this custom action button should be attached to a notification. * *(dict) --* Defines when a custom action button should be attached to a notification. * **NotificationType** *(string) --* The type of notification that the custom action should be attached to. * **ButtonText** *(string) --* The text of the button that appears on the notification. * **Criteria** *(list) --* The criteria for when a button should be shown based on values in the notification. * *(dict) --* A criteria for when a button should be shown based on values in the notification * **Operator** *(string) --* The operation to perform on the named variable. * **VariableName** *(string) --* The name of the variable to operate on. * **Value** *(string) --* A value that is compared with the actual value of the variable based on the behavior of the operator. * **Variables** *(dict) --* The variables to extract from the notification. * *(string) --* * *(string) --* * **ActionName** *(string) --* The name of the custom action that is included in the ARN. **Exceptions** * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.InternalServiceError" * "Chatbot.Client.exceptions.UnauthorizedException" Chatbot / Client / describe_chime_webhook_configurations describe_chime_webhook_configurations ************************************* Chatbot.Client.describe_chime_webhook_configurations(**kwargs) Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn See also: AWS API Documentation **Request Syntax** response = client.describe_chime_webhook_configurations( MaxResults=123, NextToken='string', ChatConfigurationArn='string' ) Parameters: * **MaxResults** (*integer*) -- 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. * **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. * **ChatConfigurationArn** (*string*) -- An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'WebhookConfigurations': [ { 'WebhookDescription': 'string', 'ChatConfigurationArn': 'string', 'IamRoleArn': 'string', 'SnsTopicArns': [ 'string', ], 'ConfigurationName': 'string', 'LoggingLevel': 'string', 'Tags': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'State': 'string', 'StateReason': '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 Amazon Chime webhooks associated with the account. * *(dict) --* An AWS Chatbot configuration for Amazon Chime. * **WebhookDescription** *(string) --* A description of the webhook. We recommend using the convention "RoomName/WebhookName". For more information, see Tutorial: Get started with Amazon Chime in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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". * **Tags** *(list) --* A map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.DescribeChimeWebhookConfigurationsExc eption" Chatbot / Client / list_microsoft_teams_channel_configurations list_microsoft_teams_channel_configurations ******************************************* Chatbot.Client.list_microsoft_teams_channel_configurations(**kwargs) Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account. See also: AWS API Documentation **Request Syntax** response = client.list_microsoft_teams_channel_configurations( MaxResults=123, NextToken='string', TeamId='string' ) Parameters: * **MaxResults** (*integer*) -- 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. * **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. * **TeamId** (*string*) -- The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.ListTeamsChannelConfigurationsExcepti on" * "Chatbot.Client.exceptions.InvalidRequestException" Chatbot / Client / delete_microsoft_teams_channel_configuration delete_microsoft_teams_channel_configuration ******************************************** Chatbot.Client.delete_microsoft_teams_channel_configuration(**kwargs) Deletes a Microsoft Teams channel configuration for AWS Chatbot See also: AWS API Documentation **Request Syntax** response = client.delete_microsoft_teams_channel_configuration( ChatConfigurationArn='string' ) Parameters: **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ResourceNotFoundException" * "Chatbot.Client.exceptions.DeleteTeamsChannelConfigurationExcept ion" Chatbot / Client / delete_microsoft_teams_configured_team delete_microsoft_teams_configured_team ************************************** Chatbot.Client.delete_microsoft_teams_configured_team(**kwargs) Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it. See also: AWS API Documentation **Request Syntax** response = client.delete_microsoft_teams_configured_team( TeamId='string' ) Parameters: **TeamId** (*string*) -- **[REQUIRED]** The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.DeleteTeamsConfiguredTeamException" Chatbot / Client / list_microsoft_teams_user_identities list_microsoft_teams_user_identities ************************************ Chatbot.Client.list_microsoft_teams_user_identities(**kwargs) A list all Microsoft Teams user identities with a mapped role. See also: AWS API Documentation **Request Syntax** response = client.list_microsoft_teams_user_identities( ChatConfigurationArn='string', NextToken='string', MaxResults=123 ) Parameters: * **ChatConfigurationArn** (*string*) -- The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list. * **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. * **MaxResults** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'TeamsUserIdentities': [ { 'IamRoleArn': 'string', 'ChatConfigurationArn': 'string', 'TeamId': 'string', 'UserId': 'string', 'AwsUserIdentity': 'string', 'TeamsChannelId': 'string', 'TeamsTenantId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TeamsUserIdentities** *(list) --* User level permissions associated to a channel configuration. * *(dict) --* Identifes a user level permission for a channel configuration. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **ChatConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **TeamId** *(string) --* The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the *AWS Chatbot Administrator Guide*. * **UserId** *(string) --* The Microsoft Teams user ID. * **AwsUserIdentity** *(string) --* The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role. * **TeamsChannelId** *(string) --* The ID of the Microsoft Teams channel. * **TeamsTenantId** *(string) --* The ID of the Microsoft Teams tenant. * **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. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.ListMicrosoftTeamsUserIdentitiesExcep tion" Chatbot / Client / get_microsoft_teams_channel_configuration get_microsoft_teams_channel_configuration ***************************************** Chatbot.Client.get_microsoft_teams_channel_configuration(**kwargs) Returns a Microsoft Teams channel configuration in an AWS account. See also: AWS API Documentation **Request Syntax** response = client.get_microsoft_teams_channel_configuration( ChatConfigurationArn='string' ) Parameters: **ChatConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve. Return type: 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' }, ], 'State': 'string', 'StateReason': '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 Teams 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 information, see Step 1: Configure a Microsoft Teams client 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. * **IamRoleArn** *(string) --* A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the *AWS Chatbot Administrator Guide*. * **SnsTopicArns** *(list) --* The Amazon Resource Names (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 map of tags assigned to a resource. A tag is a string- to-string map of key-value pairs. * *(dict) --* A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Warning: Do not include confidential or sensitive information in this field. For more information, see User-Defined Tag Restrictions in the *AWS Billing and Cost Management User Guide*. * **TagKey** *(string) --* The key of the tag. * **TagValue** *(string) --* The value of the tag. * **State** *(string) --* Either "ENABLED" or "DISABLED". The resource returns "DISABLED" if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. * **StateReason** *(string) --* Provided if State is "DISABLED". Provides context as to why the resource is disabled. **Exceptions** * "Chatbot.Client.exceptions.InvalidParameterException" * "Chatbot.Client.exceptions.InvalidRequestException" * "Chatbot.Client.exceptions.GetTeamsChannelConfigurationException"