aws-sdk-connect 1.23.0 → 1.28.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: bd177b600d6b0c07f30b393110a9c5fb6dcd7385
4
- data.tar.gz: 682ebd69c6325ca689e4b826df824ed4d65582ad
2
+ SHA256:
3
+ metadata.gz: 2e51963ae36aaa856591c95e38141c4508ce2c3220dd20f4374c932f1f792d5f
4
+ data.tar.gz: c2a9093ce23e3d16a91a71a9f7468a8d22c7d77ac3a5c1b8fd8eb8a1ef575626
5
5
  SHA512:
6
- metadata.gz: 21daf0e36362140bb19963d8dcfc12818c4246250dc715d072e2edd89547002a10c236f152c559c1cc53cc1950300a806cac37722fea06ec6f0ac3832ae62688
7
- data.tar.gz: d74158c10eff94317a43361893e583fd67819bed30bae6054f0d57a36c9e3bd5d875a7ff0b2b909b47e4603a7a6a9474aae69bf2c915ae09cbe944447b9004a7
6
+ metadata.gz: 53af5d10d95bfa7be88c0224ef5a74da6d48b3b25224011aaa6ca80d8bade02ea54bf981bcf980c4d55768ee363a759e31a01a3f17495367e6e4fcf6d14b2e9b
7
+ data.tar.gz: 929e73d5520e082029d6fb8d08450a4ab68f701a443921029474d899f7fc2b16b2bd5ab9ba7d3364f8546fe25de80f112c052aaaa54700696d9f07da7b098212
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-connect/customizations'
45
47
  # @service
46
48
  module Aws::Connect
47
49
 
48
- GEM_VERSION = '1.23.0'
50
+ GEM_VERSION = '1.28.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
32
35
  module Aws::Connect
33
36
  # An API client for Connect. To construct a client, you need to configure a `:region` and `:credentials`.
34
37
  #
35
- # client = Aws::Connect::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
38
+ # client = Aws::Connect::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
40
43
  #
41
44
  # For details on configuring region and credentials see
42
45
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -69,6 +72,7 @@ module Aws::Connect
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
74
78
 
@@ -105,7 +109,7 @@ module Aws::Connect
105
109
  # @option options [required, String] :region
106
110
  # The AWS region to connect to. The configured `:region` is
107
111
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
109
113
  #
110
114
  # * `Aws.config[:region]`
111
115
  # * `ENV['AWS_REGION']`
@@ -161,7 +165,7 @@ module Aws::Connect
161
165
  # @option options [String] :endpoint
162
166
  # The client endpoint is normally constructed from the `:region`
163
167
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
169
  #
166
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::Connect
176
180
  # requests fetching endpoints information. Defaults to 60 sec.
177
181
  #
178
182
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
184
  #
181
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
186
  # The log formatter.
@@ -229,15 +233,19 @@ module Aws::Connect
229
233
  #
230
234
  # @option options [String] :retry_mode ("legacy")
231
235
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
241
249
  #
242
250
  # @option options [String] :secret_access_key
243
251
  #
@@ -265,8 +273,7 @@ module Aws::Connect
265
273
  #
266
274
  # @option options [Integer] :http_read_timeout (60) The default
267
275
  # number of seconds to wait for response data. This value can
268
- # safely be set
269
- # per-request on the session yielded by {#session_for}.
276
+ # safely be set per-request on the session.
270
277
  #
271
278
  # @option options [Float] :http_idle_timeout (5) The number of
272
279
  # seconds a connection is allowed to sit idle before it is
@@ -278,7 +285,7 @@ module Aws::Connect
278
285
  # request body. This option has no effect unless the request has
279
286
  # "Expect" header set to "100-continue". Defaults to `nil` which
280
287
  # disables this behaviour. This value can safely be set per
281
- # request on the session yielded by {#session_for}.
288
+ # request on the session.
282
289
  #
283
290
  # @option options [Boolean] :http_wire_trace (false) When `true`,
284
291
  # HTTP debug output will be sent to the `:logger`.
@@ -307,6 +314,14 @@ module Aws::Connect
307
314
 
308
315
  # Creates a user account for the specified Amazon Connect instance.
309
316
  #
317
+ # For information about how to create user accounts using the Amazon
318
+ # Connect console, see [Add Users][1] in the *Amazon Connect
319
+ # Administrator Guide*.
320
+ #
321
+ #
322
+ #
323
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
324
+ #
310
325
  # @option params [required, String] :username
311
326
  # The user name for the account. For instances not using SAML for
312
327
  # identity management, the user name can include up to 20 characters. If
@@ -399,6 +414,14 @@ module Aws::Connect
399
414
 
400
415
  # Deletes a user account from the specified Amazon Connect instance.
401
416
  #
417
+ # For information about what happens to a user's data when their
418
+ # account is deleted, see [Delete Users from Your Amazon Connect
419
+ # Instance][1] in the *Amazon Connect Administrator Guide*.
420
+ #
421
+ #
422
+ #
423
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
424
+ #
402
425
  # @option params [required, String] :instance_id
403
426
  # The identifier of the Amazon Connect instance.
404
427
  #
@@ -603,12 +626,12 @@ module Aws::Connect
603
626
  # Gets the real-time metric data from the specified Amazon Connect
604
627
  # instance.
605
628
  #
606
- # For more information, see [Real-time Metrics Reports][1] in the
607
- # *Amazon Connect Administrator Guide*.
629
+ # For a description of each metric, see [Real-time Metrics
630
+ # Definitions][1] in the *Amazon Connect Administrator Guide*.
608
631
  #
609
632
  #
610
633
  #
611
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html
634
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
612
635
  #
613
636
  # @option params [required, String] :instance_id
614
637
  # The identifier of the Amazon Connect instance.
@@ -631,60 +654,112 @@ module Aws::Connect
631
654
  #
632
655
  # @option params [required, Array<Types::CurrentMetric>] :current_metrics
633
656
  # The metrics to retrieve. Specify the name and unit for each metric.
634
- # The following metrics are available:
657
+ # The following metrics are available. For a description of all the
658
+ # metrics, see [Real-time Metrics Definitions][1] in the *Amazon Connect
659
+ # Administrator Guide*.
635
660
  #
636
661
  # AGENTS\_AFTER\_CONTACT\_WORK
637
662
  #
638
663
  # : Unit: COUNT
639
664
  #
665
+ # Name in real-time metrics report: [ACW][2]
666
+ #
640
667
  # AGENTS\_AVAILABLE
641
668
  #
642
669
  # : Unit: COUNT
643
670
  #
671
+ # Name in real-time metrics report: [Available][3]
672
+ #
644
673
  # AGENTS\_ERROR
645
674
  #
646
675
  # : Unit: COUNT
647
676
  #
677
+ # Name in real-time metrics report: [Error][4]
678
+ #
648
679
  # AGENTS\_NON\_PRODUCTIVE
649
680
  #
650
681
  # : Unit: COUNT
651
682
  #
683
+ # Name in real-time metrics report: [NPT (Non-Productive Time)][5]
684
+ #
652
685
  # AGENTS\_ON\_CALL
653
686
  #
654
687
  # : Unit: COUNT
655
688
  #
689
+ # Name in real-time metrics report: [On contact][6]
690
+ #
656
691
  # AGENTS\_ON\_CONTACT
657
692
  #
658
693
  # : Unit: COUNT
659
694
  #
695
+ # Name in real-time metrics report: [On contact][6]
696
+ #
660
697
  # AGENTS\_ONLINE
661
698
  #
662
699
  # : Unit: COUNT
663
700
  #
701
+ # Name in real-time metrics report: [Online][7]
702
+ #
664
703
  # AGENTS\_STAFFED
665
704
  #
666
705
  # : Unit: COUNT
667
706
  #
707
+ # Name in real-time metrics report: [Staffed][8]
708
+ #
668
709
  # CONTACTS\_IN\_QUEUE
669
710
  #
670
711
  # : Unit: COUNT
671
712
  #
713
+ # Name in real-time metrics report: [In queue][9]
714
+ #
672
715
  # CONTACTS\_SCHEDULED
673
716
  #
674
717
  # : Unit: COUNT
675
718
  #
719
+ # Name in real-time metrics report: [Scheduled][10]
720
+ #
676
721
  # OLDEST\_CONTACT\_AGE
677
722
  #
678
723
  # : Unit: SECONDS
679
724
  #
725
+ # When you use groupings, Unit says SECONDS but the Value is returned
726
+ # in MILLISECONDS. For example, if you get a response like this:
727
+ #
728
+ # `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \},
729
+ # "Value": 24113.0 `\\}
730
+ #
731
+ # The actual OLDEST\_CONTACT\_AGE is 24 seconds.
732
+ #
733
+ # Name in real-time metrics report: [Oldest][11]
734
+ #
680
735
  # SLOTS\_ACTIVE
681
736
  #
682
737
  # : Unit: COUNT
683
738
  #
739
+ # Name in real-time metrics report: [Active][12]
740
+ #
684
741
  # SLOTS\_AVAILABLE
685
742
  #
686
743
  # : Unit: COUNT
687
744
  #
745
+ # Name in real-time metrics report: [Availability][13]
746
+ #
747
+ #
748
+ #
749
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
750
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
751
+ # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
752
+ # [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
753
+ # [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
754
+ # [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
755
+ # [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
756
+ # [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
757
+ # [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
758
+ # [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
759
+ # [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
760
+ # [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
761
+ # [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
762
+ #
688
763
  # @option params [String] :next_token
689
764
  # The token for the next set of results. Use the value returned in the
690
765
  # previous response in the next request to retrieve the next set of
@@ -703,6 +778,8 @@ module Aws::Connect
703
778
  # * {Types::GetCurrentMetricDataResponse#metric_results #metric_results} => Array&lt;Types::CurrentMetricResult&gt;
704
779
  # * {Types::GetCurrentMetricDataResponse#data_snapshot_time #data_snapshot_time} => Time
705
780
  #
781
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
782
+ #
706
783
  # @example Request syntax with placeholder values
707
784
  #
708
785
  # resp = client.get_current_metric_data({
@@ -778,12 +855,12 @@ module Aws::Connect
778
855
  # Gets historical metric data from the specified Amazon Connect
779
856
  # instance.
780
857
  #
781
- # For more information, see [Historical Metrics Reports][1] in the
782
- # *Amazon Connect Administrator Guide*.
858
+ # For a description of each historical metric, see [Historical Metrics
859
+ # Definitions][1] in the *Amazon Connect Administrator Guide*.
783
860
  #
784
861
  #
785
862
  #
786
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
863
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
787
864
  #
788
865
  # @option params [required, String] :instance_id
789
866
  # The identifier of the Amazon Connect instance.
@@ -826,7 +903,9 @@ module Aws::Connect
826
903
  #
827
904
  # @option params [required, Array<Types::HistoricalMetric>] :historical_metrics
828
905
  # The metrics to retrieve. Specify the name, unit, and statistic for
829
- # each metric. The following historical metrics are available:
906
+ # each metric. The following historical metrics are available. For a
907
+ # description of each metric, see [Historical Metrics Definitions][1] in
908
+ # the *Amazon Connect Administrator Guide*.
830
909
  #
831
910
  # ABANDON\_TIME
832
911
  #
@@ -982,6 +1061,10 @@ module Aws::Connect
982
1061
  # following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
983
1062
  # 180, 240, 300, 600
984
1063
  #
1064
+ #
1065
+ #
1066
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
1067
+ #
985
1068
  # @option params [String] :next_token
986
1069
  # The token for the next set of results. Use the value returned in the
987
1070
  # previous response in the next request to retrieve the next set of
@@ -995,6 +1078,8 @@ module Aws::Connect
995
1078
  # * {Types::GetMetricDataResponse#next_token #next_token} => String
996
1079
  # * {Types::GetMetricDataResponse#metric_results #metric_results} => Array&lt;Types::HistoricalMetricResult&gt;
997
1080
  #
1081
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1082
+ #
998
1083
  # @example Request syntax with placeholder values
999
1084
  #
1000
1085
  # resp = client.get_metric_data({
@@ -1048,6 +1133,13 @@ module Aws::Connect
1048
1133
  # Provides information about the contact flows for the specified Amazon
1049
1134
  # Connect instance.
1050
1135
  #
1136
+ # For more information about contact flows, see [Contact Flows][1] in
1137
+ # the *Amazon Connect Administrator Guide*.
1138
+ #
1139
+ #
1140
+ #
1141
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
1142
+ #
1051
1143
  # @option params [required, String] :instance_id
1052
1144
  # The identifier of the Amazon Connect instance.
1053
1145
  #
@@ -1067,6 +1159,8 @@ module Aws::Connect
1067
1159
  # * {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array&lt;Types::ContactFlowSummary&gt;
1068
1160
  # * {Types::ListContactFlowsResponse#next_token #next_token} => String
1069
1161
  #
1162
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1163
+ #
1070
1164
  # @example Request syntax with placeholder values
1071
1165
  #
1072
1166
  # resp = client.list_contact_flows({
@@ -1097,6 +1191,13 @@ module Aws::Connect
1097
1191
  # Provides information about the hours of operation for the specified
1098
1192
  # Amazon Connect instance.
1099
1193
  #
1194
+ # For more information about hours of operation, see [Set the Hours of
1195
+ # Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
1196
+ #
1197
+ #
1198
+ #
1199
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
1200
+ #
1100
1201
  # @option params [required, String] :instance_id
1101
1202
  # The identifier of the Amazon Connect instance.
1102
1203
  #
@@ -1113,6 +1214,8 @@ module Aws::Connect
1113
1214
  # * {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array&lt;Types::HoursOfOperationSummary&gt;
1114
1215
  # * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
1115
1216
  #
1217
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1218
+ #
1116
1219
  # @example Request syntax with placeholder values
1117
1220
  #
1118
1221
  # resp = client.list_hours_of_operations({
@@ -1141,6 +1244,14 @@ module Aws::Connect
1141
1244
  # Provides information about the phone numbers for the specified Amazon
1142
1245
  # Connect instance.
1143
1246
  #
1247
+ # For more information about phone numbers, see [Set Up Phone Numbers
1248
+ # for Your Contact Center][1] in the *Amazon Connect Administrator
1249
+ # Guide*.
1250
+ #
1251
+ #
1252
+ #
1253
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
1254
+ #
1144
1255
  # @option params [required, String] :instance_id
1145
1256
  # The identifier of the Amazon Connect instance.
1146
1257
  #
@@ -1163,6 +1274,8 @@ module Aws::Connect
1163
1274
  # * {Types::ListPhoneNumbersResponse#phone_number_summary_list #phone_number_summary_list} => Array&lt;Types::PhoneNumberSummary&gt;
1164
1275
  # * {Types::ListPhoneNumbersResponse#next_token #next_token} => String
1165
1276
  #
1277
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1278
+ #
1166
1279
  # @example Request syntax with placeholder values
1167
1280
  #
1168
1281
  # resp = client.list_phone_numbers({
@@ -1195,6 +1308,13 @@ module Aws::Connect
1195
1308
  # Provides information about the queues for the specified Amazon Connect
1196
1309
  # instance.
1197
1310
  #
1311
+ # For more information about queues, see [Queues: Standard and Agent][1]
1312
+ # in the *Amazon Connect Administrator Guide*.
1313
+ #
1314
+ #
1315
+ #
1316
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
1317
+ #
1198
1318
  # @option params [required, String] :instance_id
1199
1319
  # The identifier of the Amazon Connect instance.
1200
1320
  #
@@ -1214,6 +1334,8 @@ module Aws::Connect
1214
1334
  # * {Types::ListQueuesResponse#queue_summary_list #queue_summary_list} => Array&lt;Types::QueueSummary&gt;
1215
1335
  # * {Types::ListQueuesResponse#next_token #next_token} => String
1216
1336
  #
1337
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1338
+ #
1217
1339
  # @example Request syntax with placeholder values
1218
1340
  #
1219
1341
  # resp = client.list_queues({
@@ -1244,6 +1366,15 @@ module Aws::Connect
1244
1366
  # Provides summary information about the routing profiles for the
1245
1367
  # specified Amazon Connect instance.
1246
1368
  #
1369
+ # For more information about routing profiles, see [Routing Profiles][1]
1370
+ # and [Create a Routing Profile][2] in the *Amazon Connect Administrator
1371
+ # Guide*.
1372
+ #
1373
+ #
1374
+ #
1375
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html
1376
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
1377
+ #
1247
1378
  # @option params [required, String] :instance_id
1248
1379
  # The identifier of the Amazon Connect instance.
1249
1380
  #
@@ -1260,6 +1391,8 @@ module Aws::Connect
1260
1391
  # * {Types::ListRoutingProfilesResponse#routing_profile_summary_list #routing_profile_summary_list} => Array&lt;Types::RoutingProfileSummary&gt;
1261
1392
  # * {Types::ListRoutingProfilesResponse#next_token #next_token} => String
1262
1393
  #
1394
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1395
+ #
1263
1396
  # @example Request syntax with placeholder values
1264
1397
  #
1265
1398
  # resp = client.list_routing_profiles({
@@ -1288,6 +1421,13 @@ module Aws::Connect
1288
1421
  # Provides summary information about the security profiles for the
1289
1422
  # specified Amazon Connect instance.
1290
1423
  #
1424
+ # For more information about security profiles, see [Security
1425
+ # Profiles][1] in the *Amazon Connect Administrator Guide*.
1426
+ #
1427
+ #
1428
+ #
1429
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
1430
+ #
1291
1431
  # @option params [required, String] :instance_id
1292
1432
  # The identifier of the Amazon Connect instance.
1293
1433
  #
@@ -1304,6 +1444,8 @@ module Aws::Connect
1304
1444
  # * {Types::ListSecurityProfilesResponse#security_profile_summary_list #security_profile_summary_list} => Array&lt;Types::SecurityProfileSummary&gt;
1305
1445
  # * {Types::ListSecurityProfilesResponse#next_token #next_token} => String
1306
1446
  #
1447
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1448
+ #
1307
1449
  # @example Request syntax with placeholder values
1308
1450
  #
1309
1451
  # resp = client.list_security_profiles({
@@ -1331,6 +1473,13 @@ module Aws::Connect
1331
1473
 
1332
1474
  # Lists the tags for the specified resource.
1333
1475
  #
1476
+ # For sample policies that use tags, see [Amazon Connect Identity-Based
1477
+ # Policy Examples][1] in the *Amazon Connect Administrator Guide*.
1478
+ #
1479
+ #
1480
+ #
1481
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
1482
+ #
1334
1483
  # @option params [required, String] :resource_arn
1335
1484
  # The Amazon Resource Name (ARN) of the resource.
1336
1485
  #
@@ -1361,6 +1510,13 @@ module Aws::Connect
1361
1510
  # Provides summary information about the hierarchy groups for the
1362
1511
  # specified Amazon Connect instance.
1363
1512
  #
1513
+ # For more information about agent hierarchies, see [Set Up Agent
1514
+ # Hierarchies][1] in the *Amazon Connect Administrator Guide*.
1515
+ #
1516
+ #
1517
+ #
1518
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
1519
+ #
1364
1520
  # @option params [required, String] :instance_id
1365
1521
  # The identifier of the Amazon Connect instance.
1366
1522
  #
@@ -1377,6 +1533,8 @@ module Aws::Connect
1377
1533
  # * {Types::ListUserHierarchyGroupsResponse#user_hierarchy_group_summary_list #user_hierarchy_group_summary_list} => Array&lt;Types::HierarchyGroupSummary&gt;
1378
1534
  # * {Types::ListUserHierarchyGroupsResponse#next_token #next_token} => String
1379
1535
  #
1536
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1537
+ #
1380
1538
  # @example Request syntax with placeholder values
1381
1539
  #
1382
1540
  # resp = client.list_user_hierarchy_groups({
@@ -1421,6 +1579,8 @@ module Aws::Connect
1421
1579
  # * {Types::ListUsersResponse#user_summary_list #user_summary_list} => Array&lt;Types::UserSummary&gt;
1422
1580
  # * {Types::ListUsersResponse#next_token #next_token} => String
1423
1581
  #
1582
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1583
+ #
1424
1584
  # @example Request syntax with placeholder values
1425
1585
  #
1426
1586
  # resp = client.list_users({
@@ -1457,15 +1617,35 @@ module Aws::Connect
1457
1617
  # [CreateParticipantConnection][1] with WEBSOCKET and
1458
1618
  # CONNECTION\_CREDENTIALS.
1459
1619
  #
1620
+ # A 429 error occurs in two situations:
1621
+ #
1622
+ # * API rate limit is exceeded. API TPS throttling returns a
1623
+ # `TooManyRequests` exception from the API Gateway.
1624
+ #
1625
+ # * The [quota for concurrent active chats][2] is exceeded. Active chat
1626
+ # throttling returns a `LimitExceededException`.
1627
+ #
1628
+ # For more information about how chat works, see [Chat][3] in the
1629
+ # *Amazon Connect Administrator Guide*.
1630
+ #
1460
1631
  #
1461
1632
  #
1462
1633
  # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
1634
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
1635
+ # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
1463
1636
  #
1464
1637
  # @option params [required, String] :instance_id
1465
1638
  # The identifier of the Amazon Connect instance.
1466
1639
  #
1467
1640
  # @option params [required, String] :contact_flow_id
1468
- # The identifier of the contact flow for the chat.
1641
+ # The identifier of the contact flow for the outbound call. To see the
1642
+ # ContactFlowId in the Amazon Connect console user interface, on the
1643
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the
1644
+ # contact flow. On the contact flow page, under the name of the contact
1645
+ # flow, choose **Show additional flow information**. The ContactFlowId
1646
+ # is the last part of the ARN, shown here in bold:
1647
+ #
1648
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
1469
1649
  #
1470
1650
  # @option params [Hash<String,String>] :attributes
1471
1651
  # A custom key-value pair using an attribute map. The attributes are
@@ -1528,16 +1708,41 @@ module Aws::Connect
1528
1708
  req.send_request(options)
1529
1709
  end
1530
1710
 
1531
- # Initiates a contact flow to place an outbound call to a customer.
1711
+ # This API places an outbound call to a contact, and then initiates the
1712
+ # contact flow. It performs the actions in the contact flow that's
1713
+ # specified (in `ContactFlowId`).
1714
+ #
1715
+ # Agents are not involved in initiating the outbound API (that is,
1716
+ # dialing the contact). If the contact flow places an outbound call to a
1717
+ # contact, and then puts the contact in queue, that's when the call is
1718
+ # routed to the agent, like any other inbound case.
1532
1719
  #
1533
1720
  # There is a 60 second dialing timeout for this operation. If the call
1534
1721
  # is not connected after 60 seconds, it fails.
1535
1722
  #
1723
+ # <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
1724
+ # can dial these UK mobile numbers, you must submit a service quota
1725
+ # increase request. For more information, see [Amazon Connect Service
1726
+ # Quotas][1] in the *Amazon Connect Administrator Guide*.
1727
+ #
1728
+ # </note>
1729
+ #
1730
+ #
1731
+ #
1732
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
1733
+ #
1536
1734
  # @option params [required, String] :destination_phone_number
1537
1735
  # The phone number of the customer, in E.164 format.
1538
1736
  #
1539
1737
  # @option params [required, String] :contact_flow_id
1540
- # The identifier of the contact flow for the outbound call.
1738
+ # The identifier of the contact flow for the outbound call. To see the
1739
+ # ContactFlowId in the Amazon Connect console user interface, on the
1740
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the
1741
+ # contact flow. On the contact flow page, under the name of the contact
1742
+ # flow, choose **Show additional flow information**. The ContactFlowId
1743
+ # is the last part of the ARN, shown here in bold:
1744
+ #
1745
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
1541
1746
  #
1542
1747
  # @option params [required, String] :instance_id
1543
1748
  # The identifier of the Amazon Connect instance.
@@ -1632,6 +1837,13 @@ module Aws::Connect
1632
1837
  #
1633
1838
  # The supported resource type is users.
1634
1839
  #
1840
+ # For sample policies that use tags, see [Amazon Connect Identity-Based
1841
+ # Policy Examples][1] in the *Amazon Connect Administrator Guide*.
1842
+ #
1843
+ #
1844
+ #
1845
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
1846
+ #
1635
1847
  # @option params [required, String] :resource_arn
1636
1848
  # The Amazon Resource Name (ARN) of the resource.
1637
1849
  #
@@ -1777,6 +1989,19 @@ module Aws::Connect
1777
1989
 
1778
1990
  # Updates the identity information for the specified user.
1779
1991
  #
1992
+ # Someone with the ability to invoke `UpdateUserIndentityInfo` can
1993
+ # change the login credentials of other users by changing their email
1994
+ # address. This poses a security risk to your organization. They can
1995
+ # change the email address of a user to the attacker's email address,
1996
+ # and then reset the password through email. We strongly recommend
1997
+ # limiting who has the ability to invoke `UpdateUserIndentityInfo`. For
1998
+ # more information, see [Best Practices for Security Profiles][1] in the
1999
+ # *Amazon Connect Administrator Guide*.
2000
+ #
2001
+ #
2002
+ #
2003
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html
2004
+ #
1780
2005
  # @option params [required, Types::UserIdentityInfo] :identity_info
1781
2006
  # The identity information for the user.
1782
2007
  #
@@ -1917,7 +2142,7 @@ module Aws::Connect
1917
2142
  params: params,
1918
2143
  config: config)
1919
2144
  context[:gem_name] = 'aws-sdk-connect'
1920
- context[:gem_version] = '1.23.0'
2145
+ context[:gem_version] = '1.28.0'
1921
2146
  Seahorse::Client::Request.new(handlers, context)
1922
2147
  end
1923
2148