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.