Skip to content

Commit a4046ab

Browse files
author
awstools
committed
feat(client-chatbot): Update documentation to be consistent with the API docs
1 parent eb0b2ee commit a4046ab

32 files changed

+1062
-637
lines changed

‎clients/client-chatbot/README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,30 @@
66

77
AWS SDK for JavaScript Chatbot Client for Node.js, Browser and React Native.
88

9-
AWS Chatbot API
9+
<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>
10+
<p>AWS Chatbot APIs are currently available in the following Regions:</p>
11+
<ul>
12+
<li>
13+
<p>US East (Ohio) - <code>us-east-2</code>
14+
</p>
15+
</li>
16+
<li>
17+
<p>US West (Oregon) - <code>us-west-2</code>
18+
</p>
19+
</li>
20+
<li>
21+
<p>Asia Pacific (Singapore) - <code>ap-southeast-1</code>
22+
</p>
23+
</li>
24+
<li>
25+
<p>Europe (Ireland) - <code>eu-west-1</code>
26+
</p>
27+
</li>
28+
</ul>
29+
<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>
30+
<note>
31+
<p>Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.</p>
32+
</note>
1033

1134
## Installing
1235

‎clients/client-chatbot/src/Chatbot.ts

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,30 @@ export interface Chatbot {
601601
}
602602

603603
/**
604-
* AWS Chatbot API
604+
* <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>
605+
* <p>AWS Chatbot APIs are currently available in the following Regions:</p>
606+
* <ul>
607+
* <li>
608+
* <p>US East (Ohio) - <code>us-east-2</code>
609+
* </p>
610+
* </li>
611+
* <li>
612+
* <p>US West (Oregon) - <code>us-west-2</code>
613+
* </p>
614+
* </li>
615+
* <li>
616+
* <p>Asia Pacific (Singapore) - <code>ap-southeast-1</code>
617+
* </p>
618+
* </li>
619+
* <li>
620+
* <p>Europe (Ireland) - <code>eu-west-1</code>
621+
* </p>
622+
* </li>
623+
* </ul>
624+
* <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>
625+
* <note>
626+
* <p>Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.</p>
627+
* </note>
605628
* @public
606629
*/
607630
export class Chatbot extends ChatbotClient implements Chatbot {}

‎clients/client-chatbot/src/ChatbotClient.ts

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,30 @@ export type ChatbotClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
396396
export interface ChatbotClientResolvedConfig extends ChatbotClientResolvedConfigType {}
397397

398398
/**
399-
* AWS Chatbot API
399+
* <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>
400+
* <p>AWS Chatbot APIs are currently available in the following Regions:</p>
401+
* <ul>
402+
* <li>
403+
* <p>US East (Ohio) - <code>us-east-2</code>
404+
* </p>
405+
* </li>
406+
* <li>
407+
* <p>US West (Oregon) - <code>us-west-2</code>
408+
* </p>
409+
* </li>
410+
* <li>
411+
* <p>Asia Pacific (Singapore) - <code>ap-southeast-1</code>
412+
* </p>
413+
* </li>
414+
* <li>
415+
* <p>Europe (Ireland) - <code>eu-west-1</code>
416+
* </p>
417+
* </li>
418+
* </ul>
419+
* <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>
420+
* <note>
421+
* <p>Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.</p>
422+
* </note>
400423
* @public
401424
*/
402425
export class ChatbotClient extends __Client<

‎clients/client-chatbot/src/commands/CreateChimeWebhookConfigurationCommand.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { CreateChimeWebhookConfigurationRequest, CreateChimeWebhookConfigurationResult } from "../models/models_0";
9+
import {
10+
CreateChimeWebhookConfigurationRequest,
11+
CreateChimeWebhookConfigurationRequestFilterSensitiveLog,
12+
CreateChimeWebhookConfigurationResult,
13+
CreateChimeWebhookConfigurationResultFilterSensitiveLog,
14+
} from "../models/models_0";
1015
import {
1116
de_CreateChimeWebhookConfigurationCommand,
1217
se_CreateChimeWebhookConfigurationCommand,
@@ -33,7 +38,7 @@ export interface CreateChimeWebhookConfigurationCommandOutput
3338
__MetadataBearer {}
3439

3540
/**
36-
* Creates Chime Webhook Configuration
41+
* <p>Creates an AWS Chatbot configuration for Amazon Chime.</p>
3742
* @example
3843
* Use a bare-bones client and the command you need to make an API call.
3944
* ```javascript
@@ -86,19 +91,19 @@ export interface CreateChimeWebhookConfigurationCommandOutput
8691
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
8792
*
8893
* @throws {@link ConflictException} (client fault)
89-
* There was an issue processing your request.
94+
* <p>There was an issue processing your request.</p>
9095
*
9196
* @throws {@link CreateChimeWebhookConfigurationException} (server fault)
92-
* We can’t process your request right now because of a server issue. Try again later.
97+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
9398
*
9499
* @throws {@link InvalidParameterException} (client fault)
95-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
100+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
96101
*
97102
* @throws {@link InvalidRequestException} (client fault)
98-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
103+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
99104
*
100105
* @throws {@link LimitExceededException} (client fault)
101-
* You have exceeded a service limit for AWS Chatbot.
106+
* <p>You have exceeded a service limit for AWS Chatbot.</p>
102107
*
103108
* @throws {@link ChatbotServiceException}
104109
* <p>Base exception class for all service exceptions from Chatbot service.</p>
@@ -124,7 +129,7 @@ export class CreateChimeWebhookConfigurationCommand extends $Command
124129
})
125130
.s("WheatleyOrchestration_20171011", "CreateChimeWebhookConfiguration", {})
126131
.n("ChatbotClient", "CreateChimeWebhookConfigurationCommand")
127-
.f(void 0, void 0)
132+
.f(CreateChimeWebhookConfigurationRequestFilterSensitiveLog, CreateChimeWebhookConfigurationResultFilterSensitiveLog)
128133
.ser(se_CreateChimeWebhookConfigurationCommand)
129134
.de(de_CreateChimeWebhookConfigurationCommand)
130135
.build() {}

‎clients/client-chatbot/src/commands/CreateMicrosoftTeamsChannelConfigurationCommand.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { CreateTeamsChannelConfigurationRequest, CreateTeamsChannelConfigurationResult } from "../models/models_0";
9+
import {
10+
CreateTeamsChannelConfigurationRequest,
11+
CreateTeamsChannelConfigurationRequestFilterSensitiveLog,
12+
CreateTeamsChannelConfigurationResult,
13+
CreateTeamsChannelConfigurationResultFilterSensitiveLog,
14+
} from "../models/models_0";
1015
import {
1116
de_CreateMicrosoftTeamsChannelConfigurationCommand,
1217
se_CreateMicrosoftTeamsChannelConfigurationCommand,
@@ -33,7 +38,7 @@ export interface CreateMicrosoftTeamsChannelConfigurationCommandOutput
3338
__MetadataBearer {}
3439

3540
/**
36-
* Creates MS Teams Channel Configuration
41+
* <p>Creates an AWS Chatbot configuration for Microsoft Teams.</p>
3742
* @example
3843
* Use a bare-bones client and the command you need to make an API call.
3944
* ```javascript
@@ -101,19 +106,19 @@ export interface CreateMicrosoftTeamsChannelConfigurationCommandOutput
101106
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
102107
*
103108
* @throws {@link ConflictException} (client fault)
104-
* There was an issue processing your request.
109+
* <p>There was an issue processing your request.</p>
105110
*
106111
* @throws {@link CreateTeamsChannelConfigurationException} (server fault)
107-
* We can’t process your request right now because of a server issue. Try again later.
112+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
108113
*
109114
* @throws {@link InvalidParameterException} (client fault)
110-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
115+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
111116
*
112117
* @throws {@link InvalidRequestException} (client fault)
113-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
118+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
114119
*
115120
* @throws {@link LimitExceededException} (client fault)
116-
* You have exceeded a service limit for AWS Chatbot.
121+
* <p>You have exceeded a service limit for AWS Chatbot.</p>
117122
*
118123
* @throws {@link ChatbotServiceException}
119124
* <p>Base exception class for all service exceptions from Chatbot service.</p>
@@ -139,7 +144,7 @@ export class CreateMicrosoftTeamsChannelConfigurationCommand extends $Command
139144
})
140145
.s("WheatleyOrchestration_20171011", "CreateMicrosoftTeamsChannelConfiguration", {})
141146
.n("ChatbotClient", "CreateMicrosoftTeamsChannelConfigurationCommand")
142-
.f(void 0, void 0)
147+
.f(CreateTeamsChannelConfigurationRequestFilterSensitiveLog, CreateTeamsChannelConfigurationResultFilterSensitiveLog)
143148
.ser(se_CreateMicrosoftTeamsChannelConfigurationCommand)
144149
.de(de_CreateMicrosoftTeamsChannelConfigurationCommand)
145150
.build() {}

‎clients/client-chatbot/src/commands/CreateSlackChannelConfigurationCommand.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { CreateSlackChannelConfigurationRequest, CreateSlackChannelConfigurationResult } from "../models/models_0";
9+
import {
10+
CreateSlackChannelConfigurationRequest,
11+
CreateSlackChannelConfigurationRequestFilterSensitiveLog,
12+
CreateSlackChannelConfigurationResult,
13+
CreateSlackChannelConfigurationResultFilterSensitiveLog,
14+
} from "../models/models_0";
1015
import {
1116
de_CreateSlackChannelConfigurationCommand,
1217
se_CreateSlackChannelConfigurationCommand,
@@ -33,7 +38,7 @@ export interface CreateSlackChannelConfigurationCommandOutput
3338
__MetadataBearer {}
3439

3540
/**
36-
* Creates Slack Channel Configuration
41+
* <p>Creates an AWS Chatbot confugration for Slack.</p>
3742
* @example
3843
* Use a bare-bones client and the command you need to make an API call.
3944
* ```javascript
@@ -98,19 +103,19 @@ export interface CreateSlackChannelConfigurationCommandOutput
98103
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
99104
*
100105
* @throws {@link ConflictException} (client fault)
101-
* There was an issue processing your request.
106+
* <p>There was an issue processing your request.</p>
102107
*
103108
* @throws {@link CreateSlackChannelConfigurationException} (server fault)
104-
* We can’t process your request right now because of a server issue. Try again later.
109+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
105110
*
106111
* @throws {@link InvalidParameterException} (client fault)
107-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
112+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
108113
*
109114
* @throws {@link InvalidRequestException} (client fault)
110-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
115+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
111116
*
112117
* @throws {@link LimitExceededException} (client fault)
113-
* You have exceeded a service limit for AWS Chatbot.
118+
* <p>You have exceeded a service limit for AWS Chatbot.</p>
114119
*
115120
* @throws {@link ChatbotServiceException}
116121
* <p>Base exception class for all service exceptions from Chatbot service.</p>
@@ -136,7 +141,7 @@ export class CreateSlackChannelConfigurationCommand extends $Command
136141
})
137142
.s("WheatleyOrchestration_20171011", "CreateSlackChannelConfiguration", {})
138143
.n("ChatbotClient", "CreateSlackChannelConfigurationCommand")
139-
.f(void 0, void 0)
144+
.f(CreateSlackChannelConfigurationRequestFilterSensitiveLog, CreateSlackChannelConfigurationResultFilterSensitiveLog)
140145
.ser(se_CreateSlackChannelConfigurationCommand)
141146
.de(de_CreateSlackChannelConfigurationCommand)
142147
.build() {}

‎clients/client-chatbot/src/commands/DeleteChimeWebhookConfigurationCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteChimeWebhookConfigurationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* Deletes a Chime Webhook Configuration
36+
* <p>Deletes a Amazon Chime webhook configuration for AWS Chatbot.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -56,16 +56,16 @@ export interface DeleteChimeWebhookConfigurationCommandOutput
5656
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
5757
*
5858
* @throws {@link DeleteChimeWebhookConfigurationException} (server fault)
59-
* We can’t process your request right now because of a server issue. Try again later.
59+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
6060
*
6161
* @throws {@link InvalidParameterException} (client fault)
62-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
62+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
6363
*
6464
* @throws {@link InvalidRequestException} (client fault)
65-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
65+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
6666
*
6767
* @throws {@link ResourceNotFoundException} (client fault)
68-
* We were not able to find the resource for your request.
68+
* <p>We were unable to find the resource for your request</p>
6969
*
7070
* @throws {@link ChatbotServiceException}
7171
* <p>Base exception class for all service exceptions from Chatbot service.</p>

‎clients/client-chatbot/src/commands/DeleteMicrosoftTeamsChannelConfigurationCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteMicrosoftTeamsChannelConfigurationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* Deletes MS Teams Channel Configuration
36+
* <p>Deletes a Microsoft Teams channel configuration for AWS Chatbot</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -56,16 +56,16 @@ export interface DeleteMicrosoftTeamsChannelConfigurationCommandOutput
5656
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
5757
*
5858
* @throws {@link DeleteTeamsChannelConfigurationException} (server fault)
59-
* We can’t process your request right now because of a server issue. Try again later.
59+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
6060
*
6161
* @throws {@link InvalidParameterException} (client fault)
62-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
62+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
6363
*
6464
* @throws {@link InvalidRequestException} (client fault)
65-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
65+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
6666
*
6767
* @throws {@link ResourceNotFoundException} (client fault)
68-
* We were not able to find the resource for your request.
68+
* <p>We were unable to find the resource for your request</p>
6969
*
7070
* @throws {@link ChatbotServiceException}
7171
* <p>Base exception class for all service exceptions from Chatbot service.</p>

‎clients/client-chatbot/src/commands/DeleteMicrosoftTeamsConfiguredTeamCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface DeleteMicrosoftTeamsConfiguredTeamCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* 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.
36+
* <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.
37+
* </p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript
@@ -56,10 +57,10 @@ export interface DeleteMicrosoftTeamsConfiguredTeamCommandOutput
5657
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
5758
*
5859
* @throws {@link DeleteTeamsConfiguredTeamException} (server fault)
59-
* We can’t process your request right now because of a server issue. Try again later.
60+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
6061
*
6162
* @throws {@link InvalidParameterException} (client fault)
62-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
63+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
6364
*
6465
* @throws {@link ChatbotServiceException}
6566
* <p>Base exception class for all service exceptions from Chatbot service.</p>

‎clients/client-chatbot/src/commands/DeleteMicrosoftTeamsUserIdentityCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteMicrosoftTeamsUserIdentityCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* Deletes a Teams user identity
36+
* <p>Identifes a user level permission for a channel configuration.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -57,13 +57,13 @@ export interface DeleteMicrosoftTeamsUserIdentityCommandOutput
5757
* @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
5858
*
5959
* @throws {@link DeleteMicrosoftTeamsUserIdentityException} (server fault)
60-
* We can’t process your request right now because of a server issue. Try again later.
60+
* <p>We can’t process your request right now because of a server issue. Try again later.</p>
6161
*
6262
* @throws {@link InvalidParameterException} (client fault)
63-
* Your request input doesn't meet the constraints that AWS Chatbot requires.
63+
* <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
6464
*
6565
* @throws {@link ResourceNotFoundException} (client fault)
66-
* We were not able to find the resource for your request.
66+
* <p>We were unable to find the resource for your request</p>
6767
*
6868
* @throws {@link ChatbotServiceException}
6969
* <p>Base exception class for all service exceptions from Chatbot service.</p>

0 commit comments

Comments
 (0)