aws-sdk-chatbot 1.8.0 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -312,6 +312,15 @@ module Aws::Chatbot
312
312
  #
313
313
  # @option options [String] :session_token
314
314
  #
315
+ # @option options [Array] :sigv4a_signing_region_set
316
+ # A list of regions that should be signed with SigV4a signing. When
317
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
318
+ # in the following locations:
319
+ #
320
+ # * `Aws.config[:sigv4a_signing_region_set]`
321
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
322
+ # * `~/.aws/config`
323
+ #
315
324
  # @option options [Boolean] :stub_responses (false)
316
325
  # Causes the client to return stubbed responses. By default
317
326
  # fake responses are generated and returned. You can specify
@@ -416,32 +425,46 @@ module Aws::Chatbot
416
425
 
417
426
  # @!group API Operations
418
427
 
419
- # Creates Chime Webhook Configuration
428
+ # Creates an AWS Chatbot configuration for Amazon Chime.
420
429
  #
421
430
  # @option params [required, String] :webhook_description
422
- # Description of the webhook. Recommend using the convention
423
- # `RoomName/WebhookName`. See Chime setup tutorial for more details:
424
- # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
431
+ # A description of the webhook. We recommend using the convention
432
+ # `RoomName/WebhookName`.
433
+ #
434
+ # For more information, see [Tutorial: Get started with Amazon Chime][1]
435
+ # in the <i> AWS Chatbot Administrator Guide</i>.
436
+ #
437
+ #
438
+ #
439
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html
425
440
  #
426
441
  # @option params [required, String] :webhook_url
427
- # URL for the Chime webhook.
442
+ # The URL for the Amazon Chime webhook.
428
443
  #
429
444
  # @option params [required, Array<String>] :sns_topic_arns
430
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
445
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
446
+ # notifications to AWS Chatbot.
431
447
  #
432
448
  # @option params [required, String] :iam_role_arn
433
- # This is a user-defined role that AWS Chatbot will assume. This is not
434
- # the service-linked role. For more information, see IAM Policies for
435
- # AWS Chatbot.
449
+ # A user-defined role that AWS Chatbot assumes. This is not the
450
+ # service-linked role.
451
+ #
452
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
453
+ # AWS Chatbot Administrator Guide</i>.
454
+ #
455
+ #
456
+ #
457
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
436
458
  #
437
459
  # @option params [required, String] :configuration_name
438
460
  # The name of the configuration.
439
461
  #
440
462
  # @option params [String] :logging_level
441
- # Logging levels include ERROR, INFO, or NONE.
463
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
442
464
  #
443
465
  # @option params [Array<Types::Tag>] :tags
444
- # A list of tags to apply to the configuration.
466
+ # A map of tags assigned to a resource. A tag is a string-to-string map
467
+ # of key-value pairs.
445
468
  #
446
469
  # @return [Types::CreateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
447
470
  #
@@ -486,7 +509,7 @@ module Aws::Chatbot
486
509
  req.send_request(options)
487
510
  end
488
511
 
489
- # Creates MS Teams Channel Configuration
512
+ # Creates an AWS Chatbot configuration for Microsoft Teams.
490
513
  #
491
514
  # @option params [required, String] :channel_id
492
515
  # The ID of the Microsoft Teams channel.
@@ -495,12 +518,17 @@ module Aws::Chatbot
495
518
  # The name of the Microsoft Teams channel.
496
519
  #
497
520
  # @option params [required, String] :team_id
498
- # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
499
- # team ID, you must perform the initial authorization flow with
500
- # Microsoft Teams in the AWS Chatbot console. Then you can copy and
501
- # paste the team ID from the console. For more details, see steps 1-4 in
502
- # Get started with Microsoft Teams in the AWS Chatbot Administrator
503
- # Guide.
521
+ # The ID of the Microsoft Teams authorized with AWS Chatbot.
522
+ #
523
+ # To get the team ID, you must perform the initial authorization flow
524
+ # with Microsoft Teams in the AWS Chatbot console. Then you can copy and
525
+ # paste the team ID from the console. For more information, see [Step 1:
526
+ # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot
527
+ # Administrator Guide</i>.
528
+ #
529
+ #
530
+ #
531
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup
504
532
  #
505
533
  # @option params [String] :team_name
506
534
  # The name of the Microsoft Teams Team.
@@ -509,30 +537,37 @@ module Aws::Chatbot
509
537
  # The ID of the Microsoft Teams tenant.
510
538
  #
511
539
  # @option params [Array<String>] :sns_topic_arns
512
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
540
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
541
+ # notifications to AWS Chatbot.
513
542
  #
514
543
  # @option params [required, String] :iam_role_arn
515
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
516
- # This is a user-defined role that AWS Chatbot will assume. This is not
517
- # the service-linked role. For more information, see IAM Policies for
518
- # AWS Chatbot.
544
+ # A user-defined role that AWS Chatbot assumes. This is not the
545
+ # service-linked role.
546
+ #
547
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
548
+ # AWS Chatbot Administrator Guide</i>.
549
+ #
550
+ #
551
+ #
552
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
519
553
  #
520
554
  # @option params [required, String] :configuration_name
521
555
  # The name of the configuration.
522
556
  #
523
557
  # @option params [String] :logging_level
524
- # Logging levels include ERROR, INFO, or NONE.
558
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
525
559
  #
526
560
  # @option params [Array<String>] :guardrail_policy_arns
527
561
  # The list of IAM policy ARNs that are applied as channel guardrails.
528
- # The AWS managed 'AdministratorAccess' policy is applied by default
529
- # if this is not set.
562
+ # The AWS managed `AdministratorAccess` policy is applied by default if
563
+ # this is not set.
530
564
  #
531
565
  # @option params [Boolean] :user_authorization_required
532
566
  # Enables use of a user role requirement in your chat configuration.
533
567
  #
534
568
  # @option params [Array<Types::Tag>] :tags
535
- # A list of tags to apply to the configuration.
569
+ # A map of tags assigned to a resource. A tag is a string-to-string map
570
+ # of key-value pairs.
536
571
  #
537
572
  # @return [Types::CreateTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
538
573
  #
@@ -589,45 +624,53 @@ module Aws::Chatbot
589
624
  req.send_request(options)
590
625
  end
591
626
 
592
- # Creates Slack Channel Configuration
627
+ # Creates an AWS Chatbot confugration for Slack.
593
628
  #
594
629
  # @option params [required, String] :slack_team_id
595
630
  # The ID of the Slack workspace authorized with AWS Chatbot.
596
631
  #
597
632
  # @option params [required, String] :slack_channel_id
598
- # The ID of the Slack channel. To get the ID, open Slack, right click on
599
- # the channel name in the left pane, then choose Copy Link. The channel
600
- # ID is the 9-character string at the end of the URL. For example,
601
- # ABCBBLZZZ.
633
+ # The ID of the Slack channel.
634
+ #
635
+ # To get this ID, open Slack, right click on the channel name in the
636
+ # left pane, then choose Copy Link. The channel ID is the 9-character
637
+ # string at the end of the URL. For example, ABCBBLZZZ.
602
638
  #
603
639
  # @option params [String] :slack_channel_name
604
- # The name of the Slack Channel.
640
+ # The name of the Slack channel.
605
641
  #
606
642
  # @option params [Array<String>] :sns_topic_arns
607
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
643
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
644
+ # notifications to AWS Chatbot.
608
645
  #
609
646
  # @option params [required, String] :iam_role_arn
610
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
611
- # This is a user-defined role that AWS Chatbot will assume. This is not
612
- # the service-linked role. For more information, see IAM Policies for
613
- # AWS Chatbot.
647
+ # A user-defined role that AWS Chatbot assumes. This is not the
648
+ # service-linked role.
649
+ #
650
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
651
+ # AWS Chatbot Administrator Guide</i>.
652
+ #
653
+ #
654
+ #
655
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
614
656
  #
615
657
  # @option params [required, String] :configuration_name
616
658
  # The name of the configuration.
617
659
  #
618
660
  # @option params [String] :logging_level
619
- # Logging levels include ERROR, INFO, or NONE.
661
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
620
662
  #
621
663
  # @option params [Array<String>] :guardrail_policy_arns
622
664
  # The list of IAM policy ARNs that are applied as channel guardrails.
623
- # The AWS managed 'AdministratorAccess' policy is applied by default
624
- # if this is not set.
665
+ # The AWS managed `AdministratorAccess` policy is applied by default if
666
+ # this is not set.
625
667
  #
626
668
  # @option params [Boolean] :user_authorization_required
627
669
  # Enables use of a user role requirement in your chat configuration.
628
670
  #
629
671
  # @option params [Array<Types::Tag>] :tags
630
- # A list of tags to apply to the configuration.
672
+ # A map of tags assigned to a resource. A tag is a string-to-string map
673
+ # of key-value pairs.
631
674
  #
632
675
  # @return [Types::CreateSlackChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
633
676
  #
@@ -681,10 +724,11 @@ module Aws::Chatbot
681
724
  req.send_request(options)
682
725
  end
683
726
 
684
- # Deletes a Chime Webhook Configuration
727
+ # Deletes a Amazon Chime webhook configuration for AWS Chatbot.
685
728
  #
686
729
  # @option params [required, String] :chat_configuration_arn
687
- # The ARN of the ChimeWebhookConfiguration to delete.
730
+ # The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to
731
+ # delete.
688
732
  #
689
733
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
690
734
  #
@@ -703,10 +747,12 @@ module Aws::Chatbot
703
747
  req.send_request(options)
704
748
  end
705
749
 
706
- # Deletes MS Teams Channel Configuration
750
+ # Deletes a Microsoft Teams channel configuration for AWS Chatbot
707
751
  #
708
752
  # @option params [required, String] :chat_configuration_arn
709
- # The ARN of the MicrosoftTeamsChannelConfiguration to delete.
753
+ # The Amazon Resource Name (ARN) of the
754
+ # MicrosoftTeamsChannelConfiguration associated with the user identity
755
+ # to delete.
710
756
  #
711
757
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
712
758
  #
@@ -730,12 +776,17 @@ module Aws::Chatbot
730
776
  # Teams team must have no channels configured to remove it.
731
777
  #
732
778
  # @option params [required, String] :team_id
733
- # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
734
- # team ID, you must perform the initial authorization flow with
735
- # Microsoft Teams in the AWS Chatbot console. Then you can copy and
736
- # paste the team ID from the console. For more details, see steps 1-4 in
737
- # Get started with Microsoft Teams in the AWS Chatbot Administrator
738
- # Guide.
779
+ # The ID of the Microsoft Teams team authorized with AWS Chatbot.
780
+ #
781
+ # To get the team ID, you must perform the initial authorization flow
782
+ # with Microsoft Teams in the AWS Chatbot console. Then you can copy and
783
+ # paste the team ID from the console. For more information, see [Step 1:
784
+ # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot
785
+ # Administrator Guide</i>.
786
+ #
787
+ #
788
+ #
789
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup
739
790
  #
740
791
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
741
792
  #
@@ -754,14 +805,14 @@ module Aws::Chatbot
754
805
  req.send_request(options)
755
806
  end
756
807
 
757
- # Deletes a Teams user identity
808
+ # Identifes a user level permission for a channel configuration.
758
809
  #
759
810
  # @option params [required, String] :chat_configuration_arn
760
811
  # The ARN of the MicrosoftTeamsChannelConfiguration associated with the
761
812
  # user identity to delete.
762
813
  #
763
814
  # @option params [required, String] :user_id
764
- # Id from Microsoft Teams for user.
815
+ # The Microsoft Teams user ID.
765
816
  #
766
817
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
767
818
  #
@@ -781,10 +832,11 @@ module Aws::Chatbot
781
832
  req.send_request(options)
782
833
  end
783
834
 
784
- # Deletes Slack Channel Configuration
835
+ # Deletes a Slack channel configuration for AWS Chatbot
785
836
  #
786
837
  # @option params [required, String] :chat_configuration_arn
787
- # The ARN of the SlackChannelConfiguration to delete.
838
+ # The Amazon Resource Name (ARN) of the SlackChannelConfiguration to
839
+ # delete.
788
840
  #
789
841
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
790
842
  #
@@ -803,7 +855,7 @@ module Aws::Chatbot
803
855
  req.send_request(options)
804
856
  end
805
857
 
806
- # Deletes a Slack user identity
858
+ # Deletes a user level permission for a Slack channel configuration.
807
859
  #
808
860
  # @option params [required, String] :chat_configuration_arn
809
861
  # The ARN of the SlackChannelConfiguration associated with the user
@@ -813,7 +865,7 @@ module Aws::Chatbot
813
865
  # The ID of the Slack workspace authorized with AWS Chatbot.
814
866
  #
815
867
  # @option params [required, String] :slack_user_id
816
- # The ID of the user in Slack.
868
+ # The ID of the user in Slack
817
869
  #
818
870
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
819
871
  #
@@ -858,7 +910,7 @@ module Aws::Chatbot
858
910
  req.send_request(options)
859
911
  end
860
912
 
861
- # Lists Chime Webhook Configurations optionally filtered by
913
+ # Lists Amazon Chime webhook configurations optionally filtered by
862
914
  # ChatConfigurationArn
863
915
  #
864
916
  # @option params [Integer] :max_results
@@ -873,7 +925,8 @@ module Aws::Chatbot
873
925
  # the value specified by MaxResults.
874
926
  #
875
927
  # @option params [String] :chat_configuration_arn
876
- # An optional ARN of a ChimeWebhookConfiguration to describe.
928
+ # An optional Amazon Resource Number (ARN) of a
929
+ # ChimeWebhookConfiguration to describe.
877
930
  #
878
931
  # @return [Types::DescribeChimeWebhookConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
879
932
  #
@@ -914,7 +967,7 @@ module Aws::Chatbot
914
967
  req.send_request(options)
915
968
  end
916
969
 
917
- # Lists Slack Channel Configurations optionally filtered by
970
+ # Lists Slack channel configurations optionally filtered by
918
971
  # ChatConfigurationArn
919
972
  #
920
973
  # @option params [Integer] :max_results
@@ -929,7 +982,8 @@ module Aws::Chatbot
929
982
  # the value specified by MaxResults.
930
983
  #
931
984
  # @option params [String] :chat_configuration_arn
932
- # An optional ARN of a SlackChannelConfiguration to describe.
985
+ # An optional Amazon Resource Number (ARN) of a
986
+ # SlackChannelConfiguration to describe.
933
987
  #
934
988
  # @return [Types::DescribeSlackChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
935
989
  #
@@ -979,8 +1033,8 @@ module Aws::Chatbot
979
1033
  # Lists all Slack user identities with a mapped role.
980
1034
  #
981
1035
  # @option params [String] :chat_configuration_arn
982
- # The ARN of the SlackChannelConfiguration associated with the user
983
- # identities to describe.
1036
+ # The Amazon Resource Number (ARN) of the SlackChannelConfiguration
1037
+ # associated with the user identities to describe.
984
1038
  #
985
1039
  # @option params [String] :next_token
986
1040
  # An optional token returned from a prior request. Use this token for
@@ -1027,7 +1081,8 @@ module Aws::Chatbot
1027
1081
  req.send_request(options)
1028
1082
  end
1029
1083
 
1030
- # Lists all authorized Slack Workspaces for AWS Account
1084
+ # List all authorized Slack workspaces connected to the AWS Account
1085
+ # onboarded with AWS Chatbot.
1031
1086
  #
1032
1087
  # @option params [Integer] :max_results
1033
1088
  # The maximum number of results to include in the response. If more
@@ -1070,7 +1125,7 @@ module Aws::Chatbot
1070
1125
  req.send_request(options)
1071
1126
  end
1072
1127
 
1073
- # Get Chatbot account level preferences
1128
+ # Returns AWS Chatbot account preferences.
1074
1129
  #
1075
1130
  # @return [Types::GetAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1076
1131
  #
@@ -1090,10 +1145,11 @@ module Aws::Chatbot
1090
1145
  req.send_request(options)
1091
1146
  end
1092
1147
 
1093
- # Get a single MS Teams Channel Configurations
1148
+ # Returns a Microsoft Teams channel configuration in an AWS account.
1094
1149
  #
1095
1150
  # @option params [required, String] :chat_configuration_arn
1096
- # The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
1151
+ # The Amazon Resource Number (ARN) of the
1152
+ # MicrosoftTeamsChannelConfiguration to retrieve.
1097
1153
  #
1098
1154
  # @return [Types::GetTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1099
1155
  #
@@ -1134,7 +1190,8 @@ module Aws::Chatbot
1134
1190
  req.send_request(options)
1135
1191
  end
1136
1192
 
1137
- # Lists MS Teams Channel Configurations optionally filtered by TeamId
1193
+ # Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS
1194
+ # account.
1138
1195
  #
1139
1196
  # @option params [Integer] :max_results
1140
1197
  # The maximum number of results to include in the response. If more
@@ -1148,12 +1205,17 @@ module Aws::Chatbot
1148
1205
  # the value specified by MaxResults.
1149
1206
  #
1150
1207
  # @option params [String] :team_id
1151
- # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
1152
- # team ID, you must perform the initial authorization flow with
1153
- # Microsoft Teams in the AWS Chatbot console. Then you can copy and
1154
- # paste the team ID from the console. For more details, see steps 1-4 in
1155
- # Get started with Microsoft Teams in the AWS Chatbot Administrator
1156
- # Guide.
1208
+ # The ID of the Microsoft Teams authorized with AWS Chatbot.
1209
+ #
1210
+ # To get the team ID, you must perform the initial authorization flow
1211
+ # with Microsoft Teams in the AWS Chatbot console. Then you can copy and
1212
+ # paste the team ID from the console. For more information, see [Step 1:
1213
+ # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot
1214
+ # Administrator Guide</i>.
1215
+ #
1216
+ #
1217
+ #
1218
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup
1157
1219
  #
1158
1220
  # @return [Types::ListTeamsChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1159
1221
  #
@@ -1201,7 +1263,7 @@ module Aws::Chatbot
1201
1263
  req.send_request(options)
1202
1264
  end
1203
1265
 
1204
- # Lists all authorized MS teams for AWS Account
1266
+ # Lists all authorized Microsoft Teams for an AWS Account
1205
1267
  #
1206
1268
  # @option params [Integer] :max_results
1207
1269
  # The maximum number of results to include in the response. If more
@@ -1245,11 +1307,12 @@ module Aws::Chatbot
1245
1307
  req.send_request(options)
1246
1308
  end
1247
1309
 
1248
- # Lists all Microsoft Teams user identities with a mapped role.
1310
+ # A list all Microsoft Teams user identities with a mapped role.
1249
1311
  #
1250
1312
  # @option params [String] :chat_configuration_arn
1251
- # The ARN of the MicrosoftTeamsChannelConfiguration associated with the
1252
- # user identities to list.
1313
+ # The Amazon Resource Number (ARN) of the
1314
+ # MicrosoftTeamsChannelConfiguration associated with the user identities
1315
+ # to list.
1253
1316
  #
1254
1317
  # @option params [String] :next_token
1255
1318
  # An optional token returned from a prior request. Use this token for
@@ -1298,10 +1361,11 @@ module Aws::Chatbot
1298
1361
  req.send_request(options)
1299
1362
  end
1300
1363
 
1301
- # Retrieves the list of tags applied to a configuration.
1364
+ # Lists all of the tags associated with the Amazon Resource Name (ARN)
1365
+ # that you specify. The resource can be a user, server, or role.
1302
1366
  #
1303
1367
  # @option params [required, String] :resource_arn
1304
- # The ARN of the configuration.
1368
+ # The ARN you specified to list the tags of.
1305
1369
  #
1306
1370
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1307
1371
  #
@@ -1328,7 +1392,9 @@ module Aws::Chatbot
1328
1392
  req.send_request(options)
1329
1393
  end
1330
1394
 
1331
- # Applies the supplied tags to a configuration.
1395
+ # Attaches a key-value pair to a resource, as identified by its Amazon
1396
+ # Resource Name (ARN). Resources are users, servers, roles, and other
1397
+ # entities.
1332
1398
  #
1333
1399
  # @option params [required, String] :resource_arn
1334
1400
  # The ARN of the configuration.
@@ -1359,13 +1425,19 @@ module Aws::Chatbot
1359
1425
  req.send_request(options)
1360
1426
  end
1361
1427
 
1362
- # Removes the supplied tags from a configuration
1428
+ # Detaches a key-value pair from a resource, as identified by its Amazon
1429
+ # Resource Name (ARN). Resources are users, servers, roles, and other
1430
+ # entities.
1363
1431
  #
1364
1432
  # @option params [required, String] :resource_arn
1365
- # The ARN of the configuration.
1433
+ # The value of the resource that will have the tag removed. An Amazon
1434
+ # Resource Name (ARN) is an identifier for a specific AWS resource, such
1435
+ # as a server, user, or role.
1366
1436
  #
1367
1437
  # @option params [required, Array<String>] :tag_keys
1368
- # A list of tag keys to remove from the configuration.
1438
+ # TagKeys are key-value pairs assigned to ARNs that can be used to group
1439
+ # and search for resources by type. This metadata can be attached to
1440
+ # resources for any purpose.
1369
1441
  #
1370
1442
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1371
1443
  #
@@ -1385,22 +1457,23 @@ module Aws::Chatbot
1385
1457
  req.send_request(options)
1386
1458
  end
1387
1459
 
1388
- # Update Chatbot account level preferences
1460
+ # Updates AWS Chatbot account preferences.
1389
1461
  #
1390
1462
  # @option params [Boolean] :user_authorization_required
1391
1463
  # Enables use of a user role requirement in your chat configuration.
1392
1464
  #
1393
1465
  # @option params [Boolean] :training_data_collection_enabled
1394
- # Turns on training data collection. This helps improve the AWS Chatbot
1395
- # experience by allowing AWS Chatbot to store and use your customer
1396
- # information, such as AWS Chatbot configurations, notifications, user
1397
- # inputs, AWS Chatbot generated responses, and interaction data. This
1398
- # data helps us to continuously improve and develop Artificial
1399
- # Intelligence (AI) technologies. Your data is not shared with any third
1400
- # parties and is protected using sophisticated controls to prevent
1401
- # unauthorized access and misuse. AWS Chatbot does not store or use
1402
- # interactions in chat channels with Amazon Q for training AWS Chatbot’s
1403
- # AI technologies.
1466
+ # Turns on training data collection.
1467
+ #
1468
+ # This helps improve the AWS Chatbot experience by allowing AWS Chatbot
1469
+ # to store and use your customer information, such as AWS Chatbot
1470
+ # configurations, notifications, user inputs, AWS Chatbot generated
1471
+ # responses, and interaction data. This data helps us to continuously
1472
+ # improve and develop Artificial Intelligence (AI) technologies. Your
1473
+ # data is not shared with any third parties and is protected using
1474
+ # sophisticated controls to prevent unauthorized access and misuse. AWS
1475
+ # Chatbot does not store or use interactions in chat channels with
1476
+ # Amazon Q for training AI technologies for AWS Chatbot.
1404
1477
  #
1405
1478
  # @return [Types::UpdateAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1406
1479
  #
@@ -1427,30 +1500,42 @@ module Aws::Chatbot
1427
1500
  req.send_request(options)
1428
1501
  end
1429
1502
 
1430
- # Updates a Chime Webhook Configuration
1503
+ # Updates a Amazon Chime webhook configuration.
1431
1504
  #
1432
1505
  # @option params [required, String] :chat_configuration_arn
1433
- # The ARN of the ChimeWebhookConfiguration to update.
1506
+ # The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to
1507
+ # update.
1434
1508
  #
1435
1509
  # @option params [String] :webhook_description
1436
- # Description of the webhook. Recommend using the convention
1437
- # `RoomName/WebhookName`. See Chime setup tutorial for more details:
1438
- # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
1510
+ # A description of the webhook. We recommend using the convention
1511
+ # `RoomName/WebhookName`.
1512
+ #
1513
+ # For more information, see [Tutorial: Get started with Amazon Chime][1]
1514
+ # in the <i> AWS Chatbot Administrator Guide</i>.
1515
+ #
1516
+ #
1517
+ #
1518
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html
1439
1519
  #
1440
1520
  # @option params [String] :webhook_url
1441
- # URL for the Chime webhook.
1521
+ # The URL for the Amazon Chime webhook.
1442
1522
  #
1443
1523
  # @option params [Array<String>] :sns_topic_arns
1444
1524
  # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1445
1525
  #
1446
1526
  # @option params [String] :iam_role_arn
1447
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
1448
- # This is a user-defined role that AWS Chatbot will assume. This is not
1449
- # the service-linked role. For more information, see IAM Policies for
1450
- # AWS Chatbot.
1527
+ # A user-defined role that AWS Chatbot assumes. This is not the
1528
+ # service-linked role.
1529
+ #
1530
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
1531
+ # AWS Chatbot Administrator Guide</i>.
1532
+ #
1533
+ #
1534
+ #
1535
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
1451
1536
  #
1452
1537
  # @option params [String] :logging_level
1453
- # Logging levels include ERROR, INFO, or NONE.
1538
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
1454
1539
  #
1455
1540
  # @return [Types::UpdateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1456
1541
  #
@@ -1489,10 +1574,11 @@ module Aws::Chatbot
1489
1574
  req.send_request(options)
1490
1575
  end
1491
1576
 
1492
- # Updates MS Teams Channel Configuration
1577
+ # Updates an Microsoft Teams channel configuration.
1493
1578
  #
1494
1579
  # @option params [required, String] :chat_configuration_arn
1495
- # The ARN of the MicrosoftTeamsChannelConfiguration to update.
1580
+ # The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to
1581
+ # update.
1496
1582
  #
1497
1583
  # @option params [required, String] :channel_id
1498
1584
  # The ID of the Microsoft Teams channel.
@@ -1501,21 +1587,27 @@ module Aws::Chatbot
1501
1587
  # The name of the Microsoft Teams channel.
1502
1588
  #
1503
1589
  # @option params [Array<String>] :sns_topic_arns
1504
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1590
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
1591
+ # notifications to AWS Chatbot.
1505
1592
  #
1506
1593
  # @option params [String] :iam_role_arn
1507
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
1508
- # This is a user-defined role that AWS Chatbot will assume. This is not
1509
- # the service-linked role. For more information, see IAM Policies for
1510
- # AWS Chatbot.
1594
+ # A user-defined role that AWS Chatbot assumes. This is not the
1595
+ # service-linked role.
1596
+ #
1597
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
1598
+ # AWS Chatbot Administrator Guide</i>.
1599
+ #
1600
+ #
1601
+ #
1602
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
1511
1603
  #
1512
1604
  # @option params [String] :logging_level
1513
- # Logging levels include ERROR, INFO, or NONE.
1605
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
1514
1606
  #
1515
1607
  # @option params [Array<String>] :guardrail_policy_arns
1516
1608
  # The list of IAM policy ARNs that are applied as channel guardrails.
1517
- # The AWS managed 'AdministratorAccess' policy is applied by default
1518
- # if this is not set.
1609
+ # The AWS managed `AdministratorAccess` policy is applied by default if
1610
+ # this is not set.
1519
1611
  #
1520
1612
  # @option params [Boolean] :user_authorization_required
1521
1613
  # Enables use of a user role requirement in your chat configuration.
@@ -1566,36 +1658,44 @@ module Aws::Chatbot
1566
1658
  req.send_request(options)
1567
1659
  end
1568
1660
 
1569
- # Updates Slack Channel Configuration
1661
+ # Updates a Slack channel configuration.
1570
1662
  #
1571
1663
  # @option params [required, String] :chat_configuration_arn
1572
- # The ARN of the SlackChannelConfiguration to update.
1664
+ # The Amazon Resource Number (ARN) of the SlackChannelConfiguration to
1665
+ # update.
1573
1666
  #
1574
1667
  # @option params [required, String] :slack_channel_id
1575
- # The ID of the Slack channel. To get the ID, open Slack, right click on
1576
- # the channel name in the left pane, then choose Copy Link. The channel
1577
- # ID is the 9-character string at the end of the URL. For example,
1578
- # ABCBBLZZZ.
1668
+ # The ID of the Slack channel.
1669
+ #
1670
+ # To get this ID, open Slack, right click on the channel name in the
1671
+ # left pane, then choose Copy Link. The channel ID is the 9-character
1672
+ # string at the end of the URL. For example, ABCBBLZZZ.
1579
1673
  #
1580
1674
  # @option params [String] :slack_channel_name
1581
- # The name of the Slack Channel.
1675
+ # The name of the Slack channel.
1582
1676
  #
1583
1677
  # @option params [Array<String>] :sns_topic_arns
1584
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1678
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
1679
+ # notifications to AWS Chatbot.
1585
1680
  #
1586
1681
  # @option params [String] :iam_role_arn
1587
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
1588
- # This is a user-defined role that AWS Chatbot will assume. This is not
1589
- # the service-linked role. For more information, see IAM Policies for
1590
- # AWS Chatbot.
1682
+ # A user-defined role that AWS Chatbot assumes. This is not the
1683
+ # service-linked role.
1684
+ #
1685
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
1686
+ # AWS Chatbot Administrator Guide</i>.
1687
+ #
1688
+ #
1689
+ #
1690
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
1591
1691
  #
1592
1692
  # @option params [String] :logging_level
1593
- # Logging levels include ERROR, INFO, or NONE.
1693
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
1594
1694
  #
1595
1695
  # @option params [Array<String>] :guardrail_policy_arns
1596
1696
  # The list of IAM policy ARNs that are applied as channel guardrails.
1597
- # The AWS managed 'AdministratorAccess' policy is applied by default
1598
- # if this is not set.
1697
+ # The AWS managed `AdministratorAccess` policy is applied by default if
1698
+ # this is not set.
1599
1699
  #
1600
1700
  # @option params [Boolean] :user_authorization_required
1601
1701
  # Enables use of a user role requirement in your chat configuration.
@@ -1658,7 +1758,7 @@ module Aws::Chatbot
1658
1758
  params: params,
1659
1759
  config: config)
1660
1760
  context[:gem_name] = 'aws-sdk-chatbot'
1661
- context[:gem_version] = '1.8.0'
1761
+ context[:gem_version] = '1.10.0'
1662
1762
  Seahorse::Client::Request.new(handlers, context)
1663
1763
  end
1664
1764