2024/02/19 - chatbot - 23 new api methods
Changes This release adds support for AWS Chatbot. You can now monitor, operate, and troubleshoot your AWS resources with interactive ChatOps using the AWS SDK.
Deletes a Slack user identity
See also: AWS API Documentation
Request Syntax
client.delete_slack_user_identity(
ChatConfigurationArn='string',
SlackTeamId='string',
SlackUserId='string'
)
string
[REQUIRED] The ARN of the SlackChannelConfiguration associated with the user identity to delete.
string
[REQUIRED] The ID of the Slack workspace authorized with AWS Chatbot.
string
[REQUIRED] The ID of the user in Slack.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all Microsoft Teams user identities with a mapped role.
See also: AWS API Documentation
Request Syntax
client.list_microsoft_teams_user_identities(
ChatConfigurationArn='string',
NextToken='string',
MaxResults=123
)
string
The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.
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.
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.
dict
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) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity.
TeamId (string) -- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
UserId (string) -- Id from Microsoft Teams for user.
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.
Deletes Slack Channel Configuration
See also: AWS API Documentation
Request Syntax
client.delete_slack_channel_configuration(
ChatConfigurationArn='string'
)
string
[REQUIRED] The ARN of the SlackChannelConfiguration to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn
See also: AWS API Documentation
Request Syntax
client.describe_slack_channel_configurations(
MaxResults=123,
NextToken='string',
ChatConfigurationArn='string'
)
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.
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.
string
An optional ARN of a SlackChannelConfiguration to describe.
dict
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
},
]
}
Response Structure
(dict) --
NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
SlackChannelConfigurations (list) -- A list of Slack channel configurations.
(dict) -- An AWS Chatbot configuration for Slack.
SlackTeamName (string) -- Name of the Slack Workspace.
SlackTeamId (string) -- The ID of the Slack workspace authorized with AWS Chatbot.
SlackChannelId (string) -- The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
SlackChannelName (string) -- The name of the Slack Channel.
ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
Creates MS Teams Channel Configuration
See also: AWS API Documentation
Request Syntax
client.create_microsoft_teams_channel_configuration(
ChannelId='string',
ChannelName='string',
TeamId='string',
TeamName='string',
TenantId='string',
SnsTopicArns=[
'string',
],
IamRoleArn='string',
ConfigurationName='string',
LoggingLevel='string',
GuardrailPolicyArns=[
'string',
],
UserAuthorizationRequired=True|False
)
string
[REQUIRED] The ID of the Microsoft Teams channel.
string
The name of the Microsoft Teams channel.
string
[REQUIRED] The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
string
The name of the Microsoft Teams Team.
string
[REQUIRED] The ID of the Microsoft Teams tenant.
list
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
string
[REQUIRED] The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
string
[REQUIRED] The name of the configuration.
string
Logging levels include ERROR, INFO, or NONE.
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) --
boolean
Enables use of a user role requirement in your chat configuration.
dict
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
}
}
Response Structure
(dict) --
ChannelConfiguration (dict) -- The configuration for a Microsoft Teams channel configured with AWS Chatbot.
ChannelId (string) -- The ID of the Microsoft Teams channel.
ChannelName (string) -- The name of the Microsoft Teams channel.
TeamId (string) -- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
TeamName (string) -- The name of the Microsoft Teams Team.
TenantId (string) -- The ID of the Microsoft Teams tenant.
ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
Get Chatbot account level preferences
See also: AWS API Documentation
Request Syntax
client.get_account_preferences()
dict
Response Syntax
{
'AccountPreferences': {
'UserAuthorizationRequired': True|False,
'TrainingDataCollectionEnabled': True|False
}
}
Response Structure
(dict) --
AccountPreferences (dict) -- Preferences which apply for 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 AWS Chatbot’s AI technologies.
Lists all Slack user identities with a mapped role.
See also: AWS API Documentation
Request Syntax
client.describe_slack_user_identities(
ChatConfigurationArn='string',
NextToken='string',
MaxResults=123
)
string
The ARN of the SlackChannelConfiguration associated with the user identities to describe.
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.
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.
dict
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) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration associated with the user identity.
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 Identity 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.
Updates Slack Channel Configuration
See also: AWS API Documentation
Request Syntax
client.update_slack_channel_configuration(
ChatConfigurationArn='string',
SlackChannelId='string',
SlackChannelName='string',
SnsTopicArns=[
'string',
],
IamRoleArn='string',
LoggingLevel='string',
GuardrailPolicyArns=[
'string',
],
UserAuthorizationRequired=True|False
)
string
[REQUIRED] The ARN of the SlackChannelConfiguration to update.
string
[REQUIRED] The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
string
The name of the Slack Channel.
list
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
string
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
string
Logging levels include ERROR, INFO, or NONE.
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) --
boolean
Enables use of a user role requirement in your chat configuration.
dict
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
}
}
Response Structure
(dict) --
ChannelConfiguration (dict) -- The configuration for a Slack channel configured with AWS Chatbot.
SlackTeamName (string) -- Name of the Slack Workspace.
SlackTeamId (string) -- The ID of the Slack workspace authorized with AWS Chatbot.
SlackChannelId (string) -- The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
SlackChannelName (string) -- The name of the Slack Channel.
ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
Lists all authorized Slack Workspaces for AWS Account
See also: AWS API Documentation
Request Syntax
client.describe_slack_workspaces(
MaxResults=123,
NextToken='string'
)
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.
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.
dict
Response Syntax
{
'SlackWorkspaces': [
{
'SlackTeamId': 'string',
'SlackTeamName': '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) -- Name of the Slack Workspace.
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.
Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn
See also: AWS API Documentation
Request Syntax
client.describe_chime_webhook_configurations(
MaxResults=123,
NextToken='string',
ChatConfigurationArn='string'
)
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.
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.
string
An optional ARN of a ChimeWebhookConfiguration to describe.
dict
Response Syntax
{
'NextToken': 'string',
'WebhookConfigurations': [
{
'WebhookDescription': 'string',
'ChatConfigurationArn': 'string',
'IamRoleArn': 'string',
'SnsTopicArns': [
'string',
],
'ConfigurationName': 'string',
'LoggingLevel': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
WebhookConfigurations (list) -- A list of Chime webhooks associated with the account.
(dict) -- An AWS Chatbot configuration for Amazon Chime.
WebhookDescription (string) -- Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
ChatConfigurationArn (string) -- The ARN of the ChimeWebhookConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
Updates a Chime Webhook Configuration
See also: AWS API Documentation
Request Syntax
client.update_chime_webhook_configuration(
ChatConfigurationArn='string',
WebhookDescription='string',
WebhookUrl='string',
SnsTopicArns=[
'string',
],
IamRoleArn='string',
LoggingLevel='string'
)
string
[REQUIRED] The ARN of the ChimeWebhookConfiguration to update.
string
Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
string
URL for the Chime webhook.
list
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
string
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
string
Logging levels include ERROR, INFO, or NONE.
dict
Response Syntax
{
'WebhookConfiguration': {
'WebhookDescription': 'string',
'ChatConfigurationArn': 'string',
'IamRoleArn': 'string',
'SnsTopicArns': [
'string',
],
'ConfigurationName': 'string',
'LoggingLevel': 'string'
}
}
Response Structure
(dict) --
WebhookConfiguration (dict) -- Chime webhook configuration.
WebhookDescription (string) -- Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
ChatConfigurationArn (string) -- The ARN of the ChimeWebhookConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
Creates Chime Webhook Configuration
See also: AWS API Documentation
Request Syntax
client.create_chime_webhook_configuration(
WebhookDescription='string',
WebhookUrl='string',
SnsTopicArns=[
'string',
],
IamRoleArn='string',
ConfigurationName='string',
LoggingLevel='string'
)
string
[REQUIRED] Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
string
[REQUIRED] URL for the Chime webhook.
list
[REQUIRED] The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
string
[REQUIRED] This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
string
[REQUIRED] The name of the configuration.
string
Logging levels include ERROR, INFO, or NONE.
dict
Response Syntax
{
'WebhookConfiguration': {
'WebhookDescription': 'string',
'ChatConfigurationArn': 'string',
'IamRoleArn': 'string',
'SnsTopicArns': [
'string',
],
'ConfigurationName': 'string',
'LoggingLevel': 'string'
}
}
Response Structure
(dict) --
WebhookConfiguration (dict) -- Chime webhook configuration.
WebhookDescription (string) -- Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
ChatConfigurationArn (string) -- The ARN of the ChimeWebhookConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.
Deletes a Teams user identity
See also: AWS API Documentation
Request Syntax
client.delete_microsoft_teams_user_identity(
ChatConfigurationArn='string',
UserId='string'
)
string
[REQUIRED] The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
string
[REQUIRED] Id from Microsoft Teams for user.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates Slack Channel Configuration
See also: AWS API Documentation
Request Syntax
client.create_slack_channel_configuration(
SlackTeamId='string',
SlackChannelId='string',
SlackChannelName='string',
SnsTopicArns=[
'string',
],
IamRoleArn='string',
ConfigurationName='string',
LoggingLevel='string',
GuardrailPolicyArns=[
'string',
],
UserAuthorizationRequired=True|False
)
string
[REQUIRED] The ID of the Slack workspace authorized with AWS Chatbot.
string
[REQUIRED] The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
string
The name of the Slack Channel.
list
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
string
[REQUIRED] The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
string
[REQUIRED] The name of the configuration.
string
Logging levels include ERROR, INFO, or NONE.
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) --
boolean
Enables use of a user role requirement in your chat configuration.
dict
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
}
}
Response Structure
(dict) --
ChannelConfiguration (dict) -- The configuration for a Slack channel configured with AWS Chatbot.
SlackTeamName (string) -- Name of the Slack Workspace.
SlackTeamId (string) -- The ID of the Slack workspace authorized with AWS Chatbot.
SlackChannelId (string) -- The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
SlackChannelName (string) -- The name of the Slack Channel.
ChatConfigurationArn (string) -- The ARN of the SlackChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
Get a single MS Teams Channel Configurations
See also: AWS API Documentation
Request Syntax
client.get_microsoft_teams_channel_configuration(
ChatConfigurationArn='string'
)
string
[REQUIRED] The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
dict
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
}
}
Response Structure
(dict) --
ChannelConfiguration (dict) -- The configuration for a Microsoft Teams channel configured with AWS Chatbot.
ChannelId (string) -- The ID of the Microsoft Teams channel.
ChannelName (string) -- The name of the Microsoft Teams channel.
TeamId (string) -- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
TeamName (string) -- The name of the Microsoft Teams Team.
TenantId (string) -- The ID of the Microsoft Teams tenant.
ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
Deletes a Chime Webhook Configuration
See also: AWS API Documentation
Request Syntax
client.delete_chime_webhook_configuration(
ChatConfigurationArn='string'
)
string
[REQUIRED] The ARN of the ChimeWebhookConfiguration to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates MS Teams Channel Configuration
See also: AWS API Documentation
Request Syntax
client.update_microsoft_teams_channel_configuration(
ChatConfigurationArn='string',
ChannelId='string',
ChannelName='string',
SnsTopicArns=[
'string',
],
IamRoleArn='string',
LoggingLevel='string',
GuardrailPolicyArns=[
'string',
],
UserAuthorizationRequired=True|False
)
string
[REQUIRED] The ARN of the MicrosoftTeamsChannelConfiguration to update.
string
[REQUIRED] The ID of the Microsoft Teams channel.
string
The name of the Microsoft Teams channel.
list
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
string
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
string
Logging levels include ERROR, INFO, or NONE.
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) --
boolean
Enables use of a user role requirement in your chat configuration.
dict
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
}
}
Response Structure
(dict) --
ChannelConfiguration (dict) -- The configuration for a Microsoft Teams channel configured with AWS Chatbot.
ChannelId (string) -- The ID of the Microsoft Teams channel.
ChannelName (string) -- The name of the Microsoft Teams channel.
TeamId (string) -- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
TeamName (string) -- The name of the Microsoft Teams Team.
TenantId (string) -- The ID of the Microsoft Teams tenant.
ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
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
client.delete_microsoft_teams_configured_team(
TeamId='string'
)
string
[REQUIRED] The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes MS Teams Channel Configuration
See also: AWS API Documentation
Request Syntax
client.delete_microsoft_teams_channel_configuration(
ChatConfigurationArn='string'
)
string
[REQUIRED] The ARN of the MicrosoftTeamsChannelConfiguration to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.delete_slack_workspace_authorization(
SlackTeamId='string'
)
string
[REQUIRED] The ID of the Slack workspace authorized with AWS Chatbot.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists MS Teams Channel Configurations optionally filtered by TeamId
See also: AWS API Documentation
Request Syntax
client.list_microsoft_teams_channel_configurations(
MaxResults=123,
NextToken='string',
TeamId='string'
)
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.
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.
string
The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
dict
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
},
]
}
Response Structure
(dict) --
NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
TeamChannelConfigurations (list) -- A list of AWS Chatbot channel configurations for Microsoft Teams.
(dict) -- An AWS Chatbot configuration for Microsoft Teams.
ChannelId (string) -- The ID of the Microsoft Teams channel.
ChannelName (string) -- The name of the Microsoft Teams channel.
TeamId (string) -- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
TeamName (string) -- The name of the Microsoft Teams Team.
TenantId (string) -- The ID of the Microsoft Teams tenant.
ChatConfigurationArn (string) -- The ARN of the MicrosoftTeamsChannelConfiguration.
IamRoleArn (string) -- The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
SnsTopicArns (list) -- The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
(string) --
ConfigurationName (string) -- The name of the configuration.
LoggingLevel (string) -- Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) -- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set.
(string) --
UserAuthorizationRequired (boolean) -- Enables use of a user role requirement in your chat configuration.
Update Chatbot account level preferences
See also: AWS API Documentation
Request Syntax
client.update_account_preferences(
UserAuthorizationRequired=True|False,
TrainingDataCollectionEnabled=True|False
)
boolean
Enables use of a user role requirement in your chat configuration.
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 AWS Chatbot’s AI technologies.
dict
Response Syntax
{
'AccountPreferences': {
'UserAuthorizationRequired': True|False,
'TrainingDataCollectionEnabled': True|False
}
}
Response Structure
(dict) --
AccountPreferences (dict) -- Preferences which apply for 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 AWS Chatbot’s AI technologies.
Lists all authorized MS teams for AWS Account
See also: AWS API Documentation
Request Syntax
client.list_microsoft_teams_configured_teams(
MaxResults=123,
NextToken='string'
)
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.
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.
dict
Response Syntax
{
'ConfiguredTeams': [
{
'TenantId': 'string',
'TeamId': 'string',
'TeamName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConfiguredTeams (list) -- A list of teams in Microsoft Teams that have been configured with AWS Chatbot.
(dict) -- A Microsoft Teams team that has been authorized with AWS Chatbot.
TenantId (string) -- The ID of the Microsoft Teams tenant.
TeamId (string) -- The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
TeamName (string) -- The name of the Microsoft Teams Team.
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.