aws-sdk-chatbot 1.9.0 → 1.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chatbot/client.rb +224 -133
- data/lib/aws-sdk-chatbot/client_api.rb +73 -42
- data/lib/aws-sdk-chatbot/errors.rb +155 -0
- data/lib/aws-sdk-chatbot/types.rb +620 -260
- data/lib/aws-sdk-chatbot.rb +1 -1
- data/sig/errors.rbs +31 -0
- data/sig/types.rbs +102 -40
- metadata +2 -2
@@ -425,32 +425,46 @@ module Aws::Chatbot
|
|
425
425
|
|
426
426
|
# @!group API Operations
|
427
427
|
|
428
|
-
# Creates
|
428
|
+
# Creates an AWS Chatbot configuration for Amazon Chime.
|
429
429
|
#
|
430
430
|
# @option params [required, String] :webhook_description
|
431
|
-
#
|
432
|
-
# `RoomName/WebhookName`.
|
433
|
-
#
|
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
|
434
440
|
#
|
435
441
|
# @option params [required, String] :webhook_url
|
436
|
-
# URL for the Chime webhook.
|
442
|
+
# The URL for the Amazon Chime webhook.
|
437
443
|
#
|
438
444
|
# @option params [required, Array<String>] :sns_topic_arns
|
439
|
-
# The ARNs of the SNS topics that deliver
|
445
|
+
# The Amazon Resource Names (ARNs) of the SNS topics that deliver
|
446
|
+
# notifications to AWS Chatbot.
|
440
447
|
#
|
441
448
|
# @option params [required, String] :iam_role_arn
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
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
|
445
458
|
#
|
446
459
|
# @option params [required, String] :configuration_name
|
447
460
|
# The name of the configuration.
|
448
461
|
#
|
449
462
|
# @option params [String] :logging_level
|
450
|
-
# Logging levels include ERROR
|
463
|
+
# Logging levels include `ERROR`, `INFO`, or `NONE`.
|
451
464
|
#
|
452
465
|
# @option params [Array<Types::Tag>] :tags
|
453
|
-
# A
|
466
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
467
|
+
# of key-value pairs.
|
454
468
|
#
|
455
469
|
# @return [Types::CreateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
456
470
|
#
|
@@ -495,7 +509,7 @@ module Aws::Chatbot
|
|
495
509
|
req.send_request(options)
|
496
510
|
end
|
497
511
|
|
498
|
-
# Creates
|
512
|
+
# Creates an AWS Chatbot configuration for Microsoft Teams.
|
499
513
|
#
|
500
514
|
# @option params [required, String] :channel_id
|
501
515
|
# The ID of the Microsoft Teams channel.
|
@@ -504,12 +518,17 @@ module Aws::Chatbot
|
|
504
518
|
# The name of the Microsoft Teams channel.
|
505
519
|
#
|
506
520
|
# @option params [required, String] :team_id
|
507
|
-
# The ID of the Microsoft
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
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
|
513
532
|
#
|
514
533
|
# @option params [String] :team_name
|
515
534
|
# The name of the Microsoft Teams Team.
|
@@ -518,30 +537,37 @@ module Aws::Chatbot
|
|
518
537
|
# The ID of the Microsoft Teams tenant.
|
519
538
|
#
|
520
539
|
# @option params [Array<String>] :sns_topic_arns
|
521
|
-
# The ARNs of the SNS topics that deliver
|
540
|
+
# The Amazon Resource Names (ARNs) of the SNS topics that deliver
|
541
|
+
# notifications to AWS Chatbot.
|
522
542
|
#
|
523
543
|
# @option params [required, String] :iam_role_arn
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
# 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
|
528
553
|
#
|
529
554
|
# @option params [required, String] :configuration_name
|
530
555
|
# The name of the configuration.
|
531
556
|
#
|
532
557
|
# @option params [String] :logging_level
|
533
|
-
# Logging levels include ERROR
|
558
|
+
# Logging levels include `ERROR`, `INFO`, or `NONE`.
|
534
559
|
#
|
535
560
|
# @option params [Array<String>] :guardrail_policy_arns
|
536
561
|
# The list of IAM policy ARNs that are applied as channel guardrails.
|
537
|
-
# The AWS managed
|
538
|
-
#
|
562
|
+
# The AWS managed `AdministratorAccess` policy is applied by default if
|
563
|
+
# this is not set.
|
539
564
|
#
|
540
565
|
# @option params [Boolean] :user_authorization_required
|
541
566
|
# Enables use of a user role requirement in your chat configuration.
|
542
567
|
#
|
543
568
|
# @option params [Array<Types::Tag>] :tags
|
544
|
-
# A
|
569
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
570
|
+
# of key-value pairs.
|
545
571
|
#
|
546
572
|
# @return [Types::CreateTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
547
573
|
#
|
@@ -598,45 +624,53 @@ module Aws::Chatbot
|
|
598
624
|
req.send_request(options)
|
599
625
|
end
|
600
626
|
|
601
|
-
# Creates
|
627
|
+
# Creates an AWS Chatbot confugration for Slack.
|
602
628
|
#
|
603
629
|
# @option params [required, String] :slack_team_id
|
604
630
|
# The ID of the Slack workspace authorized with AWS Chatbot.
|
605
631
|
#
|
606
632
|
# @option params [required, String] :slack_channel_id
|
607
|
-
# The ID of the Slack channel.
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
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.
|
611
638
|
#
|
612
639
|
# @option params [String] :slack_channel_name
|
613
|
-
# The name of the Slack
|
640
|
+
# The name of the Slack channel.
|
614
641
|
#
|
615
642
|
# @option params [Array<String>] :sns_topic_arns
|
616
|
-
# The ARNs of the SNS topics that deliver
|
643
|
+
# The Amazon Resource Names (ARNs) of the SNS topics that deliver
|
644
|
+
# notifications to AWS Chatbot.
|
617
645
|
#
|
618
646
|
# @option params [required, String] :iam_role_arn
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
# 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
|
623
656
|
#
|
624
657
|
# @option params [required, String] :configuration_name
|
625
658
|
# The name of the configuration.
|
626
659
|
#
|
627
660
|
# @option params [String] :logging_level
|
628
|
-
# Logging levels include ERROR
|
661
|
+
# Logging levels include `ERROR`, `INFO`, or `NONE`.
|
629
662
|
#
|
630
663
|
# @option params [Array<String>] :guardrail_policy_arns
|
631
664
|
# The list of IAM policy ARNs that are applied as channel guardrails.
|
632
|
-
# The AWS managed
|
633
|
-
#
|
665
|
+
# The AWS managed `AdministratorAccess` policy is applied by default if
|
666
|
+
# this is not set.
|
634
667
|
#
|
635
668
|
# @option params [Boolean] :user_authorization_required
|
636
669
|
# Enables use of a user role requirement in your chat configuration.
|
637
670
|
#
|
638
671
|
# @option params [Array<Types::Tag>] :tags
|
639
|
-
# A
|
672
|
+
# A map of tags assigned to a resource. A tag is a string-to-string map
|
673
|
+
# of key-value pairs.
|
640
674
|
#
|
641
675
|
# @return [Types::CreateSlackChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
642
676
|
#
|
@@ -690,10 +724,11 @@ module Aws::Chatbot
|
|
690
724
|
req.send_request(options)
|
691
725
|
end
|
692
726
|
|
693
|
-
# Deletes a Chime
|
727
|
+
# Deletes a Amazon Chime webhook configuration for AWS Chatbot.
|
694
728
|
#
|
695
729
|
# @option params [required, String] :chat_configuration_arn
|
696
|
-
# The ARN of the ChimeWebhookConfiguration to
|
730
|
+
# The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to
|
731
|
+
# delete.
|
697
732
|
#
|
698
733
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
699
734
|
#
|
@@ -712,10 +747,12 @@ module Aws::Chatbot
|
|
712
747
|
req.send_request(options)
|
713
748
|
end
|
714
749
|
|
715
|
-
# Deletes
|
750
|
+
# Deletes a Microsoft Teams channel configuration for AWS Chatbot
|
716
751
|
#
|
717
752
|
# @option params [required, String] :chat_configuration_arn
|
718
|
-
# The ARN of the
|
753
|
+
# The Amazon Resource Name (ARN) of the
|
754
|
+
# MicrosoftTeamsChannelConfiguration associated with the user identity
|
755
|
+
# to delete.
|
719
756
|
#
|
720
757
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
721
758
|
#
|
@@ -739,12 +776,17 @@ module Aws::Chatbot
|
|
739
776
|
# Teams team must have no channels configured to remove it.
|
740
777
|
#
|
741
778
|
# @option params [required, String] :team_id
|
742
|
-
# The ID of the Microsoft
|
743
|
-
#
|
744
|
-
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
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
|
748
790
|
#
|
749
791
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
750
792
|
#
|
@@ -763,14 +805,14 @@ module Aws::Chatbot
|
|
763
805
|
req.send_request(options)
|
764
806
|
end
|
765
807
|
|
766
|
-
#
|
808
|
+
# Identifes a user level permission for a channel configuration.
|
767
809
|
#
|
768
810
|
# @option params [required, String] :chat_configuration_arn
|
769
811
|
# The ARN of the MicrosoftTeamsChannelConfiguration associated with the
|
770
812
|
# user identity to delete.
|
771
813
|
#
|
772
814
|
# @option params [required, String] :user_id
|
773
|
-
#
|
815
|
+
# The Microsoft Teams user ID.
|
774
816
|
#
|
775
817
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
776
818
|
#
|
@@ -790,10 +832,11 @@ module Aws::Chatbot
|
|
790
832
|
req.send_request(options)
|
791
833
|
end
|
792
834
|
|
793
|
-
# Deletes Slack
|
835
|
+
# Deletes a Slack channel configuration for AWS Chatbot
|
794
836
|
#
|
795
837
|
# @option params [required, String] :chat_configuration_arn
|
796
|
-
# The ARN of the SlackChannelConfiguration to
|
838
|
+
# The Amazon Resource Name (ARN) of the SlackChannelConfiguration to
|
839
|
+
# delete.
|
797
840
|
#
|
798
841
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
799
842
|
#
|
@@ -812,7 +855,7 @@ module Aws::Chatbot
|
|
812
855
|
req.send_request(options)
|
813
856
|
end
|
814
857
|
|
815
|
-
# Deletes a Slack
|
858
|
+
# Deletes a user level permission for a Slack channel configuration.
|
816
859
|
#
|
817
860
|
# @option params [required, String] :chat_configuration_arn
|
818
861
|
# The ARN of the SlackChannelConfiguration associated with the user
|
@@ -822,7 +865,7 @@ module Aws::Chatbot
|
|
822
865
|
# The ID of the Slack workspace authorized with AWS Chatbot.
|
823
866
|
#
|
824
867
|
# @option params [required, String] :slack_user_id
|
825
|
-
# The ID of the user in Slack
|
868
|
+
# The ID of the user in Slack
|
826
869
|
#
|
827
870
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
828
871
|
#
|
@@ -867,7 +910,7 @@ module Aws::Chatbot
|
|
867
910
|
req.send_request(options)
|
868
911
|
end
|
869
912
|
|
870
|
-
# Lists Chime
|
913
|
+
# Lists Amazon Chime webhook configurations optionally filtered by
|
871
914
|
# ChatConfigurationArn
|
872
915
|
#
|
873
916
|
# @option params [Integer] :max_results
|
@@ -882,7 +925,8 @@ module Aws::Chatbot
|
|
882
925
|
# the value specified by MaxResults.
|
883
926
|
#
|
884
927
|
# @option params [String] :chat_configuration_arn
|
885
|
-
# An optional ARN of a
|
928
|
+
# An optional Amazon Resource Number (ARN) of a
|
929
|
+
# ChimeWebhookConfiguration to describe.
|
886
930
|
#
|
887
931
|
# @return [Types::DescribeChimeWebhookConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
888
932
|
#
|
@@ -923,7 +967,7 @@ module Aws::Chatbot
|
|
923
967
|
req.send_request(options)
|
924
968
|
end
|
925
969
|
|
926
|
-
# Lists Slack
|
970
|
+
# Lists Slack channel configurations optionally filtered by
|
927
971
|
# ChatConfigurationArn
|
928
972
|
#
|
929
973
|
# @option params [Integer] :max_results
|
@@ -938,7 +982,8 @@ module Aws::Chatbot
|
|
938
982
|
# the value specified by MaxResults.
|
939
983
|
#
|
940
984
|
# @option params [String] :chat_configuration_arn
|
941
|
-
# An optional ARN of a
|
985
|
+
# An optional Amazon Resource Number (ARN) of a
|
986
|
+
# SlackChannelConfiguration to describe.
|
942
987
|
#
|
943
988
|
# @return [Types::DescribeSlackChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
944
989
|
#
|
@@ -988,8 +1033,8 @@ module Aws::Chatbot
|
|
988
1033
|
# Lists all Slack user identities with a mapped role.
|
989
1034
|
#
|
990
1035
|
# @option params [String] :chat_configuration_arn
|
991
|
-
# The ARN of the SlackChannelConfiguration
|
992
|
-
# identities to describe.
|
1036
|
+
# The Amazon Resource Number (ARN) of the SlackChannelConfiguration
|
1037
|
+
# associated with the user identities to describe.
|
993
1038
|
#
|
994
1039
|
# @option params [String] :next_token
|
995
1040
|
# An optional token returned from a prior request. Use this token for
|
@@ -1036,7 +1081,8 @@ module Aws::Chatbot
|
|
1036
1081
|
req.send_request(options)
|
1037
1082
|
end
|
1038
1083
|
|
1039
|
-
#
|
1084
|
+
# List all authorized Slack workspaces connected to the AWS Account
|
1085
|
+
# onboarded with AWS Chatbot.
|
1040
1086
|
#
|
1041
1087
|
# @option params [Integer] :max_results
|
1042
1088
|
# The maximum number of results to include in the response. If more
|
@@ -1079,7 +1125,7 @@ module Aws::Chatbot
|
|
1079
1125
|
req.send_request(options)
|
1080
1126
|
end
|
1081
1127
|
|
1082
|
-
#
|
1128
|
+
# Returns AWS Chatbot account preferences.
|
1083
1129
|
#
|
1084
1130
|
# @return [Types::GetAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1085
1131
|
#
|
@@ -1099,10 +1145,11 @@ module Aws::Chatbot
|
|
1099
1145
|
req.send_request(options)
|
1100
1146
|
end
|
1101
1147
|
|
1102
|
-
#
|
1148
|
+
# Returns a Microsoft Teams channel configuration in an AWS account.
|
1103
1149
|
#
|
1104
1150
|
# @option params [required, String] :chat_configuration_arn
|
1105
|
-
# The ARN of the
|
1151
|
+
# The Amazon Resource Number (ARN) of the
|
1152
|
+
# MicrosoftTeamsChannelConfiguration to retrieve.
|
1106
1153
|
#
|
1107
1154
|
# @return [Types::GetTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1108
1155
|
#
|
@@ -1143,7 +1190,8 @@ module Aws::Chatbot
|
|
1143
1190
|
req.send_request(options)
|
1144
1191
|
end
|
1145
1192
|
|
1146
|
-
# Lists
|
1193
|
+
# Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS
|
1194
|
+
# account.
|
1147
1195
|
#
|
1148
1196
|
# @option params [Integer] :max_results
|
1149
1197
|
# The maximum number of results to include in the response. If more
|
@@ -1157,12 +1205,17 @@ module Aws::Chatbot
|
|
1157
1205
|
# the value specified by MaxResults.
|
1158
1206
|
#
|
1159
1207
|
# @option params [String] :team_id
|
1160
|
-
# The ID of the Microsoft
|
1161
|
-
#
|
1162
|
-
#
|
1163
|
-
#
|
1164
|
-
#
|
1165
|
-
#
|
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
|
1166
1219
|
#
|
1167
1220
|
# @return [Types::ListTeamsChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1168
1221
|
#
|
@@ -1210,7 +1263,7 @@ module Aws::Chatbot
|
|
1210
1263
|
req.send_request(options)
|
1211
1264
|
end
|
1212
1265
|
|
1213
|
-
# Lists all authorized
|
1266
|
+
# Lists all authorized Microsoft Teams for an AWS Account
|
1214
1267
|
#
|
1215
1268
|
# @option params [Integer] :max_results
|
1216
1269
|
# The maximum number of results to include in the response. If more
|
@@ -1254,11 +1307,12 @@ module Aws::Chatbot
|
|
1254
1307
|
req.send_request(options)
|
1255
1308
|
end
|
1256
1309
|
|
1257
|
-
#
|
1310
|
+
# A list all Microsoft Teams user identities with a mapped role.
|
1258
1311
|
#
|
1259
1312
|
# @option params [String] :chat_configuration_arn
|
1260
|
-
# The
|
1261
|
-
# user identities
|
1313
|
+
# The Amazon Resource Number (ARN) of the
|
1314
|
+
# MicrosoftTeamsChannelConfiguration associated with the user identities
|
1315
|
+
# to list.
|
1262
1316
|
#
|
1263
1317
|
# @option params [String] :next_token
|
1264
1318
|
# An optional token returned from a prior request. Use this token for
|
@@ -1307,10 +1361,11 @@ module Aws::Chatbot
|
|
1307
1361
|
req.send_request(options)
|
1308
1362
|
end
|
1309
1363
|
|
1310
|
-
#
|
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.
|
1311
1366
|
#
|
1312
1367
|
# @option params [required, String] :resource_arn
|
1313
|
-
# The ARN
|
1368
|
+
# The ARN you specified to list the tags of.
|
1314
1369
|
#
|
1315
1370
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1316
1371
|
#
|
@@ -1337,7 +1392,9 @@ module Aws::Chatbot
|
|
1337
1392
|
req.send_request(options)
|
1338
1393
|
end
|
1339
1394
|
|
1340
|
-
#
|
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.
|
1341
1398
|
#
|
1342
1399
|
# @option params [required, String] :resource_arn
|
1343
1400
|
# The ARN of the configuration.
|
@@ -1368,13 +1425,19 @@ module Aws::Chatbot
|
|
1368
1425
|
req.send_request(options)
|
1369
1426
|
end
|
1370
1427
|
|
1371
|
-
#
|
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.
|
1372
1431
|
#
|
1373
1432
|
# @option params [required, String] :resource_arn
|
1374
|
-
# The
|
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.
|
1375
1436
|
#
|
1376
1437
|
# @option params [required, Array<String>] :tag_keys
|
1377
|
-
#
|
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.
|
1378
1441
|
#
|
1379
1442
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1380
1443
|
#
|
@@ -1394,22 +1457,23 @@ module Aws::Chatbot
|
|
1394
1457
|
req.send_request(options)
|
1395
1458
|
end
|
1396
1459
|
|
1397
|
-
#
|
1460
|
+
# Updates AWS Chatbot account preferences.
|
1398
1461
|
#
|
1399
1462
|
# @option params [Boolean] :user_authorization_required
|
1400
1463
|
# Enables use of a user role requirement in your chat configuration.
|
1401
1464
|
#
|
1402
1465
|
# @option params [Boolean] :training_data_collection_enabled
|
1403
|
-
# Turns on training data collection.
|
1404
|
-
#
|
1405
|
-
#
|
1406
|
-
#
|
1407
|
-
#
|
1408
|
-
#
|
1409
|
-
#
|
1410
|
-
#
|
1411
|
-
#
|
1412
|
-
#
|
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.
|
1413
1477
|
#
|
1414
1478
|
# @return [Types::UpdateAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1415
1479
|
#
|
@@ -1436,30 +1500,42 @@ module Aws::Chatbot
|
|
1436
1500
|
req.send_request(options)
|
1437
1501
|
end
|
1438
1502
|
|
1439
|
-
# Updates a Chime
|
1503
|
+
# Updates a Amazon Chime webhook configuration.
|
1440
1504
|
#
|
1441
1505
|
# @option params [required, String] :chat_configuration_arn
|
1442
|
-
# The ARN of the ChimeWebhookConfiguration to
|
1506
|
+
# The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to
|
1507
|
+
# update.
|
1443
1508
|
#
|
1444
1509
|
# @option params [String] :webhook_description
|
1445
|
-
#
|
1446
|
-
# `RoomName/WebhookName`.
|
1447
|
-
#
|
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
|
1448
1519
|
#
|
1449
1520
|
# @option params [String] :webhook_url
|
1450
|
-
# URL for the Chime webhook.
|
1521
|
+
# The URL for the Amazon Chime webhook.
|
1451
1522
|
#
|
1452
1523
|
# @option params [Array<String>] :sns_topic_arns
|
1453
1524
|
# The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
|
1454
1525
|
#
|
1455
1526
|
# @option params [String] :iam_role_arn
|
1456
|
-
#
|
1457
|
-
#
|
1458
|
-
#
|
1459
|
-
# 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
|
1460
1536
|
#
|
1461
1537
|
# @option params [String] :logging_level
|
1462
|
-
# Logging levels include ERROR
|
1538
|
+
# Logging levels include `ERROR`, `INFO`, or `NONE`.
|
1463
1539
|
#
|
1464
1540
|
# @return [Types::UpdateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1465
1541
|
#
|
@@ -1498,10 +1574,11 @@ module Aws::Chatbot
|
|
1498
1574
|
req.send_request(options)
|
1499
1575
|
end
|
1500
1576
|
|
1501
|
-
# Updates
|
1577
|
+
# Updates an Microsoft Teams channel configuration.
|
1502
1578
|
#
|
1503
1579
|
# @option params [required, String] :chat_configuration_arn
|
1504
|
-
# The ARN of the
|
1580
|
+
# The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to
|
1581
|
+
# update.
|
1505
1582
|
#
|
1506
1583
|
# @option params [required, String] :channel_id
|
1507
1584
|
# The ID of the Microsoft Teams channel.
|
@@ -1510,21 +1587,27 @@ module Aws::Chatbot
|
|
1510
1587
|
# The name of the Microsoft Teams channel.
|
1511
1588
|
#
|
1512
1589
|
# @option params [Array<String>] :sns_topic_arns
|
1513
|
-
# The ARNs of the SNS topics that deliver
|
1590
|
+
# The Amazon Resource Names (ARNs) of the SNS topics that deliver
|
1591
|
+
# notifications to AWS Chatbot.
|
1514
1592
|
#
|
1515
1593
|
# @option params [String] :iam_role_arn
|
1516
|
-
#
|
1517
|
-
#
|
1518
|
-
#
|
1519
|
-
# 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
|
1520
1603
|
#
|
1521
1604
|
# @option params [String] :logging_level
|
1522
|
-
# Logging levels include ERROR
|
1605
|
+
# Logging levels include `ERROR`, `INFO`, or `NONE`.
|
1523
1606
|
#
|
1524
1607
|
# @option params [Array<String>] :guardrail_policy_arns
|
1525
1608
|
# The list of IAM policy ARNs that are applied as channel guardrails.
|
1526
|
-
# The AWS managed
|
1527
|
-
#
|
1609
|
+
# The AWS managed `AdministratorAccess` policy is applied by default if
|
1610
|
+
# this is not set.
|
1528
1611
|
#
|
1529
1612
|
# @option params [Boolean] :user_authorization_required
|
1530
1613
|
# Enables use of a user role requirement in your chat configuration.
|
@@ -1575,36 +1658,44 @@ module Aws::Chatbot
|
|
1575
1658
|
req.send_request(options)
|
1576
1659
|
end
|
1577
1660
|
|
1578
|
-
# Updates Slack
|
1661
|
+
# Updates a Slack channel configuration.
|
1579
1662
|
#
|
1580
1663
|
# @option params [required, String] :chat_configuration_arn
|
1581
|
-
# The ARN of the SlackChannelConfiguration to
|
1664
|
+
# The Amazon Resource Number (ARN) of the SlackChannelConfiguration to
|
1665
|
+
# update.
|
1582
1666
|
#
|
1583
1667
|
# @option params [required, String] :slack_channel_id
|
1584
|
-
# The ID of the Slack channel.
|
1585
|
-
#
|
1586
|
-
#
|
1587
|
-
#
|
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.
|
1588
1673
|
#
|
1589
1674
|
# @option params [String] :slack_channel_name
|
1590
|
-
# The name of the Slack
|
1675
|
+
# The name of the Slack channel.
|
1591
1676
|
#
|
1592
1677
|
# @option params [Array<String>] :sns_topic_arns
|
1593
|
-
# The ARNs of the SNS topics that deliver
|
1678
|
+
# The Amazon Resource Names (ARNs) of the SNS topics that deliver
|
1679
|
+
# notifications to AWS Chatbot.
|
1594
1680
|
#
|
1595
1681
|
# @option params [String] :iam_role_arn
|
1596
|
-
#
|
1597
|
-
#
|
1598
|
-
#
|
1599
|
-
# 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
|
1600
1691
|
#
|
1601
1692
|
# @option params [String] :logging_level
|
1602
|
-
# Logging levels include ERROR
|
1693
|
+
# Logging levels include `ERROR`, `INFO`, or `NONE`.
|
1603
1694
|
#
|
1604
1695
|
# @option params [Array<String>] :guardrail_policy_arns
|
1605
1696
|
# The list of IAM policy ARNs that are applied as channel guardrails.
|
1606
|
-
# The AWS managed
|
1607
|
-
#
|
1697
|
+
# The AWS managed `AdministratorAccess` policy is applied by default if
|
1698
|
+
# this is not set.
|
1608
1699
|
#
|
1609
1700
|
# @option params [Boolean] :user_authorization_required
|
1610
1701
|
# Enables use of a user role requirement in your chat configuration.
|
@@ -1667,7 +1758,7 @@ module Aws::Chatbot
|
|
1667
1758
|
params: params,
|
1668
1759
|
config: config)
|
1669
1760
|
context[:gem_name] = 'aws-sdk-chatbot'
|
1670
|
-
context[:gem_version] = '1.
|
1761
|
+
context[:gem_version] = '1.10.0'
|
1671
1762
|
Seahorse::Client::Request.new(handlers, context)
|
1672
1763
|
end
|
1673
1764
|
|