aws-sdk-chatbot 1.0.0

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.
@@ -0,0 +1,1529 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Chatbot
11
+ module Types
12
+
13
+ # Preferences which apply for AWS Chatbot usage in the calling AWS
14
+ # account.
15
+ #
16
+ # @!attribute [rw] user_authorization_required
17
+ # Enables use of a user role requirement in your chat configuration.
18
+ # @return [Boolean]
19
+ #
20
+ # @!attribute [rw] training_data_collection_enabled
21
+ # Turns on training data collection. This helps improve the AWS
22
+ # Chatbot experience by allowing AWS Chatbot to store and use your
23
+ # customer information, such as AWS Chatbot configurations,
24
+ # notifications, user inputs, AWS Chatbot generated responses, and
25
+ # interaction data. This data helps us to continuously improve and
26
+ # develop Artificial Intelligence (AI) technologies. Your data is not
27
+ # shared with any third parties and is protected using sophisticated
28
+ # controls to prevent unauthorized access and misuse. AWS Chatbot does
29
+ # not store or use interactions in chat channels with Amazon Q for
30
+ # training AWS Chatbot’s AI technologies.
31
+ # @return [Boolean]
32
+ #
33
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/AccountPreferences AWS API Documentation
34
+ #
35
+ class AccountPreferences < Struct.new(
36
+ :user_authorization_required,
37
+ :training_data_collection_enabled)
38
+ SENSITIVE = []
39
+ include Aws::Structure
40
+ end
41
+
42
+ # An AWS Chatbot configuration for Amazon Chime.
43
+ #
44
+ # @!attribute [rw] webhook_description
45
+ # Description of the webhook. Recommend using the convention
46
+ # `RoomName/WebhookName`. See Chime setup tutorial for more details:
47
+ # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
48
+ # @return [String]
49
+ #
50
+ # @!attribute [rw] chat_configuration_arn
51
+ # The ARN of the ChimeWebhookConfiguration.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] iam_role_arn
55
+ # The ARN of the IAM role that defines the permissions for AWS
56
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
57
+ # This is not the service-linked role. For more information, see IAM
58
+ # Policies for AWS Chatbot.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] sns_topic_arns
62
+ # The ARNs of the SNS topics that deliver notifications to AWS
63
+ # Chatbot.
64
+ # @return [Array<String>]
65
+ #
66
+ # @!attribute [rw] configuration_name
67
+ # The name of the configuration.
68
+ # @return [String]
69
+ #
70
+ # @!attribute [rw] logging_level
71
+ # Specifies the logging level for this configuration. This property
72
+ # affects the log entries pushed to Amazon CloudWatch Logs.Logging
73
+ # levels include ERROR, INFO, or NONE.
74
+ # @return [String]
75
+ #
76
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ChimeWebhookConfiguration AWS API Documentation
77
+ #
78
+ class ChimeWebhookConfiguration < Struct.new(
79
+ :webhook_description,
80
+ :chat_configuration_arn,
81
+ :iam_role_arn,
82
+ :sns_topic_arns,
83
+ :configuration_name,
84
+ :logging_level)
85
+ SENSITIVE = []
86
+ include Aws::Structure
87
+ end
88
+
89
+ # A Microsoft Teams team that has been authorized with AWS Chatbot.
90
+ #
91
+ # @!attribute [rw] tenant_id
92
+ # The ID of the Microsoft Teams tenant.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] team_id
96
+ # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
97
+ # team ID, you must perform the initial authorization flow with
98
+ # Microsoft Teams in the AWS Chatbot console. Then you can copy and
99
+ # paste the team ID from the console. For more details, see steps 1-4
100
+ # in Get started with Microsoft Teams in the AWS Chatbot Administrator
101
+ # Guide.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] team_name
105
+ # The name of the Microsoft Teams Team.
106
+ # @return [String]
107
+ #
108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ConfiguredTeam AWS API Documentation
109
+ #
110
+ class ConfiguredTeam < Struct.new(
111
+ :tenant_id,
112
+ :team_id,
113
+ :team_name)
114
+ SENSITIVE = []
115
+ include Aws::Structure
116
+ end
117
+
118
+ # There was an issue processing your request.
119
+ #
120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ConflictException AWS API Documentation
121
+ #
122
+ class ConflictException < Aws::EmptyStructure; end
123
+
124
+ # We can’t process your request right now because of a server issue. Try
125
+ # again later.
126
+ #
127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateChimeWebhookConfigurationException AWS API Documentation
128
+ #
129
+ class CreateChimeWebhookConfigurationException < Aws::EmptyStructure; end
130
+
131
+ # @!attribute [rw] webhook_description
132
+ # Description of the webhook. Recommend using the convention
133
+ # `RoomName/WebhookName`. See Chime setup tutorial for more details:
134
+ # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] webhook_url
138
+ # URL for the Chime webhook.
139
+ # @return [String]
140
+ #
141
+ # @!attribute [rw] sns_topic_arns
142
+ # The ARNs of the SNS topics that deliver notifications to AWS
143
+ # Chatbot.
144
+ # @return [Array<String>]
145
+ #
146
+ # @!attribute [rw] iam_role_arn
147
+ # This is a user-defined role that AWS Chatbot will assume. This is
148
+ # not the service-linked role. For more information, see IAM Policies
149
+ # for AWS Chatbot.
150
+ # @return [String]
151
+ #
152
+ # @!attribute [rw] configuration_name
153
+ # The name of the configuration.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] logging_level
157
+ # Logging levels include ERROR, INFO, or NONE.
158
+ # @return [String]
159
+ #
160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateChimeWebhookConfigurationRequest AWS API Documentation
161
+ #
162
+ class CreateChimeWebhookConfigurationRequest < Struct.new(
163
+ :webhook_description,
164
+ :webhook_url,
165
+ :sns_topic_arns,
166
+ :iam_role_arn,
167
+ :configuration_name,
168
+ :logging_level)
169
+ SENSITIVE = []
170
+ include Aws::Structure
171
+ end
172
+
173
+ # @!attribute [rw] webhook_configuration
174
+ # Chime webhook configuration.
175
+ # @return [Types::ChimeWebhookConfiguration]
176
+ #
177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateChimeWebhookConfigurationResult AWS API Documentation
178
+ #
179
+ class CreateChimeWebhookConfigurationResult < Struct.new(
180
+ :webhook_configuration)
181
+ SENSITIVE = []
182
+ include Aws::Structure
183
+ end
184
+
185
+ # We can’t process your request right now because of a server issue. Try
186
+ # again later.
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateSlackChannelConfigurationException AWS API Documentation
189
+ #
190
+ class CreateSlackChannelConfigurationException < Aws::EmptyStructure; end
191
+
192
+ # @!attribute [rw] slack_team_id
193
+ # The ID of the Slack workspace authorized with AWS Chatbot.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] slack_channel_id
197
+ # The ID of the Slack channel. To get the ID, open Slack, right click
198
+ # on the channel name in the left pane, then choose Copy Link. The
199
+ # channel ID is the 9-character string at the end of the URL. For
200
+ # example, ABCBBLZZZ.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] slack_channel_name
204
+ # The name of the Slack Channel.
205
+ # @return [String]
206
+ #
207
+ # @!attribute [rw] sns_topic_arns
208
+ # The ARNs of the SNS topics that deliver notifications to AWS
209
+ # Chatbot.
210
+ # @return [Array<String>]
211
+ #
212
+ # @!attribute [rw] iam_role_arn
213
+ # The ARN of the IAM role that defines the permissions for AWS
214
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
215
+ # This is not the service-linked role. For more information, see IAM
216
+ # Policies for AWS Chatbot.
217
+ # @return [String]
218
+ #
219
+ # @!attribute [rw] configuration_name
220
+ # The name of the configuration.
221
+ # @return [String]
222
+ #
223
+ # @!attribute [rw] logging_level
224
+ # Logging levels include ERROR, INFO, or NONE.
225
+ # @return [String]
226
+ #
227
+ # @!attribute [rw] guardrail_policy_arns
228
+ # The list of IAM policy ARNs that are applied as channel guardrails.
229
+ # The AWS managed 'AdministratorAccess' policy is applied by default
230
+ # if this is not set.
231
+ # @return [Array<String>]
232
+ #
233
+ # @!attribute [rw] user_authorization_required
234
+ # Enables use of a user role requirement in your chat configuration.
235
+ # @return [Boolean]
236
+ #
237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateSlackChannelConfigurationRequest AWS API Documentation
238
+ #
239
+ class CreateSlackChannelConfigurationRequest < Struct.new(
240
+ :slack_team_id,
241
+ :slack_channel_id,
242
+ :slack_channel_name,
243
+ :sns_topic_arns,
244
+ :iam_role_arn,
245
+ :configuration_name,
246
+ :logging_level,
247
+ :guardrail_policy_arns,
248
+ :user_authorization_required)
249
+ SENSITIVE = []
250
+ include Aws::Structure
251
+ end
252
+
253
+ # @!attribute [rw] channel_configuration
254
+ # The configuration for a Slack channel configured with AWS Chatbot.
255
+ # @return [Types::SlackChannelConfiguration]
256
+ #
257
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateSlackChannelConfigurationResult AWS API Documentation
258
+ #
259
+ class CreateSlackChannelConfigurationResult < Struct.new(
260
+ :channel_configuration)
261
+ SENSITIVE = []
262
+ include Aws::Structure
263
+ end
264
+
265
+ # We can’t process your request right now because of a server issue. Try
266
+ # again later.
267
+ #
268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateTeamsChannelConfigurationException AWS API Documentation
269
+ #
270
+ class CreateTeamsChannelConfigurationException < Aws::EmptyStructure; end
271
+
272
+ # @!attribute [rw] channel_id
273
+ # The ID of the Microsoft Teams channel.
274
+ # @return [String]
275
+ #
276
+ # @!attribute [rw] channel_name
277
+ # The name of the Microsoft Teams channel.
278
+ # @return [String]
279
+ #
280
+ # @!attribute [rw] team_id
281
+ # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
282
+ # team ID, you must perform the initial authorization flow with
283
+ # Microsoft Teams in the AWS Chatbot console. Then you can copy and
284
+ # paste the team ID from the console. For more details, see steps 1-4
285
+ # in Get started with Microsoft Teams in the AWS Chatbot Administrator
286
+ # Guide.
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] team_name
290
+ # The name of the Microsoft Teams Team.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] tenant_id
294
+ # The ID of the Microsoft Teams tenant.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] sns_topic_arns
298
+ # The ARNs of the SNS topics that deliver notifications to AWS
299
+ # Chatbot.
300
+ # @return [Array<String>]
301
+ #
302
+ # @!attribute [rw] iam_role_arn
303
+ # The ARN of the IAM role that defines the permissions for AWS
304
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
305
+ # This is not the service-linked role. For more information, see IAM
306
+ # Policies for AWS Chatbot.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] configuration_name
310
+ # The name of the configuration.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] logging_level
314
+ # Logging levels include ERROR, INFO, or NONE.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] guardrail_policy_arns
318
+ # The list of IAM policy ARNs that are applied as channel guardrails.
319
+ # The AWS managed 'AdministratorAccess' policy is applied by default
320
+ # if this is not set.
321
+ # @return [Array<String>]
322
+ #
323
+ # @!attribute [rw] user_authorization_required
324
+ # Enables use of a user role requirement in your chat configuration.
325
+ # @return [Boolean]
326
+ #
327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateTeamsChannelConfigurationRequest AWS API Documentation
328
+ #
329
+ class CreateTeamsChannelConfigurationRequest < Struct.new(
330
+ :channel_id,
331
+ :channel_name,
332
+ :team_id,
333
+ :team_name,
334
+ :tenant_id,
335
+ :sns_topic_arns,
336
+ :iam_role_arn,
337
+ :configuration_name,
338
+ :logging_level,
339
+ :guardrail_policy_arns,
340
+ :user_authorization_required)
341
+ SENSITIVE = []
342
+ include Aws::Structure
343
+ end
344
+
345
+ # @!attribute [rw] channel_configuration
346
+ # The configuration for a Microsoft Teams channel configured with AWS
347
+ # Chatbot.
348
+ # @return [Types::TeamsChannelConfiguration]
349
+ #
350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateTeamsChannelConfigurationResult AWS API Documentation
351
+ #
352
+ class CreateTeamsChannelConfigurationResult < Struct.new(
353
+ :channel_configuration)
354
+ SENSITIVE = []
355
+ include Aws::Structure
356
+ end
357
+
358
+ # We can’t process your request right now because of a server issue. Try
359
+ # again later.
360
+ #
361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteChimeWebhookConfigurationException AWS API Documentation
362
+ #
363
+ class DeleteChimeWebhookConfigurationException < Aws::EmptyStructure; end
364
+
365
+ # @!attribute [rw] chat_configuration_arn
366
+ # The ARN of the ChimeWebhookConfiguration to delete.
367
+ # @return [String]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteChimeWebhookConfigurationRequest AWS API Documentation
370
+ #
371
+ class DeleteChimeWebhookConfigurationRequest < Struct.new(
372
+ :chat_configuration_arn)
373
+ SENSITIVE = []
374
+ include Aws::Structure
375
+ end
376
+
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteChimeWebhookConfigurationResult AWS API Documentation
378
+ #
379
+ class DeleteChimeWebhookConfigurationResult < Aws::EmptyStructure; end
380
+
381
+ # We can’t process your request right now because of a server issue. Try
382
+ # again later.
383
+ #
384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteMicrosoftTeamsUserIdentityException AWS API Documentation
385
+ #
386
+ class DeleteMicrosoftTeamsUserIdentityException < Aws::EmptyStructure; end
387
+
388
+ # @!attribute [rw] chat_configuration_arn
389
+ # The ARN of the MicrosoftTeamsChannelConfiguration associated with
390
+ # the user identity to delete.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] user_id
394
+ # Id from Microsoft Teams for user.
395
+ # @return [String]
396
+ #
397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteMicrosoftTeamsUserIdentityRequest AWS API Documentation
398
+ #
399
+ class DeleteMicrosoftTeamsUserIdentityRequest < Struct.new(
400
+ :chat_configuration_arn,
401
+ :user_id)
402
+ SENSITIVE = []
403
+ include Aws::Structure
404
+ end
405
+
406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteMicrosoftTeamsUserIdentityResult AWS API Documentation
407
+ #
408
+ class DeleteMicrosoftTeamsUserIdentityResult < Aws::EmptyStructure; end
409
+
410
+ # We can’t process your request right now because of a server issue. Try
411
+ # again later.
412
+ #
413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackChannelConfigurationException AWS API Documentation
414
+ #
415
+ class DeleteSlackChannelConfigurationException < Aws::EmptyStructure; end
416
+
417
+ # @!attribute [rw] chat_configuration_arn
418
+ # The ARN of the SlackChannelConfiguration to delete.
419
+ # @return [String]
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackChannelConfigurationRequest AWS API Documentation
422
+ #
423
+ class DeleteSlackChannelConfigurationRequest < Struct.new(
424
+ :chat_configuration_arn)
425
+ SENSITIVE = []
426
+ include Aws::Structure
427
+ end
428
+
429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackChannelConfigurationResult AWS API Documentation
430
+ #
431
+ class DeleteSlackChannelConfigurationResult < Aws::EmptyStructure; end
432
+
433
+ # We can’t process your request right now because of a server issue. Try
434
+ # again later.
435
+ #
436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackUserIdentityException AWS API Documentation
437
+ #
438
+ class DeleteSlackUserIdentityException < Aws::EmptyStructure; end
439
+
440
+ # @!attribute [rw] chat_configuration_arn
441
+ # The ARN of the SlackChannelConfiguration associated with the user
442
+ # identity to delete.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] slack_team_id
446
+ # The ID of the Slack workspace authorized with AWS Chatbot.
447
+ # @return [String]
448
+ #
449
+ # @!attribute [rw] slack_user_id
450
+ # The ID of the user in Slack.
451
+ # @return [String]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackUserIdentityRequest AWS API Documentation
454
+ #
455
+ class DeleteSlackUserIdentityRequest < Struct.new(
456
+ :chat_configuration_arn,
457
+ :slack_team_id,
458
+ :slack_user_id)
459
+ SENSITIVE = []
460
+ include Aws::Structure
461
+ end
462
+
463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackUserIdentityResult AWS API Documentation
464
+ #
465
+ class DeleteSlackUserIdentityResult < Aws::EmptyStructure; end
466
+
467
+ # There was an issue deleting your Slack workspace.
468
+ #
469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackWorkspaceAuthorizationFault AWS API Documentation
470
+ #
471
+ class DeleteSlackWorkspaceAuthorizationFault < Aws::EmptyStructure; end
472
+
473
+ # @!attribute [rw] slack_team_id
474
+ # The ID of the Slack workspace authorized with AWS Chatbot.
475
+ # @return [String]
476
+ #
477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackWorkspaceAuthorizationRequest AWS API Documentation
478
+ #
479
+ class DeleteSlackWorkspaceAuthorizationRequest < Struct.new(
480
+ :slack_team_id)
481
+ SENSITIVE = []
482
+ include Aws::Structure
483
+ end
484
+
485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteSlackWorkspaceAuthorizationResult AWS API Documentation
486
+ #
487
+ class DeleteSlackWorkspaceAuthorizationResult < Aws::EmptyStructure; end
488
+
489
+ # We can’t process your request right now because of a server issue. Try
490
+ # again later.
491
+ #
492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteTeamsChannelConfigurationException AWS API Documentation
493
+ #
494
+ class DeleteTeamsChannelConfigurationException < Aws::EmptyStructure; end
495
+
496
+ # @!attribute [rw] chat_configuration_arn
497
+ # The ARN of the MicrosoftTeamsChannelConfiguration to delete.
498
+ # @return [String]
499
+ #
500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteTeamsChannelConfigurationRequest AWS API Documentation
501
+ #
502
+ class DeleteTeamsChannelConfigurationRequest < Struct.new(
503
+ :chat_configuration_arn)
504
+ SENSITIVE = []
505
+ include Aws::Structure
506
+ end
507
+
508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteTeamsChannelConfigurationResult AWS API Documentation
509
+ #
510
+ class DeleteTeamsChannelConfigurationResult < Aws::EmptyStructure; end
511
+
512
+ # We can’t process your request right now because of a server issue. Try
513
+ # again later.
514
+ #
515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteTeamsConfiguredTeamException AWS API Documentation
516
+ #
517
+ class DeleteTeamsConfiguredTeamException < Aws::EmptyStructure; end
518
+
519
+ # @!attribute [rw] team_id
520
+ # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
521
+ # team ID, you must perform the initial authorization flow with
522
+ # Microsoft Teams in the AWS Chatbot console. Then you can copy and
523
+ # paste the team ID from the console. For more details, see steps 1-4
524
+ # in Get started with Microsoft Teams in the AWS Chatbot Administrator
525
+ # Guide.
526
+ # @return [String]
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteTeamsConfiguredTeamRequest AWS API Documentation
529
+ #
530
+ class DeleteTeamsConfiguredTeamRequest < Struct.new(
531
+ :team_id)
532
+ SENSITIVE = []
533
+ include Aws::Structure
534
+ end
535
+
536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DeleteTeamsConfiguredTeamResult AWS API Documentation
537
+ #
538
+ class DeleteTeamsConfiguredTeamResult < Aws::EmptyStructure; end
539
+
540
+ # We can’t process your request right now because of a server issue. Try
541
+ # again later.
542
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeChimeWebhookConfigurationsException AWS API Documentation
544
+ #
545
+ class DescribeChimeWebhookConfigurationsException < Aws::EmptyStructure; end
546
+
547
+ # @!attribute [rw] max_results
548
+ # The maximum number of results to include in the response. If more
549
+ # results exist than the specified MaxResults value, a token is
550
+ # included in the response so that the remaining results can be
551
+ # retrieved.
552
+ # @return [Integer]
553
+ #
554
+ # @!attribute [rw] next_token
555
+ # An optional token returned from a prior request. Use this token for
556
+ # pagination of results from this action. If this parameter is
557
+ # specified, the response includes only results beyond the token, up
558
+ # to the value specified by MaxResults.
559
+ # @return [String]
560
+ #
561
+ # @!attribute [rw] chat_configuration_arn
562
+ # An optional ARN of a ChimeWebhookConfiguration to describe.
563
+ # @return [String]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeChimeWebhookConfigurationsRequest AWS API Documentation
566
+ #
567
+ class DescribeChimeWebhookConfigurationsRequest < Struct.new(
568
+ :max_results,
569
+ :next_token,
570
+ :chat_configuration_arn)
571
+ SENSITIVE = []
572
+ include Aws::Structure
573
+ end
574
+
575
+ # @!attribute [rw] next_token
576
+ # An optional token returned from a prior request. Use this token for
577
+ # pagination of results from this action. If this parameter is
578
+ # specified, the response includes only results beyond the token, up
579
+ # to the value specified by MaxResults.
580
+ # @return [String]
581
+ #
582
+ # @!attribute [rw] webhook_configurations
583
+ # A list of Chime webhooks associated with the account.
584
+ # @return [Array<Types::ChimeWebhookConfiguration>]
585
+ #
586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeChimeWebhookConfigurationsResult AWS API Documentation
587
+ #
588
+ class DescribeChimeWebhookConfigurationsResult < Struct.new(
589
+ :next_token,
590
+ :webhook_configurations)
591
+ SENSITIVE = []
592
+ include Aws::Structure
593
+ end
594
+
595
+ # We can’t process your request right now because of a server issue. Try
596
+ # again later.
597
+ #
598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackChannelConfigurationsException AWS API Documentation
599
+ #
600
+ class DescribeSlackChannelConfigurationsException < Aws::EmptyStructure; end
601
+
602
+ # @!attribute [rw] max_results
603
+ # The maximum number of results to include in the response. If more
604
+ # results exist than the specified MaxResults value, a token is
605
+ # included in the response so that the remaining results can be
606
+ # retrieved.
607
+ # @return [Integer]
608
+ #
609
+ # @!attribute [rw] next_token
610
+ # An optional token returned from a prior request. Use this token for
611
+ # pagination of results from this action. If this parameter is
612
+ # specified, the response includes only results beyond the token, up
613
+ # to the value specified by MaxResults.
614
+ # @return [String]
615
+ #
616
+ # @!attribute [rw] chat_configuration_arn
617
+ # An optional ARN of a SlackChannelConfiguration to describe.
618
+ # @return [String]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackChannelConfigurationsRequest AWS API Documentation
621
+ #
622
+ class DescribeSlackChannelConfigurationsRequest < Struct.new(
623
+ :max_results,
624
+ :next_token,
625
+ :chat_configuration_arn)
626
+ SENSITIVE = []
627
+ include Aws::Structure
628
+ end
629
+
630
+ # @!attribute [rw] next_token
631
+ # An optional token returned from a prior request. Use this token for
632
+ # pagination of results from this action. If this parameter is
633
+ # specified, the response includes only results beyond the token, up
634
+ # to the value specified by MaxResults.
635
+ # @return [String]
636
+ #
637
+ # @!attribute [rw] slack_channel_configurations
638
+ # A list of Slack channel configurations.
639
+ # @return [Array<Types::SlackChannelConfiguration>]
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackChannelConfigurationsResult AWS API Documentation
642
+ #
643
+ class DescribeSlackChannelConfigurationsResult < Struct.new(
644
+ :next_token,
645
+ :slack_channel_configurations)
646
+ SENSITIVE = []
647
+ include Aws::Structure
648
+ end
649
+
650
+ # We can’t process your request right now because of a server issue. Try
651
+ # again later.
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackUserIdentitiesException AWS API Documentation
654
+ #
655
+ class DescribeSlackUserIdentitiesException < Aws::EmptyStructure; end
656
+
657
+ # @!attribute [rw] chat_configuration_arn
658
+ # The ARN of the SlackChannelConfiguration associated with the user
659
+ # identities to describe.
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] next_token
663
+ # An optional token returned from a prior request. Use this token for
664
+ # pagination of results from this action. If this parameter is
665
+ # specified, the response includes only results beyond the token, up
666
+ # to the value specified by MaxResults.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] max_results
670
+ # The maximum number of results to include in the response. If more
671
+ # results exist than the specified MaxResults value, a token is
672
+ # included in the response so that the remaining results can be
673
+ # retrieved.
674
+ # @return [Integer]
675
+ #
676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackUserIdentitiesRequest AWS API Documentation
677
+ #
678
+ class DescribeSlackUserIdentitiesRequest < Struct.new(
679
+ :chat_configuration_arn,
680
+ :next_token,
681
+ :max_results)
682
+ SENSITIVE = []
683
+ include Aws::Structure
684
+ end
685
+
686
+ # @!attribute [rw] slack_user_identities
687
+ # A list of Slack User Identities.
688
+ # @return [Array<Types::SlackUserIdentity>]
689
+ #
690
+ # @!attribute [rw] next_token
691
+ # An optional token returned from a prior request. Use this token for
692
+ # pagination of results from this action. If this parameter is
693
+ # specified, the response includes only results beyond the token, up
694
+ # to the value specified by MaxResults.
695
+ # @return [String]
696
+ #
697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackUserIdentitiesResult AWS API Documentation
698
+ #
699
+ class DescribeSlackUserIdentitiesResult < Struct.new(
700
+ :slack_user_identities,
701
+ :next_token)
702
+ SENSITIVE = []
703
+ include Aws::Structure
704
+ end
705
+
706
+ # We can’t process your request right now because of a server issue. Try
707
+ # again later.
708
+ #
709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackWorkspacesException AWS API Documentation
710
+ #
711
+ class DescribeSlackWorkspacesException < Aws::EmptyStructure; end
712
+
713
+ # @!attribute [rw] max_results
714
+ # The maximum number of results to include in the response. If more
715
+ # results exist than the specified MaxResults value, a token is
716
+ # included in the response so that the remaining results can be
717
+ # retrieved.
718
+ # @return [Integer]
719
+ #
720
+ # @!attribute [rw] next_token
721
+ # An optional token returned from a prior request. Use this token for
722
+ # pagination of results from this action. If this parameter is
723
+ # specified, the response includes only results beyond the token, up
724
+ # to the value specified by MaxResults.
725
+ # @return [String]
726
+ #
727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackWorkspacesRequest AWS API Documentation
728
+ #
729
+ class DescribeSlackWorkspacesRequest < Struct.new(
730
+ :max_results,
731
+ :next_token)
732
+ SENSITIVE = []
733
+ include Aws::Structure
734
+ end
735
+
736
+ # @!attribute [rw] slack_workspaces
737
+ # A list of Slack Workspaces registered with AWS Chatbot.
738
+ # @return [Array<Types::SlackWorkspace>]
739
+ #
740
+ # @!attribute [rw] next_token
741
+ # An optional token returned from a prior request. Use this token for
742
+ # pagination of results from this action. If this parameter is
743
+ # specified, the response includes only results beyond the token, up
744
+ # to the value specified by MaxResults.
745
+ # @return [String]
746
+ #
747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackWorkspacesResult AWS API Documentation
748
+ #
749
+ class DescribeSlackWorkspacesResult < Struct.new(
750
+ :slack_workspaces,
751
+ :next_token)
752
+ SENSITIVE = []
753
+ include Aws::Structure
754
+ end
755
+
756
+ # We can’t process your request right now because of a server issue. Try
757
+ # again later.
758
+ #
759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetAccountPreferencesException AWS API Documentation
760
+ #
761
+ class GetAccountPreferencesException < Aws::EmptyStructure; end
762
+
763
+ # @api private
764
+ #
765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetAccountPreferencesRequest AWS API Documentation
766
+ #
767
+ class GetAccountPreferencesRequest < Aws::EmptyStructure; end
768
+
769
+ # @!attribute [rw] account_preferences
770
+ # Preferences which apply for AWS Chatbot usage in the calling AWS
771
+ # account.
772
+ # @return [Types::AccountPreferences]
773
+ #
774
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetAccountPreferencesResult AWS API Documentation
775
+ #
776
+ class GetAccountPreferencesResult < Struct.new(
777
+ :account_preferences)
778
+ SENSITIVE = []
779
+ include Aws::Structure
780
+ end
781
+
782
+ # We can’t process your request right now because of a server issue. Try
783
+ # again later.
784
+ #
785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetTeamsChannelConfigurationException AWS API Documentation
786
+ #
787
+ class GetTeamsChannelConfigurationException < Aws::EmptyStructure; end
788
+
789
+ # @!attribute [rw] chat_configuration_arn
790
+ # The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
791
+ # @return [String]
792
+ #
793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetTeamsChannelConfigurationRequest AWS API Documentation
794
+ #
795
+ class GetTeamsChannelConfigurationRequest < Struct.new(
796
+ :chat_configuration_arn)
797
+ SENSITIVE = []
798
+ include Aws::Structure
799
+ end
800
+
801
+ # @!attribute [rw] channel_configuration
802
+ # The configuration for a Microsoft Teams channel configured with AWS
803
+ # Chatbot.
804
+ # @return [Types::TeamsChannelConfiguration]
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/GetTeamsChannelConfigurationResult AWS API Documentation
807
+ #
808
+ class GetTeamsChannelConfigurationResult < Struct.new(
809
+ :channel_configuration)
810
+ SENSITIVE = []
811
+ include Aws::Structure
812
+ end
813
+
814
+ # Your request input doesn't meet the constraints that AWS Chatbot
815
+ # requires.
816
+ #
817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/InvalidParameterException AWS API Documentation
818
+ #
819
+ class InvalidParameterException < Aws::EmptyStructure; end
820
+
821
+ # Your request input doesn't meet the constraints that AWS Chatbot
822
+ # requires.
823
+ #
824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/InvalidRequestException AWS API Documentation
825
+ #
826
+ class InvalidRequestException < Aws::EmptyStructure; end
827
+
828
+ # You have exceeded a service limit for AWS Chatbot.
829
+ #
830
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/LimitExceededException AWS API Documentation
831
+ #
832
+ class LimitExceededException < Aws::EmptyStructure; end
833
+
834
+ # We can’t process your request right now because of a server issue. Try
835
+ # again later.
836
+ #
837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListMicrosoftTeamsConfiguredTeamsException AWS API Documentation
838
+ #
839
+ class ListMicrosoftTeamsConfiguredTeamsException < Aws::EmptyStructure; end
840
+
841
+ # @!attribute [rw] max_results
842
+ # The maximum number of results to include in the response. If more
843
+ # results exist than the specified MaxResults value, a token is
844
+ # included in the response so that the remaining results can be
845
+ # retrieved.
846
+ # @return [Integer]
847
+ #
848
+ # @!attribute [rw] next_token
849
+ # An optional token returned from a prior request. Use this token for
850
+ # pagination of results from this action. If this parameter is
851
+ # specified, the response includes only results beyond the token, up
852
+ # to the value specified by MaxResults.
853
+ # @return [String]
854
+ #
855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListMicrosoftTeamsConfiguredTeamsRequest AWS API Documentation
856
+ #
857
+ class ListMicrosoftTeamsConfiguredTeamsRequest < Struct.new(
858
+ :max_results,
859
+ :next_token)
860
+ SENSITIVE = []
861
+ include Aws::Structure
862
+ end
863
+
864
+ # @!attribute [rw] configured_teams
865
+ # A list of teams in Microsoft Teams that have been configured with
866
+ # AWS Chatbot.
867
+ # @return [Array<Types::ConfiguredTeam>]
868
+ #
869
+ # @!attribute [rw] next_token
870
+ # An optional token returned from a prior request. Use this token for
871
+ # pagination of results from this action. If this parameter is
872
+ # specified, the response includes only results beyond the token, up
873
+ # to the value specified by MaxResults.
874
+ # @return [String]
875
+ #
876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListMicrosoftTeamsConfiguredTeamsResult AWS API Documentation
877
+ #
878
+ class ListMicrosoftTeamsConfiguredTeamsResult < Struct.new(
879
+ :configured_teams,
880
+ :next_token)
881
+ SENSITIVE = []
882
+ include Aws::Structure
883
+ end
884
+
885
+ # We can’t process your request right now because of a server issue. Try
886
+ # again later.
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListMicrosoftTeamsUserIdentitiesException AWS API Documentation
889
+ #
890
+ class ListMicrosoftTeamsUserIdentitiesException < Aws::EmptyStructure; end
891
+
892
+ # @!attribute [rw] chat_configuration_arn
893
+ # The ARN of the MicrosoftTeamsChannelConfiguration associated with
894
+ # the user identities to list.
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] next_token
898
+ # An optional token returned from a prior request. Use this token for
899
+ # pagination of results from this action. If this parameter is
900
+ # specified, the response includes only results beyond the token, up
901
+ # to the value specified by MaxResults.
902
+ # @return [String]
903
+ #
904
+ # @!attribute [rw] max_results
905
+ # The maximum number of results to include in the response. If more
906
+ # results exist than the specified MaxResults value, a token is
907
+ # included in the response so that the remaining results can be
908
+ # retrieved.
909
+ # @return [Integer]
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListMicrosoftTeamsUserIdentitiesRequest AWS API Documentation
912
+ #
913
+ class ListMicrosoftTeamsUserIdentitiesRequest < Struct.new(
914
+ :chat_configuration_arn,
915
+ :next_token,
916
+ :max_results)
917
+ SENSITIVE = []
918
+ include Aws::Structure
919
+ end
920
+
921
+ # @!attribute [rw] teams_user_identities
922
+ # User level permissions associated to a channel configuration.
923
+ # @return [Array<Types::TeamsUserIdentity>]
924
+ #
925
+ # @!attribute [rw] next_token
926
+ # An optional token returned from a prior request. Use this token for
927
+ # pagination of results from this action. If this parameter is
928
+ # specified, the response includes only results beyond the token, up
929
+ # to the value specified by MaxResults.
930
+ # @return [String]
931
+ #
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListMicrosoftTeamsUserIdentitiesResult AWS API Documentation
933
+ #
934
+ class ListMicrosoftTeamsUserIdentitiesResult < Struct.new(
935
+ :teams_user_identities,
936
+ :next_token)
937
+ SENSITIVE = []
938
+ include Aws::Structure
939
+ end
940
+
941
+ # We can’t process your request right now because of a server issue. Try
942
+ # again later.
943
+ #
944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListTeamsChannelConfigurationsException AWS API Documentation
945
+ #
946
+ class ListTeamsChannelConfigurationsException < Aws::EmptyStructure; end
947
+
948
+ # @!attribute [rw] max_results
949
+ # The maximum number of results to include in the response. If more
950
+ # results exist than the specified MaxResults value, a token is
951
+ # included in the response so that the remaining results can be
952
+ # retrieved.
953
+ # @return [Integer]
954
+ #
955
+ # @!attribute [rw] next_token
956
+ # An optional token returned from a prior request. Use this token for
957
+ # pagination of results from this action. If this parameter is
958
+ # specified, the response includes only results beyond the token, up
959
+ # to the value specified by MaxResults.
960
+ # @return [String]
961
+ #
962
+ # @!attribute [rw] team_id
963
+ # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
964
+ # team ID, you must perform the initial authorization flow with
965
+ # Microsoft Teams in the AWS Chatbot console. Then you can copy and
966
+ # paste the team ID from the console. For more details, see steps 1-4
967
+ # in Get started with Microsoft Teams in the AWS Chatbot Administrator
968
+ # Guide.
969
+ # @return [String]
970
+ #
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListTeamsChannelConfigurationsRequest AWS API Documentation
972
+ #
973
+ class ListTeamsChannelConfigurationsRequest < Struct.new(
974
+ :max_results,
975
+ :next_token,
976
+ :team_id)
977
+ SENSITIVE = []
978
+ include Aws::Structure
979
+ end
980
+
981
+ # @!attribute [rw] next_token
982
+ # An optional token returned from a prior request. Use this token for
983
+ # pagination of results from this action. If this parameter is
984
+ # specified, the response includes only results beyond the token, up
985
+ # to the value specified by MaxResults.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] team_channel_configurations
989
+ # A list of AWS Chatbot channel configurations for Microsoft Teams.
990
+ # @return [Array<Types::TeamsChannelConfiguration>]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ListTeamsChannelConfigurationsResult AWS API Documentation
993
+ #
994
+ class ListTeamsChannelConfigurationsResult < Struct.new(
995
+ :next_token,
996
+ :team_channel_configurations)
997
+ SENSITIVE = []
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # We were not able to find the resource for your request.
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/ResourceNotFoundException AWS API Documentation
1004
+ #
1005
+ class ResourceNotFoundException < Aws::EmptyStructure; end
1006
+
1007
+ # An AWS Chatbot configuration for Slack.
1008
+ #
1009
+ # @!attribute [rw] slack_team_name
1010
+ # Name of the Slack Workspace.
1011
+ # @return [String]
1012
+ #
1013
+ # @!attribute [rw] slack_team_id
1014
+ # The ID of the Slack workspace authorized with AWS Chatbot.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] slack_channel_id
1018
+ # The ID of the Slack channel. To get the ID, open Slack, right click
1019
+ # on the channel name in the left pane, then choose Copy Link. The
1020
+ # channel ID is the 9-character string at the end of the URL. For
1021
+ # example, ABCBBLZZZ.
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] slack_channel_name
1025
+ # The name of the Slack Channel.
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] chat_configuration_arn
1029
+ # The ARN of the SlackChannelConfiguration.
1030
+ # @return [String]
1031
+ #
1032
+ # @!attribute [rw] iam_role_arn
1033
+ # The ARN of the IAM role that defines the permissions for AWS
1034
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1035
+ # This is not the service-linked role. For more information, see IAM
1036
+ # Policies for AWS Chatbot.
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] sns_topic_arns
1040
+ # The ARNs of the SNS topics that deliver notifications to AWS
1041
+ # Chatbot.
1042
+ # @return [Array<String>]
1043
+ #
1044
+ # @!attribute [rw] configuration_name
1045
+ # The name of the configuration.
1046
+ # @return [String]
1047
+ #
1048
+ # @!attribute [rw] logging_level
1049
+ # Logging levels include ERROR, INFO, or NONE.
1050
+ # @return [String]
1051
+ #
1052
+ # @!attribute [rw] guardrail_policy_arns
1053
+ # The list of IAM policy ARNs that are applied as channel guardrails.
1054
+ # The AWS managed 'AdministratorAccess' policy is applied by default
1055
+ # if this is not set.
1056
+ # @return [Array<String>]
1057
+ #
1058
+ # @!attribute [rw] user_authorization_required
1059
+ # Enables use of a user role requirement in your chat configuration.
1060
+ # @return [Boolean]
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/SlackChannelConfiguration AWS API Documentation
1063
+ #
1064
+ class SlackChannelConfiguration < Struct.new(
1065
+ :slack_team_name,
1066
+ :slack_team_id,
1067
+ :slack_channel_id,
1068
+ :slack_channel_name,
1069
+ :chat_configuration_arn,
1070
+ :iam_role_arn,
1071
+ :sns_topic_arns,
1072
+ :configuration_name,
1073
+ :logging_level,
1074
+ :guardrail_policy_arns,
1075
+ :user_authorization_required)
1076
+ SENSITIVE = []
1077
+ include Aws::Structure
1078
+ end
1079
+
1080
+ # Identifes a User level permission for a channel configuration.
1081
+ #
1082
+ # @!attribute [rw] iam_role_arn
1083
+ # The ARN of the IAM role that defines the permissions for AWS
1084
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1085
+ # This is not the service-linked role. For more information, see IAM
1086
+ # Policies for AWS Chatbot.
1087
+ # @return [String]
1088
+ #
1089
+ # @!attribute [rw] chat_configuration_arn
1090
+ # The ARN of the SlackChannelConfiguration associated with the user
1091
+ # identity.
1092
+ # @return [String]
1093
+ #
1094
+ # @!attribute [rw] slack_team_id
1095
+ # The ID of the Slack workspace authorized with AWS Chatbot.
1096
+ # @return [String]
1097
+ #
1098
+ # @!attribute [rw] slack_user_id
1099
+ # The ID of the user in Slack.
1100
+ # @return [String]
1101
+ #
1102
+ # @!attribute [rw] aws_user_identity
1103
+ # The AWS user identity ARN used to associate a Slack User Identity
1104
+ # with an IAM Role.
1105
+ # @return [String]
1106
+ #
1107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/SlackUserIdentity AWS API Documentation
1108
+ #
1109
+ class SlackUserIdentity < Struct.new(
1110
+ :iam_role_arn,
1111
+ :chat_configuration_arn,
1112
+ :slack_team_id,
1113
+ :slack_user_id,
1114
+ :aws_user_identity)
1115
+ SENSITIVE = []
1116
+ include Aws::Structure
1117
+ end
1118
+
1119
+ # A Slack Workspace.
1120
+ #
1121
+ # @!attribute [rw] slack_team_id
1122
+ # The ID of the Slack workspace authorized with AWS Chatbot.
1123
+ # @return [String]
1124
+ #
1125
+ # @!attribute [rw] slack_team_name
1126
+ # Name of the Slack Workspace.
1127
+ # @return [String]
1128
+ #
1129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/SlackWorkspace AWS API Documentation
1130
+ #
1131
+ class SlackWorkspace < Struct.new(
1132
+ :slack_team_id,
1133
+ :slack_team_name)
1134
+ SENSITIVE = []
1135
+ include Aws::Structure
1136
+ end
1137
+
1138
+ # An AWS Chatbot configuration for Microsoft Teams.
1139
+ #
1140
+ # @!attribute [rw] channel_id
1141
+ # The ID of the Microsoft Teams channel.
1142
+ # @return [String]
1143
+ #
1144
+ # @!attribute [rw] channel_name
1145
+ # The name of the Microsoft Teams channel.
1146
+ # @return [String]
1147
+ #
1148
+ # @!attribute [rw] team_id
1149
+ # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
1150
+ # team ID, you must perform the initial authorization flow with
1151
+ # Microsoft Teams in the AWS Chatbot console. Then you can copy and
1152
+ # paste the team ID from the console. For more details, see steps 1-4
1153
+ # in Get started with Microsoft Teams in the AWS Chatbot Administrator
1154
+ # Guide.
1155
+ # @return [String]
1156
+ #
1157
+ # @!attribute [rw] team_name
1158
+ # The name of the Microsoft Teams Team.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] tenant_id
1162
+ # The ID of the Microsoft Teams tenant.
1163
+ # @return [String]
1164
+ #
1165
+ # @!attribute [rw] chat_configuration_arn
1166
+ # The ARN of the MicrosoftTeamsChannelConfiguration.
1167
+ # @return [String]
1168
+ #
1169
+ # @!attribute [rw] iam_role_arn
1170
+ # The ARN of the IAM role that defines the permissions for AWS
1171
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1172
+ # This is not the service-linked role. For more information, see IAM
1173
+ # Policies for AWS Chatbot.
1174
+ # @return [String]
1175
+ #
1176
+ # @!attribute [rw] sns_topic_arns
1177
+ # The ARNs of the SNS topics that deliver notifications to AWS
1178
+ # Chatbot.
1179
+ # @return [Array<String>]
1180
+ #
1181
+ # @!attribute [rw] configuration_name
1182
+ # The name of the configuration.
1183
+ # @return [String]
1184
+ #
1185
+ # @!attribute [rw] logging_level
1186
+ # Logging levels include ERROR, INFO, or NONE.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] guardrail_policy_arns
1190
+ # The list of IAM policy ARNs that are applied as channel guardrails.
1191
+ # The AWS managed 'AdministratorAccess' policy is applied by default
1192
+ # if this is not set.
1193
+ # @return [Array<String>]
1194
+ #
1195
+ # @!attribute [rw] user_authorization_required
1196
+ # Enables use of a user role requirement in your chat configuration.
1197
+ # @return [Boolean]
1198
+ #
1199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/TeamsChannelConfiguration AWS API Documentation
1200
+ #
1201
+ class TeamsChannelConfiguration < Struct.new(
1202
+ :channel_id,
1203
+ :channel_name,
1204
+ :team_id,
1205
+ :team_name,
1206
+ :tenant_id,
1207
+ :chat_configuration_arn,
1208
+ :iam_role_arn,
1209
+ :sns_topic_arns,
1210
+ :configuration_name,
1211
+ :logging_level,
1212
+ :guardrail_policy_arns,
1213
+ :user_authorization_required)
1214
+ SENSITIVE = []
1215
+ include Aws::Structure
1216
+ end
1217
+
1218
+ # Identifes a user level permission for a channel configuration.
1219
+ #
1220
+ # @!attribute [rw] iam_role_arn
1221
+ # The ARN of the IAM role that defines the permissions for AWS
1222
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1223
+ # This is not the service-linked role. For more information, see IAM
1224
+ # Policies for AWS Chatbot.
1225
+ # @return [String]
1226
+ #
1227
+ # @!attribute [rw] chat_configuration_arn
1228
+ # The ARN of the MicrosoftTeamsChannelConfiguration associated with
1229
+ # the user identity.
1230
+ # @return [String]
1231
+ #
1232
+ # @!attribute [rw] team_id
1233
+ # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
1234
+ # team ID, you must perform the initial authorization flow with
1235
+ # Microsoft Teams in the AWS Chatbot console. Then you can copy and
1236
+ # paste the team ID from the console. For more details, see steps 1-4
1237
+ # in Get started with Microsoft Teams in the AWS Chatbot Administrator
1238
+ # Guide.
1239
+ # @return [String]
1240
+ #
1241
+ # @!attribute [rw] user_id
1242
+ # Id from Microsoft Teams for user.
1243
+ # @return [String]
1244
+ #
1245
+ # @!attribute [rw] aws_user_identity
1246
+ # The AWS user identity ARN used to associate a Microsoft Teams User
1247
+ # Identity with an IAM Role.
1248
+ # @return [String]
1249
+ #
1250
+ # @!attribute [rw] teams_channel_id
1251
+ # The ID of the Microsoft Teams channel.
1252
+ # @return [String]
1253
+ #
1254
+ # @!attribute [rw] teams_tenant_id
1255
+ # The ID of the Microsoft Teams tenant.
1256
+ # @return [String]
1257
+ #
1258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/TeamsUserIdentity AWS API Documentation
1259
+ #
1260
+ class TeamsUserIdentity < Struct.new(
1261
+ :iam_role_arn,
1262
+ :chat_configuration_arn,
1263
+ :team_id,
1264
+ :user_id,
1265
+ :aws_user_identity,
1266
+ :teams_channel_id,
1267
+ :teams_tenant_id)
1268
+ SENSITIVE = []
1269
+ include Aws::Structure
1270
+ end
1271
+
1272
+ # We can’t process your request right now because of a server issue. Try
1273
+ # again later.
1274
+ #
1275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateAccountPreferencesException AWS API Documentation
1276
+ #
1277
+ class UpdateAccountPreferencesException < Aws::EmptyStructure; end
1278
+
1279
+ # @!attribute [rw] user_authorization_required
1280
+ # Enables use of a user role requirement in your chat configuration.
1281
+ # @return [Boolean]
1282
+ #
1283
+ # @!attribute [rw] training_data_collection_enabled
1284
+ # Turns on training data collection. This helps improve the AWS
1285
+ # Chatbot experience by allowing AWS Chatbot to store and use your
1286
+ # customer information, such as AWS Chatbot configurations,
1287
+ # notifications, user inputs, AWS Chatbot generated responses, and
1288
+ # interaction data. This data helps us to continuously improve and
1289
+ # develop Artificial Intelligence (AI) technologies. Your data is not
1290
+ # shared with any third parties and is protected using sophisticated
1291
+ # controls to prevent unauthorized access and misuse. AWS Chatbot does
1292
+ # not store or use interactions in chat channels with Amazon Q for
1293
+ # training AWS Chatbot’s AI technologies.
1294
+ # @return [Boolean]
1295
+ #
1296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateAccountPreferencesRequest AWS API Documentation
1297
+ #
1298
+ class UpdateAccountPreferencesRequest < Struct.new(
1299
+ :user_authorization_required,
1300
+ :training_data_collection_enabled)
1301
+ SENSITIVE = []
1302
+ include Aws::Structure
1303
+ end
1304
+
1305
+ # @!attribute [rw] account_preferences
1306
+ # Preferences which apply for AWS Chatbot usage in the calling AWS
1307
+ # account.
1308
+ # @return [Types::AccountPreferences]
1309
+ #
1310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateAccountPreferencesResult AWS API Documentation
1311
+ #
1312
+ class UpdateAccountPreferencesResult < Struct.new(
1313
+ :account_preferences)
1314
+ SENSITIVE = []
1315
+ include Aws::Structure
1316
+ end
1317
+
1318
+ # We can’t process your request right now because of a server issue. Try
1319
+ # again later.
1320
+ #
1321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateChimeWebhookConfigurationException AWS API Documentation
1322
+ #
1323
+ class UpdateChimeWebhookConfigurationException < Aws::EmptyStructure; end
1324
+
1325
+ # @!attribute [rw] chat_configuration_arn
1326
+ # The ARN of the ChimeWebhookConfiguration to update.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] webhook_description
1330
+ # Description of the webhook. Recommend using the convention
1331
+ # `RoomName/WebhookName`. See Chime setup tutorial for more details:
1332
+ # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
1333
+ # @return [String]
1334
+ #
1335
+ # @!attribute [rw] webhook_url
1336
+ # URL for the Chime webhook.
1337
+ # @return [String]
1338
+ #
1339
+ # @!attribute [rw] sns_topic_arns
1340
+ # The ARNs of the SNS topics that deliver notifications to AWS
1341
+ # Chatbot.
1342
+ # @return [Array<String>]
1343
+ #
1344
+ # @!attribute [rw] iam_role_arn
1345
+ # The ARN of the IAM role that defines the permissions for AWS
1346
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1347
+ # This is not the service-linked role. For more information, see IAM
1348
+ # Policies for AWS Chatbot.
1349
+ # @return [String]
1350
+ #
1351
+ # @!attribute [rw] logging_level
1352
+ # Logging levels include ERROR, INFO, or NONE.
1353
+ # @return [String]
1354
+ #
1355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateChimeWebhookConfigurationRequest AWS API Documentation
1356
+ #
1357
+ class UpdateChimeWebhookConfigurationRequest < Struct.new(
1358
+ :chat_configuration_arn,
1359
+ :webhook_description,
1360
+ :webhook_url,
1361
+ :sns_topic_arns,
1362
+ :iam_role_arn,
1363
+ :logging_level)
1364
+ SENSITIVE = []
1365
+ include Aws::Structure
1366
+ end
1367
+
1368
+ # @!attribute [rw] webhook_configuration
1369
+ # Chime webhook configuration.
1370
+ # @return [Types::ChimeWebhookConfiguration]
1371
+ #
1372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateChimeWebhookConfigurationResult AWS API Documentation
1373
+ #
1374
+ class UpdateChimeWebhookConfigurationResult < Struct.new(
1375
+ :webhook_configuration)
1376
+ SENSITIVE = []
1377
+ include Aws::Structure
1378
+ end
1379
+
1380
+ # We can’t process your request right now because of a server issue. Try
1381
+ # again later.
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateSlackChannelConfigurationException AWS API Documentation
1384
+ #
1385
+ class UpdateSlackChannelConfigurationException < Aws::EmptyStructure; end
1386
+
1387
+ # @!attribute [rw] chat_configuration_arn
1388
+ # The ARN of the SlackChannelConfiguration to update.
1389
+ # @return [String]
1390
+ #
1391
+ # @!attribute [rw] slack_channel_id
1392
+ # The ID of the Slack channel. To get the ID, open Slack, right click
1393
+ # on the channel name in the left pane, then choose Copy Link. The
1394
+ # channel ID is the 9-character string at the end of the URL. For
1395
+ # example, ABCBBLZZZ.
1396
+ # @return [String]
1397
+ #
1398
+ # @!attribute [rw] slack_channel_name
1399
+ # The name of the Slack Channel.
1400
+ # @return [String]
1401
+ #
1402
+ # @!attribute [rw] sns_topic_arns
1403
+ # The ARNs of the SNS topics that deliver notifications to AWS
1404
+ # Chatbot.
1405
+ # @return [Array<String>]
1406
+ #
1407
+ # @!attribute [rw] iam_role_arn
1408
+ # The ARN of the IAM role that defines the permissions for AWS
1409
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1410
+ # This is not the service-linked role. For more information, see IAM
1411
+ # Policies for AWS Chatbot.
1412
+ # @return [String]
1413
+ #
1414
+ # @!attribute [rw] logging_level
1415
+ # Logging levels include ERROR, INFO, or NONE.
1416
+ # @return [String]
1417
+ #
1418
+ # @!attribute [rw] guardrail_policy_arns
1419
+ # The list of IAM policy ARNs that are applied as channel guardrails.
1420
+ # The AWS managed 'AdministratorAccess' policy is applied by default
1421
+ # if this is not set.
1422
+ # @return [Array<String>]
1423
+ #
1424
+ # @!attribute [rw] user_authorization_required
1425
+ # Enables use of a user role requirement in your chat configuration.
1426
+ # @return [Boolean]
1427
+ #
1428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateSlackChannelConfigurationRequest AWS API Documentation
1429
+ #
1430
+ class UpdateSlackChannelConfigurationRequest < Struct.new(
1431
+ :chat_configuration_arn,
1432
+ :slack_channel_id,
1433
+ :slack_channel_name,
1434
+ :sns_topic_arns,
1435
+ :iam_role_arn,
1436
+ :logging_level,
1437
+ :guardrail_policy_arns,
1438
+ :user_authorization_required)
1439
+ SENSITIVE = []
1440
+ include Aws::Structure
1441
+ end
1442
+
1443
+ # @!attribute [rw] channel_configuration
1444
+ # The configuration for a Slack channel configured with AWS Chatbot.
1445
+ # @return [Types::SlackChannelConfiguration]
1446
+ #
1447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateSlackChannelConfigurationResult AWS API Documentation
1448
+ #
1449
+ class UpdateSlackChannelConfigurationResult < Struct.new(
1450
+ :channel_configuration)
1451
+ SENSITIVE = []
1452
+ include Aws::Structure
1453
+ end
1454
+
1455
+ # We can’t process your request right now because of a server issue. Try
1456
+ # again later.
1457
+ #
1458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateTeamsChannelConfigurationException AWS API Documentation
1459
+ #
1460
+ class UpdateTeamsChannelConfigurationException < Aws::EmptyStructure; end
1461
+
1462
+ # @!attribute [rw] chat_configuration_arn
1463
+ # The ARN of the MicrosoftTeamsChannelConfiguration to update.
1464
+ # @return [String]
1465
+ #
1466
+ # @!attribute [rw] channel_id
1467
+ # The ID of the Microsoft Teams channel.
1468
+ # @return [String]
1469
+ #
1470
+ # @!attribute [rw] channel_name
1471
+ # The name of the Microsoft Teams channel.
1472
+ # @return [String]
1473
+ #
1474
+ # @!attribute [rw] sns_topic_arns
1475
+ # The ARNs of the SNS topics that deliver notifications to AWS
1476
+ # Chatbot.
1477
+ # @return [Array<String>]
1478
+ #
1479
+ # @!attribute [rw] iam_role_arn
1480
+ # The ARN of the IAM role that defines the permissions for AWS
1481
+ # Chatbot. This is a user-defined role that AWS Chatbot will assume.
1482
+ # This is not the service-linked role. For more information, see IAM
1483
+ # Policies for AWS Chatbot.
1484
+ # @return [String]
1485
+ #
1486
+ # @!attribute [rw] logging_level
1487
+ # Logging levels include ERROR, INFO, or NONE.
1488
+ # @return [String]
1489
+ #
1490
+ # @!attribute [rw] guardrail_policy_arns
1491
+ # The list of IAM policy ARNs that are applied as channel guardrails.
1492
+ # The AWS managed 'AdministratorAccess' policy is applied by default
1493
+ # if this is not set.
1494
+ # @return [Array<String>]
1495
+ #
1496
+ # @!attribute [rw] user_authorization_required
1497
+ # Enables use of a user role requirement in your chat configuration.
1498
+ # @return [Boolean]
1499
+ #
1500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateTeamsChannelConfigurationRequest AWS API Documentation
1501
+ #
1502
+ class UpdateTeamsChannelConfigurationRequest < Struct.new(
1503
+ :chat_configuration_arn,
1504
+ :channel_id,
1505
+ :channel_name,
1506
+ :sns_topic_arns,
1507
+ :iam_role_arn,
1508
+ :logging_level,
1509
+ :guardrail_policy_arns,
1510
+ :user_authorization_required)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1514
+
1515
+ # @!attribute [rw] channel_configuration
1516
+ # The configuration for a Microsoft Teams channel configured with AWS
1517
+ # Chatbot.
1518
+ # @return [Types::TeamsChannelConfiguration]
1519
+ #
1520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/UpdateTeamsChannelConfigurationResult AWS API Documentation
1521
+ #
1522
+ class UpdateTeamsChannelConfigurationResult < Struct.new(
1523
+ :channel_configuration)
1524
+ SENSITIVE = []
1525
+ include Aws::Structure
1526
+ end
1527
+
1528
+ end
1529
+ end