aws-sdk-connect 1.28.0 → 1.29.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
2
  SHA256:
3
- metadata.gz: 2e51963ae36aaa856591c95e38141c4508ce2c3220dd20f4374c932f1f792d5f
4
- data.tar.gz: c2a9093ce23e3d16a91a71a9f7468a8d22c7d77ac3a5c1b8fd8eb8a1ef575626
3
+ metadata.gz: 250c9a84ec4c1ba2cbc111533052e08647a6c173498ba3a9261cd35f988344a6
4
+ data.tar.gz: 6b971aca4d8d9d4bbd5f3d5dc590a011de94c9094eaffce1f6169191a47bcb48
5
5
  SHA512:
6
- metadata.gz: 53af5d10d95bfa7be88c0224ef5a74da6d48b3b25224011aaa6ca80d8bade02ea54bf981bcf980c4d55768ee363a759e31a01a3f17495367e6e4fcf6d14b2e9b
7
- data.tar.gz: 929e73d5520e082029d6fb8d08450a4ab68f701a443921029474d899f7fc2b16b2bd5ab9ba7d3364f8546fe25de80f112c052aaaa54700696d9f07da7b098212
6
+ metadata.gz: e56b11785c7dec2a7f407b9daf35085f5ea23cf2e31fb46a9ad922383ec7198dd626e566b2a4ec96bc182d9709c283b2642a2345dbc7db4a8c1f2dc1970470b4
7
+ data.tar.gz: caddda581bfd50296a727908b4da43ab192d5531f3926359935877b9d95032aa2ab6cceef39592922def7fd9c78be55ae95d91277b10a68671e00b47eb681b37
@@ -47,6 +47,6 @@ require_relative 'aws-sdk-connect/customizations'
47
47
  # @service
48
48
  module Aws::Connect
49
49
 
50
- GEM_VERSION = '1.28.0'
50
+ GEM_VERSION = '1.29.0'
51
51
 
52
52
  end
@@ -314,14 +314,6 @@ 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
- #
325
317
  # @option params [required, String] :username
326
318
  # The user name for the account. For instances not using SAML for
327
319
  # identity management, the user name can include up to 20 characters. If
@@ -414,14 +406,6 @@ module Aws::Connect
414
406
 
415
407
  # Deletes a user account from the specified Amazon Connect instance.
416
408
  #
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
- #
425
409
  # @option params [required, String] :instance_id
426
410
  # The identifier of the Amazon Connect instance.
427
411
  #
@@ -626,12 +610,12 @@ module Aws::Connect
626
610
  # Gets the real-time metric data from the specified Amazon Connect
627
611
  # instance.
628
612
  #
629
- # For a description of each metric, see [Real-time Metrics
630
- # Definitions][1] in the *Amazon Connect Administrator Guide*.
613
+ # For more information, see [Real-time Metrics Reports][1] in the
614
+ # *Amazon Connect Administrator Guide*.
631
615
  #
632
616
  #
633
617
  #
634
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
618
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html
635
619
  #
636
620
  # @option params [required, String] :instance_id
637
621
  # The identifier of the Amazon Connect instance.
@@ -654,111 +638,65 @@ module Aws::Connect
654
638
  #
655
639
  # @option params [required, Array<Types::CurrentMetric>] :current_metrics
656
640
  # The metrics to retrieve. Specify the name and unit for each metric.
657
- # The following metrics are available. For a description of all the
658
- # metrics, see [Real-time Metrics Definitions][1] in the *Amazon Connect
641
+ # The following metrics are available. For a description of each metric,
642
+ # see [Real-time Metrics Definitions][1] in the *Amazon Connect
659
643
  # Administrator Guide*.
660
644
  #
661
645
  # AGENTS\_AFTER\_CONTACT\_WORK
662
646
  #
663
647
  # : Unit: COUNT
664
648
  #
665
- # Name in real-time metrics report: [ACW][2]
666
- #
667
649
  # AGENTS\_AVAILABLE
668
650
  #
669
651
  # : Unit: COUNT
670
652
  #
671
- # Name in real-time metrics report: [Available][3]
672
- #
673
653
  # AGENTS\_ERROR
674
654
  #
675
655
  # : Unit: COUNT
676
656
  #
677
- # Name in real-time metrics report: [Error][4]
678
- #
679
657
  # AGENTS\_NON\_PRODUCTIVE
680
658
  #
681
659
  # : Unit: COUNT
682
660
  #
683
- # Name in real-time metrics report: [NPT (Non-Productive Time)][5]
684
- #
685
661
  # AGENTS\_ON\_CALL
686
662
  #
687
663
  # : Unit: COUNT
688
664
  #
689
- # Name in real-time metrics report: [On contact][6]
690
- #
691
665
  # AGENTS\_ON\_CONTACT
692
666
  #
693
667
  # : Unit: COUNT
694
668
  #
695
- # Name in real-time metrics report: [On contact][6]
696
- #
697
669
  # AGENTS\_ONLINE
698
670
  #
699
671
  # : Unit: COUNT
700
672
  #
701
- # Name in real-time metrics report: [Online][7]
702
- #
703
673
  # AGENTS\_STAFFED
704
674
  #
705
675
  # : Unit: COUNT
706
676
  #
707
- # Name in real-time metrics report: [Staffed][8]
708
- #
709
677
  # CONTACTS\_IN\_QUEUE
710
678
  #
711
679
  # : Unit: COUNT
712
680
  #
713
- # Name in real-time metrics report: [In queue][9]
714
- #
715
681
  # CONTACTS\_SCHEDULED
716
682
  #
717
683
  # : Unit: COUNT
718
684
  #
719
- # Name in real-time metrics report: [Scheduled][10]
720
- #
721
685
  # OLDEST\_CONTACT\_AGE
722
686
  #
723
687
  # : Unit: SECONDS
724
688
  #
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
- #
735
689
  # SLOTS\_ACTIVE
736
690
  #
737
691
  # : Unit: COUNT
738
692
  #
739
- # Name in real-time metrics report: [Active][12]
740
- #
741
693
  # SLOTS\_AVAILABLE
742
694
  #
743
695
  # : Unit: COUNT
744
696
  #
745
- # Name in real-time metrics report: [Availability][13]
746
- #
747
697
  #
748
698
  #
749
699
  # [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
700
  #
763
701
  # @option params [String] :next_token
764
702
  # The token for the next set of results. Use the value returned in the
@@ -855,12 +793,12 @@ module Aws::Connect
855
793
  # Gets historical metric data from the specified Amazon Connect
856
794
  # instance.
857
795
  #
858
- # For a description of each historical metric, see [Historical Metrics
859
- # Definitions][1] in the *Amazon Connect Administrator Guide*.
796
+ # For more information, see [Historical Metrics Reports][1] in the
797
+ # *Amazon Connect Administrator Guide*.
860
798
  #
861
799
  #
862
800
  #
863
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
801
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
864
802
  #
865
803
  # @option params [required, String] :instance_id
866
804
  # The identifier of the Amazon Connect instance.
@@ -1133,13 +1071,6 @@ module Aws::Connect
1133
1071
  # Provides information about the contact flows for the specified Amazon
1134
1072
  # Connect instance.
1135
1073
  #
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
- #
1143
1074
  # @option params [required, String] :instance_id
1144
1075
  # The identifier of the Amazon Connect instance.
1145
1076
  #
@@ -1191,13 +1122,6 @@ module Aws::Connect
1191
1122
  # Provides information about the hours of operation for the specified
1192
1123
  # Amazon Connect instance.
1193
1124
  #
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
- #
1201
1125
  # @option params [required, String] :instance_id
1202
1126
  # The identifier of the Amazon Connect instance.
1203
1127
  #
@@ -1244,14 +1168,6 @@ module Aws::Connect
1244
1168
  # Provides information about the phone numbers for the specified Amazon
1245
1169
  # Connect instance.
1246
1170
  #
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
- #
1255
1171
  # @option params [required, String] :instance_id
1256
1172
  # The identifier of the Amazon Connect instance.
1257
1173
  #
@@ -1308,13 +1224,6 @@ module Aws::Connect
1308
1224
  # Provides information about the queues for the specified Amazon Connect
1309
1225
  # instance.
1310
1226
  #
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
- #
1318
1227
  # @option params [required, String] :instance_id
1319
1228
  # The identifier of the Amazon Connect instance.
1320
1229
  #
@@ -1366,15 +1275,6 @@ module Aws::Connect
1366
1275
  # Provides summary information about the routing profiles for the
1367
1276
  # specified Amazon Connect instance.
1368
1277
  #
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
- #
1378
1278
  # @option params [required, String] :instance_id
1379
1279
  # The identifier of the Amazon Connect instance.
1380
1280
  #
@@ -1421,13 +1321,6 @@ module Aws::Connect
1421
1321
  # Provides summary information about the security profiles for the
1422
1322
  # specified Amazon Connect instance.
1423
1323
  #
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
- #
1431
1324
  # @option params [required, String] :instance_id
1432
1325
  # The identifier of the Amazon Connect instance.
1433
1326
  #
@@ -1473,13 +1366,6 @@ module Aws::Connect
1473
1366
 
1474
1367
  # Lists the tags for the specified resource.
1475
1368
  #
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
- #
1483
1369
  # @option params [required, String] :resource_arn
1484
1370
  # The Amazon Resource Name (ARN) of the resource.
1485
1371
  #
@@ -1510,13 +1396,6 @@ module Aws::Connect
1510
1396
  # Provides summary information about the hierarchy groups for the
1511
1397
  # specified Amazon Connect instance.
1512
1398
  #
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
- #
1520
1399
  # @option params [required, String] :instance_id
1521
1400
  # The identifier of the Amazon Connect instance.
1522
1401
  #
@@ -1606,6 +1485,40 @@ module Aws::Connect
1606
1485
  req.send_request(options)
1607
1486
  end
1608
1487
 
1488
+ # When a contact is being recorded, and the recording has been suspended
1489
+ # using SuspendContactRecording, this API resumes recording the call.
1490
+ #
1491
+ # Only voice recordings are supported at this time.
1492
+ #
1493
+ # @option params [required, String] :instance_id
1494
+ # The identifier of the Amazon Connect instance.
1495
+ #
1496
+ # @option params [required, String] :contact_id
1497
+ # The identifier of the contact.
1498
+ #
1499
+ # @option params [required, String] :initial_contact_id
1500
+ # The identifier of the contact. This is the identifier of the contact
1501
+ # associated with the first interaction with the contact center.
1502
+ #
1503
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1504
+ #
1505
+ # @example Request syntax with placeholder values
1506
+ #
1507
+ # resp = client.resume_contact_recording({
1508
+ # instance_id: "InstanceId", # required
1509
+ # contact_id: "ContactId", # required
1510
+ # initial_contact_id: "ContactId", # required
1511
+ # })
1512
+ #
1513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecording AWS API Documentation
1514
+ #
1515
+ # @overload resume_contact_recording(params = {})
1516
+ # @param [Hash] params ({})
1517
+ def resume_contact_recording(params = {}, options = {})
1518
+ req = build_request(:resume_contact_recording, params)
1519
+ req.send_request(options)
1520
+ end
1521
+
1609
1522
  # Initiates a contact flow to start a new chat for the customer.
1610
1523
  # Response of this API provides a token required to obtain credentials
1611
1524
  # from the [CreateParticipantConnection][1] API in the Amazon Connect
@@ -1617,35 +1530,15 @@ module Aws::Connect
1617
1530
  # [CreateParticipantConnection][1] with WEBSOCKET and
1618
1531
  # CONNECTION\_CREDENTIALS.
1619
1532
  #
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
- #
1631
1533
  #
1632
1534
  #
1633
1535
  # [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
1636
1536
  #
1637
1537
  # @option params [required, String] :instance_id
1638
1538
  # The identifier of the Amazon Connect instance.
1639
1539
  #
1640
1540
  # @option params [required, String] :contact_flow_id
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**
1541
+ # The identifier of the contact flow for the chat.
1649
1542
  #
1650
1543
  # @option params [Hash<String,String>] :attributes
1651
1544
  # A custom key-value pair using an attribute map. The attributes are
@@ -1708,6 +1601,58 @@ module Aws::Connect
1708
1601
  req.send_request(options)
1709
1602
  end
1710
1603
 
1604
+ # This API starts recording the contact when the agent joins the call.
1605
+ # StartContactRecording is a one-time action. For example, if you use
1606
+ # StopContactRecording to stop recording an ongoing call, you can't use
1607
+ # StartContactRecording to restart it. For scenarios where the recording
1608
+ # has started and you want to suspend and resume it, such as when
1609
+ # collecting sensitive information (for example, a credit card number),
1610
+ # use SuspendContactRecording and ResumeContactRecording.
1611
+ #
1612
+ # You can use this API to override the recording behavior configured in
1613
+ # the [Set recording behavior][1] block.
1614
+ #
1615
+ # Only voice recordings are supported at this time.
1616
+ #
1617
+ #
1618
+ #
1619
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html
1620
+ #
1621
+ # @option params [required, String] :instance_id
1622
+ # The identifier of the Amazon Connect instance.
1623
+ #
1624
+ # @option params [required, String] :contact_id
1625
+ # The identifier of the contact.
1626
+ #
1627
+ # @option params [required, String] :initial_contact_id
1628
+ # The identifier of the contact. This is the identifier of the contact
1629
+ # associated with the first interaction with the contact center.
1630
+ #
1631
+ # @option params [required, Types::VoiceRecordingConfiguration] :voice_recording_configuration
1632
+ # Who is being recorded.
1633
+ #
1634
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1635
+ #
1636
+ # @example Request syntax with placeholder values
1637
+ #
1638
+ # resp = client.start_contact_recording({
1639
+ # instance_id: "InstanceId", # required
1640
+ # contact_id: "ContactId", # required
1641
+ # initial_contact_id: "ContactId", # required
1642
+ # voice_recording_configuration: { # required
1643
+ # voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
1644
+ # },
1645
+ # })
1646
+ #
1647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecording AWS API Documentation
1648
+ #
1649
+ # @overload start_contact_recording(params = {})
1650
+ # @param [Hash] params ({})
1651
+ def start_contact_recording(params = {}, options = {})
1652
+ req = build_request(:start_contact_recording, params)
1653
+ req.send_request(options)
1654
+ end
1655
+
1711
1656
  # This API places an outbound call to a contact, and then initiates the
1712
1657
  # contact flow. It performs the actions in the contact flow that's
1713
1658
  # specified (in `ContactFlowId`).
@@ -1720,29 +1665,11 @@ module Aws::Connect
1720
1665
  # There is a 60 second dialing timeout for this operation. If the call
1721
1666
  # is not connected after 60 seconds, it fails.
1722
1667
  #
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
- #
1734
1668
  # @option params [required, String] :destination_phone_number
1735
1669
  # The phone number of the customer, in E.164 format.
1736
1670
  #
1737
1671
  # @option params [required, String] :contact_flow_id
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**
1672
+ # The identifier of the contact flow for the outbound call.
1746
1673
  #
1747
1674
  # @option params [required, String] :instance_id
1748
1675
  # The identifier of the Amazon Connect instance.
@@ -1833,16 +1760,87 @@ module Aws::Connect
1833
1760
  req.send_request(options)
1834
1761
  end
1835
1762
 
1836
- # Adds the specified tags to the specified resource.
1763
+ # When a contact is being recorded, this API stops recording the call.
1764
+ # StopContactRecording is a one-time action. If you use
1765
+ # StopContactRecording to stop recording an ongoing call, you can't use
1766
+ # StartContactRecording to restart it. For scenarios where the recording
1767
+ # has started and you want to suspend it for sensitive information (for
1768
+ # example, to collect a credit card number), and then restart it, use
1769
+ # SuspendContactRecording and ResumeContactRecording.
1837
1770
  #
1838
- # The supported resource type is users.
1771
+ # Only voice recordings are supported at this time.
1839
1772
  #
1840
- # For sample policies that use tags, see [Amazon Connect Identity-Based
1841
- # Policy Examples][1] in the *Amazon Connect Administrator Guide*.
1773
+ # @option params [required, String] :instance_id
1774
+ # The identifier of the Amazon Connect instance.
1842
1775
  #
1776
+ # @option params [required, String] :contact_id
1777
+ # The identifier of the contact.
1843
1778
  #
1779
+ # @option params [required, String] :initial_contact_id
1780
+ # The identifier of the contact. This is the identifier of the contact
1781
+ # associated with the first interaction with the contact center.
1844
1782
  #
1845
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
1783
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1784
+ #
1785
+ # @example Request syntax with placeholder values
1786
+ #
1787
+ # resp = client.stop_contact_recording({
1788
+ # instance_id: "InstanceId", # required
1789
+ # contact_id: "ContactId", # required
1790
+ # initial_contact_id: "ContactId", # required
1791
+ # })
1792
+ #
1793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecording AWS API Documentation
1794
+ #
1795
+ # @overload stop_contact_recording(params = {})
1796
+ # @param [Hash] params ({})
1797
+ def stop_contact_recording(params = {}, options = {})
1798
+ req = build_request(:stop_contact_recording, params)
1799
+ req.send_request(options)
1800
+ end
1801
+
1802
+ # When a contact is being recorded, this API suspends recording the
1803
+ # call. For example, you might suspend the call recording while
1804
+ # collecting sensitive information, such as a credit card number. Then
1805
+ # use ResumeContactRecording to restart recording.
1806
+ #
1807
+ # The period of time that the recording is suspended is filled with
1808
+ # silence in the final recording.
1809
+ #
1810
+ # Only voice recordings are supported at this time.
1811
+ #
1812
+ # @option params [required, String] :instance_id
1813
+ # The identifier of the Amazon Connect instance.
1814
+ #
1815
+ # @option params [required, String] :contact_id
1816
+ # The identifier of the contact.
1817
+ #
1818
+ # @option params [required, String] :initial_contact_id
1819
+ # The identifier of the contact. This is the identifier of the contact
1820
+ # associated with the first interaction with the contact center.
1821
+ #
1822
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1823
+ #
1824
+ # @example Request syntax with placeholder values
1825
+ #
1826
+ # resp = client.suspend_contact_recording({
1827
+ # instance_id: "InstanceId", # required
1828
+ # contact_id: "ContactId", # required
1829
+ # initial_contact_id: "ContactId", # required
1830
+ # })
1831
+ #
1832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecording AWS API Documentation
1833
+ #
1834
+ # @overload suspend_contact_recording(params = {})
1835
+ # @param [Hash] params ({})
1836
+ def suspend_contact_recording(params = {}, options = {})
1837
+ req = build_request(:suspend_contact_recording, params)
1838
+ req.send_request(options)
1839
+ end
1840
+
1841
+ # Adds the specified tags to the specified resource.
1842
+ #
1843
+ # The supported resource type is users.
1846
1844
  #
1847
1845
  # @option params [required, String] :resource_arn
1848
1846
  # The Amazon Resource Name (ARN) of the resource.
@@ -1989,19 +1987,6 @@ module Aws::Connect
1989
1987
 
1990
1988
  # Updates the identity information for the specified user.
1991
1989
  #
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
- #
2005
1990
  # @option params [required, Types::UserIdentityInfo] :identity_info
2006
1991
  # The identity information for the user.
2007
1992
  #
@@ -2142,7 +2127,7 @@ module Aws::Connect
2142
2127
  params: params,
2143
2128
  config: config)
2144
2129
  context[:gem_name] = 'aws-sdk-connect'
2145
- context[:gem_version] = '1.28.0'
2130
+ context[:gem_version] = '1.29.0'
2146
2131
  Seahorse::Client::Request.new(handlers, context)
2147
2132
  end
2148
2133
 
@@ -142,6 +142,8 @@ module Aws::Connect
142
142
  QueueTypes = Shapes::ListShape.new(name: 'QueueTypes')
143
143
  Queues = Shapes::ListShape.new(name: 'Queues')
144
144
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
145
+ ResumeContactRecordingRequest = Shapes::StructureShape.new(name: 'ResumeContactRecordingRequest')
146
+ ResumeContactRecordingResponse = Shapes::StructureShape.new(name: 'ResumeContactRecordingResponse')
145
147
  RoutingProfileId = Shapes::StringShape.new(name: 'RoutingProfileId')
146
148
  RoutingProfileName = Shapes::StringShape.new(name: 'RoutingProfileName')
147
149
  RoutingProfileSummary = Shapes::StructureShape.new(name: 'RoutingProfileSummary')
@@ -154,11 +156,17 @@ module Aws::Connect
154
156
  SecurityToken = Shapes::StringShape.new(name: 'SecurityToken')
155
157
  StartChatContactRequest = Shapes::StructureShape.new(name: 'StartChatContactRequest')
156
158
  StartChatContactResponse = Shapes::StructureShape.new(name: 'StartChatContactResponse')
159
+ StartContactRecordingRequest = Shapes::StructureShape.new(name: 'StartContactRecordingRequest')
160
+ StartContactRecordingResponse = Shapes::StructureShape.new(name: 'StartContactRecordingResponse')
157
161
  StartOutboundVoiceContactRequest = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactRequest')
158
162
  StartOutboundVoiceContactResponse = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactResponse')
159
163
  Statistic = Shapes::StringShape.new(name: 'Statistic')
164
+ StopContactRecordingRequest = Shapes::StructureShape.new(name: 'StopContactRecordingRequest')
165
+ StopContactRecordingResponse = Shapes::StructureShape.new(name: 'StopContactRecordingResponse')
160
166
  StopContactRequest = Shapes::StructureShape.new(name: 'StopContactRequest')
161
167
  StopContactResponse = Shapes::StructureShape.new(name: 'StopContactResponse')
168
+ SuspendContactRecordingRequest = Shapes::StructureShape.new(name: 'SuspendContactRecordingRequest')
169
+ SuspendContactRecordingResponse = Shapes::StructureShape.new(name: 'SuspendContactRecordingResponse')
162
170
  TagKey = Shapes::StringShape.new(name: 'TagKey')
163
171
  TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
164
172
  TagMap = Shapes::MapShape.new(name: 'TagMap')
@@ -184,6 +192,8 @@ module Aws::Connect
184
192
  UserSummary = Shapes::StructureShape.new(name: 'UserSummary')
185
193
  UserSummaryList = Shapes::ListShape.new(name: 'UserSummaryList')
186
194
  Value = Shapes::FloatShape.new(name: 'Value')
195
+ VoiceRecordingConfiguration = Shapes::StructureShape.new(name: 'VoiceRecordingConfiguration')
196
+ VoiceRecordingTrack = Shapes::StringShape.new(name: 'VoiceRecordingTrack')
187
197
  timestamp = Shapes::TimestampShape.new(name: 'timestamp')
188
198
 
189
199
  Attributes.key = Shapes::ShapeRef.new(shape: AttributeName)
@@ -520,6 +530,13 @@ module Aws::Connect
520
530
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
521
531
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
522
532
 
533
+ ResumeContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
534
+ ResumeContactRecordingRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
535
+ ResumeContactRecordingRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "InitialContactId"))
536
+ ResumeContactRecordingRequest.struct_class = Types::ResumeContactRecordingRequest
537
+
538
+ ResumeContactRecordingResponse.struct_class = Types::ResumeContactRecordingResponse
539
+
523
540
  RoutingProfileSummary.add_member(:id, Shapes::ShapeRef.new(shape: RoutingProfileId, location_name: "Id"))
524
541
  RoutingProfileSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
525
542
  RoutingProfileSummary.add_member(:name, Shapes::ShapeRef.new(shape: RoutingProfileName, location_name: "Name"))
@@ -549,6 +566,14 @@ module Aws::Connect
549
566
  StartChatContactResponse.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ParticipantToken"))
550
567
  StartChatContactResponse.struct_class = Types::StartChatContactResponse
551
568
 
569
+ StartContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
570
+ StartContactRecordingRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
571
+ StartContactRecordingRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "InitialContactId"))
572
+ StartContactRecordingRequest.add_member(:voice_recording_configuration, Shapes::ShapeRef.new(shape: VoiceRecordingConfiguration, required: true, location_name: "VoiceRecordingConfiguration"))
573
+ StartContactRecordingRequest.struct_class = Types::StartContactRecordingRequest
574
+
575
+ StartContactRecordingResponse.struct_class = Types::StartContactRecordingResponse
576
+
552
577
  StartOutboundVoiceContactRequest.add_member(:destination_phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, required: true, location_name: "DestinationPhoneNumber"))
553
578
  StartOutboundVoiceContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId"))
554
579
  StartOutboundVoiceContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
@@ -561,12 +586,26 @@ module Aws::Connect
561
586
  StartOutboundVoiceContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
562
587
  StartOutboundVoiceContactResponse.struct_class = Types::StartOutboundVoiceContactResponse
563
588
 
589
+ StopContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
590
+ StopContactRecordingRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
591
+ StopContactRecordingRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "InitialContactId"))
592
+ StopContactRecordingRequest.struct_class = Types::StopContactRecordingRequest
593
+
594
+ StopContactRecordingResponse.struct_class = Types::StopContactRecordingResponse
595
+
564
596
  StopContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
565
597
  StopContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
566
598
  StopContactRequest.struct_class = Types::StopContactRequest
567
599
 
568
600
  StopContactResponse.struct_class = Types::StopContactResponse
569
601
 
602
+ SuspendContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
603
+ SuspendContactRecordingRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
604
+ SuspendContactRecordingRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "InitialContactId"))
605
+ SuspendContactRecordingRequest.struct_class = Types::SuspendContactRecordingRequest
606
+
607
+ SuspendContactRecordingResponse.struct_class = Types::SuspendContactRecordingResponse
608
+
570
609
  TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
571
610
 
572
611
  TagMap.key = Shapes::ShapeRef.new(shape: TagKey)
@@ -652,6 +691,9 @@ module Aws::Connect
652
691
 
653
692
  UserSummaryList.member = Shapes::ShapeRef.new(shape: UserSummary)
654
693
 
694
+ VoiceRecordingConfiguration.add_member(:voice_recording_track, Shapes::ShapeRef.new(shape: VoiceRecordingTrack, location_name: "VoiceRecordingTrack"))
695
+ VoiceRecordingConfiguration.struct_class = Types::VoiceRecordingConfiguration
696
+
655
697
 
656
698
  # @api private
657
699
  API = Seahorse::Model::Api.new.tap do |api|
@@ -966,6 +1008,17 @@ module Aws::Connect
966
1008
  )
967
1009
  end)
968
1010
 
1011
+ api.add_operation(:resume_contact_recording, Seahorse::Model::Operation.new.tap do |o|
1012
+ o.name = "ResumeContactRecording"
1013
+ o.http_method = "POST"
1014
+ o.http_request_uri = "/contact/resume-recording"
1015
+ o.input = Shapes::ShapeRef.new(shape: ResumeContactRecordingRequest)
1016
+ o.output = Shapes::ShapeRef.new(shape: ResumeContactRecordingResponse)
1017
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1018
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1019
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
1020
+ end)
1021
+
969
1022
  api.add_operation(:start_chat_contact, Seahorse::Model::Operation.new.tap do |o|
970
1023
  o.name = "StartChatContact"
971
1024
  o.http_method = "PUT"
@@ -979,6 +1032,18 @@ module Aws::Connect
979
1032
  o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
980
1033
  end)
981
1034
 
1035
+ api.add_operation(:start_contact_recording, Seahorse::Model::Operation.new.tap do |o|
1036
+ o.name = "StartContactRecording"
1037
+ o.http_method = "POST"
1038
+ o.http_request_uri = "/contact/start-recording"
1039
+ o.input = Shapes::ShapeRef.new(shape: StartContactRecordingRequest)
1040
+ o.output = Shapes::ShapeRef.new(shape: StartContactRecordingResponse)
1041
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1042
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
1043
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1044
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
1045
+ end)
1046
+
982
1047
  api.add_operation(:start_outbound_voice_contact, Seahorse::Model::Operation.new.tap do |o|
983
1048
  o.name = "StartOutboundVoiceContact"
984
1049
  o.http_method = "PUT"
@@ -1007,6 +1072,28 @@ module Aws::Connect
1007
1072
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
1008
1073
  end)
1009
1074
 
1075
+ api.add_operation(:stop_contact_recording, Seahorse::Model::Operation.new.tap do |o|
1076
+ o.name = "StopContactRecording"
1077
+ o.http_method = "POST"
1078
+ o.http_request_uri = "/contact/stop-recording"
1079
+ o.input = Shapes::ShapeRef.new(shape: StopContactRecordingRequest)
1080
+ o.output = Shapes::ShapeRef.new(shape: StopContactRecordingResponse)
1081
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1082
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1083
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
1084
+ end)
1085
+
1086
+ api.add_operation(:suspend_contact_recording, Seahorse::Model::Operation.new.tap do |o|
1087
+ o.name = "SuspendContactRecording"
1088
+ o.http_method = "POST"
1089
+ o.http_request_uri = "/contact/suspend-recording"
1090
+ o.input = Shapes::ShapeRef.new(shape: SuspendContactRecordingRequest)
1091
+ o.output = Shapes::ShapeRef.new(shape: SuspendContactRecordingResponse)
1092
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1093
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1094
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
1095
+ end)
1096
+
1010
1097
  api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
1011
1098
  o.name = "TagResource"
1012
1099
  o.http_method = "POST"
@@ -586,112 +586,65 @@ module Aws::Connect
586
586
  #
587
587
  # @!attribute [rw] current_metrics
588
588
  # The metrics to retrieve. Specify the name and unit for each metric.
589
- # The following metrics are available. For a description of all the
590
- # metrics, see [Real-time Metrics Definitions][1] in the *Amazon
589
+ # The following metrics are available. For a description of each
590
+ # metric, see [Real-time Metrics Definitions][1] in the *Amazon
591
591
  # Connect Administrator Guide*.
592
592
  #
593
593
  # AGENTS\_AFTER\_CONTACT\_WORK
594
594
  #
595
595
  # : Unit: COUNT
596
596
  #
597
- # Name in real-time metrics report: [ACW][2]
598
- #
599
597
  # AGENTS\_AVAILABLE
600
598
  #
601
599
  # : Unit: COUNT
602
600
  #
603
- # Name in real-time metrics report: [Available][3]
604
- #
605
601
  # AGENTS\_ERROR
606
602
  #
607
603
  # : Unit: COUNT
608
604
  #
609
- # Name in real-time metrics report: [Error][4]
610
- #
611
605
  # AGENTS\_NON\_PRODUCTIVE
612
606
  #
613
607
  # : Unit: COUNT
614
608
  #
615
- # Name in real-time metrics report: [NPT (Non-Productive Time)][5]
616
- #
617
609
  # AGENTS\_ON\_CALL
618
610
  #
619
611
  # : Unit: COUNT
620
612
  #
621
- # Name in real-time metrics report: [On contact][6]
622
- #
623
613
  # AGENTS\_ON\_CONTACT
624
614
  #
625
615
  # : Unit: COUNT
626
616
  #
627
- # Name in real-time metrics report: [On contact][6]
628
- #
629
617
  # AGENTS\_ONLINE
630
618
  #
631
619
  # : Unit: COUNT
632
620
  #
633
- # Name in real-time metrics report: [Online][7]
634
- #
635
621
  # AGENTS\_STAFFED
636
622
  #
637
623
  # : Unit: COUNT
638
624
  #
639
- # Name in real-time metrics report: [Staffed][8]
640
- #
641
625
  # CONTACTS\_IN\_QUEUE
642
626
  #
643
627
  # : Unit: COUNT
644
628
  #
645
- # Name in real-time metrics report: [In queue][9]
646
- #
647
629
  # CONTACTS\_SCHEDULED
648
630
  #
649
631
  # : Unit: COUNT
650
632
  #
651
- # Name in real-time metrics report: [Scheduled][10]
652
- #
653
633
  # OLDEST\_CONTACT\_AGE
654
634
  #
655
635
  # : Unit: SECONDS
656
636
  #
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
- #
668
637
  # SLOTS\_ACTIVE
669
638
  #
670
639
  # : Unit: COUNT
671
640
  #
672
- # Name in real-time metrics report: [Active][12]
673
- #
674
641
  # SLOTS\_AVAILABLE
675
642
  #
676
643
  # : Unit: COUNT
677
644
  #
678
- # Name in real-time metrics report: [Availability][13]
679
- #
680
645
  #
681
646
  #
682
647
  # [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
695
648
  # @return [Array<Types::CurrentMetric>]
696
649
  #
697
650
  # @!attribute [rw] next_token
@@ -1979,6 +1932,42 @@ module Aws::Connect
1979
1932
  include Aws::Structure
1980
1933
  end
1981
1934
 
1935
+ # @note When making an API call, you may pass ResumeContactRecordingRequest
1936
+ # data as a hash:
1937
+ #
1938
+ # {
1939
+ # instance_id: "InstanceId", # required
1940
+ # contact_id: "ContactId", # required
1941
+ # initial_contact_id: "ContactId", # required
1942
+ # }
1943
+ #
1944
+ # @!attribute [rw] instance_id
1945
+ # The identifier of the Amazon Connect instance.
1946
+ # @return [String]
1947
+ #
1948
+ # @!attribute [rw] contact_id
1949
+ # The identifier of the contact.
1950
+ # @return [String]
1951
+ #
1952
+ # @!attribute [rw] initial_contact_id
1953
+ # The identifier of the contact. This is the identifier of the contact
1954
+ # associated with the first interaction with the contact center.
1955
+ # @return [String]
1956
+ #
1957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingRequest AWS API Documentation
1958
+ #
1959
+ class ResumeContactRecordingRequest < Struct.new(
1960
+ :instance_id,
1961
+ :contact_id,
1962
+ :initial_contact_id)
1963
+ SENSITIVE = []
1964
+ include Aws::Structure
1965
+ end
1966
+
1967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingResponse AWS API Documentation
1968
+ #
1969
+ class ResumeContactRecordingResponse < Aws::EmptyStructure; end
1970
+
1982
1971
  # Contains summary information about a routing profile.
1983
1972
  #
1984
1973
  # @!attribute [rw] id
@@ -2051,14 +2040,7 @@ module Aws::Connect
2051
2040
  # @return [String]
2052
2041
  #
2053
2042
  # @!attribute [rw] contact_flow_id
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**
2043
+ # The identifier of the contact flow for the chat.
2062
2044
  # @return [String]
2063
2045
  #
2064
2046
  # @!attribute [rw] attributes
@@ -2129,6 +2111,50 @@ module Aws::Connect
2129
2111
  include Aws::Structure
2130
2112
  end
2131
2113
 
2114
+ # @note When making an API call, you may pass StartContactRecordingRequest
2115
+ # data as a hash:
2116
+ #
2117
+ # {
2118
+ # instance_id: "InstanceId", # required
2119
+ # contact_id: "ContactId", # required
2120
+ # initial_contact_id: "ContactId", # required
2121
+ # voice_recording_configuration: { # required
2122
+ # voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
2123
+ # },
2124
+ # }
2125
+ #
2126
+ # @!attribute [rw] instance_id
2127
+ # The identifier of the Amazon Connect instance.
2128
+ # @return [String]
2129
+ #
2130
+ # @!attribute [rw] contact_id
2131
+ # The identifier of the contact.
2132
+ # @return [String]
2133
+ #
2134
+ # @!attribute [rw] initial_contact_id
2135
+ # The identifier of the contact. This is the identifier of the contact
2136
+ # associated with the first interaction with the contact center.
2137
+ # @return [String]
2138
+ #
2139
+ # @!attribute [rw] voice_recording_configuration
2140
+ # Who is being recorded.
2141
+ # @return [Types::VoiceRecordingConfiguration]
2142
+ #
2143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingRequest AWS API Documentation
2144
+ #
2145
+ class StartContactRecordingRequest < Struct.new(
2146
+ :instance_id,
2147
+ :contact_id,
2148
+ :initial_contact_id,
2149
+ :voice_recording_configuration)
2150
+ SENSITIVE = []
2151
+ include Aws::Structure
2152
+ end
2153
+
2154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingResponse AWS API Documentation
2155
+ #
2156
+ class StartContactRecordingResponse < Aws::EmptyStructure; end
2157
+
2132
2158
  # @note When making an API call, you may pass StartOutboundVoiceContactRequest
2133
2159
  # data as a hash:
2134
2160
  #
@@ -2149,14 +2175,7 @@ module Aws::Connect
2149
2175
  # @return [String]
2150
2176
  #
2151
2177
  # @!attribute [rw] contact_flow_id
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**
2178
+ # The identifier of the contact flow for the outbound call.
2160
2179
  # @return [String]
2161
2180
  #
2162
2181
  # @!attribute [rw] instance_id
@@ -2223,6 +2242,42 @@ module Aws::Connect
2223
2242
  include Aws::Structure
2224
2243
  end
2225
2244
 
2245
+ # @note When making an API call, you may pass StopContactRecordingRequest
2246
+ # data as a hash:
2247
+ #
2248
+ # {
2249
+ # instance_id: "InstanceId", # required
2250
+ # contact_id: "ContactId", # required
2251
+ # initial_contact_id: "ContactId", # required
2252
+ # }
2253
+ #
2254
+ # @!attribute [rw] instance_id
2255
+ # The identifier of the Amazon Connect instance.
2256
+ # @return [String]
2257
+ #
2258
+ # @!attribute [rw] contact_id
2259
+ # The identifier of the contact.
2260
+ # @return [String]
2261
+ #
2262
+ # @!attribute [rw] initial_contact_id
2263
+ # The identifier of the contact. This is the identifier of the contact
2264
+ # associated with the first interaction with the contact center.
2265
+ # @return [String]
2266
+ #
2267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecordingRequest AWS API Documentation
2268
+ #
2269
+ class StopContactRecordingRequest < Struct.new(
2270
+ :instance_id,
2271
+ :contact_id,
2272
+ :initial_contact_id)
2273
+ SENSITIVE = []
2274
+ include Aws::Structure
2275
+ end
2276
+
2277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecordingResponse AWS API Documentation
2278
+ #
2279
+ class StopContactRecordingResponse < Aws::EmptyStructure; end
2280
+
2226
2281
  # @note When making an API call, you may pass StopContactRequest
2227
2282
  # data as a hash:
2228
2283
  #
@@ -2252,6 +2307,42 @@ module Aws::Connect
2252
2307
  #
2253
2308
  class StopContactResponse < Aws::EmptyStructure; end
2254
2309
 
2310
+ # @note When making an API call, you may pass SuspendContactRecordingRequest
2311
+ # data as a hash:
2312
+ #
2313
+ # {
2314
+ # instance_id: "InstanceId", # required
2315
+ # contact_id: "ContactId", # required
2316
+ # initial_contact_id: "ContactId", # required
2317
+ # }
2318
+ #
2319
+ # @!attribute [rw] instance_id
2320
+ # The identifier of the Amazon Connect instance.
2321
+ # @return [String]
2322
+ #
2323
+ # @!attribute [rw] contact_id
2324
+ # The identifier of the contact.
2325
+ # @return [String]
2326
+ #
2327
+ # @!attribute [rw] initial_contact_id
2328
+ # The identifier of the contact. This is the identifier of the contact
2329
+ # associated with the first interaction with the contact center.
2330
+ # @return [String]
2331
+ #
2332
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingRequest AWS API Documentation
2333
+ #
2334
+ class SuspendContactRecordingRequest < Struct.new(
2335
+ :instance_id,
2336
+ :contact_id,
2337
+ :initial_contact_id)
2338
+ SENSITIVE = []
2339
+ include Aws::Structure
2340
+ end
2341
+
2342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingResponse AWS API Documentation
2343
+ #
2344
+ class SuspendContactRecordingResponse < Aws::EmptyStructure; end
2345
+
2255
2346
  # @note When making an API call, you may pass TagResourceRequest
2256
2347
  # data as a hash:
2257
2348
  #
@@ -2728,5 +2819,26 @@ module Aws::Connect
2728
2819
  include Aws::Structure
2729
2820
  end
2730
2821
 
2822
+ # Contains information about the recording configuration settings.
2823
+ #
2824
+ # @note When making an API call, you may pass VoiceRecordingConfiguration
2825
+ # data as a hash:
2826
+ #
2827
+ # {
2828
+ # voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
2829
+ # }
2830
+ #
2831
+ # @!attribute [rw] voice_recording_track
2832
+ # Identifies which track is being recorded.
2833
+ # @return [String]
2834
+ #
2835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/VoiceRecordingConfiguration AWS API Documentation
2836
+ #
2837
+ class VoiceRecordingConfiguration < Struct.new(
2838
+ :voice_recording_track)
2839
+ SENSITIVE = []
2840
+ include Aws::Structure
2841
+ end
2842
+
2731
2843
  end
2732
2844
  end
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.28.0
4
+ version: 1.29.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-07-02 00:00:00.000000000 Z
11
+ date: 2020-07-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core