ChatbotClient#
Auto-generated documentation for Chatbot type annotations stubs module mypy-boto3-chatbot.
ChatbotClient#
Type annotations and code completion for boto3.client("chatbot")
.
boto3 documentation
# ChatbotClient usage example
from boto3.session import Session
from mypy_boto3_chatbot.client import ChatbotClient
def get_chatbot_client() -> ChatbotClient:
return Session().client("chatbot")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("chatbot").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("chatbot")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.CreateChimeWebhookConfigurationException,
client.exceptions.CreateSlackChannelConfigurationException,
client.exceptions.CreateTeamsChannelConfigurationException,
client.exceptions.DeleteChimeWebhookConfigurationException,
client.exceptions.DeleteMicrosoftTeamsUserIdentityException,
client.exceptions.DeleteSlackChannelConfigurationException,
client.exceptions.DeleteSlackUserIdentityException,
client.exceptions.DeleteSlackWorkspaceAuthorizationFault,
client.exceptions.DeleteTeamsChannelConfigurationException,
client.exceptions.DeleteTeamsConfiguredTeamException,
client.exceptions.DescribeChimeWebhookConfigurationsException,
client.exceptions.DescribeSlackChannelConfigurationsException,
client.exceptions.DescribeSlackUserIdentitiesException,
client.exceptions.DescribeSlackWorkspacesException,
client.exceptions.GetAccountPreferencesException,
client.exceptions.GetTeamsChannelConfigurationException,
client.exceptions.InternalServiceError,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.ListMicrosoftTeamsConfiguredTeamsException,
client.exceptions.ListMicrosoftTeamsUserIdentitiesException,
client.exceptions.ListTeamsChannelConfigurationsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceUnavailableException,
client.exceptions.TooManyTagsException,
client.exceptions.UpdateAccountPreferencesException,
client.exceptions.UpdateChimeWebhookConfigurationException,
client.exceptions.UpdateSlackChannelConfigurationException,
client.exceptions.UpdateTeamsChannelConfigurationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_chatbot.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("chatbot").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("chatbot").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_chime_webhook_configuration#
Creates an AWS Chatbot configuration for Amazon Chime.
Type annotations and code completion for boto3.client("chatbot").create_chime_webhook_configuration
method.
boto3 documentation
# create_chime_webhook_configuration method definition
def create_chime_webhook_configuration(
self,
*,
WebhookDescription: str,
WebhookUrl: str,
SnsTopicArns: Sequence[str],
IamRoleArn: str,
ConfigurationName: str,
LoggingLevel: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateChimeWebhookConfigurationResultTypeDef: # (2)
...
# create_chime_webhook_configuration method usage example with argument unpacking
kwargs: CreateChimeWebhookConfigurationRequestRequestTypeDef = { # (1)
"WebhookDescription": ...,
"WebhookUrl": ...,
"SnsTopicArns": ...,
"IamRoleArn": ...,
"ConfigurationName": ...,
}
parent.create_chime_webhook_configuration(**kwargs)
create_microsoft_teams_channel_configuration#
Creates an AWS Chatbot configuration for Microsoft Teams.
Type annotations and code completion for boto3.client("chatbot").create_microsoft_teams_channel_configuration
method.
boto3 documentation
# create_microsoft_teams_channel_configuration method definition
def create_microsoft_teams_channel_configuration(
self,
*,
ChannelId: str,
TeamId: str,
TenantId: str,
IamRoleArn: str,
ConfigurationName: str,
ChannelName: str = ...,
TeamName: str = ...,
SnsTopicArns: Sequence[str] = ...,
LoggingLevel: str = ...,
GuardrailPolicyArns: Sequence[str] = ...,
UserAuthorizationRequired: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateTeamsChannelConfigurationResultTypeDef: # (2)
...
# create_microsoft_teams_channel_configuration method usage example with argument unpacking
kwargs: CreateTeamsChannelConfigurationRequestRequestTypeDef = { # (1)
"ChannelId": ...,
"TeamId": ...,
"TenantId": ...,
"IamRoleArn": ...,
"ConfigurationName": ...,
}
parent.create_microsoft_teams_channel_configuration(**kwargs)
create_slack_channel_configuration#
Creates an AWS Chatbot confugration for Slack.
Type annotations and code completion for boto3.client("chatbot").create_slack_channel_configuration
method.
boto3 documentation
# create_slack_channel_configuration method definition
def create_slack_channel_configuration(
self,
*,
SlackTeamId: str,
SlackChannelId: str,
IamRoleArn: str,
ConfigurationName: str,
SlackChannelName: str = ...,
SnsTopicArns: Sequence[str] = ...,
LoggingLevel: str = ...,
GuardrailPolicyArns: Sequence[str] = ...,
UserAuthorizationRequired: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSlackChannelConfigurationResultTypeDef: # (2)
...
# create_slack_channel_configuration method usage example with argument unpacking
kwargs: CreateSlackChannelConfigurationRequestRequestTypeDef = { # (1)
"SlackTeamId": ...,
"SlackChannelId": ...,
"IamRoleArn": ...,
"ConfigurationName": ...,
}
parent.create_slack_channel_configuration(**kwargs)
delete_chime_webhook_configuration#
Deletes a Amazon Chime webhook configuration for AWS Chatbot.
Type annotations and code completion for boto3.client("chatbot").delete_chime_webhook_configuration
method.
boto3 documentation
# delete_chime_webhook_configuration method definition
def delete_chime_webhook_configuration(
self,
*,
ChatConfigurationArn: str,
) -> Dict[str, Any]:
...
# delete_chime_webhook_configuration method usage example with argument unpacking
kwargs: DeleteChimeWebhookConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.delete_chime_webhook_configuration(**kwargs)
delete_microsoft_teams_channel_configuration#
Deletes a Microsoft Teams channel configuration for AWS Chatbot See also: AWS API Documentation.
Type annotations and code completion for boto3.client("chatbot").delete_microsoft_teams_channel_configuration
method.
boto3 documentation
# delete_microsoft_teams_channel_configuration method definition
def delete_microsoft_teams_channel_configuration(
self,
*,
ChatConfigurationArn: str,
) -> Dict[str, Any]:
...
# delete_microsoft_teams_channel_configuration method usage example with argument unpacking
kwargs: DeleteTeamsChannelConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.delete_microsoft_teams_channel_configuration(**kwargs)
delete_microsoft_teams_configured_team#
Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team.
Type annotations and code completion for boto3.client("chatbot").delete_microsoft_teams_configured_team
method.
boto3 documentation
# delete_microsoft_teams_configured_team method definition
def delete_microsoft_teams_configured_team(
self,
*,
TeamId: str,
) -> Dict[str, Any]:
...
# delete_microsoft_teams_configured_team method usage example with argument unpacking
kwargs: DeleteTeamsConfiguredTeamRequestRequestTypeDef = { # (1)
"TeamId": ...,
}
parent.delete_microsoft_teams_configured_team(**kwargs)
delete_microsoft_teams_user_identity#
Identifes a user level permission for a channel configuration.
Type annotations and code completion for boto3.client("chatbot").delete_microsoft_teams_user_identity
method.
boto3 documentation
# delete_microsoft_teams_user_identity method definition
def delete_microsoft_teams_user_identity(
self,
*,
ChatConfigurationArn: str,
UserId: str,
) -> Dict[str, Any]:
...
# delete_microsoft_teams_user_identity method usage example with argument unpacking
kwargs: DeleteMicrosoftTeamsUserIdentityRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
"UserId": ...,
}
parent.delete_microsoft_teams_user_identity(**kwargs)
delete_slack_channel_configuration#
Deletes a Slack channel configuration for AWS Chatbot See also: AWS API Documentation.
Type annotations and code completion for boto3.client("chatbot").delete_slack_channel_configuration
method.
boto3 documentation
# delete_slack_channel_configuration method definition
def delete_slack_channel_configuration(
self,
*,
ChatConfigurationArn: str,
) -> Dict[str, Any]:
...
# delete_slack_channel_configuration method usage example with argument unpacking
kwargs: DeleteSlackChannelConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.delete_slack_channel_configuration(**kwargs)
delete_slack_user_identity#
Deletes a user level permission for a Slack channel configuration.
Type annotations and code completion for boto3.client("chatbot").delete_slack_user_identity
method.
boto3 documentation
# delete_slack_user_identity method definition
def delete_slack_user_identity(
self,
*,
ChatConfigurationArn: str,
SlackTeamId: str,
SlackUserId: str,
) -> Dict[str, Any]:
...
# delete_slack_user_identity method usage example with argument unpacking
kwargs: DeleteSlackUserIdentityRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
"SlackTeamId": ...,
"SlackUserId": ...,
}
parent.delete_slack_user_identity(**kwargs)
delete_slack_workspace_authorization#
Deletes the Slack workspace authorization that allows channels to be configured in that workspace.
Type annotations and code completion for boto3.client("chatbot").delete_slack_workspace_authorization
method.
boto3 documentation
# delete_slack_workspace_authorization method definition
def delete_slack_workspace_authorization(
self,
*,
SlackTeamId: str,
) -> Dict[str, Any]:
...
# delete_slack_workspace_authorization method usage example with argument unpacking
kwargs: DeleteSlackWorkspaceAuthorizationRequestRequestTypeDef = { # (1)
"SlackTeamId": ...,
}
parent.delete_slack_workspace_authorization(**kwargs)
describe_chime_webhook_configurations#
Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn See also: AWS API Documentation.
Type annotations and code completion for boto3.client("chatbot").describe_chime_webhook_configurations
method.
boto3 documentation
# describe_chime_webhook_configurations method definition
def describe_chime_webhook_configurations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
ChatConfigurationArn: str = ...,
) -> DescribeChimeWebhookConfigurationsResultTypeDef: # (1)
...
# describe_chime_webhook_configurations method usage example with argument unpacking
kwargs: DescribeChimeWebhookConfigurationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_chime_webhook_configurations(**kwargs)
describe_slack_channel_configurations#
Lists Slack channel configurations optionally filtered by ChatConfigurationArn See also: AWS API Documentation.
Type annotations and code completion for boto3.client("chatbot").describe_slack_channel_configurations
method.
boto3 documentation
# describe_slack_channel_configurations method definition
def describe_slack_channel_configurations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
ChatConfigurationArn: str = ...,
) -> DescribeSlackChannelConfigurationsResultTypeDef: # (1)
...
# describe_slack_channel_configurations method usage example with argument unpacking
kwargs: DescribeSlackChannelConfigurationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_slack_channel_configurations(**kwargs)
describe_slack_user_identities#
Lists all Slack user identities with a mapped role.
Type annotations and code completion for boto3.client("chatbot").describe_slack_user_identities
method.
boto3 documentation
# describe_slack_user_identities method definition
def describe_slack_user_identities(
self,
*,
ChatConfigurationArn: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeSlackUserIdentitiesResultTypeDef: # (1)
...
# describe_slack_user_identities method usage example with argument unpacking
kwargs: DescribeSlackUserIdentitiesRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.describe_slack_user_identities(**kwargs)
describe_slack_workspaces#
List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.
Type annotations and code completion for boto3.client("chatbot").describe_slack_workspaces
method.
boto3 documentation
# describe_slack_workspaces method definition
def describe_slack_workspaces(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeSlackWorkspacesResultTypeDef: # (1)
...
# describe_slack_workspaces method usage example with argument unpacking
kwargs: DescribeSlackWorkspacesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_slack_workspaces(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("chatbot").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_account_preferences#
Returns AWS Chatbot account preferences.
Type annotations and code completion for boto3.client("chatbot").get_account_preferences
method.
boto3 documentation
# get_account_preferences method definition
def get_account_preferences(
self,
) -> GetAccountPreferencesResultTypeDef: # (1)
...
get_microsoft_teams_channel_configuration#
Returns a Microsoft Teams channel configuration in an AWS account.
Type annotations and code completion for boto3.client("chatbot").get_microsoft_teams_channel_configuration
method.
boto3 documentation
# get_microsoft_teams_channel_configuration method definition
def get_microsoft_teams_channel_configuration(
self,
*,
ChatConfigurationArn: str,
) -> GetTeamsChannelConfigurationResultTypeDef: # (1)
...
# get_microsoft_teams_channel_configuration method usage example with argument unpacking
kwargs: GetTeamsChannelConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.get_microsoft_teams_channel_configuration(**kwargs)
list_microsoft_teams_channel_configurations#
Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.
Type annotations and code completion for boto3.client("chatbot").list_microsoft_teams_channel_configurations
method.
boto3 documentation
# list_microsoft_teams_channel_configurations method definition
def list_microsoft_teams_channel_configurations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
TeamId: str = ...,
) -> ListTeamsChannelConfigurationsResultTypeDef: # (1)
...
# list_microsoft_teams_channel_configurations method usage example with argument unpacking
kwargs: ListTeamsChannelConfigurationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_microsoft_teams_channel_configurations(**kwargs)
list_microsoft_teams_configured_teams#
Lists all authorized Microsoft Teams for an AWS Account See also: AWS API Documentation.
Type annotations and code completion for boto3.client("chatbot").list_microsoft_teams_configured_teams
method.
boto3 documentation
# list_microsoft_teams_configured_teams method definition
def list_microsoft_teams_configured_teams(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMicrosoftTeamsConfiguredTeamsResultTypeDef: # (1)
...
# list_microsoft_teams_configured_teams method usage example with argument unpacking
kwargs: ListMicrosoftTeamsConfiguredTeamsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_microsoft_teams_configured_teams(**kwargs)
list_microsoft_teams_user_identities#
A list all Microsoft Teams user identities with a mapped role.
Type annotations and code completion for boto3.client("chatbot").list_microsoft_teams_user_identities
method.
boto3 documentation
# list_microsoft_teams_user_identities method definition
def list_microsoft_teams_user_identities(
self,
*,
ChatConfigurationArn: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListMicrosoftTeamsUserIdentitiesResultTypeDef: # (1)
...
# list_microsoft_teams_user_identities method usage example with argument unpacking
kwargs: ListMicrosoftTeamsUserIdentitiesRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.list_microsoft_teams_user_identities(**kwargs)
list_tags_for_resource#
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
Type annotations and code completion for boto3.client("chatbot").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource#
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("chatbot").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("chatbot").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_account_preferences#
Updates AWS Chatbot account preferences.
Type annotations and code completion for boto3.client("chatbot").update_account_preferences
method.
boto3 documentation
# update_account_preferences method definition
def update_account_preferences(
self,
*,
UserAuthorizationRequired: bool = ...,
TrainingDataCollectionEnabled: bool = ...,
) -> UpdateAccountPreferencesResultTypeDef: # (1)
...
# update_account_preferences method usage example with argument unpacking
kwargs: UpdateAccountPreferencesRequestRequestTypeDef = { # (1)
"UserAuthorizationRequired": ...,
}
parent.update_account_preferences(**kwargs)
update_chime_webhook_configuration#
Updates a Amazon Chime webhook configuration.
Type annotations and code completion for boto3.client("chatbot").update_chime_webhook_configuration
method.
boto3 documentation
# update_chime_webhook_configuration method definition
def update_chime_webhook_configuration(
self,
*,
ChatConfigurationArn: str,
WebhookDescription: str = ...,
WebhookUrl: str = ...,
SnsTopicArns: Sequence[str] = ...,
IamRoleArn: str = ...,
LoggingLevel: str = ...,
) -> UpdateChimeWebhookConfigurationResultTypeDef: # (1)
...
# update_chime_webhook_configuration method usage example with argument unpacking
kwargs: UpdateChimeWebhookConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
}
parent.update_chime_webhook_configuration(**kwargs)
update_microsoft_teams_channel_configuration#
Updates an Microsoft Teams channel configuration.
Type annotations and code completion for boto3.client("chatbot").update_microsoft_teams_channel_configuration
method.
boto3 documentation
# update_microsoft_teams_channel_configuration method definition
def update_microsoft_teams_channel_configuration(
self,
*,
ChatConfigurationArn: str,
ChannelId: str,
ChannelName: str = ...,
SnsTopicArns: Sequence[str] = ...,
IamRoleArn: str = ...,
LoggingLevel: str = ...,
GuardrailPolicyArns: Sequence[str] = ...,
UserAuthorizationRequired: bool = ...,
) -> UpdateTeamsChannelConfigurationResultTypeDef: # (1)
...
# update_microsoft_teams_channel_configuration method usage example with argument unpacking
kwargs: UpdateTeamsChannelConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
"ChannelId": ...,
}
parent.update_microsoft_teams_channel_configuration(**kwargs)
update_slack_channel_configuration#
Updates a Slack channel configuration.
Type annotations and code completion for boto3.client("chatbot").update_slack_channel_configuration
method.
boto3 documentation
# update_slack_channel_configuration method definition
def update_slack_channel_configuration(
self,
*,
ChatConfigurationArn: str,
SlackChannelId: str,
SlackChannelName: str = ...,
SnsTopicArns: Sequence[str] = ...,
IamRoleArn: str = ...,
LoggingLevel: str = ...,
GuardrailPolicyArns: Sequence[str] = ...,
UserAuthorizationRequired: bool = ...,
) -> UpdateSlackChannelConfigurationResultTypeDef: # (1)
...
# update_slack_channel_configuration method usage example with argument unpacking
kwargs: UpdateSlackChannelConfigurationRequestRequestTypeDef = { # (1)
"ChatConfigurationArn": ...,
"SlackChannelId": ...,
}
parent.update_slack_channel_configuration(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("chatbot").get_paginator
method with overloads.
client.get_paginator("describe_chime_webhook_configurations")
-> DescribeChimeWebhookConfigurationsPaginatorclient.get_paginator("describe_slack_channel_configurations")
-> DescribeSlackChannelConfigurationsPaginatorclient.get_paginator("describe_slack_user_identities")
-> DescribeSlackUserIdentitiesPaginatorclient.get_paginator("describe_slack_workspaces")
-> DescribeSlackWorkspacesPaginatorclient.get_paginator("list_microsoft_teams_channel_configurations")
-> ListMicrosoftTeamsChannelConfigurationsPaginatorclient.get_paginator("list_microsoft_teams_configured_teams")
-> ListMicrosoftTeamsConfiguredTeamsPaginatorclient.get_paginator("list_microsoft_teams_user_identities")
-> ListMicrosoftTeamsUserIdentitiesPaginator