Skip to content

Type definitions#

Index > Chatbot > Type definitions

Auto-generated documentation for Chatbot type annotations stubs module mypy-boto3-chatbot.

AccountPreferencesTypeDef#

# AccountPreferencesTypeDef definition

class AccountPreferencesTypeDef(TypedDict):
    UserAuthorizationRequired: NotRequired[bool],
    TrainingDataCollectionEnabled: NotRequired[bool],

ChimeWebhookConfigurationTypeDef#

# ChimeWebhookConfigurationTypeDef definition

class ChimeWebhookConfigurationTypeDef(TypedDict):
    WebhookDescription: str,
    ChatConfigurationArn: str,
    IamRoleArn: str,
    SnsTopicArns: List[str],
    ConfigurationName: NotRequired[str],
    LoggingLevel: NotRequired[str],

ConfiguredTeamTypeDef#

# ConfiguredTeamTypeDef definition

class ConfiguredTeamTypeDef(TypedDict):
    TenantId: str,
    TeamId: str,
    TeamName: NotRequired[str],

CreateChimeWebhookConfigurationRequestRequestTypeDef#

# CreateChimeWebhookConfigurationRequestRequestTypeDef definition

class CreateChimeWebhookConfigurationRequestRequestTypeDef(TypedDict):
    WebhookDescription: str,
    WebhookUrl: str,
    SnsTopicArns: Sequence[str],
    IamRoleArn: str,
    ConfigurationName: str,
    LoggingLevel: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateSlackChannelConfigurationRequestRequestTypeDef#

# CreateSlackChannelConfigurationRequestRequestTypeDef definition

class CreateSlackChannelConfigurationRequestRequestTypeDef(TypedDict):
    SlackTeamId: str,
    SlackChannelId: str,
    IamRoleArn: str,
    ConfigurationName: str,
    SlackChannelName: NotRequired[str],
    SnsTopicArns: NotRequired[Sequence[str]],
    LoggingLevel: NotRequired[str],
    GuardrailPolicyArns: NotRequired[Sequence[str]],
    UserAuthorizationRequired: NotRequired[bool],

SlackChannelConfigurationTypeDef#

# SlackChannelConfigurationTypeDef definition

class SlackChannelConfigurationTypeDef(TypedDict):
    SlackTeamName: str,
    SlackTeamId: str,
    SlackChannelId: str,
    SlackChannelName: str,
    ChatConfigurationArn: str,
    IamRoleArn: str,
    SnsTopicArns: List[str],
    ConfigurationName: NotRequired[str],
    LoggingLevel: NotRequired[str],
    GuardrailPolicyArns: NotRequired[List[str]],
    UserAuthorizationRequired: NotRequired[bool],

CreateTeamsChannelConfigurationRequestRequestTypeDef#

# CreateTeamsChannelConfigurationRequestRequestTypeDef definition

class CreateTeamsChannelConfigurationRequestRequestTypeDef(TypedDict):
    ChannelId: str,
    TeamId: str,
    TenantId: str,
    IamRoleArn: str,
    ConfigurationName: str,
    ChannelName: NotRequired[str],
    TeamName: NotRequired[str],
    SnsTopicArns: NotRequired[Sequence[str]],
    LoggingLevel: NotRequired[str],
    GuardrailPolicyArns: NotRequired[Sequence[str]],
    UserAuthorizationRequired: NotRequired[bool],

TeamsChannelConfigurationTypeDef#

# TeamsChannelConfigurationTypeDef definition

class TeamsChannelConfigurationTypeDef(TypedDict):
    ChannelId: str,
    TeamId: str,
    TenantId: str,
    ChatConfigurationArn: str,
    IamRoleArn: str,
    SnsTopicArns: List[str],
    ChannelName: NotRequired[str],
    TeamName: NotRequired[str],
    ConfigurationName: NotRequired[str],
    LoggingLevel: NotRequired[str],
    GuardrailPolicyArns: NotRequired[List[str]],
    UserAuthorizationRequired: NotRequired[bool],

DeleteChimeWebhookConfigurationRequestRequestTypeDef#

# DeleteChimeWebhookConfigurationRequestRequestTypeDef definition

class DeleteChimeWebhookConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,

DeleteMicrosoftTeamsUserIdentityRequestRequestTypeDef#

# DeleteMicrosoftTeamsUserIdentityRequestRequestTypeDef definition

class DeleteMicrosoftTeamsUserIdentityRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,
    UserId: str,

DeleteSlackChannelConfigurationRequestRequestTypeDef#

# DeleteSlackChannelConfigurationRequestRequestTypeDef definition

class DeleteSlackChannelConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,

DeleteSlackUserIdentityRequestRequestTypeDef#

# DeleteSlackUserIdentityRequestRequestTypeDef definition

class DeleteSlackUserIdentityRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,
    SlackTeamId: str,
    SlackUserId: str,

DeleteSlackWorkspaceAuthorizationRequestRequestTypeDef#

# DeleteSlackWorkspaceAuthorizationRequestRequestTypeDef definition

class DeleteSlackWorkspaceAuthorizationRequestRequestTypeDef(TypedDict):
    SlackTeamId: str,

DeleteTeamsChannelConfigurationRequestRequestTypeDef#

# DeleteTeamsChannelConfigurationRequestRequestTypeDef definition

class DeleteTeamsChannelConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,

DeleteTeamsConfiguredTeamRequestRequestTypeDef#

# DeleteTeamsConfiguredTeamRequestRequestTypeDef definition

class DeleteTeamsConfiguredTeamRequestRequestTypeDef(TypedDict):
    TeamId: str,

DescribeChimeWebhookConfigurationsRequestRequestTypeDef#

# DescribeChimeWebhookConfigurationsRequestRequestTypeDef definition

class DescribeChimeWebhookConfigurationsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ChatConfigurationArn: NotRequired[str],

DescribeSlackChannelConfigurationsRequestRequestTypeDef#

# DescribeSlackChannelConfigurationsRequestRequestTypeDef definition

class DescribeSlackChannelConfigurationsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ChatConfigurationArn: NotRequired[str],

DescribeSlackUserIdentitiesRequestRequestTypeDef#

# DescribeSlackUserIdentitiesRequestRequestTypeDef definition

class DescribeSlackUserIdentitiesRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

SlackUserIdentityTypeDef#

# SlackUserIdentityTypeDef definition

class SlackUserIdentityTypeDef(TypedDict):
    IamRoleArn: str,
    ChatConfigurationArn: str,
    SlackTeamId: str,
    SlackUserId: str,
    AwsUserIdentity: NotRequired[str],

DescribeSlackWorkspacesRequestRequestTypeDef#

# DescribeSlackWorkspacesRequestRequestTypeDef definition

class DescribeSlackWorkspacesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

SlackWorkspaceTypeDef#

# SlackWorkspaceTypeDef definition

class SlackWorkspaceTypeDef(TypedDict):
    SlackTeamId: str,
    SlackTeamName: str,

GetTeamsChannelConfigurationRequestRequestTypeDef#

# GetTeamsChannelConfigurationRequestRequestTypeDef definition

class GetTeamsChannelConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,

ListMicrosoftTeamsConfiguredTeamsRequestRequestTypeDef#

# ListMicrosoftTeamsConfiguredTeamsRequestRequestTypeDef definition

class ListMicrosoftTeamsConfiguredTeamsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListMicrosoftTeamsUserIdentitiesRequestRequestTypeDef#

# ListMicrosoftTeamsUserIdentitiesRequestRequestTypeDef definition

class ListMicrosoftTeamsUserIdentitiesRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

TeamsUserIdentityTypeDef#

# TeamsUserIdentityTypeDef definition

class TeamsUserIdentityTypeDef(TypedDict):
    IamRoleArn: str,
    ChatConfigurationArn: str,
    TeamId: str,
    UserId: NotRequired[str],
    AwsUserIdentity: NotRequired[str],
    TeamsChannelId: NotRequired[str],
    TeamsTenantId: NotRequired[str],

ListTeamsChannelConfigurationsRequestRequestTypeDef#

# ListTeamsChannelConfigurationsRequestRequestTypeDef definition

class ListTeamsChannelConfigurationsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    TeamId: NotRequired[str],

UpdateAccountPreferencesRequestRequestTypeDef#

# UpdateAccountPreferencesRequestRequestTypeDef definition

class UpdateAccountPreferencesRequestRequestTypeDef(TypedDict):
    UserAuthorizationRequired: NotRequired[bool],
    TrainingDataCollectionEnabled: NotRequired[bool],

UpdateChimeWebhookConfigurationRequestRequestTypeDef#

# UpdateChimeWebhookConfigurationRequestRequestTypeDef definition

class UpdateChimeWebhookConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,
    WebhookDescription: NotRequired[str],
    WebhookUrl: NotRequired[str],
    SnsTopicArns: NotRequired[Sequence[str]],
    IamRoleArn: NotRequired[str],
    LoggingLevel: NotRequired[str],

UpdateSlackChannelConfigurationRequestRequestTypeDef#

# UpdateSlackChannelConfigurationRequestRequestTypeDef definition

class UpdateSlackChannelConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,
    SlackChannelId: str,
    SlackChannelName: NotRequired[str],
    SnsTopicArns: NotRequired[Sequence[str]],
    IamRoleArn: NotRequired[str],
    LoggingLevel: NotRequired[str],
    GuardrailPolicyArns: NotRequired[Sequence[str]],
    UserAuthorizationRequired: NotRequired[bool],

UpdateTeamsChannelConfigurationRequestRequestTypeDef#

# UpdateTeamsChannelConfigurationRequestRequestTypeDef definition

class UpdateTeamsChannelConfigurationRequestRequestTypeDef(TypedDict):
    ChatConfigurationArn: str,
    ChannelId: str,
    ChannelName: NotRequired[str],
    SnsTopicArns: NotRequired[Sequence[str]],
    IamRoleArn: NotRequired[str],
    LoggingLevel: NotRequired[str],
    GuardrailPolicyArns: NotRequired[Sequence[str]],
    UserAuthorizationRequired: NotRequired[bool],

CreateChimeWebhookConfigurationResultTypeDef#

# CreateChimeWebhookConfigurationResultTypeDef definition

class CreateChimeWebhookConfigurationResultTypeDef(TypedDict):
    WebhookConfiguration: ChimeWebhookConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChimeWebhookConfigurationTypeDef
  2. See ResponseMetadataTypeDef

DescribeChimeWebhookConfigurationsResultTypeDef#

# DescribeChimeWebhookConfigurationsResultTypeDef definition

class DescribeChimeWebhookConfigurationsResultTypeDef(TypedDict):
    NextToken: str,
    WebhookConfigurations: List[ChimeWebhookConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChimeWebhookConfigurationTypeDef
  2. See ResponseMetadataTypeDef

GetAccountPreferencesResultTypeDef#

# GetAccountPreferencesResultTypeDef definition

class GetAccountPreferencesResultTypeDef(TypedDict):
    AccountPreferences: AccountPreferencesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountPreferencesTypeDef
  2. See ResponseMetadataTypeDef

ListMicrosoftTeamsConfiguredTeamsResultTypeDef#

# ListMicrosoftTeamsConfiguredTeamsResultTypeDef definition

class ListMicrosoftTeamsConfiguredTeamsResultTypeDef(TypedDict):
    ConfiguredTeams: List[ConfiguredTeamTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTeamTypeDef
  2. See ResponseMetadataTypeDef

UpdateAccountPreferencesResultTypeDef#

# UpdateAccountPreferencesResultTypeDef definition

class UpdateAccountPreferencesResultTypeDef(TypedDict):
    AccountPreferences: AccountPreferencesTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountPreferencesTypeDef
  2. See ResponseMetadataTypeDef

UpdateChimeWebhookConfigurationResultTypeDef#

# UpdateChimeWebhookConfigurationResultTypeDef definition

class UpdateChimeWebhookConfigurationResultTypeDef(TypedDict):
    WebhookConfiguration: ChimeWebhookConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChimeWebhookConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateSlackChannelConfigurationResultTypeDef#

# CreateSlackChannelConfigurationResultTypeDef definition

class CreateSlackChannelConfigurationResultTypeDef(TypedDict):
    ChannelConfiguration: SlackChannelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlackChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

DescribeSlackChannelConfigurationsResultTypeDef#

# DescribeSlackChannelConfigurationsResultTypeDef definition

class DescribeSlackChannelConfigurationsResultTypeDef(TypedDict):
    NextToken: str,
    SlackChannelConfigurations: List[SlackChannelConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlackChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateSlackChannelConfigurationResultTypeDef#

# UpdateSlackChannelConfigurationResultTypeDef definition

class UpdateSlackChannelConfigurationResultTypeDef(TypedDict):
    ChannelConfiguration: SlackChannelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlackChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateTeamsChannelConfigurationResultTypeDef#

# CreateTeamsChannelConfigurationResultTypeDef definition

class CreateTeamsChannelConfigurationResultTypeDef(TypedDict):
    ChannelConfiguration: TeamsChannelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TeamsChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

GetTeamsChannelConfigurationResultTypeDef#

# GetTeamsChannelConfigurationResultTypeDef definition

class GetTeamsChannelConfigurationResultTypeDef(TypedDict):
    ChannelConfiguration: TeamsChannelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TeamsChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

ListTeamsChannelConfigurationsResultTypeDef#

# ListTeamsChannelConfigurationsResultTypeDef definition

class ListTeamsChannelConfigurationsResultTypeDef(TypedDict):
    NextToken: str,
    TeamChannelConfigurations: List[TeamsChannelConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TeamsChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateTeamsChannelConfigurationResultTypeDef#

# UpdateTeamsChannelConfigurationResultTypeDef definition

class UpdateTeamsChannelConfigurationResultTypeDef(TypedDict):
    ChannelConfiguration: TeamsChannelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TeamsChannelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

DescribeSlackUserIdentitiesResultTypeDef#

# DescribeSlackUserIdentitiesResultTypeDef definition

class DescribeSlackUserIdentitiesResultTypeDef(TypedDict):
    SlackUserIdentities: List[SlackUserIdentityTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlackUserIdentityTypeDef
  2. See ResponseMetadataTypeDef

DescribeSlackWorkspacesResultTypeDef#

# DescribeSlackWorkspacesResultTypeDef definition

class DescribeSlackWorkspacesResultTypeDef(TypedDict):
    SlackWorkspaces: List[SlackWorkspaceTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SlackWorkspaceTypeDef
  2. See ResponseMetadataTypeDef

ListMicrosoftTeamsUserIdentitiesResultTypeDef#

# ListMicrosoftTeamsUserIdentitiesResultTypeDef definition

class ListMicrosoftTeamsUserIdentitiesResultTypeDef(TypedDict):
    TeamsUserIdentities: List[TeamsUserIdentityTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TeamsUserIdentityTypeDef
  2. See ResponseMetadataTypeDef