Skip to content

ChatbotClient#

Index > Chatbot > 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.InvalidParameterException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.ListMicrosoftTeamsConfiguredTeamsException,
    client.exceptions.ListMicrosoftTeamsUserIdentitiesException,
    client.exceptions.ListTeamsChannelConfigurationsException,
    client.exceptions.ResourceNotFoundException,
    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 Chime Webhook Configuration See also: AWS API Documentation.

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 = ...,
) -> CreateChimeWebhookConfigurationResultTypeDef:  # (1)
    ...
  1. See CreateChimeWebhookConfigurationResultTypeDef 
# create_chime_webhook_configuration method usage example with argument unpacking

kwargs: CreateChimeWebhookConfigurationRequestRequestTypeDef = {  # (1)
    "WebhookDescription": ...,
    "WebhookUrl": ...,
    "SnsTopicArns": ...,
    "IamRoleArn": ...,
    "ConfigurationName": ...,
}

parent.create_chime_webhook_configuration(**kwargs)
  1. See CreateChimeWebhookConfigurationRequestRequestTypeDef

create_microsoft_teams_channel_configuration#

Creates MS Teams Channel Configuration See also: AWS API Documentation.

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 = ...,
) -> CreateTeamsChannelConfigurationResultTypeDef:  # (1)
    ...
  1. See CreateTeamsChannelConfigurationResultTypeDef 
# 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)
  1. See CreateTeamsChannelConfigurationRequestRequestTypeDef

create_slack_channel_configuration#

Creates Slack Channel Configuration See also: AWS API Documentation.

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 = ...,
) -> CreateSlackChannelConfigurationResultTypeDef:  # (1)
    ...
  1. See CreateSlackChannelConfigurationResultTypeDef 
# create_slack_channel_configuration method usage example with argument unpacking

kwargs: CreateSlackChannelConfigurationRequestRequestTypeDef = {  # (1)
    "SlackTeamId": ...,
    "SlackChannelId": ...,
    "IamRoleArn": ...,
    "ConfigurationName": ...,
}

parent.create_slack_channel_configuration(**kwargs)
  1. See CreateSlackChannelConfigurationRequestRequestTypeDef

delete_chime_webhook_configuration#

Deletes a Chime Webhook Configuration See also: AWS API Documentation.

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)
  1. See DeleteChimeWebhookConfigurationRequestRequestTypeDef

delete_microsoft_teams_channel_configuration#

Deletes MS Teams Channel Configuration 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)
  1. See DeleteTeamsChannelConfigurationRequestRequestTypeDef

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)
  1. See DeleteTeamsConfiguredTeamRequestRequestTypeDef

delete_microsoft_teams_user_identity#

Deletes a Teams user identity See also: AWS API Documentation.

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)
  1. See DeleteMicrosoftTeamsUserIdentityRequestRequestTypeDef

delete_slack_channel_configuration#

Deletes Slack Channel Configuration 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)
  1. See DeleteSlackChannelConfigurationRequestRequestTypeDef

delete_slack_user_identity#

Deletes a Slack user identity See also: AWS API Documentation.

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)
  1. See DeleteSlackUserIdentityRequestRequestTypeDef

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)
  1. See DeleteSlackWorkspaceAuthorizationRequestRequestTypeDef

describe_chime_webhook_configurations#

Lists 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)
    ...
  1. See DescribeChimeWebhookConfigurationsResultTypeDef 
# describe_chime_webhook_configurations method usage example with argument unpacking

kwargs: DescribeChimeWebhookConfigurationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_chime_webhook_configurations(**kwargs)
  1. See DescribeChimeWebhookConfigurationsRequestRequestTypeDef

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)
    ...
  1. See DescribeSlackChannelConfigurationsResultTypeDef 
# describe_slack_channel_configurations method usage example with argument unpacking

kwargs: DescribeSlackChannelConfigurationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_slack_channel_configurations(**kwargs)
  1. See DescribeSlackChannelConfigurationsRequestRequestTypeDef

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)
    ...
  1. See DescribeSlackUserIdentitiesResultTypeDef 
# describe_slack_user_identities method usage example with argument unpacking

kwargs: DescribeSlackUserIdentitiesRequestRequestTypeDef = {  # (1)
    "ChatConfigurationArn": ...,
}

parent.describe_slack_user_identities(**kwargs)
  1. See DescribeSlackUserIdentitiesRequestRequestTypeDef

describe_slack_workspaces#

Lists all authorized Slack Workspaces for AWS Account See also: AWS API Documentation.

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)
    ...
  1. See DescribeSlackWorkspacesResultTypeDef 
# describe_slack_workspaces method usage example with argument unpacking

kwargs: DescribeSlackWorkspacesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_slack_workspaces(**kwargs)
  1. See DescribeSlackWorkspacesRequestRequestTypeDef

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#

Get Chatbot account level preferences See also: AWS API Documentation.

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)
    ...
  1. See GetAccountPreferencesResultTypeDef

get_microsoft_teams_channel_configuration#

Get a single MS Teams Channel Configurations See also: AWS API Documentation.

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)
    ...
  1. See GetTeamsChannelConfigurationResultTypeDef 
# get_microsoft_teams_channel_configuration method usage example with argument unpacking

kwargs: GetTeamsChannelConfigurationRequestRequestTypeDef = {  # (1)
    "ChatConfigurationArn": ...,
}

parent.get_microsoft_teams_channel_configuration(**kwargs)
  1. See GetTeamsChannelConfigurationRequestRequestTypeDef

list_microsoft_teams_channel_configurations#

Lists MS Teams Channel Configurations optionally filtered by TeamId See also: AWS API Documentation.

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)
    ...
  1. See ListTeamsChannelConfigurationsResultTypeDef 
# list_microsoft_teams_channel_configurations method usage example with argument unpacking

kwargs: ListTeamsChannelConfigurationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_microsoft_teams_channel_configurations(**kwargs)
  1. See ListTeamsChannelConfigurationsRequestRequestTypeDef

list_microsoft_teams_configured_teams#

Lists all authorized MS teams for 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)
    ...
  1. See ListMicrosoftTeamsConfiguredTeamsResultTypeDef 
# list_microsoft_teams_configured_teams method usage example with argument unpacking

kwargs: ListMicrosoftTeamsConfiguredTeamsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_microsoft_teams_configured_teams(**kwargs)
  1. See ListMicrosoftTeamsConfiguredTeamsRequestRequestTypeDef

list_microsoft_teams_user_identities#

Lists 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)
    ...
  1. See ListMicrosoftTeamsUserIdentitiesResultTypeDef 
# list_microsoft_teams_user_identities method usage example with argument unpacking

kwargs: ListMicrosoftTeamsUserIdentitiesRequestRequestTypeDef = {  # (1)
    "ChatConfigurationArn": ...,
}

parent.list_microsoft_teams_user_identities(**kwargs)
  1. See ListMicrosoftTeamsUserIdentitiesRequestRequestTypeDef

update_account_preferences#

Update Chatbot account level preferences See also: AWS API Documentation.

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)
    ...
  1. See UpdateAccountPreferencesResultTypeDef 
# update_account_preferences method usage example with argument unpacking

kwargs: UpdateAccountPreferencesRequestRequestTypeDef = {  # (1)
    "UserAuthorizationRequired": ...,
}

parent.update_account_preferences(**kwargs)
  1. See UpdateAccountPreferencesRequestRequestTypeDef

update_chime_webhook_configuration#

Updates a Chime Webhook Configuration See also: AWS API Documentation.

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)
    ...
  1. See UpdateChimeWebhookConfigurationResultTypeDef 
# update_chime_webhook_configuration method usage example with argument unpacking

kwargs: UpdateChimeWebhookConfigurationRequestRequestTypeDef = {  # (1)
    "ChatConfigurationArn": ...,
}

parent.update_chime_webhook_configuration(**kwargs)
  1. See UpdateChimeWebhookConfigurationRequestRequestTypeDef

update_microsoft_teams_channel_configuration#

Updates MS Teams Channel Configuration See also: AWS API Documentation.

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)
    ...
  1. See UpdateTeamsChannelConfigurationResultTypeDef 
# update_microsoft_teams_channel_configuration method usage example with argument unpacking

kwargs: UpdateTeamsChannelConfigurationRequestRequestTypeDef = {  # (1)
    "ChatConfigurationArn": ...,
    "ChannelId": ...,
}

parent.update_microsoft_teams_channel_configuration(**kwargs)
  1. See UpdateTeamsChannelConfigurationRequestRequestTypeDef

update_slack_channel_configuration#

Updates Slack Channel Configuration See also: AWS API Documentation.

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)
    ...
  1. See UpdateSlackChannelConfigurationResultTypeDef 
# update_slack_channel_configuration method usage example with argument unpacking

kwargs: UpdateSlackChannelConfigurationRequestRequestTypeDef = {  # (1)
    "ChatConfigurationArn": ...,
    "SlackChannelId": ...,
}

parent.update_slack_channel_configuration(**kwargs)
  1. See UpdateSlackChannelConfigurationRequestRequestTypeDef