aws-sdk-connect 1.40.0 → 1.45.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +238 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-connect.rb +2 -2
  6. data/lib/aws-sdk-connect/client.rb +387 -128
  7. data/lib/aws-sdk-connect/client_api.rb +87 -2
  8. data/lib/aws-sdk-connect/errors.rb +1 -1
  9. data/lib/aws-sdk-connect/resource.rb +1 -1
  10. data/lib/aws-sdk-connect/types.rb +399 -103
  11. metadata +9 -7
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.45.0
data/lib/aws-sdk-connect.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-connect/customizations'
48
48
  # @!group service
49
49
  module Aws::Connect
50
50
 
51
- GEM_VERSION = '1.40.0'
51
+ GEM_VERSION = '1.45.0'
52
52
 
53
53
  end
data/lib/aws-sdk-connect/client.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -333,7 +333,8 @@ module Aws::Connect
333
333
  # Associates an approved origin to an Amazon Connect instance.
334
334
  #
335
335
  # @option params [required, String] :instance_id
336
- # The identifier of the Amazon Connect instance.
336
+ # The identifier of the Amazon Connect instance. You can find the
337
+ # instanceId in the ARN of the instance.
337
338
  #
338
339
  # @option params [required, String] :origin
339
340
  # The domain to add to your allow list.
@@ -356,6 +357,46 @@ module Aws::Connect
356
357
  req.send_request(options)
357
358
  end
358
359
 
360
+ # This API is in preview release for Amazon Connect and is subject to
361
+ # change.
362
+ #
363
+ # Allows the specified Amazon Connect instance to access the specified
364
+ # Amazon Lex or Amazon Lex V2 bot.
365
+ #
366
+ # @option params [required, String] :instance_id
367
+ # The identifier of the Amazon Connect instance. You can find the
368
+ # instanceId in the ARN of the instance.
369
+ #
370
+ # @option params [Types::LexBot] :lex_bot
371
+ # Configuration information of an Amazon Lex bot.
372
+ #
373
+ # @option params [Types::LexV2Bot] :lex_v2_bot
374
+ # The Amazon Lex V2 bot to associate with the instance.
375
+ #
376
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
377
+ #
378
+ # @example Request syntax with placeholder values
379
+ #
380
+ # resp = client.associate_bot({
381
+ # instance_id: "InstanceId", # required
382
+ # lex_bot: {
383
+ # name: "BotName",
384
+ # lex_region: "LexRegion",
385
+ # },
386
+ # lex_v2_bot: {
387
+ # alias_arn: "AliasArn",
388
+ # },
389
+ # })
390
+ #
391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateBot AWS API Documentation
392
+ #
393
+ # @overload associate_bot(params = {})
394
+ # @param [Hash] params ({})
395
+ def associate_bot(params = {}, options = {})
396
+ req = build_request(:associate_bot, params)
397
+ req.send_request(options)
398
+ end
399
+
359
400
  # This API is in preview release for Amazon Connect and is subject to
360
401
  # change.
361
402
  #
@@ -370,7 +411,8 @@ module Aws::Connect
370
411
  # being used for association.
371
412
  #
372
413
  # @option params [required, String] :instance_id
373
- # The identifier of the Amazon Connect instance.
414
+ # The identifier of the Amazon Connect instance. You can find the
415
+ # instanceId in the ARN of the instance.
374
416
  #
375
417
  # @option params [required, String] :resource_type
376
418
  # A valid resource type.
@@ -435,7 +477,8 @@ module Aws::Connect
435
477
  # Lambda function.
436
478
  #
437
479
  # @option params [required, String] :instance_id
438
- # The identifier of the Amazon Connect instance.
480
+ # The identifier of the Amazon Connect instance. You can find the
481
+ # instanceId in the ARN of the instance.
439
482
  #
440
483
  # @option params [required, String] :function_arn
441
484
  # The Amazon Resource Name (ARN) for the Lambda function being
@@ -466,10 +509,11 @@ module Aws::Connect
466
509
  # Amazon Lex bot.
467
510
  #
468
511
  # @option params [required, String] :instance_id
469
- # The identifier of the Amazon Connect instance.
512
+ # The identifier of the Amazon Connect instance. You can find the
513
+ # instanceId in the ARN of the instance.
470
514
  #
471
515
  # @option params [required, Types::LexBot] :lex_bot
472
- # The Amazon Lex box to associate with the instance.
516
+ # The Amazon Lex bot to associate with the instance.
473
517
  #
474
518
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
475
519
  #
@@ -498,7 +542,8 @@ module Aws::Connect
498
542
  # Associates a set of quick connects with a queue.
499
543
  #
500
544
  # @option params [required, String] :instance_id
501
- # The identifier of the Amazon Connect instance.
545
+ # The identifier of the Amazon Connect instance. You can find the
546
+ # instanceId in the ARN of the instance.
502
547
  #
503
548
  # @option params [required, String] :queue_id
504
549
  # The identifier for the queue.
@@ -528,7 +573,8 @@ module Aws::Connect
528
573
  # Associates a set of queues with a routing profile.
529
574
  #
530
575
  # @option params [required, String] :instance_id
531
- # The identifier of the Amazon Connect instance.
576
+ # The identifier of the Amazon Connect instance. You can find the
577
+ # instanceId in the ARN of the instance.
532
578
  #
533
579
  # @option params [required, String] :routing_profile_id
534
580
  # The identifier of the routing profile.
@@ -570,7 +616,8 @@ module Aws::Connect
570
616
  # Associates a security key to the instance.
571
617
  #
572
618
  # @option params [required, String] :instance_id
573
- # The identifier of the Amazon Connect instance.
619
+ # The identifier of the Amazon Connect instance. You can find the
620
+ # instanceId in the ARN of the instance.
574
621
  #
575
622
  # @option params [required, String] :key
576
623
  # A valid security key in PEM format.
@@ -672,6 +719,13 @@ module Aws::Connect
672
719
  # Service (Amazon S3) or Amazon Kinesis. It also does not allow for any
673
720
  # configurations on features, such as Contact Lens for Amazon Connect.
674
721
  #
722
+ # Amazon Connect enforces a limit on the total number of instances that
723
+ # you can create or delete in 30 days. If you exceed this limit, you
724
+ # will get an error message indicating there has been an excessive
725
+ # number of attempts at creating or deleting instances. You must wait 30
726
+ # days before you can restart creating and deleting instances in your
727
+ # account.
728
+ #
675
729
  # @option params [String] :client_token
676
730
  # The idempotency token.
677
731
  #
@@ -720,13 +774,11 @@ module Aws::Connect
720
774
  req.send_request(options)
721
775
  end
722
776
 
723
- # This API is in preview release for Amazon Connect and is subject to
724
- # change.
725
- #
726
777
  # Create an AppIntegration association with an Amazon Connect instance.
727
778
  #
728
779
  # @option params [required, String] :instance_id
729
- # The identifier of the Amazon Connect instance.
780
+ # The identifier of the Amazon Connect instance. You can find the
781
+ # instanceId in the ARN of the instance.
730
782
  #
731
783
  # @option params [required, String] :integration_type
732
784
  # The type of information to be ingested.
@@ -743,6 +795,9 @@ module Aws::Connect
743
795
  # @option params [required, String] :source_type
744
796
  # The type of the data source.
745
797
  #
798
+ # @option params [Hash<String,String>] :tags
799
+ # One or more tags.
800
+ #
746
801
  # @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
747
802
  #
748
803
  # * {Types::CreateIntegrationAssociationResponse#integration_association_id #integration_association_id} => String
@@ -757,6 +812,9 @@ module Aws::Connect
757
812
  # source_application_url: "URI", # required
758
813
  # source_application_name: "SourceApplicationName", # required
759
814
  # source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
815
+ # tags: {
816
+ # "TagKey" => "TagValue",
817
+ # },
760
818
  # })
761
819
  #
762
820
  # @example Response structure
@@ -779,7 +837,8 @@ module Aws::Connect
779
837
  # Creates a new queue for the specified Amazon Connect instance.
780
838
  #
781
839
  # @option params [required, String] :instance_id
782
- # The identifier of the Amazon Connect instance.
840
+ # The identifier of the Amazon Connect instance. You can find the
841
+ # instanceId in the ARN of the instance.
783
842
  #
784
843
  # @option params [required, String] :name
785
844
  # The name of the queue.
@@ -847,7 +906,8 @@ module Aws::Connect
847
906
  # Creates a quick connect for the specified Amazon Connect instance.
848
907
  #
849
908
  # @option params [required, String] :instance_id
850
- # The identifier of the Amazon Connect instance.
909
+ # The identifier of the Amazon Connect instance. You can find the
910
+ # instanceId in the ARN of the instance.
851
911
  #
852
912
  # @option params [required, String] :name
853
913
  # The name of the quick connect.
@@ -908,7 +968,8 @@ module Aws::Connect
908
968
  # Creates a new routing profile.
909
969
  #
910
970
  # @option params [required, String] :instance_id
911
- # The identifier of the Amazon Connect instance.
971
+ # The identifier of the Amazon Connect instance. You can find the
972
+ # instanceId in the ARN of the instance.
912
973
  #
913
974
  # @option params [required, String] :name
914
975
  # The name of the routing profile. Must not be more than 127 characters.
@@ -978,13 +1039,11 @@ module Aws::Connect
978
1039
  req.send_request(options)
979
1040
  end
980
1041
 
981
- # This API is in preview release for Amazon Connect and is subject to
982
- # change.
983
- #
984
1042
  # Creates a use case for an AppIntegration association.
985
1043
  #
986
1044
  # @option params [required, String] :instance_id
987
- # The identifier of the Amazon Connect instance.
1045
+ # The identifier of the Amazon Connect instance. You can find the
1046
+ # instanceId in the ARN of the instance.
988
1047
  #
989
1048
  # @option params [required, String] :integration_association_id
990
1049
  # The identifier for the AppIntegration association.
@@ -994,6 +1053,9 @@ module Aws::Connect
994
1053
  # Each AppIntegration association can have only one of each use case
995
1054
  # type.
996
1055
  #
1056
+ # @option params [Hash<String,String>] :tags
1057
+ # One or more tags.
1058
+ #
997
1059
  # @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
998
1060
  #
999
1061
  # * {Types::CreateUseCaseResponse#use_case_id #use_case_id} => String
@@ -1005,6 +1067,9 @@ module Aws::Connect
1005
1067
  # instance_id: "InstanceId", # required
1006
1068
  # integration_association_id: "IntegrationAssociationId", # required
1007
1069
  # use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
1070
+ # tags: {
1071
+ # "TagKey" => "TagValue",
1072
+ # },
1008
1073
  # })
1009
1074
  #
1010
1075
  # @example Response structure
@@ -1071,7 +1136,8 @@ module Aws::Connect
1071
1136
  # The identifier of the hierarchy group for the user.
1072
1137
  #
1073
1138
  # @option params [required, String] :instance_id
1074
- # The identifier of the Amazon Connect instance.
1139
+ # The identifier of the Amazon Connect instance. You can find the
1140
+ # instanceId in the ARN of the instance.
1075
1141
  #
1076
1142
  # @option params [Hash<String,String>] :tags
1077
1143
  # One or more tags.
@@ -1132,7 +1198,8 @@ module Aws::Connect
1132
1198
  # created at level one if the parent group ID is null.
1133
1199
  #
1134
1200
  # @option params [required, String] :instance_id
1135
- # The identifier of the Amazon Connect instance.
1201
+ # The identifier of the Amazon Connect instance. You can find the
1202
+ # instanceId in the ARN of the instance.
1136
1203
  #
1137
1204
  # @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1138
1205
  #
@@ -1166,8 +1233,16 @@ module Aws::Connect
1166
1233
  #
1167
1234
  # Deletes the Amazon Connect instance.
1168
1235
  #
1236
+ # Amazon Connect enforces a limit on the total number of instances that
1237
+ # you can create or delete in 30 days. If you exceed this limit, you
1238
+ # will get an error message indicating there has been an excessive
1239
+ # number of attempts at creating or deleting instances. You must wait 30
1240
+ # days before you can restart creating and deleting instances in your
1241
+ # account.
1242
+ #
1169
1243
  # @option params [required, String] :instance_id
1170
- # The identifier of the Amazon Connect instance.
1244
+ # The identifier of the Amazon Connect instance. You can find the
1245
+ # instanceId in the ARN of the instance.
1171
1246
  #
1172
1247
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1173
1248
  #
@@ -1186,14 +1261,12 @@ module Aws::Connect
1186
1261
  req.send_request(options)
1187
1262
  end
1188
1263
 
1189
- # This API is in preview release for Amazon Connect and is subject to
1190
- # change.
1191
- #
1192
1264
  # Deletes an AppIntegration association from an Amazon Connect instance.
1193
1265
  # The association must not have any use cases associated with it.
1194
1266
  #
1195
1267
  # @option params [required, String] :instance_id
1196
- # The identifier of the Amazon Connect instance.
1268
+ # The identifier of the Amazon Connect instance. You can find the
1269
+ # instanceId in the ARN of the instance.
1197
1270
  #
1198
1271
  # @option params [required, String] :integration_association_id
1199
1272
  # The identifier for the AppIntegration association.
@@ -1222,7 +1295,8 @@ module Aws::Connect
1222
1295
  # Deletes a quick connect.
1223
1296
  #
1224
1297
  # @option params [required, String] :instance_id
1225
- # The identifier of the Amazon Connect instance.
1298
+ # The identifier of the Amazon Connect instance. You can find the
1299
+ # instanceId in the ARN of the instance.
1226
1300
  #
1227
1301
  # @option params [required, String] :quick_connect_id
1228
1302
  # The identifier for the quick connect.
@@ -1245,13 +1319,11 @@ module Aws::Connect
1245
1319
  req.send_request(options)
1246
1320
  end
1247
1321
 
1248
- # This API is in preview release for Amazon Connect and is subject to
1249
- # change.
1250
- #
1251
1322
  # Deletes a use case from an AppIntegration association.
1252
1323
  #
1253
1324
  # @option params [required, String] :instance_id
1254
- # The identifier of the Amazon Connect instance.
1325
+ # The identifier of the Amazon Connect instance. You can find the
1326
+ # instanceId in the ARN of the instance.
1255
1327
  #
1256
1328
  # @option params [required, String] :integration_association_id
1257
1329
  # The identifier for the AppIntegration association.
@@ -1289,7 +1361,8 @@ module Aws::Connect
1289
1361
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
1290
1362
  #
1291
1363
  # @option params [required, String] :instance_id
1292
- # The identifier of the Amazon Connect instance.
1364
+ # The identifier of the Amazon Connect instance. You can find the
1365
+ # instanceId in the ARN of the instance.
1293
1366
  #
1294
1367
  # @option params [required, String] :user_id
1295
1368
  # The identifier of the user.
@@ -1319,7 +1392,8 @@ module Aws::Connect
1319
1392
  # The identifier of the hierarchy group.
1320
1393
  #
1321
1394
  # @option params [required, String] :instance_id
1322
- # The identifier of the Amazon Connect instance.
1395
+ # The identifier of the Amazon Connect instance. You can find the
1396
+ # instanceId in the ARN of the instance.
1323
1397
  #
1324
1398
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1325
1399
  #
@@ -1391,7 +1465,8 @@ module Aws::Connect
1391
1465
  # Describes the hours of operation.
1392
1466
  #
1393
1467
  # @option params [required, String] :instance_id
1394
- # The identifier of the Amazon Connect instance.
1468
+ # The identifier of the Amazon Connect instance. You can find the
1469
+ # instanceId in the ARN of the instance.
1395
1470
  #
1396
1471
  # @option params [required, String] :hours_of_operation_id
1397
1472
  # The identifier for the hours of operation.
@@ -1445,7 +1520,8 @@ module Aws::Connect
1445
1520
  # invoked.
1446
1521
  #
1447
1522
  # @option params [required, String] :instance_id
1448
- # The identifier of the Amazon Connect instance.
1523
+ # The identifier of the Amazon Connect instance. You can find the
1524
+ # instanceId in the ARN of the instance.
1449
1525
  #
1450
1526
  # @return [Types::DescribeInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1451
1527
  #
@@ -1485,7 +1561,8 @@ module Aws::Connect
1485
1561
  # Describes the specified instance attribute.
1486
1562
  #
1487
1563
  # @option params [required, String] :instance_id
1488
- # The identifier of the Amazon Connect instance.
1564
+ # The identifier of the Amazon Connect instance. You can find the
1565
+ # instanceId in the ARN of the instance.
1489
1566
  #
1490
1567
  # @option params [required, String] :attribute_type
1491
1568
  # The type of attribute.
@@ -1522,7 +1599,8 @@ module Aws::Connect
1522
1599
  # resource type, association ID, and instance ID.
1523
1600
  #
1524
1601
  # @option params [required, String] :instance_id
1525
- # The identifier of the Amazon Connect instance.
1602
+ # The identifier of the Amazon Connect instance. You can find the
1603
+ # instanceId in the ARN of the instance.
1526
1604
  #
1527
1605
  # @option params [required, String] :association_id
1528
1606
  # The existing association identifier that uniquely identifies the
@@ -1573,7 +1651,8 @@ module Aws::Connect
1573
1651
  # Describes the specified queue.
1574
1652
  #
1575
1653
  # @option params [required, String] :instance_id
1576
- # The identifier of the Amazon Connect instance.
1654
+ # The identifier of the Amazon Connect instance. You can find the
1655
+ # instanceId in the ARN of the instance.
1577
1656
  #
1578
1657
  # @option params [required, String] :queue_id
1579
1658
  # The identifier for the queue.
@@ -1619,7 +1698,8 @@ module Aws::Connect
1619
1698
  # Describes the quick connect.
1620
1699
  #
1621
1700
  # @option params [required, String] :instance_id
1622
- # The identifier of the Amazon Connect instance.
1701
+ # The identifier of the Amazon Connect instance. You can find the
1702
+ # instanceId in the ARN of the instance.
1623
1703
  #
1624
1704
  # @option params [required, String] :quick_connect_id
1625
1705
  # The identifier for the quick connect.
@@ -1662,7 +1742,8 @@ module Aws::Connect
1662
1742
  # Describes the specified routing profile.
1663
1743
  #
1664
1744
  # @option params [required, String] :instance_id
1665
- # The identifier of the Amazon Connect instance.
1745
+ # The identifier of the Amazon Connect instance. You can find the
1746
+ # instanceId in the ARN of the instance.
1666
1747
  #
1667
1748
  # @option params [required, String] :routing_profile_id
1668
1749
  # The identifier of the routing profile.
@@ -1710,7 +1791,8 @@ module Aws::Connect
1710
1791
  # The identifier of the user account.
1711
1792
  #
1712
1793
  # @option params [required, String] :instance_id
1713
- # The identifier of the Amazon Connect instance.
1794
+ # The identifier of the Amazon Connect instance. You can find the
1795
+ # instanceId in the ARN of the instance.
1714
1796
  #
1715
1797
  # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1716
1798
  #
@@ -1758,7 +1840,8 @@ module Aws::Connect
1758
1840
  # The identifier of the hierarchy group.
1759
1841
  #
1760
1842
  # @option params [required, String] :instance_id
1761
- # The identifier of the Amazon Connect instance.
1843
+ # The identifier of the Amazon Connect instance. You can find the
1844
+ # instanceId in the ARN of the instance.
1762
1845
  #
1763
1846
  # @return [Types::DescribeUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1764
1847
  #
@@ -1806,7 +1889,8 @@ module Aws::Connect
1806
1889
  # instance.
1807
1890
  #
1808
1891
  # @option params [required, String] :instance_id
1809
- # The identifier of the Amazon Connect instance.
1892
+ # The identifier of the Amazon Connect instance. You can find the
1893
+ # instanceId in the ARN of the instance.
1810
1894
  #
1811
1895
  # @return [Types::DescribeUserHierarchyStructureResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1812
1896
  #
@@ -1851,7 +1935,8 @@ module Aws::Connect
1851
1935
  # Revokes access to integrated applications from Amazon Connect.
1852
1936
  #
1853
1937
  # @option params [required, String] :instance_id
1854
- # The identifier of the Amazon Connect instance.
1938
+ # The identifier of the Amazon Connect instance. You can find the
1939
+ # instanceId in the ARN of the instance.
1855
1940
  #
1856
1941
  # @option params [required, String] :origin
1857
1942
  # The domain URL of the integrated application.
@@ -1874,6 +1959,46 @@ module Aws::Connect
1874
1959
  req.send_request(options)
1875
1960
  end
1876
1961
 
1962
+ # This API is in preview release for Amazon Connect and is subject to
1963
+ # change.
1964
+ #
1965
+ # Revokes authorization from the specified instance to access the
1966
+ # specified Amazon Lex or Amazon Lex V2 bot.
1967
+ #
1968
+ # @option params [required, String] :instance_id
1969
+ # The identifier of the Amazon Connect instance. You can find the
1970
+ # instanceId in the ARN of the instance.
1971
+ #
1972
+ # @option params [Types::LexBot] :lex_bot
1973
+ # Configuration information of an Amazon Lex bot.
1974
+ #
1975
+ # @option params [Types::LexV2Bot] :lex_v2_bot
1976
+ # The Amazon Lex V2 bot to disassociate from the instance.
1977
+ #
1978
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1979
+ #
1980
+ # @example Request syntax with placeholder values
1981
+ #
1982
+ # resp = client.disassociate_bot({
1983
+ # instance_id: "InstanceId", # required
1984
+ # lex_bot: {
1985
+ # name: "BotName",
1986
+ # lex_region: "LexRegion",
1987
+ # },
1988
+ # lex_v2_bot: {
1989
+ # alias_arn: "AliasArn",
1990
+ # },
1991
+ # })
1992
+ #
1993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateBot AWS API Documentation
1994
+ #
1995
+ # @overload disassociate_bot(params = {})
1996
+ # @param [Hash] params ({})
1997
+ def disassociate_bot(params = {}, options = {})
1998
+ req = build_request(:disassociate_bot, params)
1999
+ req.send_request(options)
2000
+ end
2001
+
1877
2002
  # This API is in preview release for Amazon Connect and is subject to
1878
2003
  # change.
1879
2004
  #
@@ -1881,7 +2006,8 @@ module Aws::Connect
1881
2006
  # type and association ID.
1882
2007
  #
1883
2008
  # @option params [required, String] :instance_id
1884
- # The identifier of the Amazon Connect instance.
2009
+ # The identifier of the Amazon Connect instance. You can find the
2010
+ # instanceId in the ARN of the instance.
1885
2011
  #
1886
2012
  # @option params [required, String] :association_id
1887
2013
  # The existing association identifier that uniquely identifies the
@@ -1916,7 +2042,8 @@ module Aws::Connect
1916
2042
  # relevant contact flow blocks.
1917
2043
  #
1918
2044
  # @option params [required, String] :instance_id
1919
- # The identifier of the Amazon Connect instance..
2045
+ # The identifier of the Amazon Connect instance. You can find the
2046
+ # instanceId in the ARN of the instance..
1920
2047
  #
1921
2048
  # @option params [required, String] :function_arn
1922
2049
  # The Amazon Resource Name (ARN) of the Lambda function being
@@ -1947,7 +2074,8 @@ module Aws::Connect
1947
2074
  # specified Amazon Lex bot.
1948
2075
  #
1949
2076
  # @option params [required, String] :instance_id
1950
- # The identifier of the Amazon Connect instance.
2077
+ # The identifier of the Amazon Connect instance. You can find the
2078
+ # instanceId in the ARN of the instance.
1951
2079
  #
1952
2080
  # @option params [required, String] :bot_name
1953
2081
  # The name of the Amazon Lex bot. Maximum character limit of 50.
@@ -1980,7 +2108,8 @@ module Aws::Connect
1980
2108
  # Disassociates a set of quick connects from a queue.
1981
2109
  #
1982
2110
  # @option params [required, String] :instance_id
1983
- # The identifier of the Amazon Connect instance.
2111
+ # The identifier of the Amazon Connect instance. You can find the
2112
+ # instanceId in the ARN of the instance.
1984
2113
  #
1985
2114
  # @option params [required, String] :queue_id
1986
2115
  # The identifier for the queue.
@@ -2010,7 +2139,8 @@ module Aws::Connect
2010
2139
  # Disassociates a set of queues from a routing profile.
2011
2140
  #
2012
2141
  # @option params [required, String] :instance_id
2013
- # The identifier of the Amazon Connect instance.
2142
+ # The identifier of the Amazon Connect instance. You can find the
2143
+ # instanceId in the ARN of the instance.
2014
2144
  #
2015
2145
  # @option params [required, String] :routing_profile_id
2016
2146
  # The identifier of the routing profile.
@@ -2048,7 +2178,8 @@ module Aws::Connect
2048
2178
  # Deletes the specified security key.
2049
2179
  #
2050
2180
  # @option params [required, String] :instance_id
2051
- # The identifier of the Amazon Connect instance.
2181
+ # The identifier of the Amazon Connect instance. You can find the
2182
+ # instanceId in the ARN of the instance.
2052
2183
  #
2053
2184
  # @option params [required, String] :association_id
2054
2185
  # The existing association identifier that uniquely identifies the
@@ -2116,7 +2247,8 @@ module Aws::Connect
2116
2247
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
2117
2248
  #
2118
2249
  # @option params [required, String] :instance_id
2119
- # The identifier of the Amazon Connect instance.
2250
+ # The identifier of the Amazon Connect instance. You can find the
2251
+ # instanceId in the ARN of the instance.
2120
2252
  #
2121
2253
  # @option params [required, Types::Filters] :filters
2122
2254
  # The queues, up to 100, or channels, to use to filter the metrics
@@ -2306,8 +2438,18 @@ module Aws::Connect
2306
2438
 
2307
2439
  # Retrieves a token for federation.
2308
2440
  #
2441
+ # <note markdown="1"> This API doesn't support root users. If you try to invoke
2442
+ # GetFederationToken with root credentials, an error message similar to
2443
+ # the following one appears:
2444
+ #
2445
+ # `Provided identity: Principal: .... User: .... cannot be used for
2446
+ # federation with Amazon Connect`
2447
+ #
2448
+ # </note>
2449
+ #
2309
2450
  # @option params [required, String] :instance_id
2310
- # The identifier of the Amazon Connect instance.
2451
+ # The identifier of the Amazon Connect instance. You can find the
2452
+ # instanceId in the ARN of the instance.
2311
2453
  #
2312
2454
  # @return [Types::GetFederationTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2313
2455
  #
@@ -2346,7 +2488,8 @@ module Aws::Connect
2346
2488
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
2347
2489
  #
2348
2490
  # @option params [required, String] :instance_id
2349
- # The identifier of the Amazon Connect instance.
2491
+ # The identifier of the Amazon Connect instance. You can find the
2492
+ # instanceId in the ARN of the instance.
2350
2493
  #
2351
2494
  # @option params [required, Time,DateTime,Date,Integer,String] :start_time
2352
2495
  # The timestamp, in UNIX Epoch time format, at which to start the
@@ -2373,14 +2516,17 @@ module Aws::Connect
2373
2516
  # both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
2374
2517
  # TASK channels are supported.
2375
2518
  #
2519
+ # <note markdown="1"> To filter by `Queues`, enter the queue ID/ARN, not the name of the
2520
+ # queue.
2521
+ #
2522
+ # </note>
2523
+ #
2376
2524
  # @option params [Array<String>] :groupings
2377
2525
  # The grouping applied to the metrics returned. For example, when
2378
2526
  # results are grouped by queue, the metrics returned are grouped by
2379
2527
  # queue. The values returned apply to the metrics for each queue rather
2380
2528
  # than aggregated for all queues.
2381
2529
  #
2382
- # The only supported grouping is `QUEUE`.
2383
- #
2384
2530
  # If no grouping is specified, a summary of metrics for all queues is
2385
2531
  # returned.
2386
2532
  #
@@ -2390,6 +2536,11 @@ module Aws::Connect
2390
2536
  # description of each metric, see [Historical Metrics Definitions][1] in
2391
2537
  # the *Amazon Connect Administrator Guide*.
2392
2538
  #
2539
+ # <note markdown="1"> This API does not support a contacts incoming metric (there's no
2540
+ # CONTACTS\_INCOMING metric missing from the documented list).
2541
+ #
2542
+ # </note>
2543
+ #
2393
2544
  # ABANDON\_TIME
2394
2545
  #
2395
2546
  # : Unit: SECONDS
@@ -2536,13 +2687,15 @@ module Aws::Connect
2536
2687
  #
2537
2688
  # SERVICE\_LEVEL
2538
2689
  #
2539
- # : Unit: PERCENT
2690
+ # : You can include up to 20 SERVICE\_LEVEL metrics in a request.
2691
+ #
2692
+ # Unit: PERCENT
2540
2693
  #
2541
2694
  # Statistic: AVG
2542
2695
  #
2543
- # Threshold: Only "Less than" comparisons are supported, with the
2544
- # following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
2545
- # 180, 240, 300, 600
2696
+ # Threshold: For `ThresholdValue`, enter any whole number from 1 to
2697
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
2698
+ # `LT` (for "Less than").
2546
2699
  #
2547
2700
  #
2548
2701
  #
@@ -2620,7 +2773,8 @@ module Aws::Connect
2620
2773
  # instance.
2621
2774
  #
2622
2775
  # @option params [required, String] :instance_id
2623
- # The identifier of the Amazon Connect instance.
2776
+ # The identifier of the Amazon Connect instance. You can find the
2777
+ # instanceId in the ARN of the instance.
2624
2778
  #
2625
2779
  # @option params [String] :next_token
2626
2780
  # The token for the next set of results. Use the value returned in the
@@ -2660,6 +2814,60 @@ module Aws::Connect
2660
2814
  req.send_request(options)
2661
2815
  end
2662
2816
 
2817
+ # This API is in preview release for Amazon Connect and is subject to
2818
+ # change.
2819
+ #
2820
+ # For the specified version of Amazon Lex, returns a paginated list of
2821
+ # all the Amazon Lex bots currently associated with the instance.
2822
+ #
2823
+ # @option params [required, String] :instance_id
2824
+ # The identifier of the Amazon Connect instance. You can find the
2825
+ # instanceId in the ARN of the instance.
2826
+ #
2827
+ # @option params [String] :next_token
2828
+ # The token for the next set of results. Use the value returned in the
2829
+ # previous response in the next request to retrieve the next set of
2830
+ # results.
2831
+ #
2832
+ # @option params [Integer] :max_results
2833
+ # The maximum number of results to return per page.
2834
+ #
2835
+ # @option params [required, String] :lex_version
2836
+ # The version of Amazon Lex or Amazon Lex V2.
2837
+ #
2838
+ # @return [Types::ListBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2839
+ #
2840
+ # * {Types::ListBotsResponse#lex_bots #lex_bots} => Array&lt;Types::LexBotConfig&gt;
2841
+ # * {Types::ListBotsResponse#next_token #next_token} => String
2842
+ #
2843
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2844
+ #
2845
+ # @example Request syntax with placeholder values
2846
+ #
2847
+ # resp = client.list_bots({
2848
+ # instance_id: "InstanceId", # required
2849
+ # next_token: "NextToken",
2850
+ # max_results: 1,
2851
+ # lex_version: "V1", # required, accepts V1, V2
2852
+ # })
2853
+ #
2854
+ # @example Response structure
2855
+ #
2856
+ # resp.lex_bots #=> Array
2857
+ # resp.lex_bots[0].lex_bot.name #=> String
2858
+ # resp.lex_bots[0].lex_bot.lex_region #=> String
2859
+ # resp.lex_bots[0].lex_v2_bot.alias_arn #=> String
2860
+ # resp.next_token #=> String
2861
+ #
2862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListBots AWS API Documentation
2863
+ #
2864
+ # @overload list_bots(params = {})
2865
+ # @param [Hash] params ({})
2866
+ def list_bots(params = {}, options = {})
2867
+ req = build_request(:list_bots, params)
2868
+ req.send_request(options)
2869
+ end
2870
+
2663
2871
  # Provides information about the contact flows for the specified Amazon
2664
2872
  # Connect instance.
2665
2873
  #
@@ -2675,7 +2883,8 @@ module Aws::Connect
2675
2883
  # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
2676
2884
  #
2677
2885
  # @option params [required, String] :instance_id
2678
- # The identifier of the Amazon Connect instance.
2886
+ # The identifier of the Amazon Connect instance. You can find the
2887
+ # instanceId in the ARN of the instance.
2679
2888
  #
2680
2889
  # @option params [Array<String>] :contact_flow_types
2681
2890
  # The type of contact flow.
@@ -2733,7 +2942,8 @@ module Aws::Connect
2733
2942
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
2734
2943
  #
2735
2944
  # @option params [required, String] :instance_id
2736
- # The identifier of the Amazon Connect instance.
2945
+ # The identifier of the Amazon Connect instance. You can find the
2946
+ # instanceId in the ARN of the instance.
2737
2947
  #
2738
2948
  # @option params [String] :next_token
2739
2949
  # The token for the next set of results. Use the value returned in the
@@ -2782,7 +2992,8 @@ module Aws::Connect
2782
2992
  # instance.
2783
2993
  #
2784
2994
  # @option params [required, String] :instance_id
2785
- # The identifier of the Amazon Connect instance.
2995
+ # The identifier of the Amazon Connect instance. You can find the
2996
+ # instanceId in the ARN of the instance.
2786
2997
  #
2787
2998
  # @option params [String] :next_token
2788
2999
  # The token for the next set of results. Use the value returned in the
@@ -2830,7 +3041,8 @@ module Aws::Connect
2830
3041
  # instance and resource type.
2831
3042
  #
2832
3043
  # @option params [required, String] :instance_id
2833
- # The identifier of the Amazon Connect instance.
3044
+ # The identifier of the Amazon Connect instance. You can find the
3045
+ # instanceId in the ARN of the instance.
2834
3046
  #
2835
3047
  # @option params [required, String] :resource_type
2836
3048
  # A valid resource type.
@@ -2938,14 +3150,12 @@ module Aws::Connect
2938
3150
  req.send_request(options)
2939
3151
  end
2940
3152
 
2941
- # This API is in preview release for Amazon Connect and is subject to
2942
- # change.
2943
- #
2944
3153
  # Provides summary information about the AppIntegration associations for
2945
3154
  # the specified Amazon Connect instance.
2946
3155
  #
2947
3156
  # @option params [required, String] :instance_id
2948
- # The identifier of the Amazon Connect instance.
3157
+ # The identifier of the Amazon Connect instance. You can find the
3158
+ # instanceId in the ARN of the instance.
2949
3159
  #
2950
3160
  # @option params [String] :next_token
2951
3161
  # The token for the next set of results. Use the value returned in the
@@ -2999,7 +3209,8 @@ module Aws::Connect
2999
3209
  # dropdown options in the relevant contact flow blocks.
3000
3210
  #
3001
3211
  # @option params [required, String] :instance_id
3002
- # The identifier of the Amazon Connect instance.
3212
+ # The identifier of the Amazon Connect instance. You can find the
3213
+ # instanceId in the ARN of the instance.
3003
3214
  #
3004
3215
  # @option params [String] :next_token
3005
3216
  # The token for the next set of results. Use the value returned in the
@@ -3046,7 +3257,8 @@ module Aws::Connect
3046
3257
  # associated with the instance.
3047
3258
  #
3048
3259
  # @option params [required, String] :instance_id
3049
- # The identifier of the Amazon Connect instance.
3260
+ # The identifier of the Amazon Connect instance. You can find the
3261
+ # instanceId in the ARN of the instance.
3050
3262
  #
3051
3263
  # @option params [String] :next_token
3052
3264
  # The token for the next set of results. Use the value returned in the
@@ -3099,7 +3311,8 @@ module Aws::Connect
3099
3311
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
3100
3312
  #
3101
3313
  # @option params [required, String] :instance_id
3102
- # The identifier of the Amazon Connect instance.
3314
+ # The identifier of the Amazon Connect instance. You can find the
3315
+ # instanceId in the ARN of the instance.
3103
3316
  #
3104
3317
  # @option params [Array<String>] :phone_number_types
3105
3318
  # The type of phone number.
@@ -3203,7 +3416,8 @@ module Aws::Connect
3203
3416
  # Lists the quick connects associated with a queue.
3204
3417
  #
3205
3418
  # @option params [required, String] :instance_id
3206
- # The identifier of the Amazon Connect instance.
3419
+ # The identifier of the Amazon Connect instance. You can find the
3420
+ # instanceId in the ARN of the instance.
3207
3421
  #
3208
3422
  # @option params [required, String] :queue_id
3209
3423
  # The identifier for the queue.
@@ -3253,6 +3467,11 @@ module Aws::Connect
3253
3467
  # Provides information about the queues for the specified Amazon Connect
3254
3468
  # instance.
3255
3469
  #
3470
+ # If you do not specify a `QueueTypes` parameter, both standard and
3471
+ # agent queues are returned. This might cause an unexpected truncation
3472
+ # of results if you have more than 1000 agents and you limit the number
3473
+ # of results of the API call in code.
3474
+ #
3256
3475
  # For more information about queues, see [Queues: Standard and Agent][1]
3257
3476
  # in the *Amazon Connect Administrator Guide*.
3258
3477
  #
@@ -3261,7 +3480,8 @@ module Aws::Connect
3261
3480
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
3262
3481
  #
3263
3482
  # @option params [required, String] :instance_id
3264
- # The identifier of the Amazon Connect instance.
3483
+ # The identifier of the Amazon Connect instance. You can find the
3484
+ # instanceId in the ARN of the instance.
3265
3485
  #
3266
3486
  # @option params [Array<String>] :queue_types
3267
3487
  # The type of queue.
@@ -3315,7 +3535,8 @@ module Aws::Connect
3315
3535
  # Connect instance.
3316
3536
  #
3317
3537
  # @option params [required, String] :instance_id
3318
- # The identifier of the Amazon Connect instance.
3538
+ # The identifier of the Amazon Connect instance. You can find the
3539
+ # instanceId in the ARN of the instance.
3319
3540
  #
3320
3541
  # @option params [String] :next_token
3321
3542
  # The token for the next set of results. Use the value returned in the
@@ -3368,7 +3589,8 @@ module Aws::Connect
3368
3589
  # Lists the queues associated with a routing profile.
3369
3590
  #
3370
3591
  # @option params [required, String] :instance_id
3371
- # The identifier of the Amazon Connect instance.
3592
+ # The identifier of the Amazon Connect instance. You can find the
3593
+ # instanceId in the ARN of the instance.
3372
3594
  #
3373
3595
  # @option params [required, String] :routing_profile_id
3374
3596
  # The identifier of the routing profile.
@@ -3430,7 +3652,8 @@ module Aws::Connect
3430
3652
  # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
3431
3653
  #
3432
3654
  # @option params [required, String] :instance_id
3433
- # The identifier of the Amazon Connect instance.
3655
+ # The identifier of the Amazon Connect instance. You can find the
3656
+ # instanceId in the ARN of the instance.
3434
3657
  #
3435
3658
  # @option params [String] :next_token
3436
3659
  # The token for the next set of results. Use the value returned in the
@@ -3479,7 +3702,8 @@ module Aws::Connect
3479
3702
  # instance.
3480
3703
  #
3481
3704
  # @option params [required, String] :instance_id
3482
- # The identifier of the Amazon Connect instance.
3705
+ # The identifier of the Amazon Connect instance. You can find the
3706
+ # instanceId in the ARN of the instance.
3483
3707
  #
3484
3708
  # @option params [String] :next_token
3485
3709
  # The token for the next set of results. Use the value returned in the
@@ -3532,7 +3756,8 @@ module Aws::Connect
3532
3756
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
3533
3757
  #
3534
3758
  # @option params [required, String] :instance_id
3535
- # The identifier of the Amazon Connect instance.
3759
+ # The identifier of the Amazon Connect instance. You can find the
3760
+ # instanceId in the ARN of the instance.
3536
3761
  #
3537
3762
  # @option params [String] :next_token
3538
3763
  # The token for the next set of results. Use the value returned in the
@@ -3610,13 +3835,11 @@ module Aws::Connect
3610
3835
  req.send_request(options)
3611
3836
  end
3612
3837
 
3613
- # This API is in preview release for Amazon Connect and is subject to
3614
- # change.
3615
- #
3616
3838
  # Lists the use cases.
3617
3839
  #
3618
3840
  # @option params [required, String] :instance_id
3619
- # The identifier of the Amazon Connect instance.
3841
+ # The identifier of the Amazon Connect instance. You can find the
3842
+ # instanceId in the ARN of the instance.
3620
3843
  #
3621
3844
  # @option params [required, String] :integration_association_id
3622
3845
  # The identifier for the integration association.
@@ -3673,7 +3896,8 @@ module Aws::Connect
3673
3896
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
3674
3897
  #
3675
3898
  # @option params [required, String] :instance_id
3676
- # The identifier of the Amazon Connect instance.
3899
+ # The identifier of the Amazon Connect instance. You can find the
3900
+ # instanceId in the ARN of the instance.
3677
3901
  #
3678
3902
  # @option params [String] :next_token
3679
3903
  # The token for the next set of results. Use the value returned in the
@@ -3719,7 +3943,8 @@ module Aws::Connect
3719
3943
  # Connect instance.
3720
3944
  #
3721
3945
  # @option params [required, String] :instance_id
3722
- # The identifier of the Amazon Connect instance.
3946
+ # The identifier of the Amazon Connect instance. You can find the
3947
+ # instanceId in the ARN of the instance.
3723
3948
  #
3724
3949
  # @option params [String] :next_token
3725
3950
  # The token for the next set of results. Use the value returned in the
@@ -3767,7 +3992,8 @@ module Aws::Connect
3767
3992
  # Only voice recordings are supported at this time.
3768
3993
  #
3769
3994
  # @option params [required, String] :instance_id
3770
- # The identifier of the Amazon Connect instance.
3995
+ # The identifier of the Amazon Connect instance. You can find the
3996
+ # instanceId in the ARN of the instance.
3771
3997
  #
3772
3998
  # @option params [required, String] :contact_id
3773
3999
  # The identifier of the contact.
@@ -3809,7 +4035,7 @@ module Aws::Connect
3809
4035
  # A 429 error occurs in two situations:
3810
4036
  #
3811
4037
  # * API rate limit is exceeded. API TPS throttling returns a
3812
- # `TooManyRequests` exception from the API Gateway.
4038
+ # `TooManyRequests` exception.
3813
4039
  #
3814
4040
  # * The [quota for concurrent active chats][2] is exceeded. Active chat
3815
4041
  # throttling returns a `LimitExceededException`.
@@ -3824,7 +4050,8 @@ module Aws::Connect
3824
4050
  # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
3825
4051
  #
3826
4052
  # @option params [required, String] :instance_id
3827
- # The identifier of the Amazon Connect instance.
4053
+ # The identifier of the Amazon Connect instance. You can find the
4054
+ # instanceId in the ARN of the instance.
3828
4055
  #
3829
4056
  # @option params [required, String] :contact_flow_id
3830
4057
  # The identifier of the contact flow for initiating the chat. To see the
@@ -3915,7 +4142,8 @@ module Aws::Connect
3915
4142
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html
3916
4143
  #
3917
4144
  # @option params [required, String] :instance_id
3918
- # The identifier of the Amazon Connect instance.
4145
+ # The identifier of the Amazon Connect instance. You can find the
4146
+ # instanceId in the ARN of the instance.
3919
4147
  #
3920
4148
  # @option params [required, String] :contact_id
3921
4149
  # The identifier of the contact.
@@ -3986,13 +4214,13 @@ module Aws::Connect
3986
4214
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
3987
4215
  #
3988
4216
  # @option params [required, String] :instance_id
3989
- # The identifier of the Amazon Connect instance.
4217
+ # The identifier of the Amazon Connect instance. You can find the
4218
+ # instanceId in the ARN of the instance.
3990
4219
  #
3991
4220
  # @option params [String] :client_token
3992
4221
  # A unique, case-sensitive identifier that you provide to ensure the
3993
4222
  # idempotency of the request. The token is valid for 7 days after
3994
4223
  # creation. If a contact is already started, the contact ID is returned.
3995
- # If the contact is disconnected, a new contact is started.
3996
4224
  #
3997
4225
  # **A suitable default value is auto-generated.** You should normally
3998
4226
  # not need to pass this option.**
@@ -4051,7 +4279,8 @@ module Aws::Connect
4051
4279
  # Initiates a contact flow to start a new task.
4052
4280
  #
4053
4281
  # @option params [required, String] :instance_id
4054
- # The identifier of the Amazon Connect instance.
4282
+ # The identifier of the Amazon Connect instance. You can find the
4283
+ # instanceId in the ARN of the instance.
4055
4284
  #
4056
4285
  # @option params [String] :previous_contact_id
4057
4286
  # The identifier of the previous chat, voice, or task contact.
@@ -4137,7 +4366,8 @@ module Aws::Connect
4137
4366
  # The ID of the contact.
4138
4367
  #
4139
4368
  # @option params [required, String] :instance_id
4140
- # The identifier of the Amazon Connect instance.
4369
+ # The identifier of the Amazon Connect instance. You can find the
4370
+ # instanceId in the ARN of the instance.
4141
4371
  #
4142
4372
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4143
4373
  #
@@ -4168,7 +4398,8 @@ module Aws::Connect
4168
4398
  # Only voice recordings are supported at this time.
4169
4399
  #
4170
4400
  # @option params [required, String] :instance_id
4171
- # The identifier of the Amazon Connect instance.
4401
+ # The identifier of the Amazon Connect instance. You can find the
4402
+ # instanceId in the ARN of the instance.
4172
4403
  #
4173
4404
  # @option params [required, String] :contact_id
4174
4405
  # The identifier of the contact.
@@ -4207,7 +4438,8 @@ module Aws::Connect
4207
4438
  # Only voice recordings are supported at this time.
4208
4439
  #
4209
4440
  # @option params [required, String] :instance_id
4210
- # The identifier of the Amazon Connect instance.
4441
+ # The identifier of the Amazon Connect instance. You can find the
4442
+ # instanceId in the ARN of the instance.
4211
4443
  #
4212
4444
  # @option params [required, String] :contact_id
4213
4445
  # The identifier of the contact.
@@ -4300,21 +4532,23 @@ module Aws::Connect
4300
4532
  req.send_request(options)
4301
4533
  end
4302
4534
 
4303
- # Creates or updates the contact attributes associated with the
4535
+ # Creates or updates user-defined contact attributes associated with the
4304
4536
  # specified contact.
4305
4537
  #
4306
- # You can add or update attributes for both ongoing and completed
4307
- # contacts. For example, while the call is active, you can update the
4308
- # customer's name or the reason the customer called. You can add notes
4309
- # about steps that the agent took during the call that display to the
4310
- # next agent that takes the call. You can also update attributes for a
4311
- # contact using data from your CRM application and save the data with
4312
- # the contact in Amazon Connect. You could also flag calls for
4538
+ # You can create or update user-defined attributes for both ongoing and
4539
+ # completed contacts. For example, while the call is active, you can
4540
+ # update the customer's name or the reason the customer called. You can
4541
+ # add notes about steps that the agent took during the call that display
4542
+ # to the next agent that takes the call. You can also update attributes
4543
+ # for a contact using data from your CRM application and save the data
4544
+ # with the contact in Amazon Connect. You could also flag calls for
4313
4545
  # additional analysis, such as legal review or to identify abusive
4314
4546
  # callers.
4315
4547
  #
4316
4548
  # Contact attributes are available in Amazon Connect for 24 months, and
4317
- # are then deleted.
4549
+ # are then deleted. For information about CTR retention and the maximum
4550
+ # size of the CTR attributes section, see [Feature specifications][1] in
4551
+ # the *Amazon Connect Administrator Guide*.
4318
4552
  #
4319
4553
  # **Important:** You cannot use the operation to update attributes for
4320
4554
  # contacts that occurred prior to the release of the API, which was
@@ -4325,12 +4559,17 @@ module Aws::Connect
4325
4559
  # that were initiated prior to the release of the API but are still
4326
4560
  # active in your instance.
4327
4561
  #
4562
+ #
4563
+ #
4564
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
4565
+ #
4328
4566
  # @option params [required, String] :initial_contact_id
4329
4567
  # The identifier of the contact. This is the identifier of the contact
4330
4568
  # associated with the first interaction with the contact center.
4331
4569
  #
4332
4570
  # @option params [required, String] :instance_id
4333
- # The identifier of the Amazon Connect instance.
4571
+ # The identifier of the Amazon Connect instance. You can find the
4572
+ # instanceId in the ARN of the instance.
4334
4573
  #
4335
4574
  # @option params [required, Hash<String,String>] :attributes
4336
4575
  # The Amazon Connect attributes. These attributes can be accessed in
@@ -4451,7 +4690,8 @@ module Aws::Connect
4451
4690
  # Updates the value for the specified attribute type.
4452
4691
  #
4453
4692
  # @option params [required, String] :instance_id
4454
- # The identifier of the Amazon Connect instance.
4693
+ # The identifier of the Amazon Connect instance. You can find the
4694
+ # instanceId in the ARN of the instance.
4455
4695
  #
4456
4696
  # @option params [required, String] :attribute_type
4457
4697
  # The type of attribute.
@@ -4485,7 +4725,8 @@ module Aws::Connect
4485
4725
  # idempotent.
4486
4726
  #
4487
4727
  # @option params [required, String] :instance_id
4488
- # The identifier of the Amazon Connect instance.
4728
+ # The identifier of the Amazon Connect instance. You can find the
4729
+ # instanceId in the ARN of the instance.
4489
4730
  #
4490
4731
  # @option params [required, String] :association_id
4491
4732
  # The existing association identifier that uniquely identifies the
@@ -4548,7 +4789,8 @@ module Aws::Connect
4548
4789
  # Updates the hours of operation for the specified queue.
4549
4790
  #
4550
4791
  # @option params [required, String] :instance_id
4551
- # The identifier of the Amazon Connect instance.
4792
+ # The identifier of the Amazon Connect instance. You can find the
4793
+ # instanceId in the ARN of the instance.
4552
4794
  #
4553
4795
  # @option params [required, String] :queue_id
4554
4796
  # The identifier for the queue.
@@ -4582,12 +4824,13 @@ module Aws::Connect
4582
4824
  # considered full.
4583
4825
  #
4584
4826
  # @option params [required, String] :instance_id
4585
- # The identifier of the Amazon Connect instance.
4827
+ # The identifier of the Amazon Connect instance. You can find the
4828
+ # instanceId in the ARN of the instance.
4586
4829
  #
4587
4830
  # @option params [required, String] :queue_id
4588
4831
  # The identifier for the queue.
4589
4832
  #
4590
- # @option params [required, Integer] :max_contacts
4833
+ # @option params [Integer] :max_contacts
4591
4834
  # The maximum number of contacts that can be in the queue before it is
4592
4835
  # considered full.
4593
4836
  #
@@ -4598,7 +4841,7 @@ module Aws::Connect
4598
4841
  # resp = client.update_queue_max_contacts({
4599
4842
  # instance_id: "InstanceId", # required
4600
4843
  # queue_id: "QueueId", # required
4601
- # max_contacts: 1, # required
4844
+ # max_contacts: 1,
4602
4845
  # })
4603
4846
  #
4604
4847
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueMaxContacts AWS API Documentation
@@ -4617,7 +4860,8 @@ module Aws::Connect
4617
4860
  # `Description` must be provided.
4618
4861
  #
4619
4862
  # @option params [required, String] :instance_id
4620
- # The identifier of the Amazon Connect instance.
4863
+ # The identifier of the Amazon Connect instance. You can find the
4864
+ # instanceId in the ARN of the instance.
4621
4865
  #
4622
4866
  # @option params [required, String] :queue_id
4623
4867
  # The identifier for the queue.
@@ -4655,7 +4899,8 @@ module Aws::Connect
4655
4899
  # for a specified queue.
4656
4900
  #
4657
4901
  # @option params [required, String] :instance_id
4658
- # The identifier of the Amazon Connect instance.
4902
+ # The identifier of the Amazon Connect instance. You can find the
4903
+ # instanceId in the ARN of the instance.
4659
4904
  #
4660
4905
  # @option params [required, String] :queue_id
4661
4906
  # The identifier for the queue.
@@ -4692,7 +4937,8 @@ module Aws::Connect
4692
4937
  # Updates the status of the queue.
4693
4938
  #
4694
4939
  # @option params [required, String] :instance_id
4695
- # The identifier of the Amazon Connect instance.
4940
+ # The identifier of the Amazon Connect instance. You can find the
4941
+ # instanceId in the ARN of the instance.
4696
4942
  #
4697
4943
  # @option params [required, String] :queue_id
4698
4944
  # The identifier for the queue.
@@ -4725,7 +4971,8 @@ module Aws::Connect
4725
4971
  # Updates the configuration settings for the specified quick connect.
4726
4972
  #
4727
4973
  # @option params [required, String] :instance_id
4728
- # The identifier of the Amazon Connect instance.
4974
+ # The identifier of the Amazon Connect instance. You can find the
4975
+ # instanceId in the ARN of the instance.
4729
4976
  #
4730
4977
  # @option params [required, String] :quick_connect_id
4731
4978
  # The identifier for the quick connect.
@@ -4773,7 +5020,8 @@ module Aws::Connect
4773
5020
  # `Description` must be provided.
4774
5021
  #
4775
5022
  # @option params [required, String] :instance_id
4776
- # The identifier of the Amazon Connect instance.
5023
+ # The identifier of the Amazon Connect instance. You can find the
5024
+ # instanceId in the ARN of the instance.
4777
5025
  #
4778
5026
  # @option params [required, String] :quick_connect_id
4779
5027
  # The identifier for the quick connect.
@@ -4808,7 +5056,8 @@ module Aws::Connect
4808
5056
  # Panel (CCP) for a routing profile.
4809
5057
  #
4810
5058
  # @option params [required, String] :instance_id
4811
- # The identifier of the Amazon Connect instance.
5059
+ # The identifier of the Amazon Connect instance. You can find the
5060
+ # instanceId in the ARN of the instance.
4812
5061
  #
4813
5062
  # @option params [required, String] :routing_profile_id
4814
5063
  # The identifier of the routing profile.
@@ -4844,7 +5093,8 @@ module Aws::Connect
4844
5093
  # Updates the default outbound queue of a routing profile.
4845
5094
  #
4846
5095
  # @option params [required, String] :instance_id
4847
- # The identifier of the Amazon Connect instance.
5096
+ # The identifier of the Amazon Connect instance. You can find the
5097
+ # instanceId in the ARN of the instance.
4848
5098
  #
4849
5099
  # @option params [required, String] :routing_profile_id
4850
5100
  # The identifier of the routing profile.
@@ -4876,7 +5126,8 @@ module Aws::Connect
4876
5126
  # `Description` must be provided.
4877
5127
  #
4878
5128
  # @option params [required, String] :instance_id
4879
- # The identifier of the Amazon Connect instance.
5129
+ # The identifier of the Amazon Connect instance. You can find the
5130
+ # instanceId in the ARN of the instance.
4880
5131
  #
4881
5132
  # @option params [required, String] :routing_profile_id
4882
5133
  # The identifier of the routing profile.
@@ -4912,7 +5163,8 @@ module Aws::Connect
4912
5163
  # profile.
4913
5164
  #
4914
5165
  # @option params [required, String] :instance_id
4915
- # The identifier of the Amazon Connect instance.
5166
+ # The identifier of the Amazon Connect instance. You can find the
5167
+ # instanceId in the ARN of the instance.
4916
5168
  #
4917
5169
  # @option params [required, String] :routing_profile_id
4918
5170
  # The identifier of the routing profile.
@@ -4959,7 +5211,8 @@ module Aws::Connect
4959
5211
  # The identifier of the user account.
4960
5212
  #
4961
5213
  # @option params [required, String] :instance_id
4962
- # The identifier of the Amazon Connect instance.
5214
+ # The identifier of the Amazon Connect instance. You can find the
5215
+ # instanceId in the ARN of the instance.
4963
5216
  #
4964
5217
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4965
5218
  #
@@ -4989,7 +5242,8 @@ module Aws::Connect
4989
5242
  # The identifier of the hierarchy group.
4990
5243
  #
4991
5244
  # @option params [required, String] :instance_id
4992
- # The identifier of the Amazon Connect instance.
5245
+ # The identifier of the Amazon Connect instance. You can find the
5246
+ # instanceId in the ARN of the instance.
4993
5247
  #
4994
5248
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4995
5249
  #
@@ -5017,7 +5271,8 @@ module Aws::Connect
5017
5271
  # The hierarchy levels to update.
5018
5272
  #
5019
5273
  # @option params [required, String] :instance_id
5020
- # The identifier of the Amazon Connect instance.
5274
+ # The identifier of the Amazon Connect instance. You can find the
5275
+ # instanceId in the ARN of the instance.
5021
5276
  #
5022
5277
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5023
5278
  #
@@ -5074,7 +5329,8 @@ module Aws::Connect
5074
5329
  # The identifier of the user account.
5075
5330
  #
5076
5331
  # @option params [required, String] :instance_id
5077
- # The identifier of the Amazon Connect instance.
5332
+ # The identifier of the Amazon Connect instance. You can find the
5333
+ # instanceId in the ARN of the instance.
5078
5334
  #
5079
5335
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5080
5336
  #
@@ -5108,7 +5364,8 @@ module Aws::Connect
5108
5364
  # The identifier of the user account.
5109
5365
  #
5110
5366
  # @option params [required, String] :instance_id
5111
- # The identifier of the Amazon Connect instance.
5367
+ # The identifier of the Amazon Connect instance. You can find the
5368
+ # instanceId in the ARN of the instance.
5112
5369
  #
5113
5370
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5114
5371
  #
@@ -5143,7 +5400,8 @@ module Aws::Connect
5143
5400
  # The identifier of the user account.
5144
5401
  #
5145
5402
  # @option params [required, String] :instance_id
5146
- # The identifier of the Amazon Connect instance.
5403
+ # The identifier of the Amazon Connect instance. You can find the
5404
+ # instanceId in the ARN of the instance.
5147
5405
  #
5148
5406
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5149
5407
  #
@@ -5173,7 +5431,8 @@ module Aws::Connect
5173
5431
  # The identifier of the user account.
5174
5432
  #
5175
5433
  # @option params [required, String] :instance_id
5176
- # The identifier of the Amazon Connect instance.
5434
+ # The identifier of the Amazon Connect instance. You can find the
5435
+ # instanceId in the ARN of the instance.
5177
5436
  #
5178
5437
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5179
5438
  #
@@ -5207,7 +5466,7 @@ module Aws::Connect
5207
5466
  params: params,
5208
5467
  config: config)
5209
5468
  context[:gem_name] = 'aws-sdk-connect'
5210
- context[:gem_version] = '1.40.0'
5469
+ context[:gem_version] = '1.45.0'
5211
5470
  Seahorse::Client::Request.new(handlers, context)
5212
5471
  end
5213
5472