feat(client-chatbot): Update documentation to be consistent with the …

…API docs
aws · Aug 27, 2024 · a4046ab · a4046ab
1 parent eb0b2ee
commit a4046ab
Show file tree

Hide file tree

Showing 32 changed files with 1,062 additions and 637 deletions.
diff --git 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
+<p>The <i>AWS Chatbot API Reference</i> provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.</p>
+<p>AWS Chatbot APIs are currently available in the following Regions:</p>
+<ul>
+<li>
+<p>US East (Ohio) - <code>us-east-2</code>
+</p>
+</li>
+<li>
+<p>US West (Oregon) - <code>us-west-2</code>
+</p>
+</li>
+<li>
+<p>Asia Pacific (Singapore) - <code>ap-southeast-1</code>
+</p>
+</li>
+<li>
+<p>Europe (Ireland) - <code>eu-west-1</code>
+</p>
+</li>
+</ul>
+<p>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.</p>
+<note>
+<p>Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.</p>
+</note>
 
 ## Installing
 

diff --git a/clients/client-chatbot/src/Chatbot.ts b/clients/client-chatbot/src/Chatbot.ts
@@ -601,7 +601,30 @@ export interface Chatbot {
 }
 
 /**
- * AWS Chatbot API
+ * <p>The <i>AWS Chatbot API Reference</i> provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.</p>
+ *          <p>AWS Chatbot APIs are currently available in the following Regions:</p>
+ *          <ul>
+ *             <li>
+ *                <p>US East (Ohio) - <code>us-east-2</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>US West (Oregon) - <code>us-west-2</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>Asia Pacific (Singapore) - <code>ap-southeast-1</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>Europe (Ireland) - <code>eu-west-1</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>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.</p>
+ *          <note>
+ *             <p>Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.</p>
+ *          </note>
  * @public
  */
 export class Chatbot extends ChatbotClient implements Chatbot {}

diff --git 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
+ * <p>The <i>AWS Chatbot API Reference</i> provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.</p>
+ *          <p>AWS Chatbot APIs are currently available in the following Regions:</p>
+ *          <ul>
+ *             <li>
+ *                <p>US East (Ohio) - <code>us-east-2</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>US West (Oregon) - <code>us-west-2</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>Asia Pacific (Singapore) - <code>ap-southeast-1</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>Europe (Ireland) - <code>eu-west-1</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>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.</p>
+ *          <note>
+ *             <p>Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.</p>
+ *          </note>
  * @public
  */
 export class ChatbotClient extends __Client<

diff --git 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
+ * <p>Creates an AWS Chatbot configuration for Amazon Chime.</p>
  * @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.
+ *  <p>There was an issue processing your request.</p>
  *
  * @throws {@link CreateChimeWebhookConfigurationException} (server fault)
- *  We can’t process your request right now because of a server issue. Try again later.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  You have exceeded a service limit for AWS Chatbot.
+ *  <p>You have exceeded a service limit for AWS Chatbot.</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
@@ -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
@@ -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
+ * <p>Creates an AWS Chatbot configuration for Microsoft Teams.</p>
  * @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.
+ *  <p>There was an issue processing your request.</p>
  *
  * @throws {@link CreateTeamsChannelConfigurationException} (server fault)
- *  We can’t process your request right now because of a server issue. Try again later.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  You have exceeded a service limit for AWS Chatbot.
+ *  <p>You have exceeded a service limit for AWS Chatbot.</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
@@ -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
@@ -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
+ * <p>Creates an AWS Chatbot confugration for Slack.</p>
  * @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.
+ *  <p>There was an issue processing your request.</p>
  *
  * @throws {@link CreateSlackChannelConfigurationException} (server fault)
- *  We can’t process your request right now because of a server issue. Try again later.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  You have exceeded a service limit for AWS Chatbot.
+ *  <p>You have exceeded a service limit for AWS Chatbot.</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
@@ -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
@@ -33,7 +33,7 @@ export interface DeleteChimeWebhookConfigurationCommandOutput
     __MetadataBearer {}
 
 /**
- * Deletes a Chime Webhook Configuration
+ * <p>Deletes a Amazon Chime webhook configuration for AWS Chatbot.</p>
  * @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.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  We were not able to find the resource for your request.
+ *  <p>We were unable to find the resource for your request</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>

diff --git 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
+ * <p>Deletes a Microsoft Teams channel configuration for AWS Chatbot</p>
  * @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.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  We were not able to find the resource for your request.
+ *  <p>We were unable to find the resource for your request</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>

diff --git 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.
+ * <p>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.
+ *  </p>
  * @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.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>

diff --git 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
+ * <p>Identifes a user level permission for a channel configuration.</p>
  * @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.
+ *  <p>We can’t process your request right now because of a server issue. Try again later.</p>
  *
  * @throws {@link InvalidParameterException} (client fault)
- *  Your request input doesn't meet the constraints that AWS Chatbot requires.
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  We were not able to find the resource for your request.
+ *  <p>We were unable to find the resource for your request</p>
  *
  * @throws {@link ChatbotServiceException}
  * <p>Base exception class for all service exceptions from Chatbot service.</p>