cdk-lambda-subminute 2.0.482 → 2.0.484

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,99 +12,99 @@ declare class Chatbot extends Service {
12
12
  constructor(options?: Chatbot.Types.ClientConfiguration)
13
13
  config: Config & Chatbot.Types.ClientConfiguration;
14
14
  /**
15
- * Creates Chime Webhook Configuration
15
+ * Creates an AWS Chatbot configuration for Amazon Chime.
16
16
  */
17
17
  createChimeWebhookConfiguration(params: Chatbot.Types.CreateChimeWebhookConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.CreateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.CreateChimeWebhookConfigurationResult, AWSError>;
18
18
  /**
19
- * Creates Chime Webhook Configuration
19
+ * Creates an AWS Chatbot configuration for Amazon Chime.
20
20
  */
21
21
  createChimeWebhookConfiguration(callback?: (err: AWSError, data: Chatbot.Types.CreateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.CreateChimeWebhookConfigurationResult, AWSError>;
22
22
  /**
23
- * Creates MS Teams Channel Configuration
23
+ * Creates an AWS Chatbot configuration for Microsoft Teams.
24
24
  */
25
25
  createMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.CreateTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.CreateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.CreateTeamsChannelConfigurationResult, AWSError>;
26
26
  /**
27
- * Creates MS Teams Channel Configuration
27
+ * Creates an AWS Chatbot configuration for Microsoft Teams.
28
28
  */
29
29
  createMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.CreateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.CreateTeamsChannelConfigurationResult, AWSError>;
30
30
  /**
31
- * Creates Slack Channel Configuration
31
+ * Creates an AWS Chatbot confugration for Slack.
32
32
  */
33
33
  createSlackChannelConfiguration(params: Chatbot.Types.CreateSlackChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.CreateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.CreateSlackChannelConfigurationResult, AWSError>;
34
34
  /**
35
- * Creates Slack Channel Configuration
35
+ * Creates an AWS Chatbot confugration for Slack.
36
36
  */
37
37
  createSlackChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.CreateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.CreateSlackChannelConfigurationResult, AWSError>;
38
38
  /**
39
- * Deletes a Chime Webhook Configuration
39
+ * Deletes a Amazon Chime webhook configuration for AWS Chatbot.
40
40
  */
41
41
  deleteChimeWebhookConfiguration(params: Chatbot.Types.DeleteChimeWebhookConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.DeleteChimeWebhookConfigurationResult, AWSError>;
42
42
  /**
43
- * Deletes a Chime Webhook Configuration
43
+ * Deletes a Amazon Chime webhook configuration for AWS Chatbot.
44
44
  */
45
45
  deleteChimeWebhookConfiguration(callback?: (err: AWSError, data: Chatbot.Types.DeleteChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.DeleteChimeWebhookConfigurationResult, AWSError>;
46
46
  /**
47
- * Deletes MS Teams Channel Configuration
47
+ * Deletes a Microsoft Teams channel configuration for AWS Chatbot
48
48
  */
49
49
  deleteMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.DeleteTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteTeamsChannelConfigurationResult, AWSError>;
50
50
  /**
51
- * Deletes MS Teams Channel Configuration
51
+ * Deletes a Microsoft Teams channel configuration for AWS Chatbot
52
52
  */
53
53
  deleteMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteTeamsChannelConfigurationResult, AWSError>;
54
54
  /**
55
- * 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.
55
+ * 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.
56
56
  */
57
57
  deleteMicrosoftTeamsConfiguredTeam(params: Chatbot.Types.DeleteTeamsConfiguredTeamRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsConfiguredTeamResult) => void): Request<Chatbot.Types.DeleteTeamsConfiguredTeamResult, AWSError>;
58
58
  /**
59
- * 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.
59
+ * 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.
60
60
  */
61
61
  deleteMicrosoftTeamsConfiguredTeam(callback?: (err: AWSError, data: Chatbot.Types.DeleteTeamsConfiguredTeamResult) => void): Request<Chatbot.Types.DeleteTeamsConfiguredTeamResult, AWSError>;
62
62
  /**
63
- * Deletes a Teams user identity
63
+ * Identifes a user level permission for a channel configuration.
64
64
  */
65
65
  deleteMicrosoftTeamsUserIdentity(params: Chatbot.Types.DeleteMicrosoftTeamsUserIdentityRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult) => void): Request<Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult, AWSError>;
66
66
  /**
67
- * Deletes a Teams user identity
67
+ * Identifes a user level permission for a channel configuration.
68
68
  */
69
69
  deleteMicrosoftTeamsUserIdentity(callback?: (err: AWSError, data: Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult) => void): Request<Chatbot.Types.DeleteMicrosoftTeamsUserIdentityResult, AWSError>;
70
70
  /**
71
- * Deletes Slack Channel Configuration
71
+ * Deletes a Slack channel configuration for AWS Chatbot
72
72
  */
73
73
  deleteSlackChannelConfiguration(params: Chatbot.Types.DeleteSlackChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteSlackChannelConfigurationResult, AWSError>;
74
74
  /**
75
- * Deletes Slack Channel Configuration
75
+ * Deletes a Slack channel configuration for AWS Chatbot
76
76
  */
77
77
  deleteSlackChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackChannelConfigurationResult) => void): Request<Chatbot.Types.DeleteSlackChannelConfigurationResult, AWSError>;
78
78
  /**
79
- * Deletes a Slack user identity
79
+ * Deletes a user level permission for a Slack channel configuration.
80
80
  */
81
81
  deleteSlackUserIdentity(params: Chatbot.Types.DeleteSlackUserIdentityRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackUserIdentityResult) => void): Request<Chatbot.Types.DeleteSlackUserIdentityResult, AWSError>;
82
82
  /**
83
- * Deletes a Slack user identity
83
+ * Deletes a user level permission for a Slack channel configuration.
84
84
  */
85
85
  deleteSlackUserIdentity(callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackUserIdentityResult) => void): Request<Chatbot.Types.DeleteSlackUserIdentityResult, AWSError>;
86
86
  /**
87
- * 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.
87
+ * 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.
88
88
  */
89
89
  deleteSlackWorkspaceAuthorization(params: Chatbot.Types.DeleteSlackWorkspaceAuthorizationRequest, callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult) => void): Request<Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult, AWSError>;
90
90
  /**
91
- * 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.
91
+ * 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.
92
92
  */
93
93
  deleteSlackWorkspaceAuthorization(callback?: (err: AWSError, data: Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult) => void): Request<Chatbot.Types.DeleteSlackWorkspaceAuthorizationResult, AWSError>;
94
94
  /**
95
- * Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn
95
+ * Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn
96
96
  */
97
97
  describeChimeWebhookConfigurations(params: Chatbot.Types.DescribeChimeWebhookConfigurationsRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeChimeWebhookConfigurationsResult) => void): Request<Chatbot.Types.DescribeChimeWebhookConfigurationsResult, AWSError>;
98
98
  /**
99
- * Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn
99
+ * Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn
100
100
  */
101
101
  describeChimeWebhookConfigurations(callback?: (err: AWSError, data: Chatbot.Types.DescribeChimeWebhookConfigurationsResult) => void): Request<Chatbot.Types.DescribeChimeWebhookConfigurationsResult, AWSError>;
102
102
  /**
103
- * Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn
103
+ * Lists Slack channel configurations optionally filtered by ChatConfigurationArn
104
104
  */
105
105
  describeSlackChannelConfigurations(params: Chatbot.Types.DescribeSlackChannelConfigurationsRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackChannelConfigurationsResult) => void): Request<Chatbot.Types.DescribeSlackChannelConfigurationsResult, AWSError>;
106
106
  /**
107
- * Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn
107
+ * Lists Slack channel configurations optionally filtered by ChatConfigurationArn
108
108
  */
109
109
  describeSlackChannelConfigurations(callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackChannelConfigurationsResult) => void): Request<Chatbot.Types.DescribeSlackChannelConfigurationsResult, AWSError>;
110
110
  /**
@@ -116,107 +116,107 @@ declare class Chatbot extends Service {
116
116
  */
117
117
  describeSlackUserIdentities(callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackUserIdentitiesResult) => void): Request<Chatbot.Types.DescribeSlackUserIdentitiesResult, AWSError>;
118
118
  /**
119
- * Lists all authorized Slack Workspaces for AWS Account
119
+ * List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.
120
120
  */
121
121
  describeSlackWorkspaces(params: Chatbot.Types.DescribeSlackWorkspacesRequest, callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackWorkspacesResult) => void): Request<Chatbot.Types.DescribeSlackWorkspacesResult, AWSError>;
122
122
  /**
123
- * Lists all authorized Slack Workspaces for AWS Account
123
+ * List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.
124
124
  */
125
125
  describeSlackWorkspaces(callback?: (err: AWSError, data: Chatbot.Types.DescribeSlackWorkspacesResult) => void): Request<Chatbot.Types.DescribeSlackWorkspacesResult, AWSError>;
126
126
  /**
127
- * Get Chatbot account level preferences
127
+ * Returns AWS Chatbot account preferences.
128
128
  */
129
129
  getAccountPreferences(params: Chatbot.Types.GetAccountPreferencesRequest, callback?: (err: AWSError, data: Chatbot.Types.GetAccountPreferencesResult) => void): Request<Chatbot.Types.GetAccountPreferencesResult, AWSError>;
130
130
  /**
131
- * Get Chatbot account level preferences
131
+ * Returns AWS Chatbot account preferences.
132
132
  */
133
133
  getAccountPreferences(callback?: (err: AWSError, data: Chatbot.Types.GetAccountPreferencesResult) => void): Request<Chatbot.Types.GetAccountPreferencesResult, AWSError>;
134
134
  /**
135
- * Get a single MS Teams Channel Configurations
135
+ * Returns a Microsoft Teams channel configuration in an AWS account.
136
136
  */
137
137
  getMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.GetTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.GetTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.GetTeamsChannelConfigurationResult, AWSError>;
138
138
  /**
139
- * Get a single MS Teams Channel Configurations
139
+ * Returns a Microsoft Teams channel configuration in an AWS account.
140
140
  */
141
141
  getMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.GetTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.GetTeamsChannelConfigurationResult, AWSError>;
142
142
  /**
143
- * Lists MS Teams Channel Configurations optionally filtered by TeamId
143
+ * Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.
144
144
  */
145
145
  listMicrosoftTeamsChannelConfigurations(params: Chatbot.Types.ListTeamsChannelConfigurationsRequest, callback?: (err: AWSError, data: Chatbot.Types.ListTeamsChannelConfigurationsResult) => void): Request<Chatbot.Types.ListTeamsChannelConfigurationsResult, AWSError>;
146
146
  /**
147
- * Lists MS Teams Channel Configurations optionally filtered by TeamId
147
+ * Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.
148
148
  */
149
149
  listMicrosoftTeamsChannelConfigurations(callback?: (err: AWSError, data: Chatbot.Types.ListTeamsChannelConfigurationsResult) => void): Request<Chatbot.Types.ListTeamsChannelConfigurationsResult, AWSError>;
150
150
  /**
151
- * Lists all authorized MS teams for AWS Account
151
+ * Lists all authorized Microsoft Teams for an AWS Account
152
152
  */
153
153
  listMicrosoftTeamsConfiguredTeams(params: Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsRequest, callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult, AWSError>;
154
154
  /**
155
- * Lists all authorized MS teams for AWS Account
155
+ * Lists all authorized Microsoft Teams for an AWS Account
156
156
  */
157
157
  listMicrosoftTeamsConfiguredTeams(callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsConfiguredTeamsResult, AWSError>;
158
158
  /**
159
- * Lists all Microsoft Teams user identities with a mapped role.
159
+ * A list all Microsoft Teams user identities with a mapped role.
160
160
  */
161
161
  listMicrosoftTeamsUserIdentities(params: Chatbot.Types.ListMicrosoftTeamsUserIdentitiesRequest, callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult, AWSError>;
162
162
  /**
163
- * Lists all Microsoft Teams user identities with a mapped role.
163
+ * A list all Microsoft Teams user identities with a mapped role.
164
164
  */
165
165
  listMicrosoftTeamsUserIdentities(callback?: (err: AWSError, data: Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult) => void): Request<Chatbot.Types.ListMicrosoftTeamsUserIdentitiesResult, AWSError>;
166
166
  /**
167
- * Retrieves the list of tags applied to a configuration.
167
+ * Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
168
168
  */
169
169
  listTagsForResource(params: Chatbot.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Chatbot.Types.ListTagsForResourceResponse) => void): Request<Chatbot.Types.ListTagsForResourceResponse, AWSError>;
170
170
  /**
171
- * Retrieves the list of tags applied to a configuration.
171
+ * Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
172
172
  */
173
173
  listTagsForResource(callback?: (err: AWSError, data: Chatbot.Types.ListTagsForResourceResponse) => void): Request<Chatbot.Types.ListTagsForResourceResponse, AWSError>;
174
174
  /**
175
- * Applies the supplied tags to a configuration.
175
+ * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
176
176
  */
177
177
  tagResource(params: Chatbot.Types.TagResourceRequest, callback?: (err: AWSError, data: Chatbot.Types.TagResourceResponse) => void): Request<Chatbot.Types.TagResourceResponse, AWSError>;
178
178
  /**
179
- * Applies the supplied tags to a configuration.
179
+ * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
180
180
  */
181
181
  tagResource(callback?: (err: AWSError, data: Chatbot.Types.TagResourceResponse) => void): Request<Chatbot.Types.TagResourceResponse, AWSError>;
182
182
  /**
183
- * Removes the supplied tags from a configuration
183
+ * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
184
184
  */
185
185
  untagResource(params: Chatbot.Types.UntagResourceRequest, callback?: (err: AWSError, data: Chatbot.Types.UntagResourceResponse) => void): Request<Chatbot.Types.UntagResourceResponse, AWSError>;
186
186
  /**
187
- * Removes the supplied tags from a configuration
187
+ * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
188
188
  */
189
189
  untagResource(callback?: (err: AWSError, data: Chatbot.Types.UntagResourceResponse) => void): Request<Chatbot.Types.UntagResourceResponse, AWSError>;
190
190
  /**
191
- * Update Chatbot account level preferences
191
+ * Updates AWS Chatbot account preferences.
192
192
  */
193
193
  updateAccountPreferences(params: Chatbot.Types.UpdateAccountPreferencesRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateAccountPreferencesResult) => void): Request<Chatbot.Types.UpdateAccountPreferencesResult, AWSError>;
194
194
  /**
195
- * Update Chatbot account level preferences
195
+ * Updates AWS Chatbot account preferences.
196
196
  */
197
197
  updateAccountPreferences(callback?: (err: AWSError, data: Chatbot.Types.UpdateAccountPreferencesResult) => void): Request<Chatbot.Types.UpdateAccountPreferencesResult, AWSError>;
198
198
  /**
199
- * Updates a Chime Webhook Configuration
199
+ * Updates a Amazon Chime webhook configuration.
200
200
  */
201
201
  updateChimeWebhookConfiguration(params: Chatbot.Types.UpdateChimeWebhookConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.UpdateChimeWebhookConfigurationResult, AWSError>;
202
202
  /**
203
- * Updates a Chime Webhook Configuration
203
+ * Updates a Amazon Chime webhook configuration.
204
204
  */
205
205
  updateChimeWebhookConfiguration(callback?: (err: AWSError, data: Chatbot.Types.UpdateChimeWebhookConfigurationResult) => void): Request<Chatbot.Types.UpdateChimeWebhookConfigurationResult, AWSError>;
206
206
  /**
207
- * Updates MS Teams Channel Configuration
207
+ * Updates an Microsoft Teams channel configuration.
208
208
  */
209
209
  updateMicrosoftTeamsChannelConfiguration(params: Chatbot.Types.UpdateTeamsChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateTeamsChannelConfigurationResult, AWSError>;
210
210
  /**
211
- * Updates MS Teams Channel Configuration
211
+ * Updates an Microsoft Teams channel configuration.
212
212
  */
213
213
  updateMicrosoftTeamsChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.UpdateTeamsChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateTeamsChannelConfigurationResult, AWSError>;
214
214
  /**
215
- * Updates Slack Channel Configuration
215
+ * Updates a Slack channel configuration.
216
216
  */
217
217
  updateSlackChannelConfiguration(params: Chatbot.Types.UpdateSlackChannelConfigurationRequest, callback?: (err: AWSError, data: Chatbot.Types.UpdateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateSlackChannelConfigurationResult, AWSError>;
218
218
  /**
219
- * Updates Slack Channel Configuration
219
+ * Updates a Slack channel configuration.
220
220
  */
221
221
  updateSlackChannelConfiguration(callback?: (err: AWSError, data: Chatbot.Types.UpdateSlackChannelConfigurationResult) => void): Request<Chatbot.Types.UpdateSlackChannelConfigurationResult, AWSError>;
222
222
  }
@@ -227,7 +227,7 @@ declare namespace Chatbot {
227
227
  */
228
228
  UserAuthorizationRequired?: BooleanAccountPreference;
229
229
  /**
230
- * 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.
230
+ * 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.
231
231
  */
232
232
  TrainingDataCollectionEnabled?: BooleanAccountPreference;
233
233
  }
@@ -238,19 +238,19 @@ declare namespace Chatbot {
238
238
  export type ChatConfigurationArn = string;
239
239
  export interface ChimeWebhookConfiguration {
240
240
  /**
241
- * 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.
241
+ * 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.
242
242
  */
243
243
  WebhookDescription: ChimeWebhookDescription;
244
244
  /**
245
- * The ARN of the ChimeWebhookConfiguration.
245
+ * The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.
246
246
  */
247
247
  ChatConfigurationArn: ChatConfigurationArn;
248
248
  /**
249
- * 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.
249
+ * 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.
250
250
  */
251
251
  IamRoleArn: Arn;
252
252
  /**
253
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
253
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
254
254
  */
255
255
  SnsTopicArns: SnsTopicArnList;
256
256
  /**
@@ -258,11 +258,11 @@ declare namespace Chatbot {
258
258
  */
259
259
  ConfigurationName?: ConfigurationName;
260
260
  /**
261
- * 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.
261
+ * Logging levels include ERROR, INFO, or NONE.
262
262
  */
263
263
  LoggingLevel?: CustomerCwLogLevel;
264
264
  /**
265
- * A list of tags applied to the configuration.
265
+ * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
266
266
  */
267
267
  Tags?: Tags;
268
268
  }
@@ -276,7 +276,7 @@ declare namespace Chatbot {
276
276
  */
277
277
  TenantId: UUID;
278
278
  /**
279
- * 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.
279
+ * 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.
280
280
  */
281
281
  TeamId: UUID;
282
282
  /**
@@ -287,19 +287,19 @@ declare namespace Chatbot {
287
287
  export type ConfiguredTeamsList = ConfiguredTeam[];
288
288
  export interface CreateChimeWebhookConfigurationRequest {
289
289
  /**
290
- * 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.
290
+ * 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.
291
291
  */
292
292
  WebhookDescription: ChimeWebhookDescription;
293
293
  /**
294
- * URL for the Chime webhook.
294
+ * The URL for the Amazon Chime webhook.
295
295
  */
296
296
  WebhookUrl: ChimeWebhookUrl;
297
297
  /**
298
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
298
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
299
299
  */
300
300
  SnsTopicArns: SnsTopicArnList;
301
301
  /**
302
- * 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.
302
+ * 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.
303
303
  */
304
304
  IamRoleArn: Arn;
305
305
  /**
@@ -311,13 +311,13 @@ declare namespace Chatbot {
311
311
  */
312
312
  LoggingLevel?: CustomerCwLogLevel;
313
313
  /**
314
- * A list of tags to apply to the configuration.
314
+ * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
315
315
  */
316
316
  Tags?: Tags;
317
317
  }
318
318
  export interface CreateChimeWebhookConfigurationResult {
319
319
  /**
320
- * Chime webhook configuration.
320
+ * An Amazon Chime webhook configuration.
321
321
  */
322
322
  WebhookConfiguration?: ChimeWebhookConfiguration;
323
323
  }
@@ -327,19 +327,19 @@ declare namespace Chatbot {
327
327
  */
328
328
  SlackTeamId: SlackTeamId;
329
329
  /**
330
- * 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.
330
+ * 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.
331
331
  */
332
332
  SlackChannelId: SlackChannelId;
333
333
  /**
334
- * The name of the Slack Channel.
334
+ * The name of the Slack channel.
335
335
  */
336
336
  SlackChannelName?: SlackChannelDisplayName;
337
337
  /**
338
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
338
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
339
339
  */
340
340
  SnsTopicArns?: SnsTopicArnList;
341
341
  /**
342
- * 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.
342
+ * 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.
343
343
  */
344
344
  IamRoleArn: Arn;
345
345
  /**
@@ -351,7 +351,7 @@ declare namespace Chatbot {
351
351
  */
352
352
  LoggingLevel?: CustomerCwLogLevel;
353
353
  /**
354
- * 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.
354
+ * 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.
355
355
  */
356
356
  GuardrailPolicyArns?: GuardrailPolicyArnList;
357
357
  /**
@@ -359,7 +359,7 @@ declare namespace Chatbot {
359
359
  */
360
360
  UserAuthorizationRequired?: BooleanAccountPreference;
361
361
  /**
362
- * A list of tags to apply to the configuration.
362
+ * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
363
363
  */
364
364
  Tags?: Tags;
365
365
  }
@@ -379,7 +379,7 @@ declare namespace Chatbot {
379
379
  */
380
380
  ChannelName?: TeamsChannelName;
381
381
  /**
382
- * 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.
382
+ * 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.
383
383
  */
384
384
  TeamId: UUID;
385
385
  /**
@@ -391,11 +391,11 @@ declare namespace Chatbot {
391
391
  */
392
392
  TenantId: UUID;
393
393
  /**
394
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
394
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
395
395
  */
396
396
  SnsTopicArns?: SnsTopicArnList;
397
397
  /**
398
- * 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.
398
+ * 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.
399
399
  */
400
400
  IamRoleArn: Arn;
401
401
  /**
@@ -407,7 +407,7 @@ declare namespace Chatbot {
407
407
  */
408
408
  LoggingLevel?: CustomerCwLogLevel;
409
409
  /**
410
- * 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.
410
+ * 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.
411
411
  */
412
412
  GuardrailPolicyArns?: GuardrailPolicyArnList;
413
413
  /**
@@ -415,7 +415,7 @@ declare namespace Chatbot {
415
415
  */
416
416
  UserAuthorizationRequired?: BooleanAccountPreference;
417
417
  /**
418
- * A list of tags to apply to the configuration.
418
+ * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
419
419
  */
420
420
  Tags?: Tags;
421
421
  }
@@ -428,7 +428,7 @@ declare namespace Chatbot {
428
428
  export type CustomerCwLogLevel = string;
429
429
  export interface DeleteChimeWebhookConfigurationRequest {
430
430
  /**
431
- * The ARN of the ChimeWebhookConfiguration to delete.
431
+ * The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.
432
432
  */
433
433
  ChatConfigurationArn: ChatConfigurationArn;
434
434
  }
@@ -440,7 +440,7 @@ declare namespace Chatbot {
440
440
  */
441
441
  ChatConfigurationArn: ChatConfigurationArn;
442
442
  /**
443
- * Id from Microsoft Teams for user.
443
+ * The Microsoft Teams user ID.
444
444
  */
445
445
  UserId: UUID;
446
446
  }
@@ -448,7 +448,7 @@ declare namespace Chatbot {
448
448
  }
449
449
  export interface DeleteSlackChannelConfigurationRequest {
450
450
  /**
451
- * The ARN of the SlackChannelConfiguration to delete.
451
+ * The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete.
452
452
  */
453
453
  ChatConfigurationArn: ChatConfigurationArn;
454
454
  }
@@ -464,7 +464,7 @@ declare namespace Chatbot {
464
464
  */
465
465
  SlackTeamId: SlackTeamId;
466
466
  /**
467
- * The ID of the user in Slack.
467
+ * The ID of the user in Slack
468
468
  */
469
469
  SlackUserId: SlackUserId;
470
470
  }
@@ -480,7 +480,7 @@ declare namespace Chatbot {
480
480
  }
481
481
  export interface DeleteTeamsChannelConfigurationRequest {
482
482
  /**
483
- * The ARN of the MicrosoftTeamsChannelConfiguration to delete.
483
+ * The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
484
484
  */
485
485
  ChatConfigurationArn: ChatConfigurationArn;
486
486
  }
@@ -488,7 +488,7 @@ declare namespace Chatbot {
488
488
  }
489
489
  export interface DeleteTeamsConfiguredTeamRequest {
490
490
  /**
491
- * 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.
491
+ * 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.
492
492
  */
493
493
  TeamId: UUID;
494
494
  }
@@ -496,45 +496,45 @@ declare namespace Chatbot {
496
496
  }
497
497
  export interface DescribeChimeWebhookConfigurationsRequest {
498
498
  /**
499
- * 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.
499
+ * 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.
500
500
  */
501
501
  MaxResults?: MaxResults;
502
502
  /**
503
- * 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.
503
+ * 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.
504
504
  */
505
505
  NextToken?: PaginationToken;
506
506
  /**
507
- * An optional ARN of a ChimeWebhookConfiguration to describe.
507
+ * An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe.
508
508
  */
509
509
  ChatConfigurationArn?: ChatConfigurationArn;
510
510
  }
511
511
  export interface DescribeChimeWebhookConfigurationsResult {
512
512
  /**
513
- * 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.
513
+ * 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.
514
514
  */
515
515
  NextToken?: PaginationToken;
516
516
  /**
517
- * A list of Chime webhooks associated with the account.
517
+ * A list of Amazon Chime webhooks associated with the account.
518
518
  */
519
519
  WebhookConfigurations?: ChimeWebhookConfigurationList;
520
520
  }
521
521
  export interface DescribeSlackChannelConfigurationsRequest {
522
522
  /**
523
- * 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.
523
+ * 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.
524
524
  */
525
525
  MaxResults?: MaxResults;
526
526
  /**
527
- * 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.
527
+ * 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.
528
528
  */
529
529
  NextToken?: PaginationToken;
530
530
  /**
531
- * An optional ARN of a SlackChannelConfiguration to describe.
531
+ * An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe.
532
532
  */
533
533
  ChatConfigurationArn?: ChatConfigurationArn;
534
534
  }
535
535
  export interface DescribeSlackChannelConfigurationsResult {
536
536
  /**
537
- * 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.
537
+ * 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.
538
538
  */
539
539
  NextToken?: PaginationToken;
540
540
  /**
@@ -544,15 +544,15 @@ declare namespace Chatbot {
544
544
  }
545
545
  export interface DescribeSlackUserIdentitiesRequest {
546
546
  /**
547
- * The ARN of the SlackChannelConfiguration associated with the user identities to describe.
547
+ * The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe.
548
548
  */
549
549
  ChatConfigurationArn?: ChatConfigurationArn;
550
550
  /**
551
- * 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.
551
+ * 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.
552
552
  */
553
553
  NextToken?: PaginationToken;
554
554
  /**
555
- * 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.
555
+ * 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.
556
556
  */
557
557
  MaxResults?: MaxResults;
558
558
  }
@@ -562,27 +562,27 @@ declare namespace Chatbot {
562
562
  */
563
563
  SlackUserIdentities?: SlackUserIdentitiesList;
564
564
  /**
565
- * 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.
565
+ * 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.
566
566
  */
567
567
  NextToken?: PaginationToken;
568
568
  }
569
569
  export interface DescribeSlackWorkspacesRequest {
570
570
  /**
571
- * 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.
571
+ * 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.
572
572
  */
573
573
  MaxResults?: MaxResults;
574
574
  /**
575
- * 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.
575
+ * 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.
576
576
  */
577
577
  NextToken?: PaginationToken;
578
578
  }
579
579
  export interface DescribeSlackWorkspacesResult {
580
580
  /**
581
- * A list of Slack Workspaces registered with AWS Chatbot.
581
+ * A list of Slack workspaces registered with AWS Chatbot.
582
582
  */
583
583
  SlackWorkspaces?: SlackWorkspacesList;
584
584
  /**
585
- * 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.
585
+ * 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.
586
586
  */
587
587
  NextToken?: PaginationToken;
588
588
  }
@@ -590,13 +590,13 @@ declare namespace Chatbot {
590
590
  }
591
591
  export interface GetAccountPreferencesResult {
592
592
  /**
593
- * Preferences which apply for AWS Chatbot usage in the calling AWS account.
593
+ * The preferences related to AWS Chatbot usage in the calling AWS account.
594
594
  */
595
595
  AccountPreferences?: AccountPreferences;
596
596
  }
597
597
  export interface GetTeamsChannelConfigurationRequest {
598
598
  /**
599
- * The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
599
+ * The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.
600
600
  */
601
601
  ChatConfigurationArn: ChatConfigurationArn;
602
602
  }
@@ -620,7 +620,7 @@ declare namespace Chatbot {
620
620
  }
621
621
  export interface ListMicrosoftTeamsConfiguredTeamsResult {
622
622
  /**
623
- * A list of teams in Microsoft Teams that have been configured with AWS Chatbot.
623
+ * A list of teams in Microsoft Teams that are configured with AWS Chatbot.
624
624
  */
625
625
  ConfiguredTeams?: ConfiguredTeamsList;
626
626
  /**
@@ -630,15 +630,15 @@ declare namespace Chatbot {
630
630
  }
631
631
  export interface ListMicrosoftTeamsUserIdentitiesRequest {
632
632
  /**
633
- * The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.
633
+ * The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.
634
634
  */
635
635
  ChatConfigurationArn?: ChatConfigurationArn;
636
636
  /**
637
- * 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.
637
+ * 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.
638
638
  */
639
639
  NextToken?: PaginationToken;
640
640
  /**
641
- * 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.
641
+ * 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.
642
642
  */
643
643
  MaxResults?: MaxResults;
644
644
  }
@@ -648,19 +648,19 @@ declare namespace Chatbot {
648
648
  */
649
649
  TeamsUserIdentities?: TeamsUserIdentitiesList;
650
650
  /**
651
- * 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.
651
+ * 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.
652
652
  */
653
653
  NextToken?: PaginationToken;
654
654
  }
655
655
  export interface ListTagsForResourceRequest {
656
656
  /**
657
- * The ARN of the configuration.
657
+ * The ARN you specified to list the tags of.
658
658
  */
659
659
  ResourceARN: AmazonResourceName;
660
660
  }
661
661
  export interface ListTagsForResourceResponse {
662
662
  /**
663
- * A list of tags applied to the configuration.
663
+ * 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.
664
664
  */
665
665
  Tags?: TagList;
666
666
  }
@@ -674,7 +674,7 @@ declare namespace Chatbot {
674
674
  */
675
675
  NextToken?: PaginationToken;
676
676
  /**
677
- * 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.
677
+ * 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.
678
678
  */
679
679
  TeamId?: UUID;
680
680
  }
@@ -692,27 +692,27 @@ declare namespace Chatbot {
692
692
  export type PaginationToken = string;
693
693
  export interface SlackChannelConfiguration {
694
694
  /**
695
- * Name of the Slack Workspace.
695
+ * Name of the Slack workspace.
696
696
  */
697
697
  SlackTeamName: SlackTeamName;
698
698
  /**
699
- * The ID of the Slack workspace authorized with AWS Chatbot.
699
+ * The ID of the Slack workspace authorized with Amazon Chime.
700
700
  */
701
701
  SlackTeamId: SlackTeamId;
702
702
  /**
703
- * 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.
703
+ * 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.
704
704
  */
705
705
  SlackChannelId: SlackChannelId;
706
706
  /**
707
- * The name of the Slack Channel.
707
+ * The name of the Slack channel.
708
708
  */
709
709
  SlackChannelName: SlackChannelDisplayName;
710
710
  /**
711
- * The ARN of the SlackChannelConfiguration.
711
+ * The Amazon Resource Number (ARN) of the SlackChannelConfiguration.
712
712
  */
713
713
  ChatConfigurationArn: ChatConfigurationArn;
714
714
  /**
715
- * 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.
715
+ * 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.
716
716
  */
717
717
  IamRoleArn: Arn;
718
718
  /**
@@ -728,7 +728,7 @@ declare namespace Chatbot {
728
728
  */
729
729
  LoggingLevel?: CustomerCwLogLevel;
730
730
  /**
731
- * 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.
731
+ * 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.
732
732
  */
733
733
  GuardrailPolicyArns?: GuardrailPolicyArnList;
734
734
  /**
@@ -736,7 +736,7 @@ declare namespace Chatbot {
736
736
  */
737
737
  UserAuthorizationRequired?: BooleanAccountPreference;
738
738
  /**
739
- * A list of tags applied to the configuration.
739
+ * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
740
740
  */
741
741
  Tags?: Tags;
742
742
  }
@@ -749,11 +749,11 @@ declare namespace Chatbot {
749
749
  export type SlackUserIdentitiesList = SlackUserIdentity[];
750
750
  export interface SlackUserIdentity {
751
751
  /**
752
- * 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.
752
+ * 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.
753
753
  */
754
754
  IamRoleArn: Arn;
755
755
  /**
756
- * The ARN of the SlackChannelConfiguration associated with the user identity.
756
+ * The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.
757
757
  */
758
758
  ChatConfigurationArn: ChatConfigurationArn;
759
759
  /**
@@ -761,11 +761,11 @@ declare namespace Chatbot {
761
761
  */
762
762
  SlackTeamId: SlackTeamId;
763
763
  /**
764
- * The ID of the user in Slack.
764
+ * The ID of the user in Slack
765
765
  */
766
766
  SlackUserId: SlackUserId;
767
767
  /**
768
- * The AWS user identity ARN used to associate a Slack User Identity with an IAM Role.
768
+ * The AWS user identity ARN used to associate a Slack user ID with an IAM Role.
769
769
  */
770
770
  AwsUserIdentity?: AwsUserIdentity;
771
771
  }
@@ -775,20 +775,19 @@ declare namespace Chatbot {
775
775
  */
776
776
  SlackTeamId: SlackTeamId;
777
777
  /**
778
- * Name of the Slack Workspace.
778
+ * The name of the Slack workspace.
779
779
  */
780
780
  SlackTeamName: SlackTeamName;
781
781
  }
782
782
  export type SlackWorkspacesList = SlackWorkspace[];
783
783
  export type SnsTopicArnList = Arn[];
784
- export type String = string;
785
784
  export interface Tag {
786
785
  /**
787
- * The tag key.
786
+ * The key of the tag.
788
787
  */
789
788
  TagKey: TagKey;
790
789
  /**
791
- * The tag value.
790
+ * The value of the tag.
792
791
  */
793
792
  TagValue: TagValue;
794
793
  }
@@ -821,27 +820,27 @@ declare namespace Chatbot {
821
820
  */
822
821
  ChannelName?: TeamsChannelName;
823
822
  /**
824
- * 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.
823
+ * 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.
825
824
  */
826
825
  TeamId: UUID;
827
826
  /**
828
827
  * The name of the Microsoft Teams Team.
829
828
  */
830
- TeamName?: String;
829
+ TeamName?: TeamName;
831
830
  /**
832
831
  * The ID of the Microsoft Teams tenant.
833
832
  */
834
833
  TenantId: UUID;
835
834
  /**
836
- * The ARN of the MicrosoftTeamsChannelConfiguration.
835
+ * The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
837
836
  */
838
837
  ChatConfigurationArn: ChatConfigurationArn;
839
838
  /**
840
- * 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.
839
+ * 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.
841
840
  */
842
841
  IamRoleArn: Arn;
843
842
  /**
844
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
843
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
845
844
  */
846
845
  SnsTopicArns: SnsTopicArnList;
847
846
  /**
@@ -853,7 +852,7 @@ declare namespace Chatbot {
853
852
  */
854
853
  LoggingLevel?: CustomerCwLogLevel;
855
854
  /**
856
- * 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.
855
+ * 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.
857
856
  */
858
857
  GuardrailPolicyArns?: GuardrailPolicyArnList;
859
858
  /**
@@ -861,7 +860,7 @@ declare namespace Chatbot {
861
860
  */
862
861
  UserAuthorizationRequired?: BooleanAccountPreference;
863
862
  /**
864
- * A list of tags applied to the configuration.
863
+ * A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
865
864
  */
866
865
  Tags?: Tags;
867
866
  }
@@ -870,23 +869,23 @@ declare namespace Chatbot {
870
869
  export type TeamsUserIdentitiesList = TeamsUserIdentity[];
871
870
  export interface TeamsUserIdentity {
872
871
  /**
873
- * 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.
872
+ * 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.
874
873
  */
875
874
  IamRoleArn: Arn;
876
875
  /**
877
- * The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity.
876
+ * The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
878
877
  */
879
878
  ChatConfigurationArn: ChatConfigurationArn;
880
879
  /**
881
- * 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.
880
+ * 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.
882
881
  */
883
882
  TeamId: UUID;
884
883
  /**
885
- * Id from Microsoft Teams for user.
884
+ * The Microsoft Teams user ID.
886
885
  */
887
886
  UserId?: UUID;
888
887
  /**
889
- * The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role.
888
+ * The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.
890
889
  */
891
890
  AwsUserIdentity?: AwsUserIdentity;
892
891
  /**
@@ -901,11 +900,11 @@ declare namespace Chatbot {
901
900
  export type UUID = string;
902
901
  export interface UntagResourceRequest {
903
902
  /**
904
- * The ARN of the configuration.
903
+ * 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.
905
904
  */
906
905
  ResourceARN: AmazonResourceName;
907
906
  /**
908
- * A list of tag keys to remove from the configuration.
907
+ * 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.
909
908
  */
910
909
  TagKeys: TagKeyList;
911
910
  }
@@ -917,27 +916,27 @@ declare namespace Chatbot {
917
916
  */
918
917
  UserAuthorizationRequired?: BooleanAccountPreference;
919
918
  /**
920
- * 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.
919
+ * 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.
921
920
  */
922
921
  TrainingDataCollectionEnabled?: BooleanAccountPreference;
923
922
  }
924
923
  export interface UpdateAccountPreferencesResult {
925
924
  /**
926
- * Preferences which apply for AWS Chatbot usage in the calling AWS account.
925
+ * Preferences related to AWS Chatbot usage in the calling AWS account.
927
926
  */
928
927
  AccountPreferences?: AccountPreferences;
929
928
  }
930
929
  export interface UpdateChimeWebhookConfigurationRequest {
931
930
  /**
932
- * The ARN of the ChimeWebhookConfiguration to update.
931
+ * The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.
933
932
  */
934
933
  ChatConfigurationArn: ChatConfigurationArn;
935
934
  /**
936
- * 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.
935
+ * 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.
937
936
  */
938
937
  WebhookDescription?: ChimeWebhookDescription;
939
938
  /**
940
- * URL for the Chime webhook.
939
+ * The URL for the Amazon Chime webhook.
941
940
  */
942
941
  WebhookUrl?: ChimeWebhookUrl;
943
942
  /**
@@ -945,7 +944,7 @@ declare namespace Chatbot {
945
944
  */
946
945
  SnsTopicArns?: SnsTopicArnList;
947
946
  /**
948
- * 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.
947
+ * 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.
949
948
  */
950
949
  IamRoleArn?: Arn;
951
950
  /**
@@ -955,29 +954,29 @@ declare namespace Chatbot {
955
954
  }
956
955
  export interface UpdateChimeWebhookConfigurationResult {
957
956
  /**
958
- * Chime webhook configuration.
957
+ * A Amazon Chime webhook configuration.
959
958
  */
960
959
  WebhookConfiguration?: ChimeWebhookConfiguration;
961
960
  }
962
961
  export interface UpdateSlackChannelConfigurationRequest {
963
962
  /**
964
- * The ARN of the SlackChannelConfiguration to update.
963
+ * The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.
965
964
  */
966
965
  ChatConfigurationArn: ChatConfigurationArn;
967
966
  /**
968
- * 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.
967
+ * 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.
969
968
  */
970
969
  SlackChannelId: SlackChannelId;
971
970
  /**
972
- * The name of the Slack Channel.
971
+ * The name of the Slack channel.
973
972
  */
974
973
  SlackChannelName?: SlackChannelDisplayName;
975
974
  /**
976
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
975
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
977
976
  */
978
977
  SnsTopicArns?: SnsTopicArnList;
979
978
  /**
980
- * 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.
979
+ * 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.
981
980
  */
982
981
  IamRoleArn?: Arn;
983
982
  /**
@@ -985,7 +984,7 @@ declare namespace Chatbot {
985
984
  */
986
985
  LoggingLevel?: CustomerCwLogLevel;
987
986
  /**
988
- * 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.
987
+ * 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.
989
988
  */
990
989
  GuardrailPolicyArns?: GuardrailPolicyArnList;
991
990
  /**
@@ -1001,7 +1000,7 @@ declare namespace Chatbot {
1001
1000
  }
1002
1001
  export interface UpdateTeamsChannelConfigurationRequest {
1003
1002
  /**
1004
- * The ARN of the MicrosoftTeamsChannelConfiguration to update.
1003
+ * The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.
1005
1004
  */
1006
1005
  ChatConfigurationArn: ChatConfigurationArn;
1007
1006
  /**
@@ -1013,11 +1012,11 @@ declare namespace Chatbot {
1013
1012
  */
1014
1013
  ChannelName?: TeamsChannelName;
1015
1014
  /**
1016
- * The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1015
+ * The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
1017
1016
  */
1018
1017
  SnsTopicArns?: SnsTopicArnList;
1019
1018
  /**
1020
- * 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.
1019
+ * 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.
1021
1020
  */
1022
1021
  IamRoleArn?: Arn;
1023
1022
  /**
@@ -1025,7 +1024,7 @@ declare namespace Chatbot {
1025
1024
  */
1026
1025
  LoggingLevel?: CustomerCwLogLevel;
1027
1026
  /**
1028
- * 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.
1027
+ * 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.
1029
1028
  */
1030
1029
  GuardrailPolicyArns?: GuardrailPolicyArnList;
1031
1030
  /**