From a4046ab5fe821efff28020425a972c6a23ee142d Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 27 Aug 2024 18:14:04 +0000 Subject: [PATCH] feat(client-chatbot): Update documentation to be consistent with the API docs --- clients/client-chatbot/README.md | 25 +- clients/client-chatbot/src/Chatbot.ts | 25 +- clients/client-chatbot/src/ChatbotClient.ts | 25 +- .../CreateChimeWebhookConfigurationCommand.ts | 21 +- ...crosoftTeamsChannelConfigurationCommand.ts | 21 +- .../CreateSlackChannelConfigurationCommand.ts | 21 +- .../DeleteChimeWebhookConfigurationCommand.ts | 10 +- ...crosoftTeamsChannelConfigurationCommand.ts | 10 +- ...leteMicrosoftTeamsConfiguredTeamCommand.ts | 7 +- ...DeleteMicrosoftTeamsUserIdentityCommand.ts | 8 +- .../DeleteSlackChannelConfigurationCommand.ts | 10 +- .../DeleteSlackUserIdentityCommand.ts | 8 +- ...eleteSlackWorkspaceAuthorizationCommand.ts | 7 +- ...scribeChimeWebhookConfigurationsCommand.ts | 11 +- ...scribeSlackChannelConfigurationsCommand.ts | 11 +- .../DescribeSlackUserIdentitiesCommand.ts | 8 +- .../DescribeSlackWorkspacesCommand.ts | 8 +- .../commands/GetAccountPreferencesCommand.ts | 6 +- ...crosoftTeamsChannelConfigurationCommand.ts | 16 +- ...rosoftTeamsChannelConfigurationsCommand.ts | 16 +- ...istMicrosoftTeamsConfiguredTeamsCommand.ts | 8 +- ...ListMicrosoftTeamsUserIdentitiesCommand.ts | 8 +- .../commands/ListTagsForResourceCommand.ts | 9 +- .../src/commands/TagResourceCommand.ts | 11 +- .../src/commands/UntagResourceCommand.ts | 9 +- .../UpdateAccountPreferencesCommand.ts | 8 +- .../UpdateChimeWebhookConfigurationCommand.ts | 19 +- ...crosoftTeamsChannelConfigurationCommand.ts | 19 +- .../UpdateSlackChannelConfigurationCommand.ts | 19 +- clients/client-chatbot/src/index.ts | 25 +- clients/client-chatbot/src/models/models_0.ts | 698 ++++++++++++------ codegen/sdk-codegen/aws-models/chatbot.json | 592 +++++++-------- 32 files changed, 1062 insertions(+), 637 deletions(-) diff --git a/clients/client-chatbot/README.md b/clients/client-chatbot/README.md index e7e996d9cb33..990025a0ef63 100644 --- a/clients/client-chatbot/README.md +++ b/clients/client-chatbot/README.md @@ -6,7 +6,30 @@ AWS SDK for JavaScript Chatbot Client for Node.js, Browser and React Native. -AWS Chatbot API +

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

+

AWS Chatbot APIs are currently available in the following Regions:

+ +

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

+ +

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

+ ## Installing diff --git a/clients/client-chatbot/src/Chatbot.ts b/clients/client-chatbot/src/Chatbot.ts index 5c5927eb1384..22f99f4360d6 100644 --- a/clients/client-chatbot/src/Chatbot.ts +++ b/clients/client-chatbot/src/Chatbot.ts @@ -601,7 +601,30 @@ export interface Chatbot { } /** - * AWS Chatbot API + *

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

+ *

AWS Chatbot APIs are currently available in the following Regions:

+ * + *

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

+ * + *

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

+ * * @public */ export class Chatbot extends ChatbotClient implements Chatbot {} diff --git a/clients/client-chatbot/src/ChatbotClient.ts b/clients/client-chatbot/src/ChatbotClient.ts index f01f53d863b9..ffbff31a020a 100644 --- a/clients/client-chatbot/src/ChatbotClient.ts +++ b/clients/client-chatbot/src/ChatbotClient.ts @@ -396,7 +396,30 @@ export type ChatbotClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht export interface ChatbotClientResolvedConfig extends ChatbotClientResolvedConfigType {} /** - * AWS Chatbot API + *

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

+ *

AWS Chatbot APIs are currently available in the following Regions:

+ * + *

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

+ * + *

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

+ * * @public */ export class ChatbotClient extends __Client< diff --git a/clients/client-chatbot/src/commands/CreateChimeWebhookConfigurationCommand.ts b/clients/client-chatbot/src/commands/CreateChimeWebhookConfigurationCommand.ts index 1f4ac234b36d..3d9bf4ace729 100644 --- a/clients/client-chatbot/src/commands/CreateChimeWebhookConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/CreateChimeWebhookConfigurationCommand.ts @@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { CreateChimeWebhookConfigurationRequest, CreateChimeWebhookConfigurationResult } from "../models/models_0"; +import { + CreateChimeWebhookConfigurationRequest, + CreateChimeWebhookConfigurationRequestFilterSensitiveLog, + CreateChimeWebhookConfigurationResult, + CreateChimeWebhookConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_CreateChimeWebhookConfigurationCommand, se_CreateChimeWebhookConfigurationCommand, @@ -33,7 +38,7 @@ export interface CreateChimeWebhookConfigurationCommandOutput __MetadataBearer {} /** - * Creates Chime Webhook Configuration + *

Creates an AWS Chatbot configuration for Amazon Chime.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -86,19 +91,19 @@ export interface CreateChimeWebhookConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link ConflictException} (client fault) - * There was an issue processing your request. + *

There was an issue processing your request.

* * @throws {@link CreateChimeWebhookConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link LimitExceededException} (client fault) - * You have exceeded a service limit for AWS Chatbot. + *

You have exceeded a service limit for AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -124,7 +129,7 @@ export class CreateChimeWebhookConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "CreateChimeWebhookConfiguration", {}) .n("ChatbotClient", "CreateChimeWebhookConfigurationCommand") - .f(void 0, void 0) + .f(CreateChimeWebhookConfigurationRequestFilterSensitiveLog, CreateChimeWebhookConfigurationResultFilterSensitiveLog) .ser(se_CreateChimeWebhookConfigurationCommand) .de(de_CreateChimeWebhookConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/CreateMicrosoftTeamsChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/CreateMicrosoftTeamsChannelConfigurationCommand.ts index a566af113226..752efab62ac5 100644 --- a/clients/client-chatbot/src/commands/CreateMicrosoftTeamsChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/CreateMicrosoftTeamsChannelConfigurationCommand.ts @@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { CreateTeamsChannelConfigurationRequest, CreateTeamsChannelConfigurationResult } from "../models/models_0"; +import { + CreateTeamsChannelConfigurationRequest, + CreateTeamsChannelConfigurationRequestFilterSensitiveLog, + CreateTeamsChannelConfigurationResult, + CreateTeamsChannelConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_CreateMicrosoftTeamsChannelConfigurationCommand, se_CreateMicrosoftTeamsChannelConfigurationCommand, @@ -33,7 +38,7 @@ export interface CreateMicrosoftTeamsChannelConfigurationCommandOutput __MetadataBearer {} /** - * Creates MS Teams Channel Configuration + *

Creates an AWS Chatbot configuration for Microsoft Teams.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -101,19 +106,19 @@ export interface CreateMicrosoftTeamsChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link ConflictException} (client fault) - * There was an issue processing your request. + *

There was an issue processing your request.

* * @throws {@link CreateTeamsChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link LimitExceededException} (client fault) - * You have exceeded a service limit for AWS Chatbot. + *

You have exceeded a service limit for AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -139,7 +144,7 @@ export class CreateMicrosoftTeamsChannelConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "CreateMicrosoftTeamsChannelConfiguration", {}) .n("ChatbotClient", "CreateMicrosoftTeamsChannelConfigurationCommand") - .f(void 0, void 0) + .f(CreateTeamsChannelConfigurationRequestFilterSensitiveLog, CreateTeamsChannelConfigurationResultFilterSensitiveLog) .ser(se_CreateMicrosoftTeamsChannelConfigurationCommand) .de(de_CreateMicrosoftTeamsChannelConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/CreateSlackChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/CreateSlackChannelConfigurationCommand.ts index e48e25caf46b..30cab1cded86 100644 --- a/clients/client-chatbot/src/commands/CreateSlackChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/CreateSlackChannelConfigurationCommand.ts @@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { CreateSlackChannelConfigurationRequest, CreateSlackChannelConfigurationResult } from "../models/models_0"; +import { + CreateSlackChannelConfigurationRequest, + CreateSlackChannelConfigurationRequestFilterSensitiveLog, + CreateSlackChannelConfigurationResult, + CreateSlackChannelConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_CreateSlackChannelConfigurationCommand, se_CreateSlackChannelConfigurationCommand, @@ -33,7 +38,7 @@ export interface CreateSlackChannelConfigurationCommandOutput __MetadataBearer {} /** - * Creates Slack Channel Configuration + *

Creates an AWS Chatbot confugration for Slack.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -98,19 +103,19 @@ export interface CreateSlackChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link ConflictException} (client fault) - * There was an issue processing your request. + *

There was an issue processing your request.

* * @throws {@link CreateSlackChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link LimitExceededException} (client fault) - * You have exceeded a service limit for AWS Chatbot. + *

You have exceeded a service limit for AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -136,7 +141,7 @@ export class CreateSlackChannelConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "CreateSlackChannelConfiguration", {}) .n("ChatbotClient", "CreateSlackChannelConfigurationCommand") - .f(void 0, void 0) + .f(CreateSlackChannelConfigurationRequestFilterSensitiveLog, CreateSlackChannelConfigurationResultFilterSensitiveLog) .ser(se_CreateSlackChannelConfigurationCommand) .de(de_CreateSlackChannelConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/DeleteChimeWebhookConfigurationCommand.ts b/clients/client-chatbot/src/commands/DeleteChimeWebhookConfigurationCommand.ts index 6e01e407f039..cfc7651b53a4 100644 --- a/clients/client-chatbot/src/commands/DeleteChimeWebhookConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteChimeWebhookConfigurationCommand.ts @@ -33,7 +33,7 @@ export interface DeleteChimeWebhookConfigurationCommandOutput __MetadataBearer {} /** - * Deletes a Chime Webhook Configuration + *

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,16 +56,16 @@ export interface DeleteChimeWebhookConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteChimeWebhookConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsChannelConfigurationCommand.ts index 9f4d75b5ff2a..f1f0d5cba26f 100644 --- a/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsChannelConfigurationCommand.ts @@ -33,7 +33,7 @@ export interface DeleteMicrosoftTeamsChannelConfigurationCommandOutput __MetadataBearer {} /** - * Deletes MS Teams Channel Configuration + *

Deletes a Microsoft Teams channel configuration for AWS Chatbot

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,16 +56,16 @@ export interface DeleteMicrosoftTeamsChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteTeamsChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsConfiguredTeamCommand.ts b/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsConfiguredTeamCommand.ts index d5436c869bd0..60d02f33e448 100644 --- a/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsConfiguredTeamCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsConfiguredTeamCommand.ts @@ -33,7 +33,8 @@ export interface DeleteMicrosoftTeamsConfiguredTeamCommandOutput __MetadataBearer {} /** - * 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. + *

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. + *

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,10 +57,10 @@ export interface DeleteMicrosoftTeamsConfiguredTeamCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteTeamsConfiguredTeamException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsUserIdentityCommand.ts b/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsUserIdentityCommand.ts index 7ab74c927a79..1134cef09281 100644 --- a/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsUserIdentityCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteMicrosoftTeamsUserIdentityCommand.ts @@ -33,7 +33,7 @@ export interface DeleteMicrosoftTeamsUserIdentityCommandOutput __MetadataBearer {} /** - * Deletes a Teams user identity + *

Identifes a user level permission for a channel configuration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,13 +57,13 @@ export interface DeleteMicrosoftTeamsUserIdentityCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteMicrosoftTeamsUserIdentityException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DeleteSlackChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/DeleteSlackChannelConfigurationCommand.ts index a41e01a5e3fc..2729046943bc 100644 --- a/clients/client-chatbot/src/commands/DeleteSlackChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteSlackChannelConfigurationCommand.ts @@ -33,7 +33,7 @@ export interface DeleteSlackChannelConfigurationCommandOutput __MetadataBearer {} /** - * Deletes Slack Channel Configuration + *

Deletes a Slack channel configuration for AWS Chatbot

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,16 +56,16 @@ export interface DeleteSlackChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteSlackChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DeleteSlackUserIdentityCommand.ts b/clients/client-chatbot/src/commands/DeleteSlackUserIdentityCommand.ts index de9ae993fc6b..87bab9c23c19 100644 --- a/clients/client-chatbot/src/commands/DeleteSlackUserIdentityCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteSlackUserIdentityCommand.ts @@ -28,7 +28,7 @@ export interface DeleteSlackUserIdentityCommandInput extends DeleteSlackUserIden export interface DeleteSlackUserIdentityCommandOutput extends DeleteSlackUserIdentityResult, __MetadataBearer {} /** - * Deletes a Slack user identity + *

Deletes a user level permission for a Slack channel configuration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,13 +53,13 @@ export interface DeleteSlackUserIdentityCommandOutput extends DeleteSlackUserIde * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteSlackUserIdentityException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DeleteSlackWorkspaceAuthorizationCommand.ts b/clients/client-chatbot/src/commands/DeleteSlackWorkspaceAuthorizationCommand.ts index c1c12ec95a7c..0637445d3361 100644 --- a/clients/client-chatbot/src/commands/DeleteSlackWorkspaceAuthorizationCommand.ts +++ b/clients/client-chatbot/src/commands/DeleteSlackWorkspaceAuthorizationCommand.ts @@ -33,7 +33,8 @@ export interface DeleteSlackWorkspaceAuthorizationCommandOutput __MetadataBearer {} /** - * 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. + *

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. + *

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,10 +57,10 @@ export interface DeleteSlackWorkspaceAuthorizationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DeleteSlackWorkspaceAuthorizationFault} (server fault) - * There was an issue deleting your Slack workspace. + *

There was an issue deleting your Slack workspace.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DescribeChimeWebhookConfigurationsCommand.ts b/clients/client-chatbot/src/commands/DescribeChimeWebhookConfigurationsCommand.ts index 0016e6d81a57..60f19fd2a9ca 100644 --- a/clients/client-chatbot/src/commands/DescribeChimeWebhookConfigurationsCommand.ts +++ b/clients/client-chatbot/src/commands/DescribeChimeWebhookConfigurationsCommand.ts @@ -9,6 +9,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribeChimeWebhookConfigurationsRequest, DescribeChimeWebhookConfigurationsResult, + DescribeChimeWebhookConfigurationsResultFilterSensitiveLog, } from "../models/models_0"; import { de_DescribeChimeWebhookConfigurationsCommand, @@ -36,7 +37,7 @@ export interface DescribeChimeWebhookConfigurationsCommandOutput __MetadataBearer {} /** - * Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn + *

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -81,13 +82,13 @@ export interface DescribeChimeWebhookConfigurationsCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DescribeChimeWebhookConfigurationsException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -113,7 +114,7 @@ export class DescribeChimeWebhookConfigurationsCommand extends $Command }) .s("WheatleyOrchestration_20171011", "DescribeChimeWebhookConfigurations", {}) .n("ChatbotClient", "DescribeChimeWebhookConfigurationsCommand") - .f(void 0, void 0) + .f(void 0, DescribeChimeWebhookConfigurationsResultFilterSensitiveLog) .ser(se_DescribeChimeWebhookConfigurationsCommand) .de(de_DescribeChimeWebhookConfigurationsCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/DescribeSlackChannelConfigurationsCommand.ts b/clients/client-chatbot/src/commands/DescribeSlackChannelConfigurationsCommand.ts index f033a596f5cd..d72820542c1c 100644 --- a/clients/client-chatbot/src/commands/DescribeSlackChannelConfigurationsCommand.ts +++ b/clients/client-chatbot/src/commands/DescribeSlackChannelConfigurationsCommand.ts @@ -9,6 +9,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { DescribeSlackChannelConfigurationsRequest, DescribeSlackChannelConfigurationsResult, + DescribeSlackChannelConfigurationsResultFilterSensitiveLog, } from "../models/models_0"; import { de_DescribeSlackChannelConfigurationsCommand, @@ -36,7 +37,7 @@ export interface DescribeSlackChannelConfigurationsCommandOutput __MetadataBearer {} /** - * Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn + *

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -88,13 +89,13 @@ export interface DescribeSlackChannelConfigurationsCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DescribeSlackChannelConfigurationsException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -120,7 +121,7 @@ export class DescribeSlackChannelConfigurationsCommand extends $Command }) .s("WheatleyOrchestration_20171011", "DescribeSlackChannelConfigurations", {}) .n("ChatbotClient", "DescribeSlackChannelConfigurationsCommand") - .f(void 0, void 0) + .f(void 0, DescribeSlackChannelConfigurationsResultFilterSensitiveLog) .ser(se_DescribeSlackChannelConfigurationsCommand) .de(de_DescribeSlackChannelConfigurationsCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/DescribeSlackUserIdentitiesCommand.ts b/clients/client-chatbot/src/commands/DescribeSlackUserIdentitiesCommand.ts index 2bc9b494e250..e7b35998c71f 100644 --- a/clients/client-chatbot/src/commands/DescribeSlackUserIdentitiesCommand.ts +++ b/clients/client-chatbot/src/commands/DescribeSlackUserIdentitiesCommand.ts @@ -31,7 +31,7 @@ export interface DescribeSlackUserIdentitiesCommandInput extends DescribeSlackUs export interface DescribeSlackUserIdentitiesCommandOutput extends DescribeSlackUserIdentitiesResult, __MetadataBearer {} /** - * Lists all Slack user identities with a mapped role. + *

Lists all Slack user identities with a mapped role.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,13 +67,13 @@ export interface DescribeSlackUserIdentitiesCommandOutput extends DescribeSlackU * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DescribeSlackUserIdentitiesException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/DescribeSlackWorkspacesCommand.ts b/clients/client-chatbot/src/commands/DescribeSlackWorkspacesCommand.ts index 2e3e59aaa3fd..9aed0d6243cf 100644 --- a/clients/client-chatbot/src/commands/DescribeSlackWorkspacesCommand.ts +++ b/clients/client-chatbot/src/commands/DescribeSlackWorkspacesCommand.ts @@ -28,7 +28,7 @@ export interface DescribeSlackWorkspacesCommandInput extends DescribeSlackWorksp export interface DescribeSlackWorkspacesCommandOutput extends DescribeSlackWorkspacesResult, __MetadataBearer {} /** - * Lists all authorized Slack Workspaces for AWS Account + *

List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -60,13 +60,13 @@ export interface DescribeSlackWorkspacesCommandOutput extends DescribeSlackWorks * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link DescribeSlackWorkspacesException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/GetAccountPreferencesCommand.ts b/clients/client-chatbot/src/commands/GetAccountPreferencesCommand.ts index 2b67b60daa72..afd539f2a538 100644 --- a/clients/client-chatbot/src/commands/GetAccountPreferencesCommand.ts +++ b/clients/client-chatbot/src/commands/GetAccountPreferencesCommand.ts @@ -28,7 +28,7 @@ export interface GetAccountPreferencesCommandInput extends GetAccountPreferences export interface GetAccountPreferencesCommandOutput extends GetAccountPreferencesResult, __MetadataBearer {} /** - * Get Chatbot account level preferences + *

Returns AWS Chatbot account preferences.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,10 +54,10 @@ export interface GetAccountPreferencesCommandOutput extends GetAccountPreference * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link GetAccountPreferencesException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/GetMicrosoftTeamsChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/GetMicrosoftTeamsChannelConfigurationCommand.ts index 1d7d3227d21e..2b3780ded020 100644 --- a/clients/client-chatbot/src/commands/GetMicrosoftTeamsChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/GetMicrosoftTeamsChannelConfigurationCommand.ts @@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetTeamsChannelConfigurationRequest, GetTeamsChannelConfigurationResult } from "../models/models_0"; +import { + GetTeamsChannelConfigurationRequest, + GetTeamsChannelConfigurationResult, + GetTeamsChannelConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_GetMicrosoftTeamsChannelConfigurationCommand, se_GetMicrosoftTeamsChannelConfigurationCommand, @@ -33,7 +37,7 @@ export interface GetMicrosoftTeamsChannelConfigurationCommandOutput __MetadataBearer {} /** - * Get a single MS Teams Channel Configurations + *

Returns a Microsoft Teams channel configuration in an AWS account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -81,13 +85,13 @@ export interface GetMicrosoftTeamsChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link GetTeamsChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -113,7 +117,7 @@ export class GetMicrosoftTeamsChannelConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "GetMicrosoftTeamsChannelConfiguration", {}) .n("ChatbotClient", "GetMicrosoftTeamsChannelConfigurationCommand") - .f(void 0, void 0) + .f(void 0, GetTeamsChannelConfigurationResultFilterSensitiveLog) .ser(se_GetMicrosoftTeamsChannelConfigurationCommand) .de(de_GetMicrosoftTeamsChannelConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/ListMicrosoftTeamsChannelConfigurationsCommand.ts b/clients/client-chatbot/src/commands/ListMicrosoftTeamsChannelConfigurationsCommand.ts index db49c4053b02..d4b0d2291a4a 100644 --- a/clients/client-chatbot/src/commands/ListMicrosoftTeamsChannelConfigurationsCommand.ts +++ b/clients/client-chatbot/src/commands/ListMicrosoftTeamsChannelConfigurationsCommand.ts @@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListTeamsChannelConfigurationsRequest, ListTeamsChannelConfigurationsResult } from "../models/models_0"; +import { + ListTeamsChannelConfigurationsRequest, + ListTeamsChannelConfigurationsResult, + ListTeamsChannelConfigurationsResultFilterSensitiveLog, +} from "../models/models_0"; import { de_ListMicrosoftTeamsChannelConfigurationsCommand, se_ListMicrosoftTeamsChannelConfigurationsCommand, @@ -33,7 +37,7 @@ export interface ListMicrosoftTeamsChannelConfigurationsCommandOutput __MetadataBearer {} /** - * Lists MS Teams Channel Configurations optionally filtered by TeamId + *

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -86,13 +90,13 @@ export interface ListMicrosoftTeamsChannelConfigurationsCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ListTeamsChannelConfigurationsException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -118,7 +122,7 @@ export class ListMicrosoftTeamsChannelConfigurationsCommand extends $Command }) .s("WheatleyOrchestration_20171011", "ListMicrosoftTeamsChannelConfigurations", {}) .n("ChatbotClient", "ListMicrosoftTeamsChannelConfigurationsCommand") - .f(void 0, void 0) + .f(void 0, ListTeamsChannelConfigurationsResultFilterSensitiveLog) .ser(se_ListMicrosoftTeamsChannelConfigurationsCommand) .de(de_ListMicrosoftTeamsChannelConfigurationsCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/ListMicrosoftTeamsConfiguredTeamsCommand.ts b/clients/client-chatbot/src/commands/ListMicrosoftTeamsConfiguredTeamsCommand.ts index f76a1a4c4805..3cca95a9cc31 100644 --- a/clients/client-chatbot/src/commands/ListMicrosoftTeamsConfiguredTeamsCommand.ts +++ b/clients/client-chatbot/src/commands/ListMicrosoftTeamsConfiguredTeamsCommand.ts @@ -33,7 +33,7 @@ export interface ListMicrosoftTeamsConfiguredTeamsCommandOutput __MetadataBearer {} /** - * Lists all authorized MS teams for AWS Account + *

Lists all authorized Microsoft Teams for an AWS Account

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,13 +66,13 @@ export interface ListMicrosoftTeamsConfiguredTeamsCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ListMicrosoftTeamsConfiguredTeamsException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/ListMicrosoftTeamsUserIdentitiesCommand.ts b/clients/client-chatbot/src/commands/ListMicrosoftTeamsUserIdentitiesCommand.ts index d8656e80bea8..e1f48ba84e4d 100644 --- a/clients/client-chatbot/src/commands/ListMicrosoftTeamsUserIdentitiesCommand.ts +++ b/clients/client-chatbot/src/commands/ListMicrosoftTeamsUserIdentitiesCommand.ts @@ -33,7 +33,7 @@ export interface ListMicrosoftTeamsUserIdentitiesCommandOutput __MetadataBearer {} /** - * Lists all Microsoft Teams user identities with a mapped role. + *

A list all Microsoft Teams user identities with a mapped role.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -71,13 +71,13 @@ export interface ListMicrosoftTeamsUserIdentitiesCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ListMicrosoftTeamsUserIdentitiesException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/ListTagsForResourceCommand.ts b/clients/client-chatbot/src/commands/ListTagsForResourceCommand.ts index 2222a949c8af..3c39d1ceb9f5 100644 --- a/clients/client-chatbot/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-chatbot/src/commands/ListTagsForResourceCommand.ts @@ -28,7 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - * Retrieves the list of tags applied to a configuration. + *

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -58,14 +58,13 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) - * Customer/consumer-facing internal service exception. - * https://w.amazon.com/index.php/AWS/API_Standards/Exceptions#InternalServiceError + *

Unexpected error during processing of request.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ServiceUnavailableException} (client fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/TagResourceCommand.ts b/clients/client-chatbot/src/commands/TagResourceCommand.ts index e32df205f02b..f975786544fc 100644 --- a/clients/client-chatbot/src/commands/TagResourceCommand.ts +++ b/clients/client-chatbot/src/commands/TagResourceCommand.ts @@ -28,7 +28,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - * Applies the supplied tags to a configuration. + *

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,17 +57,16 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) - * Customer/consumer-facing internal service exception. - * https://w.amazon.com/index.php/AWS/API_Standards/Exceptions#InternalServiceError + *

Unexpected error during processing of request.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ServiceUnavailableException} (client fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link TooManyTagsException} (client fault) - * The supplied list of tags contains too many tags. + *

The supplied list of tags contains too many tags.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/UntagResourceCommand.ts b/clients/client-chatbot/src/commands/UntagResourceCommand.ts index 9a374e5c9ba2..d713621a8895 100644 --- a/clients/client-chatbot/src/commands/UntagResourceCommand.ts +++ b/clients/client-chatbot/src/commands/UntagResourceCommand.ts @@ -28,7 +28,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - * Removes the supplied tags from a configuration + *

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,14 +54,13 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) - * Customer/consumer-facing internal service exception. - * https://w.amazon.com/index.php/AWS/API_Standards/Exceptions#InternalServiceError + *

Unexpected error during processing of request.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link ServiceUnavailableException} (client fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/UpdateAccountPreferencesCommand.ts b/clients/client-chatbot/src/commands/UpdateAccountPreferencesCommand.ts index ade7a32ca481..585fe6daada1 100644 --- a/clients/client-chatbot/src/commands/UpdateAccountPreferencesCommand.ts +++ b/clients/client-chatbot/src/commands/UpdateAccountPreferencesCommand.ts @@ -28,7 +28,7 @@ export interface UpdateAccountPreferencesCommandInput extends UpdateAccountPrefe export interface UpdateAccountPreferencesCommandOutput extends UpdateAccountPreferencesResult, __MetadataBearer {} /** - * Update Chatbot account level preferences + *

Updates AWS Chatbot account preferences.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,13 +57,13 @@ export interface UpdateAccountPreferencesCommandOutput extends UpdateAccountPref * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link UpdateAccountPreferencesException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

diff --git a/clients/client-chatbot/src/commands/UpdateChimeWebhookConfigurationCommand.ts b/clients/client-chatbot/src/commands/UpdateChimeWebhookConfigurationCommand.ts index 4845eda91ecf..e810918d7cb3 100644 --- a/clients/client-chatbot/src/commands/UpdateChimeWebhookConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/UpdateChimeWebhookConfigurationCommand.ts @@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateChimeWebhookConfigurationRequest, UpdateChimeWebhookConfigurationResult } from "../models/models_0"; +import { + UpdateChimeWebhookConfigurationRequest, + UpdateChimeWebhookConfigurationRequestFilterSensitiveLog, + UpdateChimeWebhookConfigurationResult, + UpdateChimeWebhookConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_UpdateChimeWebhookConfigurationCommand, se_UpdateChimeWebhookConfigurationCommand, @@ -33,7 +38,7 @@ export interface UpdateChimeWebhookConfigurationCommandOutput __MetadataBearer {} /** - * Updates a Chime Webhook Configuration + *

Updates a Amazon Chime webhook configuration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -80,16 +85,16 @@ export interface UpdateChimeWebhookConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link UpdateChimeWebhookConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -115,7 +120,7 @@ export class UpdateChimeWebhookConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "UpdateChimeWebhookConfiguration", {}) .n("ChatbotClient", "UpdateChimeWebhookConfigurationCommand") - .f(void 0, void 0) + .f(UpdateChimeWebhookConfigurationRequestFilterSensitiveLog, UpdateChimeWebhookConfigurationResultFilterSensitiveLog) .ser(se_UpdateChimeWebhookConfigurationCommand) .de(de_UpdateChimeWebhookConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/UpdateMicrosoftTeamsChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/UpdateMicrosoftTeamsChannelConfigurationCommand.ts index 94aa2bfb79ec..9924b1a8854d 100644 --- a/clients/client-chatbot/src/commands/UpdateMicrosoftTeamsChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/UpdateMicrosoftTeamsChannelConfigurationCommand.ts @@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateTeamsChannelConfigurationRequest, UpdateTeamsChannelConfigurationResult } from "../models/models_0"; +import { + UpdateTeamsChannelConfigurationRequest, + UpdateTeamsChannelConfigurationRequestFilterSensitiveLog, + UpdateTeamsChannelConfigurationResult, + UpdateTeamsChannelConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_UpdateMicrosoftTeamsChannelConfigurationCommand, se_UpdateMicrosoftTeamsChannelConfigurationCommand, @@ -33,7 +38,7 @@ export interface UpdateMicrosoftTeamsChannelConfigurationCommandOutput __MetadataBearer {} /** - * Updates MS Teams Channel Configuration + *

Updates an Microsoft Teams channel configuration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -92,16 +97,16 @@ export interface UpdateMicrosoftTeamsChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link UpdateTeamsChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -127,7 +132,7 @@ export class UpdateMicrosoftTeamsChannelConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "UpdateMicrosoftTeamsChannelConfiguration", {}) .n("ChatbotClient", "UpdateMicrosoftTeamsChannelConfigurationCommand") - .f(void 0, void 0) + .f(UpdateTeamsChannelConfigurationRequestFilterSensitiveLog, UpdateTeamsChannelConfigurationResultFilterSensitiveLog) .ser(se_UpdateMicrosoftTeamsChannelConfigurationCommand) .de(de_UpdateMicrosoftTeamsChannelConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/commands/UpdateSlackChannelConfigurationCommand.ts b/clients/client-chatbot/src/commands/UpdateSlackChannelConfigurationCommand.ts index 5449bf306f30..9ec3601f2f8b 100644 --- a/clients/client-chatbot/src/commands/UpdateSlackChannelConfigurationCommand.ts +++ b/clients/client-chatbot/src/commands/UpdateSlackChannelConfigurationCommand.ts @@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateSlackChannelConfigurationRequest, UpdateSlackChannelConfigurationResult } from "../models/models_0"; +import { + UpdateSlackChannelConfigurationRequest, + UpdateSlackChannelConfigurationRequestFilterSensitiveLog, + UpdateSlackChannelConfigurationResult, + UpdateSlackChannelConfigurationResultFilterSensitiveLog, +} from "../models/models_0"; import { de_UpdateSlackChannelConfigurationCommand, se_UpdateSlackChannelConfigurationCommand, @@ -33,7 +38,7 @@ export interface UpdateSlackChannelConfigurationCommandOutput __MetadataBearer {} /** - * Updates Slack Channel Configuration + *

Updates a Slack channel configuration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -91,16 +96,16 @@ export interface UpdateSlackChannelConfigurationCommandOutput * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape. * * @throws {@link InvalidParameterException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link InvalidRequestException} (client fault) - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* * @throws {@link ResourceNotFoundException} (client fault) - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* * @throws {@link UpdateSlackChannelConfigurationException} (server fault) - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* * @throws {@link ChatbotServiceException} *

Base exception class for all service exceptions from Chatbot service.

@@ -126,7 +131,7 @@ export class UpdateSlackChannelConfigurationCommand extends $Command }) .s("WheatleyOrchestration_20171011", "UpdateSlackChannelConfiguration", {}) .n("ChatbotClient", "UpdateSlackChannelConfigurationCommand") - .f(void 0, void 0) + .f(UpdateSlackChannelConfigurationRequestFilterSensitiveLog, UpdateSlackChannelConfigurationResultFilterSensitiveLog) .ser(se_UpdateSlackChannelConfigurationCommand) .de(de_UpdateSlackChannelConfigurationCommand) .build() {} diff --git a/clients/client-chatbot/src/index.ts b/clients/client-chatbot/src/index.ts index 4bb7d230d3eb..f06b8272f168 100644 --- a/clients/client-chatbot/src/index.ts +++ b/clients/client-chatbot/src/index.ts @@ -1,7 +1,30 @@ // smithy-typescript generated code /* eslint-disable */ /** - * AWS Chatbot API + *

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

+ *

AWS Chatbot APIs are currently available in the following Regions:

+ * + *

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

+ * + *

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

+ * * * @packageDocumentation */ diff --git a/clients/client-chatbot/src/models/models_0.ts b/clients/client-chatbot/src/models/models_0.ts index 36dea3a8a6b7..3fa1c2bb7730 100644 --- a/clients/client-chatbot/src/models/models_0.ts +++ b/clients/client-chatbot/src/models/models_0.ts @@ -1,118 +1,130 @@ // smithy-typescript generated code -import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; import { ChatbotServiceException as __BaseException } from "./ChatbotServiceException"; /** - * Preferences which apply for AWS Chatbot usage in the calling AWS account. + *

Preferences related to AWS Chatbot usage in the calling AWS account.

* @public */ export interface AccountPreferences { /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; /** - * 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 AWS Chatbot’s AI technologies. + *

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. + *

* @public */ TrainingDataCollectionEnabled?: boolean; } /** - * A tag applied to the configuration. + *

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

+ * + *

Do not include confidential or sensitive information in this field.

+ * + *

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

* @public */ export interface Tag { /** - * The tag key. + *

The key of the tag.

* @public */ TagKey: string | undefined; /** - * The tag value. + *

The value of the tag.

* @public */ TagValue: string | undefined; } /** - * An AWS Chatbot configuration for Amazon Chime. + *

An AWS Chatbot configuration for Amazon Chime.

* @public */ export interface ChimeWebhookConfiguration { /** - * Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. + *

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. + *

* @public */ WebhookDescription: string | undefined; /** - * The ARN of the ChimeWebhookConfiguration. + *

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns: string[] | undefined; /** - * The name of the configuration. + *

The name of the configuration.

* @public */ ConfigurationName?: string; /** - * Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * A list of tags applied to the configuration. + *

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

* @public */ Tags?: Tag[]; } /** - * A Microsoft Teams team that has been authorized with AWS Chatbot. + *

A Microsoft Teams team that is authorized with AWS Chatbot.

* @public */ export interface ConfiguredTeam { /** - * The ID of the Microsoft Teams tenant. + *

The ID of the Microsoft Teams tenant.

* @public */ TenantId: string | undefined; /** - * The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide. + *

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. + *

* @public */ TeamId: string | undefined; /** - * The name of the Microsoft Teams Team. + *

The name of the Microsoft Teams Team.

* @public */ TeamName?: string; } /** - * There was an issue processing your request. + *

There was an issue processing your request.

* @public */ export class ConflictException extends __BaseException { @@ -132,7 +144,7 @@ export class ConflictException extends __BaseException { } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class CreateChimeWebhookConfigurationException extends __BaseException { @@ -158,43 +170,47 @@ export class CreateChimeWebhookConfigurationException extends __BaseException { */ export interface CreateChimeWebhookConfigurationRequest { /** - * Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. + *

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. + *

* @public */ WebhookDescription: string | undefined; /** - * URL for the Chime webhook. + *

The URL for the Amazon Chime webhook.

* @public */ WebhookUrl: string | undefined; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns: string[] | undefined; /** - * This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The name of the configuration. + *

The name of the configuration.

* @public */ ConfigurationName: string | undefined; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * A list of tags to apply to the configuration. + *

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

* @public */ Tags?: Tag[]; @@ -205,14 +221,14 @@ export interface CreateChimeWebhookConfigurationRequest { */ export interface CreateChimeWebhookConfigurationResult { /** - * Chime webhook configuration. + *

An Amazon Chime webhook configuration.

* @public */ WebhookConfiguration?: ChimeWebhookConfiguration; } /** - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* @public */ export class InvalidParameterException extends __BaseException { @@ -232,7 +248,7 @@ export class InvalidParameterException extends __BaseException { } /** - * Your request input doesn't meet the constraints that AWS Chatbot requires. + *

Your request input doesn't meet the constraints required by AWS Chatbot.

* @public */ export class InvalidRequestException extends __BaseException { @@ -252,7 +268,7 @@ export class InvalidRequestException extends __BaseException { } /** - * You have exceeded a service limit for AWS Chatbot. + *

You have exceeded a service limit for AWS Chatbot.

* @public */ export class LimitExceededException extends __BaseException { @@ -272,7 +288,7 @@ export class LimitExceededException extends __BaseException { } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class CreateTeamsChannelConfigurationException extends __BaseException { @@ -298,157 +314,167 @@ export class CreateTeamsChannelConfigurationException extends __BaseException { */ export interface CreateTeamsChannelConfigurationRequest { /** - * The ID of the Microsoft Teams channel. + *

The ID of the Microsoft Teams channel.

* @public */ ChannelId: string | undefined; /** - * The name of the Microsoft Teams channel. + *

The name of the Microsoft Teams channel.

* @public */ ChannelName?: string; /** - * The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide. + *

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. + *

* @public */ TeamId: string | undefined; /** - * The name of the Microsoft Teams Team. + *

The name of the Microsoft Teams Team.

* @public */ TeamName?: string; /** - * The ID of the Microsoft Teams tenant. + *

The ID of the Microsoft Teams tenant.

* @public */ TenantId: string | undefined; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns?: string[]; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The name of the configuration. + *

The name of the configuration.

* @public */ ConfigurationName: string | undefined; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * 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. + *

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. + *

* @public */ GuardrailPolicyArns?: string[]; /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; /** - * A list of tags to apply to the configuration. + *

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

* @public */ Tags?: Tag[]; } /** - * An AWS Chatbot configuration for Microsoft Teams. + *

An AWS Chatbot configuration for Microsoft Teams.

* @public */ export interface TeamsChannelConfiguration { /** - * The ID of the Microsoft Teams channel. + *

The ID of the Microsoft Teams channel.

* @public */ ChannelId: string | undefined; /** - * The name of the Microsoft Teams channel. + *

The name of the Microsoft Teams channel.

* @public */ ChannelName?: string; /** - * The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide. + *

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. + *

* @public */ TeamId: string | undefined; /** - * The name of the Microsoft Teams Team. + *

The name of the Microsoft Teams Team.

* @public */ TeamName?: string; /** - * The ID of the Microsoft Teams tenant. + *

The ID of the Microsoft Teams tenant.

* @public */ TenantId: string | undefined; /** - * The ARN of the MicrosoftTeamsChannelConfiguration. + *

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns: string[] | undefined; /** - * The name of the configuration. + *

The name of the configuration.

* @public */ ConfigurationName?: string; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * 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. + *

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. + *

* @public */ GuardrailPolicyArns?: string[]; /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; /** - * A list of tags applied to the configuration. + *

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

* @public */ Tags?: Tag[]; @@ -459,14 +485,14 @@ export interface TeamsChannelConfiguration { */ export interface CreateTeamsChannelConfigurationResult { /** - * The configuration for a Microsoft Teams channel configured with AWS Chatbot. + *

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

* @public */ ChannelConfiguration?: TeamsChannelConfiguration; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class CreateSlackChannelConfigurationException extends __BaseException { @@ -492,139 +518,149 @@ export class CreateSlackChannelConfigurationException extends __BaseException { */ export interface CreateSlackChannelConfigurationRequest { /** - * The ID of the Slack workspace authorized with AWS Chatbot. + *

The ID of the Slack workspace authorized with AWS Chatbot.

* @public */ SlackTeamId: string | undefined; /** - * The ID of the Slack channel. To get the 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. + *

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. + *

* @public */ SlackChannelId: string | undefined; /** - * The name of the Slack Channel. + *

The name of the Slack channel.

* @public */ SlackChannelName?: string; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns?: string[]; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The name of the configuration. + *

The name of the configuration.

* @public */ ConfigurationName: string | undefined; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * 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. + *

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. + *

* @public */ GuardrailPolicyArns?: string[]; /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; /** - * A list of tags to apply to the configuration. + *

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

* @public */ Tags?: Tag[]; } /** - * An AWS Chatbot configuration for Slack. + *

An AWS Chatbot configuration for Slack.

* @public */ export interface SlackChannelConfiguration { /** - * Name of the Slack Workspace. + *

Name of the Slack workspace.

* @public */ SlackTeamName: string | undefined; /** - * The ID of the Slack workspace authorized with AWS Chatbot. + *

The ID of the Slack workspace authorized with Amazon Chime.

* @public */ SlackTeamId: string | undefined; /** - * The ID of the Slack channel. To get the 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. + *

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. + *

* @public */ SlackChannelId: string | undefined; /** - * The name of the Slack Channel. + *

The name of the Slack channel.

* @public */ SlackChannelName: string | undefined; /** - * The ARN of the SlackChannelConfiguration. + *

The Amazon Resource Number (ARN) of the SlackChannelConfiguration.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns: string[] | undefined; /** - * The name of the configuration. + *

The name of the configuration.

* @public */ ConfigurationName?: string; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * 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. + *

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. + *

* @public */ GuardrailPolicyArns?: string[]; /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; /** - * A list of tags applied to the configuration. + *

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

* @public */ Tags?: Tag[]; @@ -635,14 +671,14 @@ export interface SlackChannelConfiguration { */ export interface CreateSlackChannelConfigurationResult { /** - * The configuration for a Slack channel configured with AWS Chatbot. + *

The configuration for a Slack channel configured with AWS Chatbot.

* @public */ ChannelConfiguration?: SlackChannelConfiguration; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DeleteChimeWebhookConfigurationException extends __BaseException { @@ -668,7 +704,7 @@ export class DeleteChimeWebhookConfigurationException extends __BaseException { */ export interface DeleteChimeWebhookConfigurationRequest { /** - * The ARN of the ChimeWebhookConfiguration to delete. + *

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.

* @public */ ChatConfigurationArn: string | undefined; @@ -680,7 +716,7 @@ export interface DeleteChimeWebhookConfigurationRequest { export interface DeleteChimeWebhookConfigurationResult {} /** - * We were not able to find the resource for your request. + *

We were unable to find the resource for your request

* @public */ export class ResourceNotFoundException extends __BaseException { @@ -702,7 +738,7 @@ export class ResourceNotFoundException extends __BaseException { } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DeleteTeamsChannelConfigurationException extends __BaseException { @@ -728,7 +764,7 @@ export class DeleteTeamsChannelConfigurationException extends __BaseException { */ export interface DeleteTeamsChannelConfigurationRequest { /** - * The ARN of the MicrosoftTeamsChannelConfiguration to delete. + *

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

* @public */ ChatConfigurationArn: string | undefined; @@ -740,7 +776,7 @@ export interface DeleteTeamsChannelConfigurationRequest { export interface DeleteTeamsChannelConfigurationResult {} /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DeleteTeamsConfiguredTeamException extends __BaseException { @@ -766,7 +802,9 @@ export class DeleteTeamsConfiguredTeamException extends __BaseException { */ export interface DeleteTeamsConfiguredTeamRequest { /** - * The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide. + *

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. + *

* @public */ TeamId: string | undefined; @@ -778,7 +816,7 @@ export interface DeleteTeamsConfiguredTeamRequest { export interface DeleteTeamsConfiguredTeamResult {} /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DeleteMicrosoftTeamsUserIdentityException extends __BaseException { @@ -804,13 +842,13 @@ export class DeleteMicrosoftTeamsUserIdentityException extends __BaseException { */ export interface DeleteMicrosoftTeamsUserIdentityRequest { /** - * The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. + *

The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

* @public */ ChatConfigurationArn: string | undefined; /** - * Id from Microsoft Teams for user. + *

The Microsoft Teams user ID.

* @public */ UserId: string | undefined; @@ -822,7 +860,7 @@ export interface DeleteMicrosoftTeamsUserIdentityRequest { export interface DeleteMicrosoftTeamsUserIdentityResult {} /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DeleteSlackChannelConfigurationException extends __BaseException { @@ -848,7 +886,7 @@ export class DeleteSlackChannelConfigurationException extends __BaseException { */ export interface DeleteSlackChannelConfigurationRequest { /** - * The ARN of the SlackChannelConfiguration to delete. + *

The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete.

* @public */ ChatConfigurationArn: string | undefined; @@ -860,7 +898,7 @@ export interface DeleteSlackChannelConfigurationRequest { export interface DeleteSlackChannelConfigurationResult {} /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DeleteSlackUserIdentityException extends __BaseException { @@ -886,19 +924,19 @@ export class DeleteSlackUserIdentityException extends __BaseException { */ export interface DeleteSlackUserIdentityRequest { /** - * The ARN of the SlackChannelConfiguration associated with the user identity to delete. + *

The ARN of the SlackChannelConfiguration associated with the user identity to delete.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ID of the Slack workspace authorized with AWS Chatbot. + *

The ID of the Slack workspace authorized with AWS Chatbot.

* @public */ SlackTeamId: string | undefined; /** - * The ID of the user in Slack. + *

The ID of the user in Slack

* @public */ SlackUserId: string | undefined; @@ -910,7 +948,7 @@ export interface DeleteSlackUserIdentityRequest { export interface DeleteSlackUserIdentityResult {} /** - * There was an issue deleting your Slack workspace. + *

There was an issue deleting your Slack workspace.

* @public */ export class DeleteSlackWorkspaceAuthorizationFault extends __BaseException { @@ -936,7 +974,7 @@ export class DeleteSlackWorkspaceAuthorizationFault extends __BaseException { */ export interface DeleteSlackWorkspaceAuthorizationRequest { /** - * The ID of the Slack workspace authorized with AWS Chatbot. + *

The ID of the Slack workspace authorized with AWS Chatbot.

* @public */ SlackTeamId: string | undefined; @@ -948,7 +986,7 @@ export interface DeleteSlackWorkspaceAuthorizationRequest { export interface DeleteSlackWorkspaceAuthorizationResult {} /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DescribeChimeWebhookConfigurationsException extends __BaseException { @@ -974,19 +1012,21 @@ export class DescribeChimeWebhookConfigurationsException extends __BaseException */ 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. + *

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. + *

* @public */ MaxResults?: number; /** - * 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. + *

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. + *

* @public */ NextToken?: string; /** - * An optional ARN of a ChimeWebhookConfiguration to describe. + *

An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe.

* @public */ ChatConfigurationArn?: string; @@ -997,20 +1037,21 @@ export interface DescribeChimeWebhookConfigurationsRequest { */ 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. + *

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. + *

* @public */ NextToken?: string; /** - * A list of Chime webhooks associated with the account. + *

A list of Amazon Chime webhooks associated with the account.

* @public */ WebhookConfigurations?: ChimeWebhookConfiguration[]; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DescribeSlackChannelConfigurationsException extends __BaseException { @@ -1036,19 +1077,21 @@ export class DescribeSlackChannelConfigurationsException extends __BaseException */ 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. + *

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. + *

* @public */ MaxResults?: number; /** - * 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. + *

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. + *

* @public */ NextToken?: string; /** - * An optional ARN of a SlackChannelConfiguration to describe. + *

An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe.

* @public */ ChatConfigurationArn?: string; @@ -1059,20 +1102,21 @@ export interface DescribeSlackChannelConfigurationsRequest { */ 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. + *

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. + *

* @public */ NextToken?: string; /** - * A list of Slack channel configurations. + *

A list of Slack channel configurations.

* @public */ SlackChannelConfigurations?: SlackChannelConfiguration[]; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DescribeSlackUserIdentitiesException extends __BaseException { @@ -1098,55 +1142,59 @@ export class DescribeSlackUserIdentitiesException extends __BaseException { */ export interface DescribeSlackUserIdentitiesRequest { /** - * The ARN of the SlackChannelConfiguration associated with the user identities to describe. + *

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

* @public */ ChatConfigurationArn?: string; /** - * 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. + *

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. + *

* @public */ NextToken?: string; /** - * 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. + *

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. + *

* @public */ MaxResults?: number; } /** - * Identifes a User level permission for a channel configuration. + *

Identifes a user level permission for a channel configuration.

* @public */ export interface SlackUserIdentity { /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The ARN of the SlackChannelConfiguration associated with the user identity. + *

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ID of the Slack workspace authorized with AWS Chatbot. + *

The ID of the Slack workspace authorized with AWS Chatbot.

* @public */ SlackTeamId: string | undefined; /** - * The ID of the user in Slack. + *

The ID of the user in Slack

* @public */ SlackUserId: string | undefined; /** - * The AWS user identity ARN used to associate a Slack User Identity with an IAM Role. + *

The AWS user identity ARN used to associate a Slack user ID with an IAM Role.

* @public */ AwsUserIdentity?: string; @@ -1157,20 +1205,21 @@ export interface SlackUserIdentity { */ export interface DescribeSlackUserIdentitiesResult { /** - * A list of Slack User Identities. + *

A list of Slack User Identities.

* @public */ SlackUserIdentities?: SlackUserIdentity[]; /** - * 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. + *

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. + *

* @public */ NextToken?: string; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class DescribeSlackWorkspacesException extends __BaseException { @@ -1196,31 +1245,33 @@ export class DescribeSlackWorkspacesException extends __BaseException { */ 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. + *

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. + *

* @public */ MaxResults?: number; /** - * 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. + *

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. + *

* @public */ NextToken?: string; } /** - * A Slack Workspace. + *

A Slack workspace.

* @public */ export interface SlackWorkspace { /** - * The ID of the Slack workspace authorized with AWS Chatbot. + *

The ID of the Slack workspace authorized with AWS Chatbot.

* @public */ SlackTeamId: string | undefined; /** - * Name of the Slack Workspace. + *

The name of the Slack workspace.

* @public */ SlackTeamName: string | undefined; @@ -1231,20 +1282,21 @@ export interface SlackWorkspace { */ export interface DescribeSlackWorkspacesResult { /** - * A list of Slack Workspaces registered with AWS Chatbot. + *

A list of Slack workspaces registered with AWS Chatbot.

* @public */ SlackWorkspaces?: SlackWorkspace[]; /** - * 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. + *

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. + *

* @public */ NextToken?: string; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class GetAccountPreferencesException extends __BaseException { @@ -1275,14 +1327,14 @@ export interface GetAccountPreferencesRequest {} */ export interface GetAccountPreferencesResult { /** - * Preferences which apply for AWS Chatbot usage in the calling AWS account. + *

The preferences related to AWS Chatbot usage in the calling AWS account.

* @public */ AccountPreferences?: AccountPreferences; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class GetTeamsChannelConfigurationException extends __BaseException { @@ -1308,7 +1360,7 @@ export class GetTeamsChannelConfigurationException extends __BaseException { */ export interface GetTeamsChannelConfigurationRequest { /** - * The ARN of the MicrosoftTeamsChannelConfiguration to retrieve. + *

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

* @public */ ChatConfigurationArn: string | undefined; @@ -1319,15 +1371,14 @@ export interface GetTeamsChannelConfigurationRequest { */ export interface GetTeamsChannelConfigurationResult { /** - * The configuration for a Microsoft Teams channel configured with AWS Chatbot. + *

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

* @public */ ChannelConfiguration?: TeamsChannelConfiguration; } /** - * Customer/consumer-facing internal service exception. - * https://w.amazon.com/index.php/AWS/API_Standards/Exceptions#InternalServiceError + *

Unexpected error during processing of request.

* @public */ export class InternalServiceError extends __BaseException { @@ -1349,7 +1400,7 @@ export class InternalServiceError extends __BaseException { } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class ListTeamsChannelConfigurationsException extends __BaseException { @@ -1375,19 +1426,21 @@ export class ListTeamsChannelConfigurationsException extends __BaseException { */ 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. + *

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.

* @public */ MaxResults?: number; /** - * 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. + *

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.

* @public */ NextToken?: string; /** - * The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide. + *

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. + *

* @public */ TeamId?: string; @@ -1398,20 +1451,20 @@ export interface ListTeamsChannelConfigurationsRequest { */ 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. + *

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.

* @public */ NextToken?: string; /** - * A list of AWS Chatbot channel configurations for Microsoft Teams. + *

A list of AWS Chatbot channel configurations for Microsoft Teams.

* @public */ TeamChannelConfigurations?: TeamsChannelConfiguration[]; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class ListMicrosoftTeamsConfiguredTeamsException extends __BaseException { @@ -1437,13 +1490,13 @@ export class ListMicrosoftTeamsConfiguredTeamsException extends __BaseException */ 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. + *

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.

* @public */ MaxResults?: number; /** - * 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. + *

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.

* @public */ NextToken?: string; @@ -1454,20 +1507,20 @@ export interface ListMicrosoftTeamsConfiguredTeamsRequest { */ export interface ListMicrosoftTeamsConfiguredTeamsResult { /** - * A list of teams in Microsoft Teams that have been configured with AWS Chatbot. + *

A list of teams in Microsoft Teams that are configured with AWS Chatbot.

* @public */ ConfiguredTeams?: ConfiguredTeam[]; /** - * 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. + *

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.

* @public */ NextToken?: string; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class ListMicrosoftTeamsUserIdentitiesException extends __BaseException { @@ -1493,67 +1546,73 @@ export class ListMicrosoftTeamsUserIdentitiesException extends __BaseException { */ export interface ListMicrosoftTeamsUserIdentitiesRequest { /** - * The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list. + *

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

* @public */ ChatConfigurationArn?: string; /** - * 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. + *

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. + *

* @public */ NextToken?: string; /** - * 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. + *

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. + *

* @public */ MaxResults?: number; } /** - * Identifes a user level permission for a channel configuration. + *

Identifes a user level permission for a channel configuration.

* @public */ export interface TeamsUserIdentity { /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn: string | undefined; /** - * The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity. + *

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide. + *

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. + *

* @public */ TeamId: string | undefined; /** - * Id from Microsoft Teams for user. + *

The Microsoft Teams user ID.

* @public */ UserId?: string; /** - * The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role. + *

The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.

* @public */ AwsUserIdentity?: string; /** - * The ID of the Microsoft Teams channel. + *

The ID of the Microsoft Teams channel.

* @public */ TeamsChannelId?: string; /** - * The ID of the Microsoft Teams tenant. + *

The ID of the Microsoft Teams tenant.

* @public */ TeamsTenantId?: string; @@ -1564,13 +1623,14 @@ export interface TeamsUserIdentity { */ export interface ListMicrosoftTeamsUserIdentitiesResult { /** - * User level permissions associated to a channel configuration. + *

User level permissions associated to a channel configuration.

* @public */ TeamsUserIdentities?: TeamsUserIdentity[]; /** - * 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. + *

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. + *

* @public */ NextToken?: string; @@ -1581,7 +1641,7 @@ export interface ListMicrosoftTeamsUserIdentitiesResult { */ export interface ListTagsForResourceRequest { /** - * The ARN of the configuration. + *

The ARN you specified to list the tags of.

* @public */ ResourceARN: string | undefined; @@ -1592,14 +1652,14 @@ export interface ListTagsForResourceRequest { */ export interface ListTagsForResourceResponse { /** - * A list of tags applied to the configuration. + *

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.

* @public */ Tags?: Tag[]; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class ServiceUnavailableException extends __BaseException { @@ -1623,13 +1683,13 @@ export class ServiceUnavailableException extends __BaseException { */ export interface TagResourceRequest { /** - * The ARN of the configuration. + *

The ARN of the configuration.

* @public */ ResourceARN: string | undefined; /** - * A list of tags to apply to the configuration. + *

A list of tags to apply to the configuration.

* @public */ Tags: Tag[] | undefined; @@ -1641,7 +1701,7 @@ export interface TagResourceRequest { export interface TagResourceResponse {} /** - * The supplied list of tags contains too many tags. + *

The supplied list of tags contains too many tags.

* @public */ export class TooManyTagsException extends __BaseException { @@ -1665,13 +1725,13 @@ export class TooManyTagsException extends __BaseException { */ export interface UntagResourceRequest { /** - * The ARN of the configuration. + *

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.

* @public */ ResourceARN: string | undefined; /** - * A list of tag keys to remove from the configuration. + *

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.

* @public */ TagKeys: string[] | undefined; @@ -1683,7 +1743,7 @@ export interface UntagResourceRequest { export interface UntagResourceResponse {} /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class UpdateAccountPreferencesException extends __BaseException { @@ -1709,13 +1769,15 @@ export class UpdateAccountPreferencesException extends __BaseException { */ export interface UpdateAccountPreferencesRequest { /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; /** - * 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 AWS Chatbot’s AI technologies. + *

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. + *

* @public */ TrainingDataCollectionEnabled?: boolean; @@ -1726,14 +1788,14 @@ export interface UpdateAccountPreferencesRequest { */ export interface UpdateAccountPreferencesResult { /** - * Preferences which apply for AWS Chatbot usage in the calling AWS account. + *

Preferences related to AWS Chatbot usage in the calling AWS account.

* @public */ AccountPreferences?: AccountPreferences; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class UpdateChimeWebhookConfigurationException extends __BaseException { @@ -1759,37 +1821,41 @@ export class UpdateChimeWebhookConfigurationException extends __BaseException { */ export interface UpdateChimeWebhookConfigurationRequest { /** - * The ARN of the ChimeWebhookConfiguration to update. + *

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.

* @public */ ChatConfigurationArn: string | undefined; /** - * Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html. + *

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. + *

* @public */ WebhookDescription?: string; /** - * URL for the Chime webhook. + *

The URL for the Amazon Chime webhook.

* @public */ WebhookUrl?: string; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns?: string[]; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn?: string; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; @@ -1800,14 +1866,14 @@ export interface UpdateChimeWebhookConfigurationRequest { */ export interface UpdateChimeWebhookConfigurationResult { /** - * Chime webhook configuration. + *

A Amazon Chime webhook configuration.

* @public */ WebhookConfiguration?: ChimeWebhookConfiguration; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class UpdateTeamsChannelConfigurationException extends __BaseException { @@ -1833,49 +1899,52 @@ export class UpdateTeamsChannelConfigurationException extends __BaseException { */ export interface UpdateTeamsChannelConfigurationRequest { /** - * The ARN of the MicrosoftTeamsChannelConfiguration to update. + *

The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ID of the Microsoft Teams channel. + *

The ID of the Microsoft Teams channel.

* @public */ ChannelId: string | undefined; /** - * The name of the Microsoft Teams channel. + *

The name of the Microsoft Teams channel.

* @public */ ChannelName?: string; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns?: string[]; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn?: string; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * 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. + *

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. + *

* @public */ GuardrailPolicyArns?: string[]; /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; @@ -1886,14 +1955,14 @@ export interface UpdateTeamsChannelConfigurationRequest { */ export interface UpdateTeamsChannelConfigurationResult { /** - * The configuration for a Microsoft Teams channel configured with AWS Chatbot. + *

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

* @public */ ChannelConfiguration?: TeamsChannelConfiguration; } /** - * We can’t process your request right now because of a server issue. Try again later. + *

We can’t process your request right now because of a server issue. Try again later.

* @public */ export class UpdateSlackChannelConfigurationException extends __BaseException { @@ -1919,49 +1988,54 @@ export class UpdateSlackChannelConfigurationException extends __BaseException { */ export interface UpdateSlackChannelConfigurationRequest { /** - * The ARN of the SlackChannelConfiguration to update. + *

The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.

* @public */ ChatConfigurationArn: string | undefined; /** - * The ID of the Slack channel. To get the 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. + *

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. + *

* @public */ SlackChannelId: string | undefined; /** - * The name of the Slack Channel. + *

The name of the Slack channel.

* @public */ SlackChannelName?: string; /** - * The ARNs of the SNS topics that deliver notifications to AWS Chatbot. + *

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

* @public */ SnsTopicArns?: string[]; /** - * The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot. + *

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. + *

* @public */ IamRoleArn?: string; /** - * Logging levels include ERROR, INFO, or NONE. + *

Logging levels include ERROR, INFO, or NONE.

* @public */ LoggingLevel?: string; /** - * 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. + *

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. + *

* @public */ GuardrailPolicyArns?: string[]; /** - * Enables use of a user role requirement in your chat configuration. + *

Enables use of a user role requirement in your chat configuration.

* @public */ UserAuthorizationRequired?: boolean; @@ -1972,8 +2046,218 @@ export interface UpdateSlackChannelConfigurationRequest { */ export interface UpdateSlackChannelConfigurationResult { /** - * The configuration for a Slack channel configured with AWS Chatbot. + *

The configuration for a Slack channel configured with AWS Chatbot.

* @public */ ChannelConfiguration?: SlackChannelConfiguration; } + +/** + * @internal + */ +export const ChimeWebhookConfigurationFilterSensitiveLog = (obj: ChimeWebhookConfiguration): any => ({ + ...obj, + ...(obj.WebhookDescription && { WebhookDescription: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const CreateChimeWebhookConfigurationRequestFilterSensitiveLog = ( + obj: CreateChimeWebhookConfigurationRequest +): any => ({ + ...obj, + ...(obj.WebhookDescription && { WebhookDescription: SENSITIVE_STRING }), + ...(obj.WebhookUrl && { WebhookUrl: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const CreateChimeWebhookConfigurationResultFilterSensitiveLog = ( + obj: CreateChimeWebhookConfigurationResult +): any => ({ + ...obj, + ...(obj.WebhookConfiguration && { + WebhookConfiguration: ChimeWebhookConfigurationFilterSensitiveLog(obj.WebhookConfiguration), + }), +}); + +/** + * @internal + */ +export const CreateTeamsChannelConfigurationRequestFilterSensitiveLog = ( + obj: CreateTeamsChannelConfigurationRequest +): any => ({ + ...obj, + ...(obj.ChannelName && { ChannelName: SENSITIVE_STRING }), + ...(obj.TeamName && { TeamName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const TeamsChannelConfigurationFilterSensitiveLog = (obj: TeamsChannelConfiguration): any => ({ + ...obj, + ...(obj.ChannelName && { ChannelName: SENSITIVE_STRING }), + ...(obj.TeamName && { TeamName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const CreateTeamsChannelConfigurationResultFilterSensitiveLog = ( + obj: CreateTeamsChannelConfigurationResult +): any => ({ + ...obj, + ...(obj.ChannelConfiguration && { + ChannelConfiguration: TeamsChannelConfigurationFilterSensitiveLog(obj.ChannelConfiguration), + }), +}); + +/** + * @internal + */ +export const CreateSlackChannelConfigurationRequestFilterSensitiveLog = ( + obj: CreateSlackChannelConfigurationRequest +): any => ({ + ...obj, + ...(obj.SlackChannelName && { SlackChannelName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const SlackChannelConfigurationFilterSensitiveLog = (obj: SlackChannelConfiguration): any => ({ + ...obj, + ...(obj.SlackChannelName && { SlackChannelName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const CreateSlackChannelConfigurationResultFilterSensitiveLog = ( + obj: CreateSlackChannelConfigurationResult +): any => ({ + ...obj, + ...(obj.ChannelConfiguration && { + ChannelConfiguration: SlackChannelConfigurationFilterSensitiveLog(obj.ChannelConfiguration), + }), +}); + +/** + * @internal + */ +export const DescribeChimeWebhookConfigurationsResultFilterSensitiveLog = ( + obj: DescribeChimeWebhookConfigurationsResult +): any => ({ + ...obj, + ...(obj.WebhookConfigurations && { + WebhookConfigurations: obj.WebhookConfigurations.map((item) => ChimeWebhookConfigurationFilterSensitiveLog(item)), + }), +}); + +/** + * @internal + */ +export const DescribeSlackChannelConfigurationsResultFilterSensitiveLog = ( + obj: DescribeSlackChannelConfigurationsResult +): any => ({ + ...obj, + ...(obj.SlackChannelConfigurations && { + SlackChannelConfigurations: obj.SlackChannelConfigurations.map((item) => + SlackChannelConfigurationFilterSensitiveLog(item) + ), + }), +}); + +/** + * @internal + */ +export const GetTeamsChannelConfigurationResultFilterSensitiveLog = (obj: GetTeamsChannelConfigurationResult): any => ({ + ...obj, + ...(obj.ChannelConfiguration && { + ChannelConfiguration: TeamsChannelConfigurationFilterSensitiveLog(obj.ChannelConfiguration), + }), +}); + +/** + * @internal + */ +export const ListTeamsChannelConfigurationsResultFilterSensitiveLog = ( + obj: ListTeamsChannelConfigurationsResult +): any => ({ + ...obj, + ...(obj.TeamChannelConfigurations && { + TeamChannelConfigurations: obj.TeamChannelConfigurations.map((item) => + TeamsChannelConfigurationFilterSensitiveLog(item) + ), + }), +}); + +/** + * @internal + */ +export const UpdateChimeWebhookConfigurationRequestFilterSensitiveLog = ( + obj: UpdateChimeWebhookConfigurationRequest +): any => ({ + ...obj, + ...(obj.WebhookDescription && { WebhookDescription: SENSITIVE_STRING }), + ...(obj.WebhookUrl && { WebhookUrl: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateChimeWebhookConfigurationResultFilterSensitiveLog = ( + obj: UpdateChimeWebhookConfigurationResult +): any => ({ + ...obj, + ...(obj.WebhookConfiguration && { + WebhookConfiguration: ChimeWebhookConfigurationFilterSensitiveLog(obj.WebhookConfiguration), + }), +}); + +/** + * @internal + */ +export const UpdateTeamsChannelConfigurationRequestFilterSensitiveLog = ( + obj: UpdateTeamsChannelConfigurationRequest +): any => ({ + ...obj, + ...(obj.ChannelName && { ChannelName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateTeamsChannelConfigurationResultFilterSensitiveLog = ( + obj: UpdateTeamsChannelConfigurationResult +): any => ({ + ...obj, + ...(obj.ChannelConfiguration && { + ChannelConfiguration: TeamsChannelConfigurationFilterSensitiveLog(obj.ChannelConfiguration), + }), +}); + +/** + * @internal + */ +export const UpdateSlackChannelConfigurationRequestFilterSensitiveLog = ( + obj: UpdateSlackChannelConfigurationRequest +): any => ({ + ...obj, + ...(obj.SlackChannelName && { SlackChannelName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateSlackChannelConfigurationResultFilterSensitiveLog = ( + obj: UpdateSlackChannelConfigurationResult +): any => ({ + ...obj, + ...(obj.ChannelConfiguration && { + ChannelConfiguration: SlackChannelConfigurationFilterSensitiveLog(obj.ChannelConfiguration), + }), +}); diff --git a/codegen/sdk-codegen/aws-models/chatbot.json b/codegen/sdk-codegen/aws-models/chatbot.json index d6f26c7bf665..8a26b8ea88e1 100644 --- a/codegen/sdk-codegen/aws-models/chatbot.json +++ b/codegen/sdk-codegen/aws-models/chatbot.json @@ -1,33 +1,5 @@ { "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.chatbot#AccountPreferences": { "type": "structure", @@ -35,18 +7,18 @@ "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "TrainingDataCollectionEnabled": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "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 AWS Chatbot’s AI technologies." + "smithy.api#documentation": "

Turns on training data collection.

\n

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.\n

" } } }, "traits": { - "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + "smithy.api#documentation": "

Preferences related to AWS Chatbot usage in the calling AWS account.

" } }, "com.amazonaws.chatbot#AmazonResourceName": { @@ -98,52 +70,52 @@ "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { - "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.", + "smithy.api#documentation": "

A description of the webhook. We recommend using the convention RoomName/WebhookName.

\n

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration." + "smithy.api#documentation": "

The name of the configuration.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { - "smithy.api#documentation": "An AWS Chatbot configuration for Amazon Chime." + "smithy.api#documentation": "

An AWS Chatbot configuration for Amazon Chime.

" } }, "com.amazonaws.chatbot#ChimeWebhookConfigurationList": { @@ -158,7 +130,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#ChimeWebhookUrl": { @@ -168,7 +141,8 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^https://hooks\\.chime\\.aws/incomingwebhooks/[A-Za-z0-9\\-]+?\\?token=[A-Za-z0-9\\-]+$" + "smithy.api#pattern": "^https://hooks\\.chime\\.aws/incomingwebhooks/[A-Za-z0-9\\-]+?\\?token=[A-Za-z0-9\\-]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#ConfigurationName": { @@ -187,26 +161,26 @@ "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

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.\n

", "smithy.api#required": {} } }, "TeamName": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams Team." + "smithy.api#documentation": "

The name of the Microsoft Teams Team.

" } } }, "traits": { - "smithy.api#documentation": "A Microsoft Teams team that has been authorized with AWS Chatbot." + "smithy.api#documentation": "

A Microsoft Teams team that is authorized with AWS Chatbot.

" } }, "com.amazonaws.chatbot#ConfiguredTeamsList": { @@ -223,7 +197,7 @@ } }, "traits": { - "smithy.api#documentation": "There was an issue processing your request.", + "smithy.api#documentation": "

There was an issue processing your request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -254,7 +228,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates Chime Webhook Configuration", + "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Amazon Chime.

", "smithy.api#http": { "method": "POST", "uri": "/create-chime-webhook-configuration", @@ -270,7 +244,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -281,48 +255,48 @@ "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { - "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.", + "smithy.api#documentation": "

A description of the webhook. We recommend using the convention RoomName/WebhookName.

\n

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "WebhookUrl": { "target": "com.amazonaws.chatbot#ChimeWebhookUrl", "traits": { - "smithy.api#documentation": "URL for the Chime webhook.", + "smithy.api#documentation": "

The URL for the Amazon Chime webhook.

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration.", + "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, @@ -336,7 +310,7 @@ "WebhookConfiguration": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", "traits": { - "smithy.api#documentation": "Chime webhook configuration." + "smithy.api#documentation": "

An Amazon Chime webhook configuration.

" } } }, @@ -370,12 +344,13 @@ } ], "traits": { - "smithy.api#documentation": "Creates MS Teams Channel Configuration", + "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Microsoft Teams.

", "smithy.api#http": { "method": "POST", "uri": "/create-ms-teams-channel-configuration", "code": 201 - } + }, + "smithy.api#suppress": ["OperationInputOutputName.input", "OperationInputOutputName.output"] } }, "com.amazonaws.chatbot#CreateSlackChannelConfiguration": { @@ -404,7 +379,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates Slack Channel Configuration", + "smithy.api#documentation": "

Creates an AWS Chatbot confugration for Slack.

", "smithy.api#http": { "method": "POST", "uri": "/create-slack-channel-configuration", @@ -420,7 +395,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -431,65 +406,65 @@ "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { - "smithy.api#documentation": "The ID of the Slack channel. To get the 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.", + "smithy.api#documentation": "

The ID of the Slack channel.

\n

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.\n

", "smithy.api#required": {} } }, "SlackChannelName": { "target": "com.amazonaws.chatbot#SlackChannelDisplayName", "traits": { - "smithy.api#documentation": "The name of the Slack Channel." + "smithy.api#documentation": "

The name of the Slack channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration.", + "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, @@ -503,7 +478,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Slack channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Slack channel configured with AWS Chatbot.

" } } }, @@ -519,7 +494,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -530,78 +505,78 @@ "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams channel." + "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

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.\n

", "smithy.api#required": {} } }, "TeamName": { "target": "com.amazonaws.chatbot#TeamName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams Team." + "smithy.api#documentation": "

The name of the Microsoft Teams Team.

" } }, "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration.", + "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, @@ -615,7 +590,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

" } } }, @@ -656,7 +631,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Chime Webhook Configuration", + "smithy.api#documentation": "

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

", "smithy.api#http": { "method": "POST", "uri": "/delete-chime-webhook-configuration", @@ -672,7 +647,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -683,7 +658,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration to delete.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.

", "smithy.api#required": {} } } @@ -722,12 +697,13 @@ } ], "traits": { - "smithy.api#documentation": "Deletes MS Teams Channel Configuration", + "smithy.api#documentation": "

Deletes a Microsoft Teams channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", "uri": "/delete-ms-teams-channel-configuration", "code": 204 - } + }, + "smithy.api#suppress": ["OperationInputOutputName.input", "OperationInputOutputName.output"] } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsConfiguredTeam": { @@ -747,12 +723,13 @@ } ], "traits": { - "smithy.api#documentation": "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.", + "smithy.api#documentation": "

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.\n

", "smithy.api#http": { "method": "POST", "uri": "/delete-ms-teams-configured-teams", "code": 204 - } + }, + "smithy.api#suppress": ["OperationInputOutputName.input", "OperationInputOutputName.output"] } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentity": { @@ -775,7 +752,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Teams user identity", + "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/delete-ms-teams-user-identity", @@ -791,7 +768,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -802,14 +779,14 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.", + "smithy.api#documentation": "

The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "Id from Microsoft Teams for user.", + "smithy.api#documentation": "

The Microsoft Teams user ID.

", "smithy.api#required": {} } } @@ -848,7 +825,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes Slack Channel Configuration", + "smithy.api#documentation": "

Deletes a Slack channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-channel-configuration", @@ -864,7 +841,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -875,7 +852,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration to delete.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete.

", "smithy.api#required": {} } } @@ -911,7 +888,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Slack user identity", + "smithy.api#documentation": "

Deletes a user level permission for a Slack channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-user-identity", @@ -927,7 +904,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -938,21 +915,21 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identity to delete.", + "smithy.api#documentation": "

The ARN of the SlackChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackUserId": { "target": "com.amazonaws.chatbot#SlackUserId", "traits": { - "smithy.api#documentation": "The ID of the user in Slack.", + "smithy.api#documentation": "

The ID of the user in Slack

", "smithy.api#required": {} } } @@ -985,7 +962,7 @@ } ], "traits": { - "smithy.api#documentation": "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.", + "smithy.api#documentation": "

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.\n

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-workspace-authorization", @@ -1001,7 +978,7 @@ } }, "traits": { - "smithy.api#documentation": "There was an issue deleting your Slack workspace.", + "smithy.api#documentation": "

There was an issue deleting your Slack workspace.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1012,7 +989,7 @@ "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } } @@ -1036,7 +1013,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1047,7 +1024,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to delete.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } } @@ -1071,7 +1048,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1082,7 +1059,7 @@ "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams team authorized with AWS Chatbot.

\n

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.\n

", "smithy.api#required": {} } } @@ -1118,7 +1095,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn", + "smithy.api#documentation": "

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", "uri": "/describe-chime-webhook-configurations", @@ -1127,8 +1104,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "WebhookConfigurations" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsException": { @@ -1139,7 +1118,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1150,19 +1129,19 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "An optional ARN of a ChimeWebhookConfiguration to describe." + "smithy.api#documentation": "

An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe.

" } } }, @@ -1176,13 +1155,13 @@ "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "WebhookConfigurations": { "target": "com.amazonaws.chatbot#ChimeWebhookConfigurationList", "traits": { - "smithy.api#documentation": "A list of Chime webhooks associated with the account." + "smithy.api#documentation": "

A list of Amazon Chime webhooks associated with the account.

" } } }, @@ -1210,7 +1189,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn", + "smithy.api#documentation": "

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-channel-configurations", @@ -1219,8 +1198,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "SlackChannelConfigurations" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsException": { @@ -1231,7 +1212,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1242,19 +1223,19 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "An optional ARN of a SlackChannelConfiguration to describe." + "smithy.api#documentation": "

An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe.

" } } }, @@ -1268,13 +1249,13 @@ "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "SlackChannelConfigurations": { "target": "com.amazonaws.chatbot#SlackChannelConfigurationList", "traits": { - "smithy.api#documentation": "A list of Slack channel configurations." + "smithy.api#documentation": "

A list of Slack channel configurations.

" } } }, @@ -1302,7 +1283,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all Slack user identities with a mapped role.", + "smithy.api#documentation": "

Lists all Slack user identities with a mapped role.

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-user-identities", @@ -1311,8 +1292,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "SlackUserIdentities" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackUserIdentitiesException": { @@ -1323,7 +1306,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1334,19 +1317,19 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identities to describe." + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } } }, @@ -1360,13 +1343,13 @@ "SlackUserIdentities": { "target": "com.amazonaws.chatbot#SlackUserIdentitiesList", "traits": { - "smithy.api#documentation": "A list of Slack User Identities." + "smithy.api#documentation": "

A list of Slack User Identities.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } } }, @@ -1394,7 +1377,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all authorized Slack Workspaces for AWS Account", + "smithy.api#documentation": "

List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-workspaces", @@ -1403,8 +1386,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "SlackWorkspaces" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackWorkspacesException": { @@ -1415,7 +1400,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1426,13 +1411,13 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } } }, @@ -1446,13 +1431,13 @@ "SlackWorkspaces": { "target": "com.amazonaws.chatbot#SlackWorkspacesList", "traits": { - "smithy.api#documentation": "A list of Slack Workspaces registered with AWS Chatbot." + "smithy.api#documentation": "

A list of Slack workspaces registered with AWS Chatbot.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } } }, @@ -1480,12 +1465,13 @@ } ], "traits": { - "smithy.api#documentation": "Get Chatbot account level preferences", + "smithy.api#documentation": "

Returns AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", "uri": "/get-account-preferences", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#GetAccountPreferencesException": { @@ -1496,7 +1482,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1514,7 +1500,7 @@ "AccountPreferences": { "target": "com.amazonaws.chatbot#AccountPreferences", "traits": { - "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + "smithy.api#documentation": "

The preferences related to AWS Chatbot usage in the calling AWS account.

" } } }, @@ -1542,12 +1528,14 @@ } ], "traits": { - "smithy.api#documentation": "Get a single MS Teams Channel Configurations", + "smithy.api#documentation": "

Returns a Microsoft Teams channel configuration in an AWS account.

", "smithy.api#http": { "method": "POST", "uri": "/get-ms-teams-channel-configuration", "code": 200 - } + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": ["OperationInputOutputName.input", "OperationInputOutputName.output"] } }, "com.amazonaws.chatbot#GetTeamsChannelConfigurationException": { @@ -1558,7 +1546,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1569,7 +1557,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

", "smithy.api#required": {} } } @@ -1584,7 +1572,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

" } } }, @@ -1616,7 +1604,7 @@ } }, "traits": { - "smithy.api#documentation": "Customer/consumer-facing internal service exception.\n https://w.amazon.com/index.php/AWS/API_Standards/Exceptions#InternalServiceError", + "smithy.api#documentation": "

Unexpected error during processing of request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1629,7 +1617,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request input doesn't meet the constraints that AWS Chatbot requires.", + "smithy.api#documentation": "

Your request input doesn't meet the constraints required by AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1642,7 +1630,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request input doesn't meet the constraints that AWS Chatbot requires.", + "smithy.api#documentation": "

Your request input doesn't meet the constraints required by AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1655,7 +1643,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded a service limit for AWS Chatbot.", + "smithy.api#documentation": "

You have exceeded a service limit for AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1680,7 +1668,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists MS Teams Channel Configurations optionally filtered by TeamId", + "smithy.api#documentation": "

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-channel-configurations", @@ -1689,8 +1677,11 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "TeamChannelConfigurations" + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": ["OperationInputOutputName.input", "OperationInputOutputName.output"] } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeams": { @@ -1713,7 +1704,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all authorized MS teams for AWS Account", + "smithy.api#documentation": "

Lists all authorized Microsoft Teams for an AWS Account

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-configured-teams", @@ -1722,8 +1713,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "ConfiguredTeams" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsException": { @@ -1734,7 +1727,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1745,13 +1738,13 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.

" } } }, @@ -1765,13 +1758,13 @@ "ConfiguredTeams": { "target": "com.amazonaws.chatbot#ConfiguredTeamsList", "traits": { - "smithy.api#documentation": "A list of teams in Microsoft Teams that have been configured with AWS Chatbot." + "smithy.api#documentation": "

A list of teams in Microsoft Teams that are configured with AWS Chatbot.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.

" } } }, @@ -1799,7 +1792,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all Microsoft Teams user identities with a mapped role.", + "smithy.api#documentation": "

A list all Microsoft Teams user identities with a mapped role.

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-user-identities", @@ -1808,8 +1801,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "TeamsUserIdentities" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesException": { @@ -1820,7 +1815,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1831,19 +1826,19 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list." + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } } }, @@ -1857,13 +1852,13 @@ "TeamsUserIdentities": { "target": "com.amazonaws.chatbot#TeamsUserIdentitiesList", "traits": { - "smithy.api#documentation": "User level permissions associated to a channel configuration." + "smithy.api#documentation": "

User level permissions associated to a channel configuration.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } } }, @@ -1891,12 +1886,13 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the list of tags applied to a configuration.", + "smithy.api#documentation": "

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

", "smithy.api#http": { "method": "POST", "uri": "/list-tags-for-resource", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListTagsForResourceRequest": { @@ -1905,7 +1901,7 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the configuration.", + "smithy.api#documentation": "

The ARN you specified to list the tags of.

", "smithy.api#required": {} } } @@ -1920,7 +1916,7 @@ "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

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.

" } } }, @@ -1936,7 +1932,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1947,19 +1943,19 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide." + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

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.\n

" } } }, @@ -1973,13 +1969,13 @@ "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.

" } }, "TeamChannelConfigurations": { "target": "com.amazonaws.chatbot#TeamChannelConfigurationsList", "traits": { - "smithy.api#documentation": "A list of AWS Chatbot channel configurations for Microsoft Teams." + "smithy.api#documentation": "

A list of AWS Chatbot channel configurations for Microsoft Teams.

" } } }, @@ -2014,7 +2010,7 @@ } }, "traits": { - "smithy.api#documentation": "We were not able to find the resource for your request.", + "smithy.api#documentation": "

We were unable to find the resource for your request

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2027,7 +2023,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2038,85 +2034,85 @@ "SlackTeamName": { "target": "com.amazonaws.chatbot#SlackTeamName", "traits": { - "smithy.api#documentation": "Name of the Slack Workspace.", + "smithy.api#documentation": "

Name of the Slack workspace.

", "smithy.api#required": {} } }, "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with Amazon Chime.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { - "smithy.api#documentation": "The ID of the Slack channel. To get the 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.", + "smithy.api#documentation": "

The ID of the Slack channel.

\n

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.\n

", "smithy.api#required": {} } }, "SlackChannelName": { "target": "com.amazonaws.chatbot#SlackChannelDisplayName", "traits": { - "smithy.api#documentation": "The name of the Slack Channel.", + "smithy.api#documentation": "

The name of the Slack channel.

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration." + "smithy.api#documentation": "

The name of the configuration.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { - "smithy.api#documentation": "An AWS Chatbot configuration for Slack." + "smithy.api#documentation": "

An AWS Chatbot configuration for Slack.

" } }, "com.amazonaws.chatbot#SlackChannelConfigurationList": { @@ -2131,7 +2127,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#SlackChannelId": { @@ -2185,40 +2182,40 @@ "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identity.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackUserId": { "target": "com.amazonaws.chatbot#SlackUserId", "traits": { - "smithy.api#documentation": "The ID of the user in Slack.", + "smithy.api#documentation": "

The ID of the user in Slack

", "smithy.api#required": {} } }, "AwsUserIdentity": { "target": "com.amazonaws.chatbot#AwsUserIdentity", "traits": { - "smithy.api#documentation": "The AWS user identity ARN used to associate a Slack User Identity with an IAM Role." + "smithy.api#documentation": "

The AWS user identity ARN used to associate a Slack user ID with an IAM Role.

" } } }, "traits": { - "smithy.api#documentation": "Identifes a User level permission for a channel configuration." + "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

" } }, "com.amazonaws.chatbot#SlackWorkspace": { @@ -2227,20 +2224,20 @@ "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackTeamName": { "target": "com.amazonaws.chatbot#SlackTeamName", "traits": { - "smithy.api#documentation": "Name of the Slack Workspace.", + "smithy.api#documentation": "

The name of the Slack workspace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A Slack Workspace." + "smithy.api#documentation": "

A Slack workspace.

" } }, "com.amazonaws.chatbot#SlackWorkspacesList": { @@ -2255,29 +2252,26 @@ "target": "com.amazonaws.chatbot#Arn" } }, - "com.amazonaws.chatbot#String": { - "type": "string" - }, "com.amazonaws.chatbot#Tag": { "type": "structure", "members": { "TagKey": { "target": "com.amazonaws.chatbot#TagKey", "traits": { - "smithy.api#documentation": "The tag key.", + "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, "TagValue": { "target": "com.amazonaws.chatbot#TagValue", "traits": { - "smithy.api#documentation": "The tag value.", + "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A tag applied to the configuration." + "smithy.api#documentation": "

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

\n \n

Do not include confidential or sensitive information in this field.

\n \n

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

" } }, "com.amazonaws.chatbot#TagKey": { @@ -2336,7 +2330,7 @@ } ], "traits": { - "smithy.api#documentation": "Applies the supplied tags to a configuration.", + "smithy.api#documentation": "

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

", "smithy.api#http": { "method": "POST", "uri": "/tag-resource", @@ -2350,14 +2344,14 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the configuration.", + "smithy.api#documentation": "

The ARN of the configuration.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration.", + "smithy.api#documentation": "

A list of tags to apply to the configuration.

", "smithy.api#required": {} } } @@ -2377,7 +2371,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 256 } } @@ -2401,7 +2395,8 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^(.*)$" + "smithy.api#pattern": "^(.*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#TeamsChannelConfiguration": { @@ -2410,90 +2405,90 @@ "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams channel." + "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

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.\n

", "smithy.api#required": {} } }, "TeamName": { - "target": "com.amazonaws.chatbot#String", + "target": "com.amazonaws.chatbot#TeamName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams Team." + "smithy.api#documentation": "

The name of the Microsoft Teams Team.

" } }, "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration." + "smithy.api#documentation": "

The name of the configuration.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { - "smithy.api#documentation": "An AWS Chatbot configuration for Microsoft Teams." + "smithy.api#documentation": "

An AWS Chatbot configuration for Microsoft Teams.

" } }, "com.amazonaws.chatbot#TeamsChannelId": { @@ -2513,7 +2508,8 @@ "min": 1, "max": 1000 }, - "smithy.api#pattern": "^(.*)$" + "smithy.api#pattern": "^(.*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#TeamsUserIdentitiesList": { @@ -2528,51 +2524,51 @@ "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

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.\n

", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "Id from Microsoft Teams for user." + "smithy.api#documentation": "

The Microsoft Teams user ID.

" } }, "AwsUserIdentity": { "target": "com.amazonaws.chatbot#AwsUserIdentity", "traits": { - "smithy.api#documentation": "The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role." + "smithy.api#documentation": "

The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.

" } }, "TeamsChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel." + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

" } }, "TeamsTenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant." + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

" } } }, "traits": { - "smithy.api#documentation": "Identifes a user level permission for a channel configuration." + "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

" } }, "com.amazonaws.chatbot#TooManyTagsException": { @@ -2583,7 +2579,7 @@ } }, "traits": { - "smithy.api#documentation": "The supplied list of tags contains too many tags.", + "smithy.api#documentation": "

The supplied list of tags contains too many tags.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2618,7 +2614,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the supplied tags from a configuration", + "smithy.api#documentation": "

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

", "smithy.api#http": { "method": "POST", "uri": "/untag-resource", @@ -2632,14 +2628,14 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the configuration.", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chatbot#TagKeyList", "traits": { - "smithy.api#documentation": "A list of tag keys to remove from the configuration.", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } @@ -2675,7 +2671,7 @@ } ], "traits": { - "smithy.api#documentation": "Update Chatbot account level preferences", + "smithy.api#documentation": "

Updates AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", "uri": "/update-account-preferences", @@ -2691,7 +2687,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2702,13 +2698,13 @@ "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "TrainingDataCollectionEnabled": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "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 AWS Chatbot’s AI technologies." + "smithy.api#documentation": "

Turns on training data collection.

\n

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.\n

" } } }, @@ -2722,7 +2718,7 @@ "AccountPreferences": { "target": "com.amazonaws.chatbot#AccountPreferences", "traits": { - "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + "smithy.api#documentation": "

Preferences related to AWS Chatbot usage in the calling AWS account.

" } } }, @@ -2753,7 +2749,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Chime Webhook Configuration", + "smithy.api#documentation": "

Updates a Amazon Chime webhook configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-chime-webhook-configuration", @@ -2769,7 +2765,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2780,38 +2776,38 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration to update.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.

", "smithy.api#required": {} } }, "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { - "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html." + "smithy.api#documentation": "

A description of the webhook. We recommend using the convention RoomName/WebhookName.

\n

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.\n

" } }, "WebhookUrl": { "target": "com.amazonaws.chatbot#ChimeWebhookUrl", "traits": { - "smithy.api#documentation": "URL for the Chime webhook." + "smithy.api#documentation": "

The URL for the Amazon Chime webhook.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } } }, @@ -2825,7 +2821,7 @@ "WebhookConfiguration": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", "traits": { - "smithy.api#documentation": "Chime webhook configuration." + "smithy.api#documentation": "

A Amazon Chime webhook configuration.

" } } }, @@ -2856,12 +2852,13 @@ } ], "traits": { - "smithy.api#documentation": "Updates MS Teams Channel Configuration", + "smithy.api#documentation": "

Updates an Microsoft Teams channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-ms-teams-channel-configuration", "code": 200 - } + }, + "smithy.api#suppress": ["OperationInputOutputName.input", "OperationInputOutputName.output"] } }, "com.amazonaws.chatbot#UpdateSlackChannelConfiguration": { @@ -2887,7 +2884,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates Slack Channel Configuration", + "smithy.api#documentation": "

Updates a Slack channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-slack-channel-configuration", @@ -2903,7 +2900,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2914,51 +2911,51 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration to update.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { - "smithy.api#documentation": "The ID of the Slack channel. To get the 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.", + "smithy.api#documentation": "

The ID of the Slack channel.

\n

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.\n

", "smithy.api#required": {} } }, "SlackChannelName": { "target": "com.amazonaws.chatbot#SlackChannelDisplayName", "traits": { - "smithy.api#documentation": "The name of the Slack Channel." + "smithy.api#documentation": "

The name of the Slack channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } } }, @@ -2972,7 +2969,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Slack channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Slack channel configured with AWS Chatbot.

" } } }, @@ -2988,7 +2985,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2999,51 +2996,51 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to update.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.

", "smithy.api#required": {} } }, "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams channel." + "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "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." + "smithy.api#documentation": "

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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } } }, @@ -3057,7 +3054,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

" } } }, @@ -3160,7 +3157,20 @@ "name": "chatbot" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Chatbot API", + "smithy.api#auth": ["aws.auth#sigv4"], + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": ["x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id"], + "maxAge": 86400 + }, + "smithy.api#documentation": "

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

\n

AWS Chatbot APIs are currently available in the following Regions:

\n \n

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

\n \n

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

\n ", "smithy.api#title": "AWS Chatbot", "smithy.api#xmlNamespace": { "uri": "http://wheatley.amazonaws.com/orchestration/2017-10-11/"