/
home
/
infinitibizsol
/
testingcrm.infinitibizsol.com
/
node_modules
/
aws-sdk
/
clients
/
File Upload :
llllll
Current File: /home/infinitibizsol/testingcrm.infinitibizsol.com/node_modules/aws-sdk/clients/chatbot.d.ts
import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class Chatbot extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: Chatbot.Types.ClientConfiguration) config: Config & Chatbot.Types.ClientConfiguration; /** * Creates an AWS Chatbot configuration for Amazon Chime. */ createChimeWebhookConfiguration(params: Chatbot.Types.CreateChimeWebhookConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.CreateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.CreateChimeWebhookConfigurationResult, AWSError>; /** * Creates an AWS Chatbot configuration for Amazon Chime. */ createChimeWebhookConfiguration(callback?: (err: AWSError, data: Chatbot.Types.CreateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.CreateChimeWebhookConfigurationResult, AWSError>; /** * Creates an AWS Chatbot configuration for Microsoft Teams. */ createMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.CreateTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.CreateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.CreateTeamsChannelConfigurationResult, AWSError>; /** * Creates an AWS Chatbot configuration for Microsoft Teams. */ createMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.CreateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.CreateTeamsChannelConfigurationResult, AWSError>; /** * Creates an AWS Chatbot confugration for Slack. */ createSlackChannelConfiguration(params: Chatbot.Types.CreateSlackChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.CreateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.CreateSlackChannelConfigurationResult, AWSError>; /** * Creates an AWS Chatbot confugration for Slack. */ createSlackChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.CreateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.CreateSlackChannelConfigurationResult, AWSError>; /** * Deletes a Amazon Chime webhook configuration for AWS Chatbot. */ deleteChimeWebhookConfiguration(params: Chatbot.Types.DeleteChimeWebhookConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.DeleteChimeWebhookConfigurationResult, AWSError>; /** * Deletes a Amazon Chime webhook configuration for AWS Chatbot. */ deleteChimeWebhookConfiguration(callback?: (err: AWSError, data: Chatbot.Types.DeleteChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.DeleteChimeWebhookConfigurationResult, AWSError>; /** * Deletes a Microsoft Teams channel configuration for AWS Chatbot */ deleteMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.DeleteTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteTeamsChannelConfigurationResult, AWSError>; /** * Deletes a Microsoft Teams channel configuration for AWS Chatbot */ deleteMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteTeamsChannelConfigurationResult, AWSError>; /** * 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. */ deleteMicrosoftTeamsConfiguredTeam(params: Chatbot.Types.DeleteTeamsConfiguredTeamRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsConfiguredTeamResult) => void): Request<Chatbot.Types.DeleteTeamsConfiguredTeamResult, AWSError>; /** * 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. */ deleteMicrosoftTeamsConfiguredTeam(callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsConfiguredTeamResult) => void): Request<Chatbot.Types.DeleteTeamsConfiguredTeamResult, AWSError>; /** * Identifes a user level permission for a channel configuration. */ deleteMicrosoftTeamsUserIdentity(params: Chatbot.Types.DeleteMicrosoftTeamsUserIdentityRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult) => void): Request<Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult, AWSError>; /** * Identifes a user level permission for a channel configuration. */ deleteMicrosoftTeamsUserIdentity(callback?: (err: AWSError, data: Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult) => void): Request<Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult, AWSError>; /** * Deletes a Slack channel configuration for AWS Chatbot */ deleteSlackChannelConfiguration(params: Chatbot.Types.DeleteSlackChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteSlackChannelConfigurationResult, AWSError>; /** * Deletes a Slack channel configuration for AWS Chatbot */ deleteSlackChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteSlackChannelConfigurationResult, AWSError>; /** * Deletes a user level permission for a Slack channel configuration. */ deleteSlackUserIdentity(params: Chatbot.Types.DeleteSlackUserIdentityRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackUserIdentityResult) => void): Request<Chatbot.Types.DeleteSlackUserIdentityResult, AWSError>; /** * Deletes a user level permission for a Slack channel configuration. */ deleteSlackUserIdentity(callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackUserIdentityResult) => void): Request<Chatbot.Types.DeleteSlackUserIdentityResult, AWSError>; /** * 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. */ deleteSlackWorkspaceAuthorization(params: Chatbot.Types.DeleteSlackWorkspaceAuthorizationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult) => void): Request<Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult, AWSError>; /** * 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. */ deleteSlackWorkspaceAuthorization(callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult) => void): Request<Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult, AWSError>; /** * Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn */ describeChimeWebhookConfigurations(params: Chatbot.Types.DescribeChimeWebhookConfigurationsRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeChimeWebhookConfigurationsResult) => void): Request<Chatbot.Types.DescribeChimeWebhookConfigurationsResult, AWSError>; /** * Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn */ describeChimeWebhookConfigurations(callback?: (err: AWSError, data: Chatbot.Types.DescribeChimeWebhookConfigurationsResult) => void): Request<Chatbot.Types.DescribeChimeWebhookConfigurationsResult, AWSError>; /** * Lists Slack channel configurations optionally filtered by ChatConfigurationArn */ describeSlackChannelConfigurations(params: Chatbot.Types.DescribeSlackChannelConfigurationsRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackChannelConfigurationsResult) => void): Request<Chatbot.Types.DescribeSlackChannelConfigurationsResult, AWSError>; /** * Lists Slack channel configurations optionally filtered by ChatConfigurationArn */ describeSlackChannelConfigurations(callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackChannelConfigurationsResult) => void): Request<Chatbot.Types.DescribeSlackChannelConfigurationsResult, AWSError>; /** * Lists all Slack user identities with a mapped role. */ describeSlackUserIdentities(params: Chatbot.Types.DescribeSlackUserIdentitiesRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackUserIdentitiesResult) => void): Request<Chatbot.Types.DescribeSlackUserIdentitiesResult, AWSError>; /** * Lists all Slack user identities with a mapped role. */ describeSlackUserIdentities(callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackUserIdentitiesResult) => void): Request<Chatbot.Types.DescribeSlackUserIdentitiesResult, AWSError>; /** * List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot. */ describeSlackWorkspaces(params: Chatbot.Types.DescribeSlackWorkspacesRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackWorkspacesResult) => void): Request<Chatbot.Types.DescribeSlackWorkspacesResult, AWSError>; /** * List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot. */ describeSlackWorkspaces(callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackWorkspacesResult) => void): Request<Chatbot.Types.DescribeSlackWorkspacesResult, AWSError>; /** * Returns AWS Chatbot account preferences. */ getAccountPreferences(params: Chatbot.Types.GetAccountPreferencesRequest, callback?: (err: AWSError, data: Chatbot.Types.GetAccountPreferencesResult) => void): Request<Chatbot.Types.GetAccountPreferencesResult, AWSError>; /** * Returns AWS Chatbot account preferences. */ getAccountPreferences(callback?: (err: AWSError, data: Chatbot.Types.GetAccountPreferencesResult) => void): Request<Chatbot.Types.GetAccountPreferencesResult, AWSError>; /** * Returns a Microsoft Teams channel configuration in an AWS account. */ getMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.GetTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.GetTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.GetTeamsChannelConfigurationResult, AWSError>; /** * Returns a Microsoft Teams channel configuration in an AWS account. */ getMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.GetTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.GetTeamsChannelConfigurationResult, AWSError>; /** * Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account. */ listMicrosoftTeamsChannelConfigurations(params: Chatbot.Types.ListTeamsChannelConfigurationsRequest, callback?: (err: AWSError, data: Chatbot.Types.ListTeamsChannelConfigurationsResult) => void): Request<Chatbot.Types.ListTeamsChannelConfigurationsResult, AWSError>; /** * Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account. */ listMicrosoftTeamsChannelConfigurations(callback?: (err: AWSError, data: Chatbot.Types.ListTeamsChannelConfigurationsResult) => void): Request<Chatbot.Types.ListTeamsChannelConfigurationsResult, AWSError>; /** * Lists all authorized Microsoft Teams for an AWS Account */ listMicrosoftTeamsConfiguredTeams(params: Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsRequest, callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult, AWSError>; /** * Lists all authorized Microsoft Teams for an AWS Account */ listMicrosoftTeamsConfiguredTeams(callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult, AWSError>; /** * A list all Microsoft Teams user identities with a mapped role. */ listMicrosoftTeamsUserIdentities(params: Chatbot.Types.ListMicrosoftTeamsUserIdentitiesRequest, callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult, AWSError>; /** * A list all Microsoft Teams user identities with a mapped role. */ listMicrosoftTeamsUserIdentities(callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult, AWSError>; /** * Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. */ listTagsForResource(params: Chatbot.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Chatbot.Types.ListTagsForResourceResponse) => void): Request<Chatbot.Types.ListTagsForResourceResponse, AWSError>; /** * Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. */ listTagsForResource(callback?: (err: AWSError, data: Chatbot.Types.ListTagsForResourceResponse) => void): Request<Chatbot.Types.ListTagsForResourceResponse, AWSError>; /** * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. */ tagResource(params: Chatbot.Types.TagResourceRequest, callback?: (err: AWSError, data: Chatbot.Types.TagResourceResponse) => void): Request<Chatbot.Types.TagResourceResponse, AWSError>; /** * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. */ tagResource(callback?: (err: AWSError, data: Chatbot.Types.TagResourceResponse) => void): Request<Chatbot.Types.TagResourceResponse, AWSError>; /** * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. */ untagResource(params: Chatbot.Types.UntagResourceRequest, callback?: (err: AWSError, data: Chatbot.Types.UntagResourceResponse) => void): Request<Chatbot.Types.UntagResourceResponse, AWSError>; /** * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. */ untagResource(callback?: (err: AWSError, data: Chatbot.Types.UntagResourceResponse) => void): Request<Chatbot.Types.UntagResourceResponse, AWSError>; /** * Updates AWS Chatbot account preferences. */ updateAccountPreferences(params: Chatbot.Types.UpdateAccountPreferencesRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateAccountPreferencesResult) => void): Request<Chatbot.Types.UpdateAccountPreferencesResult, AWSError>; /** * Updates AWS Chatbot account preferences. */ updateAccountPreferences(callback?: (err: AWSError, data: Chatbot.Types.UpdateAccountPreferencesResult) => void): Request<Chatbot.Types.UpdateAccountPreferencesResult, AWSError>; /** * Updates a Amazon Chime webhook configuration. */ updateChimeWebhookConfiguration(params: Chatbot.Types.UpdateChimeWebhookConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.UpdateChimeWebhookConfigurationResult, AWSError>; /** * Updates a Amazon Chime webhook configuration. */ updateChimeWebhookConfiguration(callback?: (err: AWSError, data: Chatbot.Types.UpdateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.UpdateChimeWebhookConfigurationResult, AWSError>; /** * Updates an Microsoft Teams channel configuration. */ updateMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.UpdateTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateTeamsChannelConfigurationResult, AWSError>; /** * Updates an Microsoft Teams channel configuration. */ updateMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.UpdateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateTeamsChannelConfigurationResult, AWSError>; /** * Updates a Slack channel configuration. */ updateSlackChannelConfiguration(params: Chatbot.Types.UpdateSlackChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateSlackChannelConfigurationResult, AWSError>; /** * Updates a Slack channel configuration. */ updateSlackChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.UpdateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateSlackChannelConfigurationResult, AWSError>; } declare namespace Chatbot { export interface AccountPreferences { /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; /** * 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 AI technologies for AWS Chatbot. */ TrainingDataCollectionEnabled?: BooleanAccountPreference; } export type AmazonResourceName = string; export type Arn = string; export type AwsUserIdentity = string; export type BooleanAccountPreference = boolean; export type ChatConfigurationArn = string; export interface ChimeWebhookConfiguration { /** * A description of the webhook. We recommend using the convention RoomName/WebhookName. For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide. */ WebhookDescription: ChimeWebhookDescription; /** * The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration. */ ChatConfigurationArn: ChatConfigurationArn; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns: SnsTopicArnList; /** * The name of the configuration. */ ConfigurationName?: ConfigurationName; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. */ Tags?: Tags; } export type ChimeWebhookConfigurationList = ChimeWebhookConfiguration[]; export type ChimeWebhookDescription = string; export type ChimeWebhookUrl = string; export type ConfigurationName = string; export interface ConfiguredTeam { /** * The ID of the Microsoft Teams tenant. */ TenantId: UUID; /** * The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide. */ TeamId: UUID; /** * The name of the Microsoft Teams Team. */ TeamName?: UUID; } export type ConfiguredTeamsList = ConfiguredTeam[]; export interface CreateChimeWebhookConfigurationRequest { /** * A description of the webhook. We recommend using the convention RoomName/WebhookName. For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide. */ WebhookDescription: ChimeWebhookDescription; /** * The URL for the Amazon Chime webhook. */ WebhookUrl: ChimeWebhookUrl; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns: SnsTopicArnList; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The name of the configuration. */ ConfigurationName: ConfigurationName; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. */ Tags?: Tags; } export interface CreateChimeWebhookConfigurationResult { /** * An Amazon Chime webhook configuration. */ WebhookConfiguration?: ChimeWebhookConfiguration; } export interface CreateSlackChannelConfigurationRequest { /** * The ID of the Slack workspace authorized with AWS Chatbot. */ SlackTeamId: SlackTeamId; /** * The ID of the Slack channel. To get this 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. */ SlackChannelId: SlackChannelId; /** * The name of the Slack channel. */ SlackChannelName?: SlackChannelDisplayName; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns?: SnsTopicArnList; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The name of the configuration. */ ConfigurationName: ConfigurationName; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * 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. */ GuardrailPolicyArns?: GuardrailPolicyArnList; /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; /** * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. */ Tags?: Tags; } export interface CreateSlackChannelConfigurationResult { /** * The configuration for a Slack channel configured with AWS Chatbot. */ ChannelConfiguration?: SlackChannelConfiguration; } export interface CreateTeamsChannelConfigurationRequest { /** * The ID of the Microsoft Teams channel. */ ChannelId: TeamsChannelId; /** * The name of the Microsoft Teams channel. */ ChannelName?: TeamsChannelName; /** * The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide. */ TeamId: UUID; /** * The name of the Microsoft Teams Team. */ TeamName?: TeamName; /** * The ID of the Microsoft Teams tenant. */ TenantId: UUID; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns?: SnsTopicArnList; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The name of the configuration. */ ConfigurationName: ConfigurationName; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * 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. */ GuardrailPolicyArns?: GuardrailPolicyArnList; /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; /** * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. */ Tags?: Tags; } export interface CreateTeamsChannelConfigurationResult { /** * The configuration for a Microsoft Teams channel configured with AWS Chatbot. */ ChannelConfiguration?: TeamsChannelConfiguration; } export type CustomerCwLogLevel = string; export interface DeleteChimeWebhookConfigurationRequest { /** * The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete. */ ChatConfigurationArn: ChatConfigurationArn; } export interface DeleteChimeWebhookConfigurationResult { } export interface DeleteMicrosoftTeamsUserIdentityRequest { /** * The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. */ ChatConfigurationArn: ChatConfigurationArn; /** * The Microsoft Teams user ID. */ UserId: UUID; } export interface DeleteMicrosoftTeamsUserIdentityResult { } export interface DeleteSlackChannelConfigurationRequest { /** * The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete. */ ChatConfigurationArn: ChatConfigurationArn; } export interface DeleteSlackChannelConfigurationResult { } export interface DeleteSlackUserIdentityRequest { /** * The ARN of the SlackChannelConfiguration associated with the user identity to delete. */ ChatConfigurationArn: ChatConfigurationArn; /** * The ID of the Slack workspace authorized with AWS Chatbot. */ SlackTeamId: SlackTeamId; /** * The ID of the user in Slack */ SlackUserId: SlackUserId; } export interface DeleteSlackUserIdentityResult { } export interface DeleteSlackWorkspaceAuthorizationRequest { /** * The ID of the Slack workspace authorized with AWS Chatbot. */ SlackTeamId: SlackTeamId; } export interface DeleteSlackWorkspaceAuthorizationResult { } export interface DeleteTeamsChannelConfigurationRequest { /** * The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. */ ChatConfigurationArn: ChatConfigurationArn; } export interface DeleteTeamsChannelConfigurationResult { } export interface DeleteTeamsConfiguredTeamRequest { /** * The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide. */ TeamId: UUID; } export interface DeleteTeamsConfiguredTeamResult { } export interface DescribeChimeWebhookConfigurationsRequest { /** * 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. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: PaginationToken; /** * An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe. */ ChatConfigurationArn?: ChatConfigurationArn; } export interface DescribeChimeWebhookConfigurationsResult { /** * 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. */ NextToken?: PaginationToken; /** * A list of Amazon Chime webhooks associated with the account. */ WebhookConfigurations?: ChimeWebhookConfigurationList; } export interface DescribeSlackChannelConfigurationsRequest { /** * 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. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: PaginationToken; /** * An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe. */ ChatConfigurationArn?: ChatConfigurationArn; } export interface DescribeSlackChannelConfigurationsResult { /** * 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. */ NextToken?: PaginationToken; /** * A list of Slack channel configurations. */ SlackChannelConfigurations?: SlackChannelConfigurationList; } export interface DescribeSlackUserIdentitiesRequest { /** * The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe. */ ChatConfigurationArn?: ChatConfigurationArn; /** * 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. */ NextToken?: PaginationToken; /** * 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. */ MaxResults?: MaxResults; } export interface DescribeSlackUserIdentitiesResult { /** * A list of Slack User Identities. */ SlackUserIdentities?: SlackUserIdentitiesList; /** * 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. */ NextToken?: PaginationToken; } export interface DescribeSlackWorkspacesRequest { /** * 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. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: PaginationToken; } export interface DescribeSlackWorkspacesResult { /** * A list of Slack workspaces registered with AWS Chatbot. */ SlackWorkspaces?: SlackWorkspacesList; /** * 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. */ NextToken?: PaginationToken; } export interface GetAccountPreferencesRequest { } export interface GetAccountPreferencesResult { /** * The preferences related to AWS Chatbot usage in the calling AWS account. */ AccountPreferences?: AccountPreferences; } export interface GetTeamsChannelConfigurationRequest { /** * The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve. */ ChatConfigurationArn: ChatConfigurationArn; } export interface GetTeamsChannelConfigurationResult { /** * The configuration for a Microsoft Teams channel configured with AWS Chatbot. */ ChannelConfiguration?: TeamsChannelConfiguration; } export type GuardrailPolicyArn = string; export type GuardrailPolicyArnList = GuardrailPolicyArn[]; export interface ListMicrosoftTeamsConfiguredTeamsRequest { /** * 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. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: PaginationToken; } export interface ListMicrosoftTeamsConfiguredTeamsResult { /** * A list of teams in Microsoft Teams that are configured with AWS Chatbot. */ ConfiguredTeams?: ConfiguredTeamsList; /** * 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. */ NextToken?: PaginationToken; } export interface ListMicrosoftTeamsUserIdentitiesRequest { /** * The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list. */ ChatConfigurationArn?: ChatConfigurationArn; /** * 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. */ NextToken?: PaginationToken; /** * 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. */ MaxResults?: MaxResults; } export interface ListMicrosoftTeamsUserIdentitiesResult { /** * User level permissions associated to a channel configuration. */ TeamsUserIdentities?: TeamsUserIdentitiesList; /** * 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. */ NextToken?: PaginationToken; } export interface ListTagsForResourceRequest { /** * The ARN you specified to list the tags of. */ ResourceARN: AmazonResourceName; } export interface ListTagsForResourceResponse { /** * Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define. */ Tags?: TagList; } export interface ListTeamsChannelConfigurationsRequest { /** * 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. */ MaxResults?: MaxResults; /** * 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. */ NextToken?: PaginationToken; /** * The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide. */ TeamId?: UUID; } export interface ListTeamsChannelConfigurationsResult { /** * 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. */ NextToken?: PaginationToken; /** * A list of AWS Chatbot channel configurations for Microsoft Teams. */ TeamChannelConfigurations?: TeamChannelConfigurationsList; } export type MaxResults = number; export type PaginationToken = string; export interface SlackChannelConfiguration { /** * Name of the Slack workspace. */ SlackTeamName: SlackTeamName; /** * The ID of the Slack workspace authorized with Amazon Chime. */ SlackTeamId: SlackTeamId; /** * The ID of the Slack channel. To get this 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. */ SlackChannelId: SlackChannelId; /** * The name of the Slack channel. */ SlackChannelName: SlackChannelDisplayName; /** * The Amazon Resource Number (ARN) of the SlackChannelConfiguration. */ ChatConfigurationArn: ChatConfigurationArn; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns: SnsTopicArnList; /** * The name of the configuration. */ ConfigurationName?: ConfigurationName; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * 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. */ GuardrailPolicyArns?: GuardrailPolicyArnList; /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; /** * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. */ Tags?: Tags; } export type SlackChannelConfigurationList = SlackChannelConfiguration[]; export type SlackChannelDisplayName = string; export type SlackChannelId = string; export type SlackTeamId = string; export type SlackTeamName = string; export type SlackUserId = string; export type SlackUserIdentitiesList = SlackUserIdentity[]; export interface SlackUserIdentity { /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete. */ ChatConfigurationArn: ChatConfigurationArn; /** * The ID of the Slack workspace authorized with AWS Chatbot. */ SlackTeamId: SlackTeamId; /** * The ID of the user in Slack */ SlackUserId: SlackUserId; /** * The AWS user identity ARN used to associate a Slack user ID with an IAM Role. */ AwsUserIdentity?: AwsUserIdentity; } export interface SlackWorkspace { /** * The ID of the Slack workspace authorized with AWS Chatbot. */ SlackTeamId: SlackTeamId; /** * The name of the Slack workspace. */ SlackTeamName: SlackTeamName; } export type SlackWorkspacesList = SlackWorkspace[]; export type SnsTopicArnList = Arn[]; export interface Tag { /** * The key of the tag. */ TagKey: TagKey; /** * The value of the tag. */ TagValue: TagValue; } export type TagKey = string; export type TagKeyList = TagKey[]; export type TagList = Tag[]; export interface TagResourceRequest { /** * The ARN of the configuration. */ ResourceARN: AmazonResourceName; /** * A list of tags to apply to the configuration. */ Tags: TagList; } export interface TagResourceResponse { } export type TagValue = string; export type Tags = Tag[]; export type TeamChannelConfigurationsList = TeamsChannelConfiguration[]; export type TeamName = string; export interface TeamsChannelConfiguration { /** * The ID of the Microsoft Teams channel. */ ChannelId: TeamsChannelId; /** * The name of the Microsoft Teams channel. */ ChannelName?: TeamsChannelName; /** * The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide. */ TeamId: UUID; /** * The name of the Microsoft Teams Team. */ TeamName?: TeamName; /** * The ID of the Microsoft Teams tenant. */ TenantId: UUID; /** * The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. */ ChatConfigurationArn: ChatConfigurationArn; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns: SnsTopicArnList; /** * The name of the configuration. */ ConfigurationName?: ConfigurationName; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * 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. */ GuardrailPolicyArns?: GuardrailPolicyArnList; /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; /** * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs. */ Tags?: Tags; } export type TeamsChannelId = string; export type TeamsChannelName = string; export type TeamsUserIdentitiesList = TeamsUserIdentity[]; export interface TeamsUserIdentity { /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn: Arn; /** * The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. */ ChatConfigurationArn: ChatConfigurationArn; /** * The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide. */ TeamId: UUID; /** * The Microsoft Teams user ID. */ UserId?: UUID; /** * The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role. */ AwsUserIdentity?: AwsUserIdentity; /** * The ID of the Microsoft Teams channel. */ TeamsChannelId?: TeamsChannelId; /** * The ID of the Microsoft Teams tenant. */ TeamsTenantId?: UUID; } export type UUID = string; export interface UntagResourceRequest { /** * The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role. */ ResourceARN: AmazonResourceName; /** * TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose. */ TagKeys: TagKeyList; } export interface UntagResourceResponse { } export interface UpdateAccountPreferencesRequest { /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; /** * 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 AI technologies for AWS Chatbot. */ TrainingDataCollectionEnabled?: BooleanAccountPreference; } export interface UpdateAccountPreferencesResult { /** * Preferences related to AWS Chatbot usage in the calling AWS account. */ AccountPreferences?: AccountPreferences; } export interface UpdateChimeWebhookConfigurationRequest { /** * The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update. */ ChatConfigurationArn: ChatConfigurationArn; /** * A description of the webhook. We recommend using the convention RoomName/WebhookName. For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide. */ WebhookDescription?: ChimeWebhookDescription; /** * The URL for the Amazon Chime webhook. */ WebhookUrl?: ChimeWebhookUrl; /** * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns?: SnsTopicArnList; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn?: Arn; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; } export interface UpdateChimeWebhookConfigurationResult { /** * A Amazon Chime webhook configuration. */ WebhookConfiguration?: ChimeWebhookConfiguration; } export interface UpdateSlackChannelConfigurationRequest { /** * The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update. */ ChatConfigurationArn: ChatConfigurationArn; /** * The ID of the Slack channel. To get this 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. */ SlackChannelId: SlackChannelId; /** * The name of the Slack channel. */ SlackChannelName?: SlackChannelDisplayName; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns?: SnsTopicArnList; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn?: Arn; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * 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. */ GuardrailPolicyArns?: GuardrailPolicyArnList; /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; } export interface UpdateSlackChannelConfigurationResult { /** * The configuration for a Slack channel configured with AWS Chatbot. */ ChannelConfiguration?: SlackChannelConfiguration; } export interface UpdateTeamsChannelConfigurationRequest { /** * The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update. */ ChatConfigurationArn: ChatConfigurationArn; /** * The ID of the Microsoft Teams channel. */ ChannelId: TeamsChannelId; /** * The name of the Microsoft Teams channel. */ ChannelName?: TeamsChannelName; /** * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot. */ SnsTopicArns?: SnsTopicArnList; /** * A user-defined role that AWS Chatbot assumes. This is not the service-linked role. For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide. */ IamRoleArn?: Arn; /** * Logging levels include ERROR, INFO, or NONE. */ LoggingLevel?: CustomerCwLogLevel; /** * 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. */ GuardrailPolicyArns?: GuardrailPolicyArnList; /** * Enables use of a user role requirement in your chat configuration. */ UserAuthorizationRequired?: BooleanAccountPreference; } export interface UpdateTeamsChannelConfigurationResult { /** * The configuration for a Microsoft Teams channel configured with AWS Chatbot. */ ChannelConfiguration?: TeamsChannelConfiguration; } /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2017-10-11"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the Chatbot client. */ export import Types = Chatbot; } export = Chatbot;
Copyright ©2k19 -
Hexid
|
Tex7ure