aws-sdk-connect 1.27.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 40113a8d40fd591d8df59a811bb76175bfa838628ff89665e154deadc17305fd
4
- data.tar.gz: 3ef243fd2bbf2328c7a49626d4bc40804ca16ee4eca90ab8cf61e6c941425303
3
+ metadata.gz: 2e51963ae36aaa856591c95e38141c4508ce2c3220dd20f4374c932f1f792d5f
4
+ data.tar.gz: c2a9093ce23e3d16a91a71a9f7468a8d22c7d77ac3a5c1b8fd8eb8a1ef575626
5
5
  SHA512:
6
- metadata.gz: 52328f8059bb069aba009a945464f706245a7836d7cde4d6a62f6f6cbb14ca9d73eb736dcf0f47cfda4bd74a6c7a1001e11f62706d2b9607da329065346ce546
7
- data.tar.gz: 11256b7937c0ec8ac8cd8e4e2596233be8ac5b4563dca7c64b530ac779067b2a4800665ad59d65c8109a7087212abd354824a40216b478e21cca03130d10911e
6
+ metadata.gz: 53af5d10d95bfa7be88c0224ef5a74da6d48b3b25224011aaa6ca80d8bade02ea54bf981bcf980c4d55768ee363a759e31a01a3f17495367e6e4fcf6d14b2e9b
7
+ data.tar.gz: 929e73d5520e082029d6fb8d08450a4ab68f701a443921029474d899f7fc2b16b2bd5ab9ba7d3364f8546fe25de80f112c052aaaa54700696d9f07da7b098212
@@ -47,6 +47,6 @@ require_relative 'aws-sdk-connect/customizations'
47
47
  # @service
48
48
  module Aws::Connect
49
49
 
50
- GEM_VERSION = '1.27.0'
50
+ GEM_VERSION = '1.28.0'
51
51
 
52
52
  end
@@ -314,6 +314,14 @@ module Aws::Connect
314
314
 
315
315
  # Creates a user account for the specified Amazon Connect instance.
316
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
+ #
317
325
  # @option params [required, String] :username
318
326
  # The user name for the account. For instances not using SAML for
319
327
  # identity management, the user name can include up to 20 characters. If
@@ -406,6 +414,14 @@ module Aws::Connect
406
414
 
407
415
  # Deletes a user account from the specified Amazon Connect instance.
408
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
+ #
409
425
  # @option params [required, String] :instance_id
410
426
  # The identifier of the Amazon Connect instance.
411
427
  #
@@ -610,12 +626,12 @@ module Aws::Connect
610
626
  # Gets the real-time metric data from the specified Amazon Connect
611
627
  # instance.
612
628
  #
613
- # For more information, see [Real-time Metrics Reports][1] in the
614
- # *Amazon Connect Administrator Guide*.
629
+ # For a description of each metric, see [Real-time Metrics
630
+ # Definitions][1] in the *Amazon Connect Administrator Guide*.
615
631
  #
616
632
  #
617
633
  #
618
- # [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
619
635
  #
620
636
  # @option params [required, String] :instance_id
621
637
  # The identifier of the Amazon Connect instance.
@@ -638,60 +654,112 @@ module Aws::Connect
638
654
  #
639
655
  # @option params [required, Array<Types::CurrentMetric>] :current_metrics
640
656
  # The metrics to retrieve. Specify the name and unit for each metric.
641
- # 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*.
642
660
  #
643
661
  # AGENTS\_AFTER\_CONTACT\_WORK
644
662
  #
645
663
  # : Unit: COUNT
646
664
  #
665
+ # Name in real-time metrics report: [ACW][2]
666
+ #
647
667
  # AGENTS\_AVAILABLE
648
668
  #
649
669
  # : Unit: COUNT
650
670
  #
671
+ # Name in real-time metrics report: [Available][3]
672
+ #
651
673
  # AGENTS\_ERROR
652
674
  #
653
675
  # : Unit: COUNT
654
676
  #
677
+ # Name in real-time metrics report: [Error][4]
678
+ #
655
679
  # AGENTS\_NON\_PRODUCTIVE
656
680
  #
657
681
  # : Unit: COUNT
658
682
  #
683
+ # Name in real-time metrics report: [NPT (Non-Productive Time)][5]
684
+ #
659
685
  # AGENTS\_ON\_CALL
660
686
  #
661
687
  # : Unit: COUNT
662
688
  #
689
+ # Name in real-time metrics report: [On contact][6]
690
+ #
663
691
  # AGENTS\_ON\_CONTACT
664
692
  #
665
693
  # : Unit: COUNT
666
694
  #
695
+ # Name in real-time metrics report: [On contact][6]
696
+ #
667
697
  # AGENTS\_ONLINE
668
698
  #
669
699
  # : Unit: COUNT
670
700
  #
701
+ # Name in real-time metrics report: [Online][7]
702
+ #
671
703
  # AGENTS\_STAFFED
672
704
  #
673
705
  # : Unit: COUNT
674
706
  #
707
+ # Name in real-time metrics report: [Staffed][8]
708
+ #
675
709
  # CONTACTS\_IN\_QUEUE
676
710
  #
677
711
  # : Unit: COUNT
678
712
  #
713
+ # Name in real-time metrics report: [In queue][9]
714
+ #
679
715
  # CONTACTS\_SCHEDULED
680
716
  #
681
717
  # : Unit: COUNT
682
718
  #
719
+ # Name in real-time metrics report: [Scheduled][10]
720
+ #
683
721
  # OLDEST\_CONTACT\_AGE
684
722
  #
685
723
  # : Unit: SECONDS
686
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
+ #
687
735
  # SLOTS\_ACTIVE
688
736
  #
689
737
  # : Unit: COUNT
690
738
  #
739
+ # Name in real-time metrics report: [Active][12]
740
+ #
691
741
  # SLOTS\_AVAILABLE
692
742
  #
693
743
  # : Unit: COUNT
694
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
+ #
695
763
  # @option params [String] :next_token
696
764
  # The token for the next set of results. Use the value returned in the
697
765
  # previous response in the next request to retrieve the next set of
@@ -787,12 +855,12 @@ module Aws::Connect
787
855
  # Gets historical metric data from the specified Amazon Connect
788
856
  # instance.
789
857
  #
790
- # For more information, see [Historical Metrics Reports][1] in the
791
- # *Amazon Connect Administrator Guide*.
858
+ # For a description of each historical metric, see [Historical Metrics
859
+ # Definitions][1] in the *Amazon Connect Administrator Guide*.
792
860
  #
793
861
  #
794
862
  #
795
- # [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
796
864
  #
797
865
  # @option params [required, String] :instance_id
798
866
  # The identifier of the Amazon Connect instance.
@@ -835,7 +903,9 @@ module Aws::Connect
835
903
  #
836
904
  # @option params [required, Array<Types::HistoricalMetric>] :historical_metrics
837
905
  # The metrics to retrieve. Specify the name, unit, and statistic for
838
- # 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*.
839
909
  #
840
910
  # ABANDON\_TIME
841
911
  #
@@ -991,6 +1061,10 @@ module Aws::Connect
991
1061
  # following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
992
1062
  # 180, 240, 300, 600
993
1063
  #
1064
+ #
1065
+ #
1066
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
1067
+ #
994
1068
  # @option params [String] :next_token
995
1069
  # The token for the next set of results. Use the value returned in the
996
1070
  # previous response in the next request to retrieve the next set of
@@ -1059,6 +1133,13 @@ module Aws::Connect
1059
1133
  # Provides information about the contact flows for the specified Amazon
1060
1134
  # Connect instance.
1061
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
+ #
1062
1143
  # @option params [required, String] :instance_id
1063
1144
  # The identifier of the Amazon Connect instance.
1064
1145
  #
@@ -1110,6 +1191,13 @@ module Aws::Connect
1110
1191
  # Provides information about the hours of operation for the specified
1111
1192
  # Amazon Connect instance.
1112
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
+ #
1113
1201
  # @option params [required, String] :instance_id
1114
1202
  # The identifier of the Amazon Connect instance.
1115
1203
  #
@@ -1156,6 +1244,14 @@ module Aws::Connect
1156
1244
  # Provides information about the phone numbers for the specified Amazon
1157
1245
  # Connect instance.
1158
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
+ #
1159
1255
  # @option params [required, String] :instance_id
1160
1256
  # The identifier of the Amazon Connect instance.
1161
1257
  #
@@ -1212,6 +1308,13 @@ module Aws::Connect
1212
1308
  # Provides information about the queues for the specified Amazon Connect
1213
1309
  # instance.
1214
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
+ #
1215
1318
  # @option params [required, String] :instance_id
1216
1319
  # The identifier of the Amazon Connect instance.
1217
1320
  #
@@ -1263,6 +1366,15 @@ module Aws::Connect
1263
1366
  # Provides summary information about the routing profiles for the
1264
1367
  # specified Amazon Connect instance.
1265
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
+ #
1266
1378
  # @option params [required, String] :instance_id
1267
1379
  # The identifier of the Amazon Connect instance.
1268
1380
  #
@@ -1309,6 +1421,13 @@ module Aws::Connect
1309
1421
  # Provides summary information about the security profiles for the
1310
1422
  # specified Amazon Connect instance.
1311
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
+ #
1312
1431
  # @option params [required, String] :instance_id
1313
1432
  # The identifier of the Amazon Connect instance.
1314
1433
  #
@@ -1354,6 +1473,13 @@ module Aws::Connect
1354
1473
 
1355
1474
  # Lists the tags for the specified resource.
1356
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
+ #
1357
1483
  # @option params [required, String] :resource_arn
1358
1484
  # The Amazon Resource Name (ARN) of the resource.
1359
1485
  #
@@ -1384,6 +1510,13 @@ module Aws::Connect
1384
1510
  # Provides summary information about the hierarchy groups for the
1385
1511
  # specified Amazon Connect instance.
1386
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
+ #
1387
1520
  # @option params [required, String] :instance_id
1388
1521
  # The identifier of the Amazon Connect instance.
1389
1522
  #
@@ -1484,15 +1617,35 @@ module Aws::Connect
1484
1617
  # [CreateParticipantConnection][1] with WEBSOCKET and
1485
1618
  # CONNECTION\_CREDENTIALS.
1486
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
+ #
1487
1631
  #
1488
1632
  #
1489
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
1490
1636
  #
1491
1637
  # @option params [required, String] :instance_id
1492
1638
  # The identifier of the Amazon Connect instance.
1493
1639
  #
1494
1640
  # @option params [required, String] :contact_flow_id
1495
- # 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**
1496
1649
  #
1497
1650
  # @option params [Hash<String,String>] :attributes
1498
1651
  # A custom key-value pair using an attribute map. The attributes are
@@ -1555,16 +1708,41 @@ module Aws::Connect
1555
1708
  req.send_request(options)
1556
1709
  end
1557
1710
 
1558
- # 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.
1559
1719
  #
1560
1720
  # There is a 60 second dialing timeout for this operation. If the call
1561
1721
  # is not connected after 60 seconds, it fails.
1562
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
+ #
1563
1734
  # @option params [required, String] :destination_phone_number
1564
1735
  # The phone number of the customer, in E.164 format.
1565
1736
  #
1566
1737
  # @option params [required, String] :contact_flow_id
1567
- # 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**
1568
1746
  #
1569
1747
  # @option params [required, String] :instance_id
1570
1748
  # The identifier of the Amazon Connect instance.
@@ -1659,6 +1837,13 @@ module Aws::Connect
1659
1837
  #
1660
1838
  # The supported resource type is users.
1661
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
+ #
1662
1847
  # @option params [required, String] :resource_arn
1663
1848
  # The Amazon Resource Name (ARN) of the resource.
1664
1849
  #
@@ -1804,6 +1989,19 @@ module Aws::Connect
1804
1989
 
1805
1990
  # Updates the identity information for the specified user.
1806
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
+ #
1807
2005
  # @option params [required, Types::UserIdentityInfo] :identity_info
1808
2006
  # The identity information for the user.
1809
2007
  #
@@ -1944,7 +2142,7 @@ module Aws::Connect
1944
2142
  params: params,
1945
2143
  config: config)
1946
2144
  context[:gem_name] = 'aws-sdk-connect'
1947
- context[:gem_version] = '1.27.0'
2145
+ context[:gem_version] = '1.28.0'
1948
2146
  Seahorse::Client::Request.new(handlers, context)
1949
2147
  end
1950
2148
 
@@ -229,7 +229,13 @@ module Aws::Connect
229
229
  include Aws::Structure
230
230
  end
231
231
 
232
- # Contains information about a real-time metric.
232
+ # Contains information about a real-time metric. For a description of
233
+ # each metric, see [Real-time Metrics Definitions][1] in the *Amazon
234
+ # Connect Administrator Guide*.
235
+ #
236
+ #
237
+ #
238
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
233
239
  #
234
240
  # @note When making an API call, you may pass CurrentMetric
235
241
  # data as a hash:
@@ -580,59 +586,112 @@ module Aws::Connect
580
586
  #
581
587
  # @!attribute [rw] current_metrics
582
588
  # The metrics to retrieve. Specify the name and unit for each metric.
583
- # The following metrics are available:
589
+ # The following metrics are available. For a description of all the
590
+ # metrics, see [Real-time Metrics Definitions][1] in the *Amazon
591
+ # Connect Administrator Guide*.
584
592
  #
585
593
  # AGENTS\_AFTER\_CONTACT\_WORK
586
594
  #
587
595
  # : Unit: COUNT
588
596
  #
597
+ # Name in real-time metrics report: [ACW][2]
598
+ #
589
599
  # AGENTS\_AVAILABLE
590
600
  #
591
601
  # : Unit: COUNT
592
602
  #
603
+ # Name in real-time metrics report: [Available][3]
604
+ #
593
605
  # AGENTS\_ERROR
594
606
  #
595
607
  # : Unit: COUNT
596
608
  #
609
+ # Name in real-time metrics report: [Error][4]
610
+ #
597
611
  # AGENTS\_NON\_PRODUCTIVE
598
612
  #
599
613
  # : Unit: COUNT
600
614
  #
615
+ # Name in real-time metrics report: [NPT (Non-Productive Time)][5]
616
+ #
601
617
  # AGENTS\_ON\_CALL
602
618
  #
603
619
  # : Unit: COUNT
604
620
  #
621
+ # Name in real-time metrics report: [On contact][6]
622
+ #
605
623
  # AGENTS\_ON\_CONTACT
606
624
  #
607
625
  # : Unit: COUNT
608
626
  #
627
+ # Name in real-time metrics report: [On contact][6]
628
+ #
609
629
  # AGENTS\_ONLINE
610
630
  #
611
631
  # : Unit: COUNT
612
632
  #
633
+ # Name in real-time metrics report: [Online][7]
634
+ #
613
635
  # AGENTS\_STAFFED
614
636
  #
615
637
  # : Unit: COUNT
616
638
  #
639
+ # Name in real-time metrics report: [Staffed][8]
640
+ #
617
641
  # CONTACTS\_IN\_QUEUE
618
642
  #
619
643
  # : Unit: COUNT
620
644
  #
645
+ # Name in real-time metrics report: [In queue][9]
646
+ #
621
647
  # CONTACTS\_SCHEDULED
622
648
  #
623
649
  # : Unit: COUNT
624
650
  #
651
+ # Name in real-time metrics report: [Scheduled][10]
652
+ #
625
653
  # OLDEST\_CONTACT\_AGE
626
654
  #
627
655
  # : Unit: SECONDS
628
656
  #
657
+ # When you use groupings, Unit says SECONDS but the Value is
658
+ # returned in MILLISECONDS. For example, if you get a response like
659
+ # this:
660
+ #
661
+ # `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS"
662
+ # \}, "Value": 24113.0 `\\}
663
+ #
664
+ # The actual OLDEST\_CONTACT\_AGE is 24 seconds.
665
+ #
666
+ # Name in real-time metrics report: [Oldest][11]
667
+ #
629
668
  # SLOTS\_ACTIVE
630
669
  #
631
670
  # : Unit: COUNT
632
671
  #
672
+ # Name in real-time metrics report: [Active][12]
673
+ #
633
674
  # SLOTS\_AVAILABLE
634
675
  #
635
676
  # : Unit: COUNT
677
+ #
678
+ # Name in real-time metrics report: [Availability][13]
679
+ #
680
+ #
681
+ #
682
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
683
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
684
+ # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
685
+ # [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
686
+ # [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
687
+ # [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
688
+ # [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
689
+ # [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
690
+ # [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
691
+ # [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
692
+ # [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
693
+ # [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
694
+ # [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
636
695
  # @return [Array<Types::CurrentMetric>]
637
696
  #
638
697
  # @!attribute [rw] next_token
@@ -795,7 +854,9 @@ module Aws::Connect
795
854
  #
796
855
  # @!attribute [rw] historical_metrics
797
856
  # The metrics to retrieve. Specify the name, unit, and statistic for
798
- # each metric. The following historical metrics are available:
857
+ # each metric. The following historical metrics are available. For a
858
+ # description of each metric, see [Historical Metrics Definitions][1]
859
+ # in the *Amazon Connect Administrator Guide*.
799
860
  #
800
861
  # ABANDON\_TIME
801
862
  #
@@ -950,6 +1011,10 @@ module Aws::Connect
950
1011
  # Threshold: Only "Less than" comparisons are supported, with the
951
1012
  # following service level thresholds: 15, 20, 25, 30, 45, 60, 90,
952
1013
  # 120, 180, 240, 300, 600
1014
+ #
1015
+ #
1016
+ #
1017
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
953
1018
  # @return [Array<Types::HistoricalMetric>]
954
1019
  #
955
1020
  # @!attribute [rw] next_token
@@ -1151,7 +1216,13 @@ module Aws::Connect
1151
1216
  include Aws::Structure
1152
1217
  end
1153
1218
 
1154
- # Contains information about a historical metric.
1219
+ # Contains information about a historical metric. For a description of
1220
+ # each metric, see [Historical Metrics Definitions][1] in the *Amazon
1221
+ # Connect Administrator Guide*.
1222
+ #
1223
+ #
1224
+ #
1225
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
1155
1226
  #
1156
1227
  # @note When making an API call, you may pass HistoricalMetric
1157
1228
  # data as a hash:
@@ -1980,7 +2051,14 @@ module Aws::Connect
1980
2051
  # @return [String]
1981
2052
  #
1982
2053
  # @!attribute [rw] contact_flow_id
1983
- # The identifier of the contact flow for the chat.
2054
+ # The identifier of the contact flow for the outbound call. To see the
2055
+ # ContactFlowId in the Amazon Connect console user interface, on the
2056
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the
2057
+ # contact flow. On the contact flow page, under the name of the
2058
+ # contact flow, choose **Show additional flow information**. The
2059
+ # ContactFlowId is the last part of the ARN, shown here in bold:
2060
+ #
2061
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
1984
2062
  # @return [String]
1985
2063
  #
1986
2064
  # @!attribute [rw] attributes
@@ -2071,7 +2149,14 @@ module Aws::Connect
2071
2149
  # @return [String]
2072
2150
  #
2073
2151
  # @!attribute [rw] contact_flow_id
2074
- # The identifier of the contact flow for the outbound call.
2152
+ # The identifier of the contact flow for the outbound call. To see the
2153
+ # ContactFlowId in the Amazon Connect console user interface, on the
2154
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the
2155
+ # contact flow. On the contact flow page, under the name of the
2156
+ # contact flow, choose **Show additional flow information**. The
2157
+ # ContactFlowId is the last part of the ARN, shown here in bold:
2158
+ #
2159
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
2075
2160
  # @return [String]
2076
2161
  #
2077
2162
  # @!attribute [rw] instance_id
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connect
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.27.0
4
+ version: 1.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-23 00:00:00.000000000 Z
11
+ date: 2020-07-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core