aws-sdk-chatbot 1.9.0 → 1.11.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.
@@ -32,6 +32,7 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
32
  require 'aws-sdk-core/plugins/request_compression.rb'
33
33
  require 'aws-sdk-core/plugins/defaults_mode.rb'
34
34
  require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/telemetry.rb'
35
36
  require 'aws-sdk-core/plugins/sign.rb'
36
37
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
37
38
 
@@ -83,6 +84,7 @@ module Aws::Chatbot
83
84
  add_plugin(Aws::Plugins::RequestCompression)
84
85
  add_plugin(Aws::Plugins::DefaultsMode)
85
86
  add_plugin(Aws::Plugins::RecursionDetection)
87
+ add_plugin(Aws::Plugins::Telemetry)
86
88
  add_plugin(Aws::Plugins::Sign)
87
89
  add_plugin(Aws::Plugins::Protocols::RestJson)
88
90
  add_plugin(Aws::Chatbot::Plugins::Endpoints)
@@ -330,6 +332,16 @@ module Aws::Chatbot
330
332
  # ** Please note ** When response stubbing is enabled, no HTTP
331
333
  # requests are made, and retries are disabled.
332
334
  #
335
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
336
+ # Allows you to provide a telemetry provider, which is used to
337
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
338
+ # will not record or emit any telemetry data. The SDK supports the
339
+ # following telemetry providers:
340
+ #
341
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
342
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
343
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
344
+ #
333
345
  # @option options [Aws::TokenProvider] :token_provider
334
346
  # A Bearer Token Provider. This can be an instance of any one of the
335
347
  # following classes:
@@ -425,32 +437,46 @@ module Aws::Chatbot
425
437
 
426
438
  # @!group API Operations
427
439
 
428
- # Creates Chime Webhook Configuration
440
+ # Creates an AWS Chatbot configuration for Amazon Chime.
429
441
  #
430
442
  # @option params [required, String] :webhook_description
431
- # Description of the webhook. Recommend using the convention
432
- # `RoomName/WebhookName`. See Chime setup tutorial for more details:
433
- # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
443
+ # A description of the webhook. We recommend using the convention
444
+ # `RoomName/WebhookName`.
445
+ #
446
+ # For more information, see [Tutorial: Get started with Amazon Chime][1]
447
+ # in the <i> AWS Chatbot Administrator Guide</i>.
448
+ #
449
+ #
450
+ #
451
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html
434
452
  #
435
453
  # @option params [required, String] :webhook_url
436
- # URL for the Chime webhook.
454
+ # The URL for the Amazon Chime webhook.
437
455
  #
438
456
  # @option params [required, Array<String>] :sns_topic_arns
439
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
457
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
458
+ # notifications to AWS Chatbot.
440
459
  #
441
460
  # @option params [required, String] :iam_role_arn
442
- # This is a user-defined role that AWS Chatbot will assume. This is not
443
- # the service-linked role. For more information, see IAM Policies for
444
- # AWS Chatbot.
461
+ # A user-defined role that AWS Chatbot assumes. This is not the
462
+ # service-linked role.
463
+ #
464
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
465
+ # AWS Chatbot Administrator Guide</i>.
466
+ #
467
+ #
468
+ #
469
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
445
470
  #
446
471
  # @option params [required, String] :configuration_name
447
472
  # The name of the configuration.
448
473
  #
449
474
  # @option params [String] :logging_level
450
- # Logging levels include ERROR, INFO, or NONE.
475
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
451
476
  #
452
477
  # @option params [Array<Types::Tag>] :tags
453
- # A list of tags to apply to the configuration.
478
+ # A map of tags assigned to a resource. A tag is a string-to-string map
479
+ # of key-value pairs.
454
480
  #
455
481
  # @return [Types::CreateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
456
482
  #
@@ -495,7 +521,7 @@ module Aws::Chatbot
495
521
  req.send_request(options)
496
522
  end
497
523
 
498
- # Creates MS Teams Channel Configuration
524
+ # Creates an AWS Chatbot configuration for Microsoft Teams.
499
525
  #
500
526
  # @option params [required, String] :channel_id
501
527
  # The ID of the Microsoft Teams channel.
@@ -504,12 +530,17 @@ module Aws::Chatbot
504
530
  # The name of the Microsoft Teams channel.
505
531
  #
506
532
  # @option params [required, String] :team_id
507
- # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
508
- # team ID, you must perform the initial authorization flow with
509
- # Microsoft Teams in the AWS Chatbot console. Then you can copy and
510
- # paste the team ID from the console. For more details, see steps 1-4 in
511
- # Get started with Microsoft Teams in the AWS Chatbot Administrator
512
- # Guide.
533
+ # The ID of the Microsoft Teams authorized with AWS Chatbot.
534
+ #
535
+ # To get the team ID, you must perform the initial authorization flow
536
+ # with Microsoft Teams in the AWS Chatbot console. Then you can copy and
537
+ # paste the team ID from the console. For more information, see [Step 1:
538
+ # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot
539
+ # Administrator Guide</i>.
540
+ #
541
+ #
542
+ #
543
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup
513
544
  #
514
545
  # @option params [String] :team_name
515
546
  # The name of the Microsoft Teams Team.
@@ -518,30 +549,37 @@ module Aws::Chatbot
518
549
  # The ID of the Microsoft Teams tenant.
519
550
  #
520
551
  # @option params [Array<String>] :sns_topic_arns
521
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
552
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
553
+ # notifications to AWS Chatbot.
522
554
  #
523
555
  # @option params [required, String] :iam_role_arn
524
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
525
- # This is a user-defined role that AWS Chatbot will assume. This is not
526
- # the service-linked role. For more information, see IAM Policies for
527
- # AWS Chatbot.
556
+ # A user-defined role that AWS Chatbot assumes. This is not the
557
+ # service-linked role.
558
+ #
559
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
560
+ # AWS Chatbot Administrator Guide</i>.
561
+ #
562
+ #
563
+ #
564
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
528
565
  #
529
566
  # @option params [required, String] :configuration_name
530
567
  # The name of the configuration.
531
568
  #
532
569
  # @option params [String] :logging_level
533
- # Logging levels include ERROR, INFO, or NONE.
570
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
534
571
  #
535
572
  # @option params [Array<String>] :guardrail_policy_arns
536
573
  # The list of IAM policy ARNs that are applied as channel guardrails.
537
- # The AWS managed 'AdministratorAccess' policy is applied by default
538
- # if this is not set.
574
+ # The AWS managed `AdministratorAccess` policy is applied by default if
575
+ # this is not set.
539
576
  #
540
577
  # @option params [Boolean] :user_authorization_required
541
578
  # Enables use of a user role requirement in your chat configuration.
542
579
  #
543
580
  # @option params [Array<Types::Tag>] :tags
544
- # A list of tags to apply to the configuration.
581
+ # A map of tags assigned to a resource. A tag is a string-to-string map
582
+ # of key-value pairs.
545
583
  #
546
584
  # @return [Types::CreateTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
547
585
  #
@@ -598,45 +636,53 @@ module Aws::Chatbot
598
636
  req.send_request(options)
599
637
  end
600
638
 
601
- # Creates Slack Channel Configuration
639
+ # Creates an AWS Chatbot confugration for Slack.
602
640
  #
603
641
  # @option params [required, String] :slack_team_id
604
642
  # The ID of the Slack workspace authorized with AWS Chatbot.
605
643
  #
606
644
  # @option params [required, String] :slack_channel_id
607
- # The ID of the Slack channel. To get the ID, open Slack, right click on
608
- # the channel name in the left pane, then choose Copy Link. The channel
609
- # ID is the 9-character string at the end of the URL. For example,
610
- # ABCBBLZZZ.
645
+ # The ID of the Slack channel.
646
+ #
647
+ # To get this ID, open Slack, right click on the channel name in the
648
+ # left pane, then choose Copy Link. The channel ID is the 9-character
649
+ # string at the end of the URL. For example, ABCBBLZZZ.
611
650
  #
612
651
  # @option params [String] :slack_channel_name
613
- # The name of the Slack Channel.
652
+ # The name of the Slack channel.
614
653
  #
615
654
  # @option params [Array<String>] :sns_topic_arns
616
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
655
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
656
+ # notifications to AWS Chatbot.
617
657
  #
618
658
  # @option params [required, String] :iam_role_arn
619
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
620
- # This is a user-defined role that AWS Chatbot will assume. This is not
621
- # the service-linked role. For more information, see IAM Policies for
622
- # AWS Chatbot.
659
+ # A user-defined role that AWS Chatbot assumes. This is not the
660
+ # service-linked role.
661
+ #
662
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
663
+ # AWS Chatbot Administrator Guide</i>.
664
+ #
665
+ #
666
+ #
667
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
623
668
  #
624
669
  # @option params [required, String] :configuration_name
625
670
  # The name of the configuration.
626
671
  #
627
672
  # @option params [String] :logging_level
628
- # Logging levels include ERROR, INFO, or NONE.
673
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
629
674
  #
630
675
  # @option params [Array<String>] :guardrail_policy_arns
631
676
  # The list of IAM policy ARNs that are applied as channel guardrails.
632
- # The AWS managed 'AdministratorAccess' policy is applied by default
633
- # if this is not set.
677
+ # The AWS managed `AdministratorAccess` policy is applied by default if
678
+ # this is not set.
634
679
  #
635
680
  # @option params [Boolean] :user_authorization_required
636
681
  # Enables use of a user role requirement in your chat configuration.
637
682
  #
638
683
  # @option params [Array<Types::Tag>] :tags
639
- # A list of tags to apply to the configuration.
684
+ # A map of tags assigned to a resource. A tag is a string-to-string map
685
+ # of key-value pairs.
640
686
  #
641
687
  # @return [Types::CreateSlackChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
642
688
  #
@@ -690,10 +736,11 @@ module Aws::Chatbot
690
736
  req.send_request(options)
691
737
  end
692
738
 
693
- # Deletes a Chime Webhook Configuration
739
+ # Deletes a Amazon Chime webhook configuration for AWS Chatbot.
694
740
  #
695
741
  # @option params [required, String] :chat_configuration_arn
696
- # The ARN of the ChimeWebhookConfiguration to delete.
742
+ # The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to
743
+ # delete.
697
744
  #
698
745
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
699
746
  #
@@ -712,10 +759,12 @@ module Aws::Chatbot
712
759
  req.send_request(options)
713
760
  end
714
761
 
715
- # Deletes MS Teams Channel Configuration
762
+ # Deletes a Microsoft Teams channel configuration for AWS Chatbot
716
763
  #
717
764
  # @option params [required, String] :chat_configuration_arn
718
- # The ARN of the MicrosoftTeamsChannelConfiguration to delete.
765
+ # The Amazon Resource Name (ARN) of the
766
+ # MicrosoftTeamsChannelConfiguration associated with the user identity
767
+ # to delete.
719
768
  #
720
769
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
721
770
  #
@@ -739,12 +788,17 @@ module Aws::Chatbot
739
788
  # Teams team must have no channels configured to remove it.
740
789
  #
741
790
  # @option params [required, String] :team_id
742
- # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
743
- # team ID, you must perform the initial authorization flow with
744
- # Microsoft Teams in the AWS Chatbot console. Then you can copy and
745
- # paste the team ID from the console. For more details, see steps 1-4 in
746
- # Get started with Microsoft Teams in the AWS Chatbot Administrator
747
- # Guide.
791
+ # The ID of the Microsoft Teams team authorized with AWS Chatbot.
792
+ #
793
+ # To get the team ID, you must perform the initial authorization flow
794
+ # with Microsoft Teams in the AWS Chatbot console. Then you can copy and
795
+ # paste the team ID from the console. For more information, see [Step 1:
796
+ # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot
797
+ # Administrator Guide</i>.
798
+ #
799
+ #
800
+ #
801
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup
748
802
  #
749
803
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
750
804
  #
@@ -763,14 +817,14 @@ module Aws::Chatbot
763
817
  req.send_request(options)
764
818
  end
765
819
 
766
- # Deletes a Teams user identity
820
+ # Identifes a user level permission for a channel configuration.
767
821
  #
768
822
  # @option params [required, String] :chat_configuration_arn
769
823
  # The ARN of the MicrosoftTeamsChannelConfiguration associated with the
770
824
  # user identity to delete.
771
825
  #
772
826
  # @option params [required, String] :user_id
773
- # Id from Microsoft Teams for user.
827
+ # The Microsoft Teams user ID.
774
828
  #
775
829
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
776
830
  #
@@ -790,10 +844,11 @@ module Aws::Chatbot
790
844
  req.send_request(options)
791
845
  end
792
846
 
793
- # Deletes Slack Channel Configuration
847
+ # Deletes a Slack channel configuration for AWS Chatbot
794
848
  #
795
849
  # @option params [required, String] :chat_configuration_arn
796
- # The ARN of the SlackChannelConfiguration to delete.
850
+ # The Amazon Resource Name (ARN) of the SlackChannelConfiguration to
851
+ # delete.
797
852
  #
798
853
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
799
854
  #
@@ -812,7 +867,7 @@ module Aws::Chatbot
812
867
  req.send_request(options)
813
868
  end
814
869
 
815
- # Deletes a Slack user identity
870
+ # Deletes a user level permission for a Slack channel configuration.
816
871
  #
817
872
  # @option params [required, String] :chat_configuration_arn
818
873
  # The ARN of the SlackChannelConfiguration associated with the user
@@ -822,7 +877,7 @@ module Aws::Chatbot
822
877
  # The ID of the Slack workspace authorized with AWS Chatbot.
823
878
  #
824
879
  # @option params [required, String] :slack_user_id
825
- # The ID of the user in Slack.
880
+ # The ID of the user in Slack
826
881
  #
827
882
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
828
883
  #
@@ -867,7 +922,7 @@ module Aws::Chatbot
867
922
  req.send_request(options)
868
923
  end
869
924
 
870
- # Lists Chime Webhook Configurations optionally filtered by
925
+ # Lists Amazon Chime webhook configurations optionally filtered by
871
926
  # ChatConfigurationArn
872
927
  #
873
928
  # @option params [Integer] :max_results
@@ -882,7 +937,8 @@ module Aws::Chatbot
882
937
  # the value specified by MaxResults.
883
938
  #
884
939
  # @option params [String] :chat_configuration_arn
885
- # An optional ARN of a ChimeWebhookConfiguration to describe.
940
+ # An optional Amazon Resource Number (ARN) of a
941
+ # ChimeWebhookConfiguration to describe.
886
942
  #
887
943
  # @return [Types::DescribeChimeWebhookConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
888
944
  #
@@ -923,7 +979,7 @@ module Aws::Chatbot
923
979
  req.send_request(options)
924
980
  end
925
981
 
926
- # Lists Slack Channel Configurations optionally filtered by
982
+ # Lists Slack channel configurations optionally filtered by
927
983
  # ChatConfigurationArn
928
984
  #
929
985
  # @option params [Integer] :max_results
@@ -938,7 +994,8 @@ module Aws::Chatbot
938
994
  # the value specified by MaxResults.
939
995
  #
940
996
  # @option params [String] :chat_configuration_arn
941
- # An optional ARN of a SlackChannelConfiguration to describe.
997
+ # An optional Amazon Resource Number (ARN) of a
998
+ # SlackChannelConfiguration to describe.
942
999
  #
943
1000
  # @return [Types::DescribeSlackChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
944
1001
  #
@@ -988,8 +1045,8 @@ module Aws::Chatbot
988
1045
  # Lists all Slack user identities with a mapped role.
989
1046
  #
990
1047
  # @option params [String] :chat_configuration_arn
991
- # The ARN of the SlackChannelConfiguration associated with the user
992
- # identities to describe.
1048
+ # The Amazon Resource Number (ARN) of the SlackChannelConfiguration
1049
+ # associated with the user identities to describe.
993
1050
  #
994
1051
  # @option params [String] :next_token
995
1052
  # An optional token returned from a prior request. Use this token for
@@ -1036,7 +1093,8 @@ module Aws::Chatbot
1036
1093
  req.send_request(options)
1037
1094
  end
1038
1095
 
1039
- # Lists all authorized Slack Workspaces for AWS Account
1096
+ # List all authorized Slack workspaces connected to the AWS Account
1097
+ # onboarded with AWS Chatbot.
1040
1098
  #
1041
1099
  # @option params [Integer] :max_results
1042
1100
  # The maximum number of results to include in the response. If more
@@ -1079,7 +1137,7 @@ module Aws::Chatbot
1079
1137
  req.send_request(options)
1080
1138
  end
1081
1139
 
1082
- # Get Chatbot account level preferences
1140
+ # Returns AWS Chatbot account preferences.
1083
1141
  #
1084
1142
  # @return [Types::GetAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1085
1143
  #
@@ -1099,10 +1157,11 @@ module Aws::Chatbot
1099
1157
  req.send_request(options)
1100
1158
  end
1101
1159
 
1102
- # Get a single MS Teams Channel Configurations
1160
+ # Returns a Microsoft Teams channel configuration in an AWS account.
1103
1161
  #
1104
1162
  # @option params [required, String] :chat_configuration_arn
1105
- # The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
1163
+ # The Amazon Resource Number (ARN) of the
1164
+ # MicrosoftTeamsChannelConfiguration to retrieve.
1106
1165
  #
1107
1166
  # @return [Types::GetTeamsChannelConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1108
1167
  #
@@ -1143,7 +1202,8 @@ module Aws::Chatbot
1143
1202
  req.send_request(options)
1144
1203
  end
1145
1204
 
1146
- # Lists MS Teams Channel Configurations optionally filtered by TeamId
1205
+ # Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS
1206
+ # account.
1147
1207
  #
1148
1208
  # @option params [Integer] :max_results
1149
1209
  # The maximum number of results to include in the response. If more
@@ -1157,12 +1217,17 @@ module Aws::Chatbot
1157
1217
  # the value specified by MaxResults.
1158
1218
  #
1159
1219
  # @option params [String] :team_id
1160
- # The ID of the Microsoft Team authorized with AWS Chatbot. To get the
1161
- # team ID, you must perform the initial authorization flow with
1162
- # Microsoft Teams in the AWS Chatbot console. Then you can copy and
1163
- # paste the team ID from the console. For more details, see steps 1-4 in
1164
- # Get started with Microsoft Teams in the AWS Chatbot Administrator
1165
- # Guide.
1220
+ # The ID of the Microsoft Teams authorized with AWS Chatbot.
1221
+ #
1222
+ # To get the team ID, you must perform the initial authorization flow
1223
+ # with Microsoft Teams in the AWS Chatbot console. Then you can copy and
1224
+ # paste the team ID from the console. For more information, see [Step 1:
1225
+ # Configure a Microsoft Teams client][1] in the <i> AWS Chatbot
1226
+ # Administrator Guide</i>.
1227
+ #
1228
+ #
1229
+ #
1230
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup
1166
1231
  #
1167
1232
  # @return [Types::ListTeamsChannelConfigurationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1168
1233
  #
@@ -1210,7 +1275,7 @@ module Aws::Chatbot
1210
1275
  req.send_request(options)
1211
1276
  end
1212
1277
 
1213
- # Lists all authorized MS teams for AWS Account
1278
+ # Lists all authorized Microsoft Teams for an AWS Account
1214
1279
  #
1215
1280
  # @option params [Integer] :max_results
1216
1281
  # The maximum number of results to include in the response. If more
@@ -1254,11 +1319,12 @@ module Aws::Chatbot
1254
1319
  req.send_request(options)
1255
1320
  end
1256
1321
 
1257
- # Lists all Microsoft Teams user identities with a mapped role.
1322
+ # A list all Microsoft Teams user identities with a mapped role.
1258
1323
  #
1259
1324
  # @option params [String] :chat_configuration_arn
1260
- # The ARN of the MicrosoftTeamsChannelConfiguration associated with the
1261
- # user identities to list.
1325
+ # The Amazon Resource Number (ARN) of the
1326
+ # MicrosoftTeamsChannelConfiguration associated with the user identities
1327
+ # to list.
1262
1328
  #
1263
1329
  # @option params [String] :next_token
1264
1330
  # An optional token returned from a prior request. Use this token for
@@ -1307,10 +1373,11 @@ module Aws::Chatbot
1307
1373
  req.send_request(options)
1308
1374
  end
1309
1375
 
1310
- # Retrieves the list of tags applied to a configuration.
1376
+ # Lists all of the tags associated with the Amazon Resource Name (ARN)
1377
+ # that you specify. The resource can be a user, server, or role.
1311
1378
  #
1312
1379
  # @option params [required, String] :resource_arn
1313
- # The ARN of the configuration.
1380
+ # The ARN you specified to list the tags of.
1314
1381
  #
1315
1382
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1316
1383
  #
@@ -1337,7 +1404,9 @@ module Aws::Chatbot
1337
1404
  req.send_request(options)
1338
1405
  end
1339
1406
 
1340
- # Applies the supplied tags to a configuration.
1407
+ # Attaches a key-value pair to a resource, as identified by its Amazon
1408
+ # Resource Name (ARN). Resources are users, servers, roles, and other
1409
+ # entities.
1341
1410
  #
1342
1411
  # @option params [required, String] :resource_arn
1343
1412
  # The ARN of the configuration.
@@ -1368,13 +1437,19 @@ module Aws::Chatbot
1368
1437
  req.send_request(options)
1369
1438
  end
1370
1439
 
1371
- # Removes the supplied tags from a configuration
1440
+ # Detaches a key-value pair from a resource, as identified by its Amazon
1441
+ # Resource Name (ARN). Resources are users, servers, roles, and other
1442
+ # entities.
1372
1443
  #
1373
1444
  # @option params [required, String] :resource_arn
1374
- # The ARN of the configuration.
1445
+ # The value of the resource that will have the tag removed. An Amazon
1446
+ # Resource Name (ARN) is an identifier for a specific AWS resource, such
1447
+ # as a server, user, or role.
1375
1448
  #
1376
1449
  # @option params [required, Array<String>] :tag_keys
1377
- # A list of tag keys to remove from the configuration.
1450
+ # TagKeys are key-value pairs assigned to ARNs that can be used to group
1451
+ # and search for resources by type. This metadata can be attached to
1452
+ # resources for any purpose.
1378
1453
  #
1379
1454
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1380
1455
  #
@@ -1394,22 +1469,23 @@ module Aws::Chatbot
1394
1469
  req.send_request(options)
1395
1470
  end
1396
1471
 
1397
- # Update Chatbot account level preferences
1472
+ # Updates AWS Chatbot account preferences.
1398
1473
  #
1399
1474
  # @option params [Boolean] :user_authorization_required
1400
1475
  # Enables use of a user role requirement in your chat configuration.
1401
1476
  #
1402
1477
  # @option params [Boolean] :training_data_collection_enabled
1403
- # Turns on training data collection. This helps improve the AWS Chatbot
1404
- # experience by allowing AWS Chatbot to store and use your customer
1405
- # information, such as AWS Chatbot configurations, notifications, user
1406
- # inputs, AWS Chatbot generated responses, and interaction data. This
1407
- # data helps us to continuously improve and develop Artificial
1408
- # Intelligence (AI) technologies. Your data is not shared with any third
1409
- # parties and is protected using sophisticated controls to prevent
1410
- # unauthorized access and misuse. AWS Chatbot does not store or use
1411
- # interactions in chat channels with Amazon Q for training AWS Chatbot’s
1412
- # AI technologies.
1478
+ # Turns on training data collection.
1479
+ #
1480
+ # This helps improve the AWS Chatbot experience by allowing AWS Chatbot
1481
+ # to store and use your customer information, such as AWS Chatbot
1482
+ # configurations, notifications, user inputs, AWS Chatbot generated
1483
+ # responses, and interaction data. This data helps us to continuously
1484
+ # improve and develop Artificial Intelligence (AI) technologies. Your
1485
+ # data is not shared with any third parties and is protected using
1486
+ # sophisticated controls to prevent unauthorized access and misuse. AWS
1487
+ # Chatbot does not store or use interactions in chat channels with
1488
+ # Amazon Q for training AI technologies for AWS Chatbot.
1413
1489
  #
1414
1490
  # @return [Types::UpdateAccountPreferencesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1415
1491
  #
@@ -1436,30 +1512,42 @@ module Aws::Chatbot
1436
1512
  req.send_request(options)
1437
1513
  end
1438
1514
 
1439
- # Updates a Chime Webhook Configuration
1515
+ # Updates a Amazon Chime webhook configuration.
1440
1516
  #
1441
1517
  # @option params [required, String] :chat_configuration_arn
1442
- # The ARN of the ChimeWebhookConfiguration to update.
1518
+ # The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to
1519
+ # update.
1443
1520
  #
1444
1521
  # @option params [String] :webhook_description
1445
- # Description of the webhook. Recommend using the convention
1446
- # `RoomName/WebhookName`. See Chime setup tutorial for more details:
1447
- # https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.
1522
+ # A description of the webhook. We recommend using the convention
1523
+ # `RoomName/WebhookName`.
1524
+ #
1525
+ # For more information, see [Tutorial: Get started with Amazon Chime][1]
1526
+ # in the <i> AWS Chatbot Administrator Guide</i>.
1527
+ #
1528
+ #
1529
+ #
1530
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html
1448
1531
  #
1449
1532
  # @option params [String] :webhook_url
1450
- # URL for the Chime webhook.
1533
+ # The URL for the Amazon Chime webhook.
1451
1534
  #
1452
1535
  # @option params [Array<String>] :sns_topic_arns
1453
1536
  # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1454
1537
  #
1455
1538
  # @option params [String] :iam_role_arn
1456
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
1457
- # This is a user-defined role that AWS Chatbot will assume. This is not
1458
- # the service-linked role. For more information, see IAM Policies for
1459
- # AWS Chatbot.
1539
+ # A user-defined role that AWS Chatbot assumes. This is not the
1540
+ # service-linked role.
1541
+ #
1542
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
1543
+ # AWS Chatbot Administrator Guide</i>.
1544
+ #
1545
+ #
1546
+ #
1547
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
1460
1548
  #
1461
1549
  # @option params [String] :logging_level
1462
- # Logging levels include ERROR, INFO, or NONE.
1550
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
1463
1551
  #
1464
1552
  # @return [Types::UpdateChimeWebhookConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1465
1553
  #
@@ -1498,10 +1586,11 @@ module Aws::Chatbot
1498
1586
  req.send_request(options)
1499
1587
  end
1500
1588
 
1501
- # Updates MS Teams Channel Configuration
1589
+ # Updates an Microsoft Teams channel configuration.
1502
1590
  #
1503
1591
  # @option params [required, String] :chat_configuration_arn
1504
- # The ARN of the MicrosoftTeamsChannelConfiguration to update.
1592
+ # The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to
1593
+ # update.
1505
1594
  #
1506
1595
  # @option params [required, String] :channel_id
1507
1596
  # The ID of the Microsoft Teams channel.
@@ -1510,21 +1599,27 @@ module Aws::Chatbot
1510
1599
  # The name of the Microsoft Teams channel.
1511
1600
  #
1512
1601
  # @option params [Array<String>] :sns_topic_arns
1513
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1602
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
1603
+ # notifications to AWS Chatbot.
1514
1604
  #
1515
1605
  # @option params [String] :iam_role_arn
1516
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
1517
- # This is a user-defined role that AWS Chatbot will assume. This is not
1518
- # the service-linked role. For more information, see IAM Policies for
1519
- # AWS Chatbot.
1606
+ # A user-defined role that AWS Chatbot assumes. This is not the
1607
+ # service-linked role.
1608
+ #
1609
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
1610
+ # AWS Chatbot Administrator Guide</i>.
1611
+ #
1612
+ #
1613
+ #
1614
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
1520
1615
  #
1521
1616
  # @option params [String] :logging_level
1522
- # Logging levels include ERROR, INFO, or NONE.
1617
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
1523
1618
  #
1524
1619
  # @option params [Array<String>] :guardrail_policy_arns
1525
1620
  # The list of IAM policy ARNs that are applied as channel guardrails.
1526
- # The AWS managed 'AdministratorAccess' policy is applied by default
1527
- # if this is not set.
1621
+ # The AWS managed `AdministratorAccess` policy is applied by default if
1622
+ # this is not set.
1528
1623
  #
1529
1624
  # @option params [Boolean] :user_authorization_required
1530
1625
  # Enables use of a user role requirement in your chat configuration.
@@ -1575,36 +1670,44 @@ module Aws::Chatbot
1575
1670
  req.send_request(options)
1576
1671
  end
1577
1672
 
1578
- # Updates Slack Channel Configuration
1673
+ # Updates a Slack channel configuration.
1579
1674
  #
1580
1675
  # @option params [required, String] :chat_configuration_arn
1581
- # The ARN of the SlackChannelConfiguration to update.
1676
+ # The Amazon Resource Number (ARN) of the SlackChannelConfiguration to
1677
+ # update.
1582
1678
  #
1583
1679
  # @option params [required, String] :slack_channel_id
1584
- # The ID of the Slack channel. To get the ID, open Slack, right click on
1585
- # the channel name in the left pane, then choose Copy Link. The channel
1586
- # ID is the 9-character string at the end of the URL. For example,
1587
- # ABCBBLZZZ.
1680
+ # The ID of the Slack channel.
1681
+ #
1682
+ # To get this ID, open Slack, right click on the channel name in the
1683
+ # left pane, then choose Copy Link. The channel ID is the 9-character
1684
+ # string at the end of the URL. For example, ABCBBLZZZ.
1588
1685
  #
1589
1686
  # @option params [String] :slack_channel_name
1590
- # The name of the Slack Channel.
1687
+ # The name of the Slack channel.
1591
1688
  #
1592
1689
  # @option params [Array<String>] :sns_topic_arns
1593
- # The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
1690
+ # The Amazon Resource Names (ARNs) of the SNS topics that deliver
1691
+ # notifications to AWS Chatbot.
1594
1692
  #
1595
1693
  # @option params [String] :iam_role_arn
1596
- # The ARN of the IAM role that defines the permissions for AWS Chatbot.
1597
- # This is a user-defined role that AWS Chatbot will assume. This is not
1598
- # the service-linked role. For more information, see IAM Policies for
1599
- # AWS Chatbot.
1694
+ # A user-defined role that AWS Chatbot assumes. This is not the
1695
+ # service-linked role.
1696
+ #
1697
+ # For more information, see [IAM policies for AWS Chatbot][1] in the <i>
1698
+ # AWS Chatbot Administrator Guide</i>.
1699
+ #
1700
+ #
1701
+ #
1702
+ # [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html
1600
1703
  #
1601
1704
  # @option params [String] :logging_level
1602
- # Logging levels include ERROR, INFO, or NONE.
1705
+ # Logging levels include `ERROR`, `INFO`, or `NONE`.
1603
1706
  #
1604
1707
  # @option params [Array<String>] :guardrail_policy_arns
1605
1708
  # The list of IAM policy ARNs that are applied as channel guardrails.
1606
- # The AWS managed 'AdministratorAccess' policy is applied by default
1607
- # if this is not set.
1709
+ # The AWS managed `AdministratorAccess` policy is applied by default if
1710
+ # this is not set.
1608
1711
  #
1609
1712
  # @option params [Boolean] :user_authorization_required
1610
1713
  # Enables use of a user role requirement in your chat configuration.
@@ -1660,14 +1763,19 @@ module Aws::Chatbot
1660
1763
  # @api private
1661
1764
  def build_request(operation_name, params = {})
1662
1765
  handlers = @handlers.for(operation_name)
1766
+ tracer = config.telemetry_provider.tracer_provider.tracer(
1767
+ Aws::Telemetry.module_to_tracer_name('Aws::Chatbot')
1768
+ )
1663
1769
  context = Seahorse::Client::RequestContext.new(
1664
1770
  operation_name: operation_name,
1665
1771
  operation: config.api.operation(operation_name),
1666
1772
  client: self,
1667
1773
  params: params,
1668
- config: config)
1774
+ config: config,
1775
+ tracer: tracer
1776
+ )
1669
1777
  context[:gem_name] = 'aws-sdk-chatbot'
1670
- context[:gem_version] = '1.9.0'
1778
+ context[:gem_version] = '1.11.0'
1671
1779
  Seahorse::Client::Request.new(handlers, context)
1672
1780
  end
1673
1781