aws-sdk-connect 1.184.0 → 1.186.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +1097 -216
- data/lib/aws-sdk-connect/client_api.rb +621 -1
- data/lib/aws-sdk-connect/errors.rb +21 -0
- data/lib/aws-sdk-connect/types.rb +1403 -166
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +432 -45
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +449 -39
- metadata +2 -2
@@ -697,7 +697,7 @@ module Aws::Connect
|
|
697
697
|
# instance_id: "InstanceId", # required
|
698
698
|
# resource_id: "ARN", # required
|
699
699
|
# flow_id: "ARN", # required
|
700
|
-
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
700
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
701
701
|
# })
|
702
702
|
#
|
703
703
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateFlow AWS API Documentation
|
@@ -764,7 +764,7 @@ module Aws::Connect
|
|
764
764
|
#
|
765
765
|
# resp = client.associate_instance_storage_config({
|
766
766
|
# instance_id: "InstanceId", # required
|
767
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
|
767
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
|
768
768
|
# storage_config: { # required
|
769
769
|
# association_id: "AssociationId",
|
770
770
|
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
@@ -993,7 +993,7 @@ module Aws::Connect
|
|
993
993
|
# {
|
994
994
|
# queue_reference: { # required
|
995
995
|
# queue_id: "QueueId", # required
|
996
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
996
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
997
997
|
# },
|
998
998
|
# priority: 1, # required
|
999
999
|
# delay: 1, # required
|
@@ -1277,7 +1277,7 @@ module Aws::Connect
|
|
1277
1277
|
# resp.files[0].file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
1278
1278
|
# resp.files[0].created_by.connect_user_arn #=> String
|
1279
1279
|
# resp.files[0].created_by.aws_identity_arn #=> String
|
1280
|
-
# resp.files[0].file_use_case_type #=> String, one of "ATTACHMENT"
|
1280
|
+
# resp.files[0].file_use_case_type #=> String, one of "EMAIL_MESSAGE", "ATTACHMENT"
|
1281
1281
|
# resp.files[0].associated_resource_arn #=> String
|
1282
1282
|
# resp.files[0].tags #=> Hash
|
1283
1283
|
# resp.files[0].tags["TagKey"] #=> String
|
@@ -1320,7 +1320,7 @@ module Aws::Connect
|
|
1320
1320
|
# resp = client.batch_get_flow_association({
|
1321
1321
|
# instance_id: "InstanceId", # required
|
1322
1322
|
# resource_ids: ["ARN"], # required
|
1323
|
-
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER
|
1323
|
+
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
1324
1324
|
# })
|
1325
1325
|
#
|
1326
1326
|
# @example Response structure
|
@@ -1328,7 +1328,7 @@ module Aws::Connect
|
|
1328
1328
|
# resp.flow_association_summary_list #=> Array
|
1329
1329
|
# resp.flow_association_summary_list[0].resource_id #=> String
|
1330
1330
|
# resp.flow_association_summary_list[0].flow_id #=> String
|
1331
|
-
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER"
|
1331
|
+
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL"
|
1332
1332
|
#
|
1333
1333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchGetFlowAssociation AWS API Documentation
|
1334
1334
|
#
|
@@ -1393,11 +1393,11 @@ module Aws::Connect
|
|
1393
1393
|
# contact_data_request_list: [ # required
|
1394
1394
|
# {
|
1395
1395
|
# system_endpoint: {
|
1396
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
1396
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
1397
1397
|
# address: "EndpointAddress",
|
1398
1398
|
# },
|
1399
1399
|
# customer_endpoint: {
|
1400
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
1400
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
1401
1401
|
# address: "EndpointAddress",
|
1402
1402
|
# },
|
1403
1403
|
# request_identifier: "RequestIdentifier",
|
@@ -1648,6 +1648,87 @@ module Aws::Connect
|
|
1648
1648
|
req.send_request(options)
|
1649
1649
|
end
|
1650
1650
|
|
1651
|
+
# @option params [required, String] :instance_id
|
1652
|
+
#
|
1653
|
+
# @option params [String] :client_token
|
1654
|
+
# **A suitable default value is auto-generated.** You should normally
|
1655
|
+
# not need to pass this option.**
|
1656
|
+
#
|
1657
|
+
# @option params [String] :related_contact_id
|
1658
|
+
#
|
1659
|
+
# @option params [Hash<String,String>] :attributes
|
1660
|
+
#
|
1661
|
+
# @option params [Hash<String,Types::Reference>] :references
|
1662
|
+
#
|
1663
|
+
# @option params [required, String] :channel
|
1664
|
+
#
|
1665
|
+
# @option params [required, String] :initiation_method
|
1666
|
+
#
|
1667
|
+
# @option params [Integer] :expiry_duration_in_minutes
|
1668
|
+
#
|
1669
|
+
# @option params [Types::UserInfo] :user_info
|
1670
|
+
#
|
1671
|
+
# @option params [String] :initiate_as
|
1672
|
+
#
|
1673
|
+
# @option params [String] :name
|
1674
|
+
#
|
1675
|
+
# @option params [String] :description
|
1676
|
+
#
|
1677
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
1678
|
+
#
|
1679
|
+
# @return [Types::CreateContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1680
|
+
#
|
1681
|
+
# * {Types::CreateContactResponse#contact_id #contact_id} => String
|
1682
|
+
# * {Types::CreateContactResponse#contact_arn #contact_arn} => String
|
1683
|
+
#
|
1684
|
+
# @example Request syntax with placeholder values
|
1685
|
+
#
|
1686
|
+
# resp = client.create_contact({
|
1687
|
+
# instance_id: "InstanceId", # required
|
1688
|
+
# client_token: "ClientToken",
|
1689
|
+
# related_contact_id: "ContactId",
|
1690
|
+
# attributes: {
|
1691
|
+
# "AttributeName" => "AttributeValue",
|
1692
|
+
# },
|
1693
|
+
# references: {
|
1694
|
+
# "ReferenceKey" => {
|
1695
|
+
# value: "ReferenceValue",
|
1696
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
1697
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
1698
|
+
# arn: "ReferenceArn",
|
1699
|
+
# status_reason: "ReferenceStatusReason",
|
1700
|
+
# },
|
1701
|
+
# },
|
1702
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
1703
|
+
# initiation_method: "INBOUND", # required, accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
|
1704
|
+
# expiry_duration_in_minutes: 1,
|
1705
|
+
# user_info: {
|
1706
|
+
# user_id: "AgentResourceId",
|
1707
|
+
# },
|
1708
|
+
# initiate_as: "CONNECTED_TO_USER", # accepts CONNECTED_TO_USER
|
1709
|
+
# name: "Name",
|
1710
|
+
# description: "Description",
|
1711
|
+
# segment_attributes: {
|
1712
|
+
# "SegmentAttributeName" => {
|
1713
|
+
# value_string: "SegmentAttributeValueString",
|
1714
|
+
# },
|
1715
|
+
# },
|
1716
|
+
# })
|
1717
|
+
#
|
1718
|
+
# @example Response structure
|
1719
|
+
#
|
1720
|
+
# resp.contact_id #=> String
|
1721
|
+
# resp.contact_arn #=> String
|
1722
|
+
#
|
1723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContact AWS API Documentation
|
1724
|
+
#
|
1725
|
+
# @overload create_contact(params = {})
|
1726
|
+
# @param [Hash] params ({})
|
1727
|
+
def create_contact(params = {}, options = {})
|
1728
|
+
req = build_request(:create_contact, params)
|
1729
|
+
req.send_request(options)
|
1730
|
+
end
|
1731
|
+
|
1651
1732
|
# Creates a flow for the specified Amazon Connect instance.
|
1652
1733
|
#
|
1653
1734
|
# You can also create and update flows using the [Amazon Connect Flow
|
@@ -1699,6 +1780,7 @@ module Aws::Connect
|
|
1699
1780
|
#
|
1700
1781
|
# * {Types::CreateContactFlowResponse#contact_flow_id #contact_flow_id} => String
|
1701
1782
|
# * {Types::CreateContactFlowResponse#contact_flow_arn #contact_flow_arn} => String
|
1783
|
+
# * {Types::CreateContactFlowResponse#flow_content_sha_256 #flow_content_sha_256} => String
|
1702
1784
|
#
|
1703
1785
|
# @example Request syntax with placeholder values
|
1704
1786
|
#
|
@@ -1718,6 +1800,7 @@ module Aws::Connect
|
|
1718
1800
|
#
|
1719
1801
|
# resp.contact_flow_id #=> String
|
1720
1802
|
# resp.contact_flow_arn #=> String
|
1803
|
+
# resp.flow_content_sha_256 #=> String
|
1721
1804
|
#
|
1722
1805
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlow AWS API Documentation
|
1723
1806
|
#
|
@@ -1802,6 +1885,106 @@ module Aws::Connect
|
|
1802
1885
|
req.send_request(options)
|
1803
1886
|
end
|
1804
1887
|
|
1888
|
+
# Publishes a new version of the flow provided. Versions are immutable
|
1889
|
+
# and monotonically increasing. If a version of the same flow content
|
1890
|
+
# already exists, no new version is created and instead the existing
|
1891
|
+
# version number is returned. If the `FlowContentSha256` provided is
|
1892
|
+
# different from the `FlowContentSha256` of the `$LATEST` published flow
|
1893
|
+
# content, then an error is returned. This API only supports creating
|
1894
|
+
# versions for flows of type `Campaign`.
|
1895
|
+
#
|
1896
|
+
# @option params [required, String] :instance_id
|
1897
|
+
# The identifier of the Amazon Connect instance.
|
1898
|
+
#
|
1899
|
+
# @option params [String] :description
|
1900
|
+
# The description of the flow version.
|
1901
|
+
#
|
1902
|
+
# @option params [required, String] :contact_flow_id
|
1903
|
+
# The identifier of the flow.
|
1904
|
+
#
|
1905
|
+
# @option params [String] :flow_content_sha_256
|
1906
|
+
# Indicates the checksum value of the flow content.
|
1907
|
+
#
|
1908
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified_time
|
1909
|
+
# The Amazon Web Services Region where this resource was last modified.
|
1910
|
+
#
|
1911
|
+
# @option params [String] :last_modified_region
|
1912
|
+
# The Amazon Web Services Region where this resource was last modified.
|
1913
|
+
#
|
1914
|
+
# @return [Types::CreateContactFlowVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1915
|
+
#
|
1916
|
+
# * {Types::CreateContactFlowVersionResponse#contact_flow_arn #contact_flow_arn} => String
|
1917
|
+
# * {Types::CreateContactFlowVersionResponse#version #version} => Integer
|
1918
|
+
#
|
1919
|
+
# @example Request syntax with placeholder values
|
1920
|
+
#
|
1921
|
+
# resp = client.create_contact_flow_version({
|
1922
|
+
# instance_id: "InstanceId", # required
|
1923
|
+
# description: "ContactFlowDescription",
|
1924
|
+
# contact_flow_id: "ARN", # required
|
1925
|
+
# flow_content_sha_256: "FlowContentSha256",
|
1926
|
+
# last_modified_time: Time.now,
|
1927
|
+
# last_modified_region: "RegionName",
|
1928
|
+
# })
|
1929
|
+
#
|
1930
|
+
# @example Response structure
|
1931
|
+
#
|
1932
|
+
# resp.contact_flow_arn #=> String
|
1933
|
+
# resp.version #=> Integer
|
1934
|
+
#
|
1935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowVersion AWS API Documentation
|
1936
|
+
#
|
1937
|
+
# @overload create_contact_flow_version(params = {})
|
1938
|
+
# @param [Hash] params ({})
|
1939
|
+
def create_contact_flow_version(params = {}, options = {})
|
1940
|
+
req = build_request(:create_contact_flow_version, params)
|
1941
|
+
req.send_request(options)
|
1942
|
+
end
|
1943
|
+
|
1944
|
+
# @option params [String] :description
|
1945
|
+
#
|
1946
|
+
# @option params [required, String] :instance_id
|
1947
|
+
#
|
1948
|
+
# @option params [required, String] :email_address
|
1949
|
+
#
|
1950
|
+
# @option params [String] :display_name
|
1951
|
+
#
|
1952
|
+
# @option params [Hash<String,String>] :tags
|
1953
|
+
#
|
1954
|
+
# @option params [String] :client_token
|
1955
|
+
#
|
1956
|
+
# @return [Types::CreateEmailAddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1957
|
+
#
|
1958
|
+
# * {Types::CreateEmailAddressResponse#email_address_id #email_address_id} => String
|
1959
|
+
# * {Types::CreateEmailAddressResponse#email_address_arn #email_address_arn} => String
|
1960
|
+
#
|
1961
|
+
# @example Request syntax with placeholder values
|
1962
|
+
#
|
1963
|
+
# resp = client.create_email_address({
|
1964
|
+
# description: "Description",
|
1965
|
+
# instance_id: "InstanceId", # required
|
1966
|
+
# email_address: "EmailAddress", # required
|
1967
|
+
# display_name: "EmailAddressDisplayName",
|
1968
|
+
# tags: {
|
1969
|
+
# "TagKey" => "TagValue",
|
1970
|
+
# },
|
1971
|
+
# client_token: "ClientToken",
|
1972
|
+
# })
|
1973
|
+
#
|
1974
|
+
# @example Response structure
|
1975
|
+
#
|
1976
|
+
# resp.email_address_id #=> String
|
1977
|
+
# resp.email_address_arn #=> String
|
1978
|
+
#
|
1979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEmailAddress AWS API Documentation
|
1980
|
+
#
|
1981
|
+
# @overload create_email_address(params = {})
|
1982
|
+
# @param [Hash] params ({})
|
1983
|
+
def create_email_address(params = {}, options = {})
|
1984
|
+
req = build_request(:create_email_address, params)
|
1985
|
+
req.send_request(options)
|
1986
|
+
end
|
1987
|
+
|
1805
1988
|
# Creates an evaluation form in the specified Amazon Connect instance.
|
1806
1989
|
# The form can be used to define questions related to agent performance,
|
1807
1990
|
# and create sections to organize such questions. Question and section
|
@@ -2137,7 +2320,7 @@ module Aws::Connect
|
|
2137
2320
|
#
|
2138
2321
|
# resp = client.create_integration_association({
|
2139
2322
|
# instance_id: "InstanceId", # required
|
2140
|
-
# integration_type: "EVENT", # required, accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, CASES_DOMAIN, APPLICATION, FILE_SCANNER
|
2323
|
+
# integration_type: "EVENT", # required, accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, Q_MESSAGE_TEMPLATES, CASES_DOMAIN, APPLICATION, FILE_SCANNER, SES_IDENTITY
|
2141
2324
|
# integration_arn: "ARN", # required
|
2142
2325
|
# source_application_url: "URI",
|
2143
2326
|
# source_application_name: "SourceApplicationName",
|
@@ -2289,7 +2472,6 @@ module Aws::Connect
|
|
2289
2472
|
# * SourceContactId = "C2"
|
2290
2473
|
#
|
2291
2474
|
# * RehydrationType = "FROM\_SEGMENT"
|
2292
|
-
#
|
2293
2475
|
# * **Expected behavior**
|
2294
2476
|
#
|
2295
2477
|
# * This starts a persistent chat session from the specified past
|
@@ -2298,7 +2480,6 @@ module Aws::Connect
|
|
2298
2480
|
# chat segment C3 is dropped from the persistent chat session.
|
2299
2481
|
#
|
2300
2482
|
# ^
|
2301
|
-
#
|
2302
2483
|
# * **Use Case 2**: The customer wants to continue the past chat session
|
2303
2484
|
# and see the transcript of the entire past engagement, including the
|
2304
2485
|
# post chat survey. For this they will use the following
|
@@ -2309,7 +2490,6 @@ module Aws::Connect
|
|
2309
2490
|
# * SourceContactId = "C1"
|
2310
2491
|
#
|
2311
2492
|
# * RehydrationType = "ENTIRE\_PAST\_SESSION"
|
2312
|
-
#
|
2313
2493
|
# * **Expected behavior**
|
2314
2494
|
#
|
2315
2495
|
# * This starts a persistent chat session from the most recently
|
@@ -2515,6 +2695,8 @@ module Aws::Connect
|
|
2515
2695
|
# @option params [Types::OutboundCallerConfig] :outbound_caller_config
|
2516
2696
|
# The outbound caller ID name, number, and outbound whisper flow.
|
2517
2697
|
#
|
2698
|
+
# @option params [Types::OutboundEmailConfig] :outbound_email_config
|
2699
|
+
#
|
2518
2700
|
# @option params [required, String] :hours_of_operation_id
|
2519
2701
|
# The identifier for the hours of operation.
|
2520
2702
|
#
|
@@ -2546,6 +2728,9 @@ module Aws::Connect
|
|
2546
2728
|
# outbound_caller_id_number_id: "PhoneNumberId",
|
2547
2729
|
# outbound_flow_id: "ContactFlowId",
|
2548
2730
|
# },
|
2731
|
+
# outbound_email_config: {
|
2732
|
+
# outbound_email_address_id: "EmailAddressId",
|
2733
|
+
# },
|
2549
2734
|
# hours_of_operation_id: "HoursOfOperationId", # required
|
2550
2735
|
# max_contacts: 1,
|
2551
2736
|
# quick_connect_ids: ["QuickConnectId"],
|
@@ -2700,7 +2885,7 @@ module Aws::Connect
|
|
2700
2885
|
# {
|
2701
2886
|
# queue_reference: { # required
|
2702
2887
|
# queue_id: "QueueId", # required
|
2703
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2888
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
2704
2889
|
# },
|
2705
2890
|
# priority: 1, # required
|
2706
2891
|
# delay: 1, # required
|
@@ -2708,7 +2893,7 @@ module Aws::Connect
|
|
2708
2893
|
# ],
|
2709
2894
|
# media_concurrencies: [ # required
|
2710
2895
|
# {
|
2711
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2896
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
2712
2897
|
# concurrency: 1, # required
|
2713
2898
|
# cross_channel_behavior: {
|
2714
2899
|
# behavior_type: "ROUTE_CURRENT_CHANNEL_ONLY", # required, accepts ROUTE_CURRENT_CHANNEL_ONLY, ROUTE_ANY_CHANNEL
|
@@ -2803,8 +2988,11 @@ module Aws::Connect
|
|
2803
2988
|
# contact_flow_id: "ContactFlowId", # required
|
2804
2989
|
# references: {
|
2805
2990
|
# "ReferenceKey" => {
|
2806
|
-
# value: "ReferenceValue",
|
2807
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
2991
|
+
# value: "ReferenceValue",
|
2992
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
2993
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
2994
|
+
# arn: "ReferenceArn",
|
2995
|
+
# status_reason: "ReferenceStatusReason",
|
2808
2996
|
# },
|
2809
2997
|
# },
|
2810
2998
|
# },
|
@@ -3003,6 +3191,8 @@ module Aws::Connect
|
|
3003
3191
|
# The identifier of the flow that runs by default when a task is created
|
3004
3192
|
# by referencing this template.
|
3005
3193
|
#
|
3194
|
+
# @option params [String] :self_assign_flow_id
|
3195
|
+
#
|
3006
3196
|
# @option params [Types::TaskTemplateConstraints] :constraints
|
3007
3197
|
# Constraints that are applicable to the fields listed.
|
3008
3198
|
#
|
@@ -3044,6 +3234,7 @@ module Aws::Connect
|
|
3044
3234
|
# name: "TaskTemplateName", # required
|
3045
3235
|
# description: "TaskTemplateDescription",
|
3046
3236
|
# contact_flow_id: "ContactFlowId",
|
3237
|
+
# self_assign_flow_id: "ContactFlowId",
|
3047
3238
|
# constraints: {
|
3048
3239
|
# required_fields: [
|
3049
3240
|
# {
|
@@ -3084,7 +3275,7 @@ module Aws::Connect
|
|
3084
3275
|
# name: "TaskTemplateFieldName",
|
3085
3276
|
# },
|
3086
3277
|
# description: "TaskTemplateFieldDescription",
|
3087
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
3278
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL, SELF_ASSIGN, EXPIRY_DURATION
|
3088
3279
|
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
3089
3280
|
# },
|
3090
3281
|
# ],
|
@@ -3842,6 +4033,28 @@ module Aws::Connect
|
|
3842
4033
|
req.send_request(options)
|
3843
4034
|
end
|
3844
4035
|
|
4036
|
+
# @option params [required, String] :instance_id
|
4037
|
+
#
|
4038
|
+
# @option params [required, String] :email_address_id
|
4039
|
+
#
|
4040
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4041
|
+
#
|
4042
|
+
# @example Request syntax with placeholder values
|
4043
|
+
#
|
4044
|
+
# resp = client.delete_email_address({
|
4045
|
+
# instance_id: "InstanceId", # required
|
4046
|
+
# email_address_id: "EmailAddressId", # required
|
4047
|
+
# })
|
4048
|
+
#
|
4049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEmailAddress AWS API Documentation
|
4050
|
+
#
|
4051
|
+
# @overload delete_email_address(params = {})
|
4052
|
+
# @param [Hash] params ({})
|
4053
|
+
def delete_email_address(params = {}, options = {})
|
4054
|
+
req = build_request(:delete_email_address, params)
|
4055
|
+
req.send_request(options)
|
4056
|
+
end
|
4057
|
+
|
3845
4058
|
# Deletes an evaluation form in the specified Amazon Connect instance.
|
3846
4059
|
#
|
3847
4060
|
# * If the version property is provided, only the specified version of
|
@@ -4651,10 +4864,11 @@ module Aws::Connect
|
|
4651
4864
|
# resp.contact.id #=> String
|
4652
4865
|
# resp.contact.initial_contact_id #=> String
|
4653
4866
|
# resp.contact.previous_contact_id #=> String
|
4654
|
-
# resp.contact.
|
4867
|
+
# resp.contact.contact_association_id #=> String
|
4868
|
+
# resp.contact.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
|
4655
4869
|
# resp.contact.name #=> String
|
4656
4870
|
# resp.contact.description #=> String
|
4657
|
-
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
4871
|
+
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
4658
4872
|
# resp.contact.queue_info.id #=> String
|
4659
4873
|
# resp.contact.queue_info.enqueue_timestamp #=> Time
|
4660
4874
|
# resp.contact.agent_info.id #=> String
|
@@ -4680,6 +4894,12 @@ module Aws::Connect
|
|
4680
4894
|
# resp.contact.scheduled_timestamp #=> Time
|
4681
4895
|
# resp.contact.related_contact_id #=> String
|
4682
4896
|
# resp.contact.wisdom_info.session_arn #=> String
|
4897
|
+
# resp.contact.customer_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
|
4898
|
+
# resp.contact.customer_endpoint.address #=> String
|
4899
|
+
# resp.contact.customer_endpoint.display_name #=> String
|
4900
|
+
# resp.contact.system_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
|
4901
|
+
# resp.contact.system_endpoint.address #=> String
|
4902
|
+
# resp.contact.system_endpoint.display_name #=> String
|
4683
4903
|
# resp.contact.queue_time_adjustment_seconds #=> Integer
|
4684
4904
|
# resp.contact.queue_priority #=> Integer
|
4685
4905
|
# resp.contact.tags #=> Hash
|
@@ -4717,6 +4937,12 @@ module Aws::Connect
|
|
4717
4937
|
# resp.contact.quality_metrics.customer.audio.potential_quality_issues #=> Array
|
4718
4938
|
# resp.contact.quality_metrics.customer.audio.potential_quality_issues[0] #=> String
|
4719
4939
|
# resp.contact.disconnect_details.potential_disconnect_issue #=> String
|
4940
|
+
# resp.contact.additional_email_recipients.to_list #=> Array
|
4941
|
+
# resp.contact.additional_email_recipients.to_list[0].address #=> String
|
4942
|
+
# resp.contact.additional_email_recipients.to_list[0].display_name #=> String
|
4943
|
+
# resp.contact.additional_email_recipients.cc_list #=> Array
|
4944
|
+
# resp.contact.additional_email_recipients.cc_list[0].address #=> String
|
4945
|
+
# resp.contact.additional_email_recipients.cc_list[0].display_name #=> String
|
4720
4946
|
# resp.contact.segment_attributes #=> Hash
|
4721
4947
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_string #=> String
|
4722
4948
|
#
|
@@ -4879,6 +5105,12 @@ module Aws::Connect
|
|
4879
5105
|
# resp.contact_flow.content #=> String
|
4880
5106
|
# resp.contact_flow.tags #=> Hash
|
4881
5107
|
# resp.contact_flow.tags["TagKey"] #=> String
|
5108
|
+
# resp.contact_flow.is_default #=> Boolean
|
5109
|
+
# resp.contact_flow.flow_content_sha_256 #=> String
|
5110
|
+
# resp.contact_flow.version #=> Integer
|
5111
|
+
# resp.contact_flow.version_description #=> String
|
5112
|
+
# resp.contact_flow.last_modified_time #=> Time
|
5113
|
+
# resp.contact_flow.last_modified_region #=> String
|
4882
5114
|
#
|
4883
5115
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlow AWS API Documentation
|
4884
5116
|
#
|
@@ -4939,6 +5171,49 @@ module Aws::Connect
|
|
4939
5171
|
req.send_request(options)
|
4940
5172
|
end
|
4941
5173
|
|
5174
|
+
# @option params [required, String] :instance_id
|
5175
|
+
#
|
5176
|
+
# @option params [required, String] :email_address_id
|
5177
|
+
#
|
5178
|
+
# @return [Types::DescribeEmailAddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5179
|
+
#
|
5180
|
+
# * {Types::DescribeEmailAddressResponse#email_address_id #email_address_id} => String
|
5181
|
+
# * {Types::DescribeEmailAddressResponse#email_address_arn #email_address_arn} => String
|
5182
|
+
# * {Types::DescribeEmailAddressResponse#email_address #email_address} => String
|
5183
|
+
# * {Types::DescribeEmailAddressResponse#display_name #display_name} => String
|
5184
|
+
# * {Types::DescribeEmailAddressResponse#description #description} => String
|
5185
|
+
# * {Types::DescribeEmailAddressResponse#create_timestamp #create_timestamp} => String
|
5186
|
+
# * {Types::DescribeEmailAddressResponse#modified_timestamp #modified_timestamp} => String
|
5187
|
+
# * {Types::DescribeEmailAddressResponse#tags #tags} => Hash<String,String>
|
5188
|
+
#
|
5189
|
+
# @example Request syntax with placeholder values
|
5190
|
+
#
|
5191
|
+
# resp = client.describe_email_address({
|
5192
|
+
# instance_id: "InstanceId", # required
|
5193
|
+
# email_address_id: "EmailAddressId", # required
|
5194
|
+
# })
|
5195
|
+
#
|
5196
|
+
# @example Response structure
|
5197
|
+
#
|
5198
|
+
# resp.email_address_id #=> String
|
5199
|
+
# resp.email_address_arn #=> String
|
5200
|
+
# resp.email_address #=> String
|
5201
|
+
# resp.display_name #=> String
|
5202
|
+
# resp.description #=> String
|
5203
|
+
# resp.create_timestamp #=> String
|
5204
|
+
# resp.modified_timestamp #=> String
|
5205
|
+
# resp.tags #=> Hash
|
5206
|
+
# resp.tags["TagKey"] #=> String
|
5207
|
+
#
|
5208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEmailAddress AWS API Documentation
|
5209
|
+
#
|
5210
|
+
# @overload describe_email_address(params = {})
|
5211
|
+
# @param [Hash] params ({})
|
5212
|
+
def describe_email_address(params = {}, options = {})
|
5213
|
+
req = build_request(:describe_email_address, params)
|
5214
|
+
req.send_request(options)
|
5215
|
+
end
|
5216
|
+
|
4942
5217
|
# Describes an evaluation form in the specified Amazon Connect instance.
|
4943
5218
|
# If the version property is not provided, the latest version of the
|
4944
5219
|
# evaluation form is described.
|
@@ -5214,7 +5489,7 @@ module Aws::Connect
|
|
5214
5489
|
# resp = client.describe_instance_storage_config({
|
5215
5490
|
# instance_id: "InstanceId", # required
|
5216
5491
|
# association_id: "AssociationId", # required
|
5217
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
|
5492
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
|
5218
5493
|
# })
|
5219
5494
|
#
|
5220
5495
|
# @example Response structure
|
@@ -5417,6 +5692,7 @@ module Aws::Connect
|
|
5417
5692
|
# resp.queue.outbound_caller_config.outbound_caller_id_name #=> String
|
5418
5693
|
# resp.queue.outbound_caller_config.outbound_caller_id_number_id #=> String
|
5419
5694
|
# resp.queue.outbound_caller_config.outbound_flow_id #=> String
|
5695
|
+
# resp.queue.outbound_email_config.outbound_email_address_id #=> String
|
5420
5696
|
# resp.queue.hours_of_operation_id #=> String
|
5421
5697
|
# resp.queue.max_contacts #=> Integer
|
5422
5698
|
# resp.queue.status #=> String, one of "ENABLED", "DISABLED"
|
@@ -5516,7 +5792,7 @@ module Aws::Connect
|
|
5516
5792
|
# resp.routing_profile.routing_profile_id #=> String
|
5517
5793
|
# resp.routing_profile.description #=> String
|
5518
5794
|
# resp.routing_profile.media_concurrencies #=> Array
|
5519
|
-
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
5795
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
5520
5796
|
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
5521
5797
|
# resp.routing_profile.media_concurrencies[0].cross_channel_behavior.behavior_type #=> String, one of "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL"
|
5522
5798
|
# resp.routing_profile.default_outbound_queue_id #=> String
|
@@ -5579,7 +5855,10 @@ module Aws::Connect
|
|
5579
5855
|
# resp.rule.actions[0].task_action.contact_flow_id #=> String
|
5580
5856
|
# resp.rule.actions[0].task_action.references #=> Hash
|
5581
5857
|
# resp.rule.actions[0].task_action.references["ReferenceKey"].value #=> String
|
5582
|
-
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "NUMBER", "STRING", "DATE", "EMAIL"
|
5858
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "CONTACT_ANALYSIS", "NUMBER", "STRING", "DATE", "EMAIL", "EMAIL_MESSAGE"
|
5859
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
5860
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].arn #=> String
|
5861
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].status_reason #=> String
|
5583
5862
|
# resp.rule.actions[0].event_bridge_action.name #=> String
|
5584
5863
|
# resp.rule.actions[0].send_notification_action.delivery_method #=> String, one of "EMAIL"
|
5585
5864
|
# resp.rule.actions[0].send_notification_action.subject #=> String
|
@@ -6157,7 +6436,7 @@ module Aws::Connect
|
|
6157
6436
|
# resp = client.disassociate_flow({
|
6158
6437
|
# instance_id: "InstanceId", # required
|
6159
6438
|
# resource_id: "ARN", # required
|
6160
|
-
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
6439
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
6161
6440
|
# })
|
6162
6441
|
#
|
6163
6442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlow AWS API Documentation
|
@@ -6197,7 +6476,7 @@ module Aws::Connect
|
|
6197
6476
|
# resp = client.disassociate_instance_storage_config({
|
6198
6477
|
# instance_id: "InstanceId", # required
|
6199
6478
|
# association_id: "AssociationId", # required
|
6200
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
|
6479
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
|
6201
6480
|
# })
|
6202
6481
|
#
|
6203
6482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfig AWS API Documentation
|
@@ -6392,7 +6671,7 @@ module Aws::Connect
|
|
6392
6671
|
# queue_references: [ # required
|
6393
6672
|
# {
|
6394
6673
|
# queue_id: "QueueId", # required
|
6395
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
6674
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
6396
6675
|
# },
|
6397
6676
|
# ],
|
6398
6677
|
# })
|
@@ -6612,7 +6891,7 @@ module Aws::Connect
|
|
6612
6891
|
# resp.file_name #=> String
|
6613
6892
|
# resp.file_size_in_bytes #=> Integer
|
6614
6893
|
# resp.associated_resource_arn #=> String
|
6615
|
-
# resp.file_use_case_type #=> String, one of "ATTACHMENT"
|
6894
|
+
# resp.file_use_case_type #=> String, one of "EMAIL_MESSAGE", "ATTACHMENT"
|
6616
6895
|
# resp.created_by.connect_user_arn #=> String
|
6617
6896
|
# resp.created_by.aws_identity_arn #=> String
|
6618
6897
|
# resp.download_url_metadata.url #=> String
|
@@ -6881,7 +7160,7 @@ module Aws::Connect
|
|
6881
7160
|
# instance_id: "InstanceId", # required
|
6882
7161
|
# filters: { # required
|
6883
7162
|
# queues: ["QueueId"],
|
6884
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
7163
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
6885
7164
|
# routing_profiles: ["RoutingProfileId"],
|
6886
7165
|
# routing_step_expressions: ["RoutingExpression"],
|
6887
7166
|
# },
|
@@ -6908,7 +7187,7 @@ module Aws::Connect
|
|
6908
7187
|
# resp.metric_results #=> Array
|
6909
7188
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
6910
7189
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
6911
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
7190
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
6912
7191
|
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
6913
7192
|
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
6914
7193
|
# resp.metric_results[0].dimensions.routing_step_expression #=> String
|
@@ -7022,8 +7301,8 @@ module Aws::Connect
|
|
7022
7301
|
# resp.user_data_list[0].active_slots_by_channel["Channel"] #=> Integer
|
7023
7302
|
# resp.user_data_list[0].contacts #=> Array
|
7024
7303
|
# resp.user_data_list[0].contacts[0].contact_id #=> String
|
7025
|
-
# resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
7026
|
-
# resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND"
|
7304
|
+
# resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
7305
|
+
# resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
|
7027
7306
|
# resp.user_data_list[0].contacts[0].agent_contact_state #=> String, one of "INCOMING", "PENDING", "CONNECTING", "CONNECTED", "CONNECTED_ONHOLD", "MISSED", "ERROR", "ENDED", "REJECTED"
|
7028
7307
|
# resp.user_data_list[0].contacts[0].state_start_timestamp #=> Time
|
7029
7308
|
# resp.user_data_list[0].contacts[0].connected_to_agent_timestamp #=> Time
|
@@ -7129,14 +7408,14 @@ module Aws::Connect
|
|
7129
7408
|
# resp = client.get_flow_association({
|
7130
7409
|
# instance_id: "InstanceId", # required
|
7131
7410
|
# resource_id: "ARN", # required
|
7132
|
-
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
7411
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
7133
7412
|
# })
|
7134
7413
|
#
|
7135
7414
|
# @example Response structure
|
7136
7415
|
#
|
7137
7416
|
# resp.resource_id #=> String
|
7138
7417
|
# resp.flow_id #=> String
|
7139
|
-
# resp.resource_type #=> String, one of "SMS_PHONE_NUMBER"
|
7418
|
+
# resp.resource_type #=> String, one of "SMS_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL"
|
7140
7419
|
#
|
7141
7420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociation AWS API Documentation
|
7142
7421
|
#
|
@@ -7416,7 +7695,7 @@ module Aws::Connect
|
|
7416
7695
|
# end_time: Time.now, # required
|
7417
7696
|
# filters: { # required
|
7418
7697
|
# queues: ["QueueId"],
|
7419
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
7698
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
7420
7699
|
# routing_profiles: ["RoutingProfileId"],
|
7421
7700
|
# routing_step_expressions: ["RoutingExpression"],
|
7422
7701
|
# },
|
@@ -7442,7 +7721,7 @@ module Aws::Connect
|
|
7442
7721
|
# resp.metric_results #=> Array
|
7443
7722
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
7444
7723
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
7445
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
7724
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
7446
7725
|
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
7447
7726
|
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
7448
7727
|
# resp.metric_results[0].dimensions.routing_step_expression #=> String
|
@@ -7532,7 +7811,6 @@ module Aws::Connect
|
|
7532
7811
|
#
|
7533
7812
|
# * `TOTAL`: The difference between `StartTime` and `EndTime` must be
|
7534
7813
|
# less than 35 days.
|
7535
|
-
#
|
7536
7814
|
# * `TimeZone`: The timezone applied to requested metrics.
|
7537
7815
|
#
|
7538
7816
|
# @option params [required, Array<Types::FilterV2>] :filters
|
@@ -7571,12 +7849,13 @@ module Aws::Connect
|
|
7571
7849
|
# `AGENT_HIERARCHY_LEVEL_ONE` \| `AGENT_HIERARCHY_LEVEL_TWO` \|
|
7572
7850
|
# `AGENT_HIERARCHY_LEVEL_THREE` \| `AGENT_HIERARCHY_LEVEL_FOUR` \|
|
7573
7851
|
# `AGENT_HIERARCHY_LEVEL_FIVE` \| `ANSWERING_MACHINE_DETECTION_STATUS`
|
7574
|
-
# \| `CAMPAIGN` \| `
|
7575
|
-
# \| `
|
7576
|
-
# `
|
7577
|
-
# `
|
7578
|
-
# `
|
7579
|
-
#
|
7852
|
+
# \| `CAMPAIGN` \| `CAMPAIGN_DELIVERY_EVENT_TYPE`
|
7853
|
+
# \|`CASE_TEMPLATE_ARN` \| `CASE_STATUS` \| `CHANNEL` \|
|
7854
|
+
# `contact/segmentAttributes/connect:Subtype` \| `DISCONNECT_REASON`
|
7855
|
+
# \| `FEATURE` \| `FLOW_TYPE` \| `FLOWS_NEXT_RESOURCE_ID` \|
|
7856
|
+
# `FLOWS_NEXT_RESOURCE_QUEUE_ID` \| `FLOWS_OUTCOME_TYPE` \|
|
7857
|
+
# `FLOWS_RESOURCE_ID` \| `INITIATION_METHOD` \|
|
7858
|
+
# `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
7580
7859
|
# `ROUTING_STEP_EXPRESSION` \| `QUEUE` \| `Q_CONNECT_ENABLED` \|
|
7581
7860
|
#
|
7582
7861
|
# * **Filter values**: A maximum of 100 filter values are supported in a
|
@@ -7607,7 +7886,6 @@ module Aws::Connect
|
|
7607
7886
|
#
|
7608
7887
|
# * FALSE includes all contacts that did not have Amazon Q in Connect
|
7609
7888
|
# enabled as part of the flow
|
7610
|
-
#
|
7611
7889
|
# This filter is available only for contact record-driven metrics.
|
7612
7890
|
#
|
7613
7891
|
# [Campaign][2] ARNs are valid `filterValues` for the `CAMPAIGN`
|
@@ -7630,11 +7908,12 @@ module Aws::Connect
|
|
7630
7908
|
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
7631
7909
|
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
|
7632
7910
|
# `ANSWERING_MACHINE_DETECTION_STATUS` \| `CAMPAIGN` \|
|
7633
|
-
# `
|
7634
|
-
# `contact/segmentAttributes/connect:Subtype` \|
|
7635
|
-
# `
|
7636
|
-
# `
|
7637
|
-
# `
|
7911
|
+
# `CAMPAIGN_DELIVERY_EVENT_TYPE` \| `CASE_TEMPLATE_ARN` \| `CASE_STATUS`
|
7912
|
+
# \| `CHANNEL` \| `contact/segmentAttributes/connect:Subtype` \|
|
7913
|
+
# `DISCONNECT_REASON` \| `FLOWS_RESOURCE_ID` \|
|
7914
|
+
# `FLOWS_MODULE_RESOURCE_ID` \| `FLOW_TYPE` \| `FLOWS_OUTCOME_TYPE` \|
|
7915
|
+
# `INITIATION_METHOD` \| `Q_CONNECT_ENABLED` \| `QUEUE` \|
|
7916
|
+
# `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
7638
7917
|
# `ROUTING_STEP_EXPRESSION`
|
7639
7918
|
#
|
7640
7919
|
# @option params [required, Array<Types::MetricV2>] :metrics
|
@@ -7844,12 +8123,12 @@ module Aws::Connect
|
|
7844
8123
|
#
|
7845
8124
|
# AVG\_DIALS\_PER\_MINUTE
|
7846
8125
|
#
|
7847
|
-
# : This metric is available only for
|
7848
|
-
#
|
8126
|
+
# : This metric is available only for outbound campaigns that use the
|
8127
|
+
# agent assisted voice and automated voice delivery modes.
|
7849
8128
|
#
|
7850
8129
|
# Unit: Count
|
7851
8130
|
#
|
7852
|
-
# Valid groupings and filters:
|
8131
|
+
# Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
|
7853
8132
|
#
|
7854
8133
|
# UI name: [Average dials per minute][21]
|
7855
8134
|
#
|
@@ -8057,8 +8336,8 @@ module Aws::Connect
|
|
8057
8336
|
#
|
8058
8337
|
# AVG\_WAIT\_TIME\_AFTER\_CUSTOMER\_CONNECTION
|
8059
8338
|
#
|
8060
|
-
# : This metric is available only for
|
8061
|
-
#
|
8339
|
+
# : This metric is available only for outbound campaigns that use the
|
8340
|
+
# agent assisted voice and automated voice delivery modes.
|
8062
8341
|
#
|
8063
8342
|
# Unit: Seconds
|
8064
8343
|
#
|
@@ -8068,12 +8347,12 @@ module Aws::Connect
|
|
8068
8347
|
#
|
8069
8348
|
# CAMPAIGN\_CONTACTS\_ABANDONED\_AFTER\_X
|
8070
8349
|
#
|
8071
|
-
# : This metric is available only for
|
8072
|
-
#
|
8350
|
+
# : This metric is available only for outbound campaigns using the agent
|
8351
|
+
# assisted voice and automated voice delivery modes.
|
8073
8352
|
#
|
8074
8353
|
# Unit: Count
|
8075
8354
|
#
|
8076
|
-
# Valid groupings and filters:
|
8355
|
+
# Valid groupings and filters: Agent, Campaign
|
8077
8356
|
#
|
8078
8357
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8079
8358
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
@@ -8083,12 +8362,12 @@ module Aws::Connect
|
|
8083
8362
|
#
|
8084
8363
|
# CAMPAIGN\_CONTACTS\_ABANDONED\_AFTER\_X\_RATE
|
8085
8364
|
#
|
8086
|
-
# : This metric is available only for
|
8087
|
-
#
|
8365
|
+
# : This metric is available only for outbound campaigns using the agent
|
8366
|
+
# assisted voice and automated voice delivery modes.
|
8088
8367
|
#
|
8089
8368
|
# Unit: Percent
|
8090
8369
|
#
|
8091
|
-
# Valid groupings and filters:
|
8370
|
+
# Valid groupings and filters: Agent, Campaign
|
8092
8371
|
#
|
8093
8372
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8094
8373
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
@@ -8096,6 +8375,30 @@ module Aws::Connect
|
|
8096
8375
|
#
|
8097
8376
|
# UI name: [Campaign contacts abandoned after X rate][40]
|
8098
8377
|
#
|
8378
|
+
# CAMPAIGN\_INTERACTIONS
|
8379
|
+
#
|
8380
|
+
# : This metric is available only for outbound campaigns using the email
|
8381
|
+
# delivery mode.
|
8382
|
+
#
|
8383
|
+
# Unit: Count
|
8384
|
+
#
|
8385
|
+
# Valid metric filter key: CAMPAIGN\_INTERACTION\_EVENT\_TYPE
|
8386
|
+
#
|
8387
|
+
# Valid groupings and filters: Campaign
|
8388
|
+
#
|
8389
|
+
# UI name: [Campaign interactions][41]
|
8390
|
+
#
|
8391
|
+
# CAMPAIGN\_SEND\_ATTEMPTS
|
8392
|
+
#
|
8393
|
+
# : This metric is available only for outbound campaigns.
|
8394
|
+
#
|
8395
|
+
# Unit: Count
|
8396
|
+
#
|
8397
|
+
# Valid groupings and filters: Campaign, Channel,
|
8398
|
+
# contact/segmentAttributes/connect:Subtype
|
8399
|
+
#
|
8400
|
+
# UI name: [Campaign send attempts][42]
|
8401
|
+
#
|
8099
8402
|
# CASES\_CREATED
|
8100
8403
|
#
|
8101
8404
|
# : Unit: Count
|
@@ -8104,7 +8407,7 @@ module Aws::Connect
|
|
8104
8407
|
#
|
8105
8408
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8106
8409
|
#
|
8107
|
-
# UI name: [Cases created][
|
8410
|
+
# UI name: [Cases created][43]
|
8108
8411
|
#
|
8109
8412
|
# CONTACTS\_CREATED
|
8110
8413
|
#
|
@@ -8115,7 +8418,7 @@ module Aws::Connect
|
|
8115
8418
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
8116
8419
|
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
|
8117
8420
|
#
|
8118
|
-
# UI name: [Contacts created][
|
8421
|
+
# UI name: [Contacts created][44]
|
8119
8422
|
#
|
8120
8423
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
8121
8424
|
#
|
@@ -8131,7 +8434,7 @@ module Aws::Connect
|
|
8131
8434
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
8132
8435
|
# RoutingStepExpression, Q in Connect
|
8133
8436
|
#
|
8134
|
-
# UI name: [API contacts handled][
|
8437
|
+
# UI name: [API contacts handled][45]
|
8135
8438
|
#
|
8136
8439
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
8137
8440
|
#
|
@@ -8146,7 +8449,7 @@ module Aws::Connect
|
|
8146
8449
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
8147
8450
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8148
8451
|
#
|
8149
|
-
# UI name: [Contacts handled (connected to agent timestamp)][
|
8452
|
+
# UI name: [Contacts handled (connected to agent timestamp)][46]
|
8150
8453
|
#
|
8151
8454
|
# CONTACTS\_HOLD\_ABANDONS
|
8152
8455
|
#
|
@@ -8156,7 +8459,7 @@ module Aws::Connect
|
|
8156
8459
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8157
8460
|
# Connect
|
8158
8461
|
#
|
8159
|
-
# UI name: [Contacts hold disconnect][
|
8462
|
+
# UI name: [Contacts hold disconnect][46]
|
8160
8463
|
#
|
8161
8464
|
# CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
|
8162
8465
|
#
|
@@ -8165,7 +8468,7 @@ module Aws::Connect
|
|
8165
8468
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8166
8469
|
# Agent Hierarchy, Q in Connect
|
8167
8470
|
#
|
8168
|
-
# UI name: [Contacts hold agent disconnect][
|
8471
|
+
# UI name: [Contacts hold agent disconnect][47]
|
8169
8472
|
#
|
8170
8473
|
# CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
|
8171
8474
|
#
|
@@ -8174,7 +8477,7 @@ module Aws::Connect
|
|
8174
8477
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8175
8478
|
# Agent Hierarchy, Q in Connect
|
8176
8479
|
#
|
8177
|
-
# UI name: [Contacts hold customer disconnect][
|
8480
|
+
# UI name: [Contacts hold customer disconnect][48]
|
8178
8481
|
#
|
8179
8482
|
# CONTACTS\_PUT\_ON\_HOLD
|
8180
8483
|
#
|
@@ -8183,7 +8486,7 @@ module Aws::Connect
|
|
8183
8486
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8184
8487
|
# Agent Hierarchy, Q in Connect
|
8185
8488
|
#
|
8186
|
-
# UI name: [Contacts put on hold][
|
8489
|
+
# UI name: [Contacts put on hold][48]
|
8187
8490
|
#
|
8188
8491
|
# CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
|
8189
8492
|
#
|
@@ -8192,7 +8495,7 @@ module Aws::Connect
|
|
8192
8495
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8193
8496
|
# Agent Hierarchy, Q in Connect
|
8194
8497
|
#
|
8195
|
-
# UI name: [Contacts transferred out external][
|
8498
|
+
# UI name: [Contacts transferred out external][49]
|
8196
8499
|
#
|
8197
8500
|
# CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
|
8198
8501
|
#
|
@@ -8201,7 +8504,7 @@ module Aws::Connect
|
|
8201
8504
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8202
8505
|
# Agent Hierarchy, Q in Connect
|
8203
8506
|
#
|
8204
|
-
# UI name: [Contacts transferred out internal][
|
8507
|
+
# UI name: [Contacts transferred out internal][50]
|
8205
8508
|
#
|
8206
8509
|
# CONTACTS\_QUEUED
|
8207
8510
|
#
|
@@ -8211,7 +8514,7 @@ module Aws::Connect
|
|
8211
8514
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8212
8515
|
# Connect
|
8213
8516
|
#
|
8214
|
-
# UI name: [Contacts queued][
|
8517
|
+
# UI name: [Contacts queued][51]
|
8215
8518
|
#
|
8216
8519
|
# CONTACTS\_QUEUED\_BY\_ENQUEUE
|
8217
8520
|
#
|
@@ -8220,7 +8523,7 @@ module Aws::Connect
|
|
8220
8523
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
8221
8524
|
# contact/segmentAttributes/connect:Subtype
|
8222
8525
|
#
|
8223
|
-
# UI name: [Contacts queued (enqueue timestamp)][
|
8526
|
+
# UI name: [Contacts queued (enqueue timestamp)][52]
|
8224
8527
|
#
|
8225
8528
|
# CONTACTS\_REMOVED\_FROM\_QUEUE\_IN\_X
|
8226
8529
|
#
|
@@ -8233,7 +8536,7 @@ module Aws::Connect
|
|
8233
8536
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8234
8537
|
# (for "Less than") or `LTE` (for "Less than equal").
|
8235
8538
|
#
|
8236
|
-
# UI name: [Contacts removed from queue in X seconds][
|
8539
|
+
# UI name: [Contacts removed from queue in X seconds][53]
|
8237
8540
|
#
|
8238
8541
|
# CONTACTS\_RESOLVED\_IN\_X
|
8239
8542
|
#
|
@@ -8246,7 +8549,7 @@ module Aws::Connect
|
|
8246
8549
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8247
8550
|
# (for "Less than") or `LTE` (for "Less than equal").
|
8248
8551
|
#
|
8249
|
-
# UI name: [Contacts resolved in X][
|
8552
|
+
# UI name: [Contacts resolved in X][54]
|
8250
8553
|
#
|
8251
8554
|
# CONTACTS\_TRANSFERRED\_OUT
|
8252
8555
|
#
|
@@ -8256,7 +8559,7 @@ module Aws::Connect
|
|
8256
8559
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
8257
8560
|
# Q in Connect
|
8258
8561
|
#
|
8259
|
-
# UI name: [Contacts transferred out][
|
8562
|
+
# UI name: [Contacts transferred out][55]
|
8260
8563
|
#
|
8261
8564
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
8262
8565
|
#
|
@@ -8270,7 +8573,7 @@ module Aws::Connect
|
|
8270
8573
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8271
8574
|
# Connect
|
8272
8575
|
#
|
8273
|
-
# UI name: [Contacts transferred out by agent][
|
8576
|
+
# UI name: [Contacts transferred out by agent][56]
|
8274
8577
|
#
|
8275
8578
|
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
8276
8579
|
#
|
@@ -8280,7 +8583,7 @@ module Aws::Connect
|
|
8280
8583
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8281
8584
|
# Connect
|
8282
8585
|
#
|
8283
|
-
# UI name: [Contacts transferred out queue][
|
8586
|
+
# UI name: [Contacts transferred out queue][56]
|
8284
8587
|
#
|
8285
8588
|
# CURRENT\_CASES
|
8286
8589
|
#
|
@@ -8290,43 +8593,57 @@ module Aws::Connect
|
|
8290
8593
|
#
|
8291
8594
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8292
8595
|
#
|
8293
|
-
# UI name: [Current cases][
|
8596
|
+
# UI name: [Current cases][57]
|
8294
8597
|
#
|
8295
8598
|
# DELIVERY\_ATTEMPTS
|
8296
8599
|
#
|
8297
|
-
# : This metric is available only for
|
8298
|
-
# campaigns analytics.
|
8600
|
+
# : This metric is available only for outbound campaigns.
|
8299
8601
|
#
|
8300
8602
|
# Unit: Count
|
8301
8603
|
#
|
8302
8604
|
# Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
|
8303
|
-
# `DISCONNECT_REASON`
|
8605
|
+
# `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
|
8606
|
+
#
|
8607
|
+
# Valid groupings and filters: Agent, Answering Machine Detection
|
8608
|
+
# Status, Campaign, Campaign Delivery EventType, Channel,
|
8609
|
+
# contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,
|
8610
|
+
# Routing Profile
|
8304
8611
|
#
|
8305
|
-
#
|
8306
|
-
# Profile, Answering Machine Detection Status, Disconnect Reason
|
8612
|
+
# UI name: [Delivery attempts][58]
|
8307
8613
|
#
|
8308
|
-
#
|
8614
|
+
# <note markdown="1"> Campaign Delivery EventType filter and grouping are only available
|
8615
|
+
# for SMS and Email campaign delivery modes. Agent, Queue, Routing
|
8616
|
+
# Profile, Answering Machine Detection Status and Disconnect Reason
|
8617
|
+
# are only available for agent assisted voice and automated voice
|
8618
|
+
# delivery modes.
|
8619
|
+
#
|
8620
|
+
# </note>
|
8309
8621
|
#
|
8310
8622
|
# DELIVERY\_ATTEMPT\_DISPOSITION\_RATE
|
8311
8623
|
#
|
8312
|
-
# : This metric is available only for
|
8313
|
-
#
|
8314
|
-
# enabled.
|
8624
|
+
# : This metric is available only for outbound campaigns. Dispositions
|
8625
|
+
# for the agent assisted voice and automated voice delivery modes are
|
8626
|
+
# only available with answering machine detection enabled.
|
8315
8627
|
#
|
8316
8628
|
# Unit: Percent
|
8317
8629
|
#
|
8318
8630
|
# Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
|
8319
|
-
# `DISCONNECT_REASON`
|
8631
|
+
# `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
|
8320
8632
|
#
|
8321
|
-
# Valid groupings and filters:
|
8322
|
-
#
|
8633
|
+
# Valid groupings and filters: Agent, Answering Machine Detection
|
8634
|
+
# Status, Campaign, Channel,
|
8635
|
+
# contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,
|
8636
|
+
# Routing Profile
|
8323
8637
|
#
|
8324
|
-
#
|
8325
|
-
# filters but not valid groupings.
|
8638
|
+
# UI name: [Delivery attempt disposition rate][59]
|
8326
8639
|
#
|
8327
|
-
#
|
8640
|
+
# <note markdown="1"> Campaign Delivery Event Type filter and grouping are only available
|
8641
|
+
# for SMS and Email campaign delivery modes. Agent, Queue, Routing
|
8642
|
+
# Profile, Answering Machine Detection Status and Disconnect Reason
|
8643
|
+
# are only available for agent assisted voice and automated voice
|
8644
|
+
# delivery modes.
|
8328
8645
|
#
|
8329
|
-
#
|
8646
|
+
# </note>
|
8330
8647
|
#
|
8331
8648
|
# FLOWS\_OUTCOME
|
8332
8649
|
#
|
@@ -8338,7 +8655,7 @@ module Aws::Connect
|
|
8338
8655
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8339
8656
|
# published timestamp
|
8340
8657
|
#
|
8341
|
-
# UI name: [Flows outcome][
|
8658
|
+
# UI name: [Flows outcome][60]
|
8342
8659
|
#
|
8343
8660
|
# FLOWS\_STARTED
|
8344
8661
|
#
|
@@ -8349,19 +8666,19 @@ module Aws::Connect
|
|
8349
8666
|
# resource ID, Flows resource ID, Initiation method, Resource
|
8350
8667
|
# published timestamp
|
8351
8668
|
#
|
8352
|
-
# UI name: [Flows started][
|
8669
|
+
# UI name: [Flows started][61]
|
8353
8670
|
#
|
8354
8671
|
# HUMAN\_ANSWERED\_CALLS
|
8355
8672
|
#
|
8356
|
-
# : This metric is available only for
|
8357
|
-
#
|
8358
|
-
# enabled.
|
8673
|
+
# : This metric is available only for outbound campaigns. Dispositions
|
8674
|
+
# for the agent assisted voice and automated voice delivery modes are
|
8675
|
+
# only available with answering machine detection enabled.
|
8359
8676
|
#
|
8360
8677
|
# Unit: Count
|
8361
8678
|
#
|
8362
|
-
# Valid groupings and filters:
|
8679
|
+
# Valid groupings and filters: Agent, Campaign
|
8363
8680
|
#
|
8364
|
-
# UI name: [Human answered][
|
8681
|
+
# UI name: [Human answered][62]
|
8365
8682
|
#
|
8366
8683
|
# MAX\_FLOW\_TIME
|
8367
8684
|
#
|
@@ -8373,7 +8690,7 @@ module Aws::Connect
|
|
8373
8690
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8374
8691
|
# published timestamp
|
8375
8692
|
#
|
8376
|
-
# UI name: [Maximum flow time][
|
8693
|
+
# UI name: [Maximum flow time][63]
|
8377
8694
|
#
|
8378
8695
|
# MAX\_QUEUED\_TIME
|
8379
8696
|
#
|
@@ -8383,7 +8700,7 @@ module Aws::Connect
|
|
8383
8700
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8384
8701
|
# Connect
|
8385
8702
|
#
|
8386
|
-
# UI name: [Maximum queued time][
|
8703
|
+
# UI name: [Maximum queued time][64]
|
8387
8704
|
#
|
8388
8705
|
# MIN\_FLOW\_TIME
|
8389
8706
|
#
|
@@ -8395,7 +8712,7 @@ module Aws::Connect
|
|
8395
8712
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8396
8713
|
# published timestamp
|
8397
8714
|
#
|
8398
|
-
# UI name: [Minimum flow time][
|
8715
|
+
# UI name: [Minimum flow time][65]
|
8399
8716
|
#
|
8400
8717
|
# PERCENT\_CASES\_FIRST\_CONTACT\_RESOLVED
|
8401
8718
|
#
|
@@ -8405,7 +8722,7 @@ module Aws::Connect
|
|
8405
8722
|
#
|
8406
8723
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8407
8724
|
#
|
8408
|
-
# UI name: [Cases resolved on first contact][
|
8725
|
+
# UI name: [Cases resolved on first contact][66]
|
8409
8726
|
#
|
8410
8727
|
# PERCENT\_CONTACTS\_STEP\_EXPIRED
|
8411
8728
|
#
|
@@ -8437,7 +8754,7 @@ module Aws::Connect
|
|
8437
8754
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8438
8755
|
# published timestamp
|
8439
8756
|
#
|
8440
|
-
# UI name: [Flows outcome percentage][
|
8757
|
+
# UI name: [Flows outcome percentage][67].
|
8441
8758
|
#
|
8442
8759
|
# <note markdown="1"> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.
|
8443
8760
|
#
|
@@ -8454,7 +8771,7 @@ module Aws::Connect
|
|
8454
8771
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8455
8772
|
# Connect
|
8456
8773
|
#
|
8457
|
-
# UI name: [Non-talk time percent][
|
8774
|
+
# UI name: [Non-talk time percent][68]
|
8458
8775
|
#
|
8459
8776
|
# PERCENT\_TALK\_TIME
|
8460
8777
|
#
|
@@ -8467,7 +8784,7 @@ module Aws::Connect
|
|
8467
8784
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8468
8785
|
# Connect
|
8469
8786
|
#
|
8470
|
-
# UI name: [Talk time percent][
|
8787
|
+
# UI name: [Talk time percent][69]
|
8471
8788
|
#
|
8472
8789
|
# PERCENT\_TALK\_TIME\_AGENT
|
8473
8790
|
#
|
@@ -8480,7 +8797,7 @@ module Aws::Connect
|
|
8480
8797
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8481
8798
|
# Connect
|
8482
8799
|
#
|
8483
|
-
# UI name: [Agent talk time percent][
|
8800
|
+
# UI name: [Agent talk time percent][70]
|
8484
8801
|
#
|
8485
8802
|
# PERCENT\_TALK\_TIME\_CUSTOMER
|
8486
8803
|
#
|
@@ -8493,7 +8810,7 @@ module Aws::Connect
|
|
8493
8810
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8494
8811
|
# Connect
|
8495
8812
|
#
|
8496
|
-
# UI name: [Customer talk time percent][
|
8813
|
+
# UI name: [Customer talk time percent][71]
|
8497
8814
|
#
|
8498
8815
|
# REOPENED\_CASE\_ACTIONS
|
8499
8816
|
#
|
@@ -8503,7 +8820,7 @@ module Aws::Connect
|
|
8503
8820
|
#
|
8504
8821
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8505
8822
|
#
|
8506
|
-
# UI name: [Cases reopened][
|
8823
|
+
# UI name: [Cases reopened][72]
|
8507
8824
|
#
|
8508
8825
|
# RESOLVED\_CASE\_ACTIONS
|
8509
8826
|
#
|
@@ -8513,7 +8830,7 @@ module Aws::Connect
|
|
8513
8830
|
#
|
8514
8831
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8515
8832
|
#
|
8516
|
-
# UI name: [Cases resolved][
|
8833
|
+
# UI name: [Cases resolved][73]
|
8517
8834
|
#
|
8518
8835
|
# SERVICE\_LEVEL
|
8519
8836
|
#
|
@@ -8528,7 +8845,7 @@ module Aws::Connect
|
|
8528
8845
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8529
8846
|
# (for "Less than") or `LTE` (for "Less than equal").
|
8530
8847
|
#
|
8531
|
-
# UI name: [Service level X][
|
8848
|
+
# UI name: [Service level X][74]
|
8532
8849
|
#
|
8533
8850
|
# STEP\_CONTACTS\_QUEUED
|
8534
8851
|
#
|
@@ -8546,7 +8863,7 @@ module Aws::Connect
|
|
8546
8863
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8547
8864
|
# Agent Hierarchy, Q in Connect
|
8548
8865
|
#
|
8549
|
-
# UI name: [After contact work time][
|
8866
|
+
# UI name: [After contact work time][75]
|
8550
8867
|
#
|
8551
8868
|
# SUM\_CONNECTING\_TIME\_AGENT
|
8552
8869
|
#
|
@@ -8559,7 +8876,7 @@ module Aws::Connect
|
|
8559
8876
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8560
8877
|
# Agent Hierarchy
|
8561
8878
|
#
|
8562
|
-
# UI name: [Agent API connecting time][
|
8879
|
+
# UI name: [Agent API connecting time][76]
|
8563
8880
|
#
|
8564
8881
|
# <note markdown="1"> The `Negate` key in metric-level filters is not applicable for this
|
8565
8882
|
# metric.
|
@@ -8581,7 +8898,7 @@ module Aws::Connect
|
|
8581
8898
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
|
8582
8899
|
# RoutingStepExpression, Q in Connect
|
8583
8900
|
#
|
8584
|
-
# UI name: [Contact abandoned][
|
8901
|
+
# UI name: [Contact abandoned][77]
|
8585
8902
|
#
|
8586
8903
|
# SUM\_CONTACTS\_ABANDONED\_IN\_X
|
8587
8904
|
#
|
@@ -8594,7 +8911,7 @@ module Aws::Connect
|
|
8594
8911
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8595
8912
|
# (for "Less than") or `LTE` (for "Less than equal").
|
8596
8913
|
#
|
8597
|
-
# UI name: [Contacts abandoned in X seconds][
|
8914
|
+
# UI name: [Contacts abandoned in X seconds][78]
|
8598
8915
|
#
|
8599
8916
|
# SUM\_CONTACTS\_ANSWERED\_IN\_X
|
8600
8917
|
#
|
@@ -8607,7 +8924,7 @@ module Aws::Connect
|
|
8607
8924
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8608
8925
|
# (for "Less than") or `LTE` (for "Less than equal").
|
8609
8926
|
#
|
8610
|
-
# UI name: [Contacts answered in X seconds][
|
8927
|
+
# UI name: [Contacts answered in X seconds][79]
|
8611
8928
|
#
|
8612
8929
|
# SUM\_CONTACT\_FLOW\_TIME
|
8613
8930
|
#
|
@@ -8616,7 +8933,7 @@ module Aws::Connect
|
|
8616
8933
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8617
8934
|
# Agent Hierarchy, Q in Connect
|
8618
8935
|
#
|
8619
|
-
# UI name: [Contact flow time][
|
8936
|
+
# UI name: [Contact flow time][80]
|
8620
8937
|
#
|
8621
8938
|
# SUM\_CONTACT\_TIME\_AGENT
|
8622
8939
|
#
|
@@ -8624,7 +8941,7 @@ module Aws::Connect
|
|
8624
8941
|
#
|
8625
8942
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8626
8943
|
#
|
8627
|
-
# UI name: [Agent on contact time][
|
8944
|
+
# UI name: [Agent on contact time][81]
|
8628
8945
|
#
|
8629
8946
|
# SUM\_CONTACTS\_DISCONNECTED
|
8630
8947
|
#
|
@@ -8636,7 +8953,7 @@ module Aws::Connect
|
|
8636
8953
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8637
8954
|
# Connect
|
8638
8955
|
#
|
8639
|
-
# UI name: [Contact disconnected][
|
8956
|
+
# UI name: [Contact disconnected][82]
|
8640
8957
|
#
|
8641
8958
|
# SUM\_ERROR\_STATUS\_TIME\_AGENT
|
8642
8959
|
#
|
@@ -8644,7 +8961,7 @@ module Aws::Connect
|
|
8644
8961
|
#
|
8645
8962
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8646
8963
|
#
|
8647
|
-
# UI name: [Error status time][
|
8964
|
+
# UI name: [Error status time][83]
|
8648
8965
|
#
|
8649
8966
|
# SUM\_HANDLE\_TIME
|
8650
8967
|
#
|
@@ -8653,7 +8970,7 @@ module Aws::Connect
|
|
8653
8970
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8654
8971
|
# Agent Hierarchy, Q in Connect
|
8655
8972
|
#
|
8656
|
-
# UI name: [Contact handle time][
|
8973
|
+
# UI name: [Contact handle time][84]
|
8657
8974
|
#
|
8658
8975
|
# SUM\_HOLD\_TIME
|
8659
8976
|
#
|
@@ -8662,7 +8979,7 @@ module Aws::Connect
|
|
8662
8979
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8663
8980
|
# Agent Hierarchy, Q in Connect
|
8664
8981
|
#
|
8665
|
-
# UI name: [Customer hold time][
|
8982
|
+
# UI name: [Customer hold time][85]
|
8666
8983
|
#
|
8667
8984
|
# SUM\_IDLE\_TIME\_AGENT
|
8668
8985
|
#
|
@@ -8670,7 +8987,7 @@ module Aws::Connect
|
|
8670
8987
|
#
|
8671
8988
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8672
8989
|
#
|
8673
|
-
# UI name: [Agent idle time][
|
8990
|
+
# UI name: [Agent idle time][86]
|
8674
8991
|
#
|
8675
8992
|
# SUM\_INTERACTION\_AND\_HOLD\_TIME
|
8676
8993
|
#
|
@@ -8679,7 +8996,7 @@ module Aws::Connect
|
|
8679
8996
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8680
8997
|
# Agent Hierarchy, Q in Connect
|
8681
8998
|
#
|
8682
|
-
# UI name: [Agent interaction and hold time][
|
8999
|
+
# UI name: [Agent interaction and hold time][87]
|
8683
9000
|
#
|
8684
9001
|
# SUM\_INTERACTION\_TIME
|
8685
9002
|
#
|
@@ -8688,7 +9005,7 @@ module Aws::Connect
|
|
8688
9005
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8689
9006
|
# Agent Hierarchy
|
8690
9007
|
#
|
8691
|
-
# UI name: [Agent interaction time][
|
9008
|
+
# UI name: [Agent interaction time][88]
|
8692
9009
|
#
|
8693
9010
|
# SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
|
8694
9011
|
#
|
@@ -8696,7 +9013,7 @@ module Aws::Connect
|
|
8696
9013
|
#
|
8697
9014
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8698
9015
|
#
|
8699
|
-
# UI name: [Non-Productive Time][
|
9016
|
+
# UI name: [Non-Productive Time][89]
|
8700
9017
|
#
|
8701
9018
|
# SUM\_ONLINE\_TIME\_AGENT
|
8702
9019
|
#
|
@@ -8704,7 +9021,7 @@ module Aws::Connect
|
|
8704
9021
|
#
|
8705
9022
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8706
9023
|
#
|
8707
|
-
# UI name: [Online time][
|
9024
|
+
# UI name: [Online time][90]
|
8708
9025
|
#
|
8709
9026
|
# SUM\_RETRY\_CALLBACK\_ATTEMPTS
|
8710
9027
|
#
|
@@ -8713,7 +9030,7 @@ module Aws::Connect
|
|
8713
9030
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
8714
9031
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8715
9032
|
#
|
8716
|
-
# UI name: [Callback attempts][
|
9033
|
+
# UI name: [Callback attempts][91]
|
8717
9034
|
#
|
8718
9035
|
#
|
8719
9036
|
#
|
@@ -8757,55 +9074,57 @@ module Aws::Connect
|
|
8757
9074
|
# [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical
|
8758
9075
|
# [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-historical
|
8759
9076
|
# [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-rate-historical
|
8760
|
-
# [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8761
|
-
# [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8762
|
-
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8763
|
-
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8764
|
-
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8765
|
-
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8766
|
-
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8767
|
-
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8768
|
-
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8769
|
-
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8770
|
-
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8771
|
-
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8772
|
-
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8773
|
-
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8774
|
-
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8775
|
-
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8776
|
-
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8777
|
-
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8778
|
-
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8779
|
-
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8780
|
-
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8781
|
-
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8782
|
-
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8783
|
-
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8784
|
-
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8785
|
-
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8786
|
-
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8787
|
-
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8788
|
-
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8789
|
-
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8790
|
-
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8791
|
-
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8792
|
-
# [73]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8793
|
-
# [74]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8794
|
-
# [75]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8795
|
-
# [76]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8796
|
-
# [77]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8797
|
-
# [78]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8798
|
-
# [79]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8799
|
-
# [80]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-
|
8800
|
-
# [81]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8801
|
-
# [82]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-
|
8802
|
-
# [83]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8803
|
-
# [84]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8804
|
-
# [85]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8805
|
-
# [86]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-
|
8806
|
-
# [87]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8807
|
-
# [88]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8808
|
-
# [89]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
9077
|
+
# [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-interactions-historical
|
9078
|
+
# [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-send-attempts-historical
|
9079
|
+
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-created-historical
|
9080
|
+
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical
|
9081
|
+
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical
|
9082
|
+
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical
|
9083
|
+
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical
|
9084
|
+
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical
|
9085
|
+
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical
|
9086
|
+
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical
|
9087
|
+
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical
|
9088
|
+
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical
|
9089
|
+
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical
|
9090
|
+
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical
|
9091
|
+
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical
|
9092
|
+
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical
|
9093
|
+
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical
|
9094
|
+
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempts-historical
|
9095
|
+
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempt-disposition-rate-historical
|
9096
|
+
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical
|
9097
|
+
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical
|
9098
|
+
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#human-answered-historical
|
9099
|
+
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical
|
9100
|
+
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical
|
9101
|
+
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical
|
9102
|
+
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical
|
9103
|
+
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical
|
9104
|
+
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical
|
9105
|
+
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical
|
9106
|
+
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical
|
9107
|
+
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical
|
9108
|
+
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical
|
9109
|
+
# [73]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical
|
9110
|
+
# [74]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical
|
9111
|
+
# [75]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical
|
9112
|
+
# [76]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time
|
9113
|
+
# [77]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical
|
9114
|
+
# [78]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical
|
9115
|
+
# [79]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical
|
9116
|
+
# [80]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical
|
9117
|
+
# [81]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical
|
9118
|
+
# [82]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical
|
9119
|
+
# [83]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical
|
9120
|
+
# [84]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical
|
9121
|
+
# [85]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical
|
9122
|
+
# [86]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica
|
9123
|
+
# [87]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical
|
9124
|
+
# [88]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical
|
9125
|
+
# [89]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical
|
9126
|
+
# [90]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical
|
9127
|
+
# [91]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical
|
8809
9128
|
#
|
8810
9129
|
# @option params [String] :next_token
|
8811
9130
|
# The token for the next set of results. Use the value returned in the
|
@@ -8958,6 +9277,7 @@ module Aws::Connect
|
|
8958
9277
|
# * {Types::GetTaskTemplateResponse#name #name} => String
|
8959
9278
|
# * {Types::GetTaskTemplateResponse#description #description} => String
|
8960
9279
|
# * {Types::GetTaskTemplateResponse#contact_flow_id #contact_flow_id} => String
|
9280
|
+
# * {Types::GetTaskTemplateResponse#self_assign_flow_id #self_assign_flow_id} => String
|
8961
9281
|
# * {Types::GetTaskTemplateResponse#constraints #constraints} => Types::TaskTemplateConstraints
|
8962
9282
|
# * {Types::GetTaskTemplateResponse#defaults #defaults} => Types::TaskTemplateDefaults
|
8963
9283
|
# * {Types::GetTaskTemplateResponse#fields #fields} => Array<Types::TaskTemplateField>
|
@@ -8982,6 +9302,7 @@ module Aws::Connect
|
|
8982
9302
|
# resp.name #=> String
|
8983
9303
|
# resp.description #=> String
|
8984
9304
|
# resp.contact_flow_id #=> String
|
9305
|
+
# resp.self_assign_flow_id #=> String
|
8985
9306
|
# resp.constraints.required_fields #=> Array
|
8986
9307
|
# resp.constraints.required_fields[0].id.name #=> String
|
8987
9308
|
# resp.constraints.read_only_fields #=> Array
|
@@ -8994,7 +9315,7 @@ module Aws::Connect
|
|
8994
9315
|
# resp.fields #=> Array
|
8995
9316
|
# resp.fields[0].id.name #=> String
|
8996
9317
|
# resp.fields[0].description #=> String
|
8997
|
-
# resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL"
|
9318
|
+
# resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL", "SELF_ASSIGN", "EXPIRY_DURATION"
|
8998
9319
|
# resp.fields[0].single_select_options #=> Array
|
8999
9320
|
# resp.fields[0].single_select_options[0] #=> String
|
9000
9321
|
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
@@ -9320,6 +9641,51 @@ module Aws::Connect
|
|
9320
9641
|
req.send_request(options)
|
9321
9642
|
end
|
9322
9643
|
|
9644
|
+
# @option params [required, String] :instance_id
|
9645
|
+
#
|
9646
|
+
# @option params [required, String] :contact_id
|
9647
|
+
#
|
9648
|
+
# @option params [Integer] :max_results
|
9649
|
+
#
|
9650
|
+
# @option params [String] :next_token
|
9651
|
+
#
|
9652
|
+
# @return [Types::ListAssociatedContactsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9653
|
+
#
|
9654
|
+
# * {Types::ListAssociatedContactsResponse#contact_summary_list #contact_summary_list} => Array<Types::AssociatedContactSummary>
|
9655
|
+
# * {Types::ListAssociatedContactsResponse#next_token #next_token} => String
|
9656
|
+
#
|
9657
|
+
# @example Request syntax with placeholder values
|
9658
|
+
#
|
9659
|
+
# resp = client.list_associated_contacts({
|
9660
|
+
# instance_id: "InstanceId", # required
|
9661
|
+
# contact_id: "ContactId", # required
|
9662
|
+
# max_results: 1,
|
9663
|
+
# next_token: "NextToken",
|
9664
|
+
# })
|
9665
|
+
#
|
9666
|
+
# @example Response structure
|
9667
|
+
#
|
9668
|
+
# resp.contact_summary_list #=> Array
|
9669
|
+
# resp.contact_summary_list[0].contact_id #=> String
|
9670
|
+
# resp.contact_summary_list[0].contact_arn #=> String
|
9671
|
+
# resp.contact_summary_list[0].initiation_timestamp #=> Time
|
9672
|
+
# resp.contact_summary_list[0].disconnect_timestamp #=> Time
|
9673
|
+
# resp.contact_summary_list[0].initial_contact_id #=> String
|
9674
|
+
# resp.contact_summary_list[0].previous_contact_id #=> String
|
9675
|
+
# resp.contact_summary_list[0].related_contact_id #=> String
|
9676
|
+
# resp.contact_summary_list[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
|
9677
|
+
# resp.contact_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
9678
|
+
# resp.next_token #=> String
|
9679
|
+
#
|
9680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAssociatedContacts AWS API Documentation
|
9681
|
+
#
|
9682
|
+
# @overload list_associated_contacts(params = {})
|
9683
|
+
# @param [Hash] params ({})
|
9684
|
+
def list_associated_contacts(params = {}, options = {})
|
9685
|
+
req = build_request(:list_associated_contacts, params)
|
9686
|
+
req.send_request(options)
|
9687
|
+
end
|
9688
|
+
|
9323
9689
|
# This API is in preview release for Amazon Connect and is subject to
|
9324
9690
|
# change. To request access to this API, contact Amazon Web Services
|
9325
9691
|
# Support.
|
@@ -9554,6 +9920,57 @@ module Aws::Connect
|
|
9554
9920
|
req.send_request(options)
|
9555
9921
|
end
|
9556
9922
|
|
9923
|
+
# Returns all the available versions for the specified Amazon Connect
|
9924
|
+
# instance and flow identifier.
|
9925
|
+
#
|
9926
|
+
# @option params [required, String] :instance_id
|
9927
|
+
# The identifier of the Amazon Connect instance.
|
9928
|
+
#
|
9929
|
+
# @option params [required, String] :contact_flow_id
|
9930
|
+
# The identifier of the flow.
|
9931
|
+
#
|
9932
|
+
# @option params [String] :next_token
|
9933
|
+
# The token for the next set of results. Use the value returned in the
|
9934
|
+
# previous response in the next request to retrieve the next set of
|
9935
|
+
# results.
|
9936
|
+
#
|
9937
|
+
# @option params [Integer] :max_results
|
9938
|
+
# The maximum number of results to return per page. The default
|
9939
|
+
# MaxResult size is 100.
|
9940
|
+
#
|
9941
|
+
# @return [Types::ListContactFlowVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9942
|
+
#
|
9943
|
+
# * {Types::ListContactFlowVersionsResponse#contact_flow_version_summary_list #contact_flow_version_summary_list} => Array<Types::ContactFlowVersionSummary>
|
9944
|
+
# * {Types::ListContactFlowVersionsResponse#next_token #next_token} => String
|
9945
|
+
#
|
9946
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9947
|
+
#
|
9948
|
+
# @example Request syntax with placeholder values
|
9949
|
+
#
|
9950
|
+
# resp = client.list_contact_flow_versions({
|
9951
|
+
# instance_id: "InstanceId", # required
|
9952
|
+
# contact_flow_id: "ARN", # required
|
9953
|
+
# next_token: "NextToken",
|
9954
|
+
# max_results: 1,
|
9955
|
+
# })
|
9956
|
+
#
|
9957
|
+
# @example Response structure
|
9958
|
+
#
|
9959
|
+
# resp.contact_flow_version_summary_list #=> Array
|
9960
|
+
# resp.contact_flow_version_summary_list[0].arn #=> String
|
9961
|
+
# resp.contact_flow_version_summary_list[0].version_description #=> String
|
9962
|
+
# resp.contact_flow_version_summary_list[0].version #=> Integer
|
9963
|
+
# resp.next_token #=> String
|
9964
|
+
#
|
9965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowVersions AWS API Documentation
|
9966
|
+
#
|
9967
|
+
# @overload list_contact_flow_versions(params = {})
|
9968
|
+
# @param [Hash] params ({})
|
9969
|
+
def list_contact_flow_versions(params = {}, options = {})
|
9970
|
+
req = build_request(:list_contact_flow_versions, params)
|
9971
|
+
req.send_request(options)
|
9972
|
+
end
|
9973
|
+
|
9557
9974
|
# Provides information about the flows for the specified Amazon Connect
|
9558
9975
|
# instance.
|
9559
9976
|
#
|
@@ -9665,7 +10082,7 @@ module Aws::Connect
|
|
9665
10082
|
# resp = client.list_contact_references({
|
9666
10083
|
# instance_id: "InstanceId", # required
|
9667
10084
|
# contact_id: "ContactId", # required
|
9668
|
-
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
10085
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
9669
10086
|
# next_token: "NextToken",
|
9670
10087
|
# })
|
9671
10088
|
#
|
@@ -9676,7 +10093,10 @@ module Aws::Connect
|
|
9676
10093
|
# resp.reference_summary_list[0].url.value #=> String
|
9677
10094
|
# resp.reference_summary_list[0].attachment.name #=> String
|
9678
10095
|
# resp.reference_summary_list[0].attachment.value #=> String
|
9679
|
-
# resp.reference_summary_list[0].attachment.status #=> String, one of "APPROVED", "REJECTED"
|
10096
|
+
# resp.reference_summary_list[0].attachment.status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
10097
|
+
# resp.reference_summary_list[0].attachment.arn #=> String
|
10098
|
+
# resp.reference_summary_list[0].email_message.name #=> String
|
10099
|
+
# resp.reference_summary_list[0].email_message.arn #=> String
|
9680
10100
|
# resp.reference_summary_list[0].string.name #=> String
|
9681
10101
|
# resp.reference_summary_list[0].string.value #=> String
|
9682
10102
|
# resp.reference_summary_list[0].number.name #=> String
|
@@ -9909,7 +10329,7 @@ module Aws::Connect
|
|
9909
10329
|
#
|
9910
10330
|
# resp = client.list_flow_associations({
|
9911
10331
|
# instance_id: "InstanceId", # required
|
9912
|
-
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER
|
10332
|
+
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
9913
10333
|
# next_token: "NextToken",
|
9914
10334
|
# max_results: 1,
|
9915
10335
|
# })
|
@@ -9919,7 +10339,7 @@ module Aws::Connect
|
|
9919
10339
|
# resp.flow_association_summary_list #=> Array
|
9920
10340
|
# resp.flow_association_summary_list[0].resource_id #=> String
|
9921
10341
|
# resp.flow_association_summary_list[0].flow_id #=> String
|
9922
|
-
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER"
|
10342
|
+
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL"
|
9923
10343
|
# resp.next_token #=> String
|
9924
10344
|
#
|
9925
10345
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociations AWS API Documentation
|
@@ -10081,7 +10501,7 @@ module Aws::Connect
|
|
10081
10501
|
#
|
10082
10502
|
# resp = client.list_instance_storage_configs({
|
10083
10503
|
# instance_id: "InstanceId", # required
|
10084
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
|
10504
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
|
10085
10505
|
# next_token: "NextToken",
|
10086
10506
|
# max_results: 1,
|
10087
10507
|
# })
|
@@ -10202,7 +10622,7 @@ module Aws::Connect
|
|
10202
10622
|
#
|
10203
10623
|
# resp = client.list_integration_associations({
|
10204
10624
|
# instance_id: "InstanceId", # required
|
10205
|
-
# integration_type: "EVENT", # accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, CASES_DOMAIN, APPLICATION, FILE_SCANNER
|
10625
|
+
# integration_type: "EVENT", # accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, Q_MESSAGE_TEMPLATES, CASES_DOMAIN, APPLICATION, FILE_SCANNER, SES_IDENTITY
|
10206
10626
|
# next_token: "NextToken",
|
10207
10627
|
# max_results: 1,
|
10208
10628
|
# integration_arn: "ARN",
|
@@ -10214,7 +10634,7 @@ module Aws::Connect
|
|
10214
10634
|
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
10215
10635
|
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
10216
10636
|
# resp.integration_association_summary_list[0].instance_id #=> String
|
10217
|
-
# resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT", "VOICE_ID", "PINPOINT_APP", "WISDOM_ASSISTANT", "WISDOM_KNOWLEDGE_BASE", "WISDOM_QUICK_RESPONSES", "CASES_DOMAIN", "APPLICATION", "FILE_SCANNER"
|
10637
|
+
# resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT", "VOICE_ID", "PINPOINT_APP", "WISDOM_ASSISTANT", "WISDOM_KNOWLEDGE_BASE", "WISDOM_QUICK_RESPONSES", "Q_MESSAGE_TEMPLATES", "CASES_DOMAIN", "APPLICATION", "FILE_SCANNER", "SES_IDENTITY"
|
10218
10638
|
# resp.integration_association_summary_list[0].integration_arn #=> String
|
10219
10639
|
# resp.integration_association_summary_list[0].source_application_url #=> String
|
10220
10640
|
# resp.integration_association_summary_list[0].source_application_name #=> String
|
@@ -10996,7 +11416,7 @@ module Aws::Connect
|
|
10996
11416
|
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
10997
11417
|
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
10998
11418
|
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
10999
|
-
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
11419
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
11000
11420
|
# resp.last_modified_time #=> Time
|
11001
11421
|
# resp.last_modified_region #=> String
|
11002
11422
|
#
|
@@ -12660,6 +13080,12 @@ module Aws::Connect
|
|
12660
13080
|
# resp.contact_flows[0].content #=> String
|
12661
13081
|
# resp.contact_flows[0].tags #=> Hash
|
12662
13082
|
# resp.contact_flows[0].tags["TagKey"] #=> String
|
13083
|
+
# resp.contact_flows[0].is_default #=> Boolean
|
13084
|
+
# resp.contact_flows[0].flow_content_sha_256 #=> String
|
13085
|
+
# resp.contact_flows[0].version #=> Integer
|
13086
|
+
# resp.contact_flows[0].version_description #=> String
|
13087
|
+
# resp.contact_flows[0].last_modified_time #=> Time
|
13088
|
+
# resp.contact_flows[0].last_modified_region #=> String
|
12663
13089
|
# resp.next_token #=> String
|
12664
13090
|
# resp.approximate_total_count #=> Integer
|
12665
13091
|
#
|
@@ -12721,7 +13147,7 @@ module Aws::Connect
|
|
12721
13147
|
# l4_ids: ["HierarchyGroupId"],
|
12722
13148
|
# l5_ids: ["HierarchyGroupId"],
|
12723
13149
|
# },
|
12724
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
13150
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
12725
13151
|
# contact_analysis: {
|
12726
13152
|
# transcript: {
|
12727
13153
|
# criteria: [ # required
|
@@ -12734,7 +13160,7 @@ module Aws::Connect
|
|
12734
13160
|
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
12735
13161
|
# },
|
12736
13162
|
# },
|
12737
|
-
# initiation_methods: ["INBOUND"], # accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND
|
13163
|
+
# initiation_methods: ["INBOUND"], # accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
|
12738
13164
|
# queue_ids: ["QueueId"],
|
12739
13165
|
# searchable_contact_attributes: {
|
12740
13166
|
# criteria: [ # required
|
@@ -12745,6 +13171,15 @@ module Aws::Connect
|
|
12745
13171
|
# ],
|
12746
13172
|
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
12747
13173
|
# },
|
13174
|
+
# searchable_segment_attributes: {
|
13175
|
+
# criteria: [ # required
|
13176
|
+
# {
|
13177
|
+
# key: "SearchableSegmentAttributeKey", # required
|
13178
|
+
# values: ["SearchableSegmentAttributeValue"], # required
|
13179
|
+
# },
|
13180
|
+
# ],
|
13181
|
+
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
13182
|
+
# },
|
12748
13183
|
# },
|
12749
13184
|
# max_results: 1,
|
12750
13185
|
# next_token: "LargeNextToken",
|
@@ -12761,8 +13196,8 @@ module Aws::Connect
|
|
12761
13196
|
# resp.contacts[0].id #=> String
|
12762
13197
|
# resp.contacts[0].initial_contact_id #=> String
|
12763
13198
|
# resp.contacts[0].previous_contact_id #=> String
|
12764
|
-
# resp.contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND"
|
12765
|
-
# resp.contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
13199
|
+
# resp.contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
|
13200
|
+
# resp.contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
12766
13201
|
# resp.contacts[0].queue_info.id #=> String
|
12767
13202
|
# resp.contacts[0].queue_info.enqueue_timestamp #=> Time
|
12768
13203
|
# resp.contacts[0].agent_info.id #=> String
|
@@ -12770,6 +13205,8 @@ module Aws::Connect
|
|
12770
13205
|
# resp.contacts[0].initiation_timestamp #=> Time
|
12771
13206
|
# resp.contacts[0].disconnect_timestamp #=> Time
|
12772
13207
|
# resp.contacts[0].scheduled_timestamp #=> Time
|
13208
|
+
# resp.contacts[0].segment_attributes #=> Hash
|
13209
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_string #=> String
|
12773
13210
|
# resp.next_token #=> String
|
12774
13211
|
# resp.total_count #=> Integer
|
12775
13212
|
#
|
@@ -12782,12 +13219,95 @@ module Aws::Connect
|
|
12782
13219
|
req.send_request(options)
|
12783
13220
|
end
|
12784
13221
|
|
12785
|
-
# Searches the hours of operation in an Amazon Connect instance, with
|
12786
|
-
# optional filtering.
|
12787
|
-
#
|
12788
13222
|
# @option params [required, String] :instance_id
|
12789
|
-
#
|
12790
|
-
#
|
13223
|
+
#
|
13224
|
+
# @option params [Integer] :max_results
|
13225
|
+
#
|
13226
|
+
# @option params [String] :next_token
|
13227
|
+
#
|
13228
|
+
# @option params [Types::EmailAddressSearchCriteria] :search_criteria
|
13229
|
+
#
|
13230
|
+
# @option params [Types::EmailAddressSearchFilter] :search_filter
|
13231
|
+
#
|
13232
|
+
# @return [Types::SearchEmailAddressesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13233
|
+
#
|
13234
|
+
# * {Types::SearchEmailAddressesResponse#next_token #next_token} => String
|
13235
|
+
# * {Types::SearchEmailAddressesResponse#email_addresses #email_addresses} => Array<Types::EmailAddressMetadata>
|
13236
|
+
# * {Types::SearchEmailAddressesResponse#approximate_total_count #approximate_total_count} => Integer
|
13237
|
+
#
|
13238
|
+
# @example Request syntax with placeholder values
|
13239
|
+
#
|
13240
|
+
# resp = client.search_email_addresses({
|
13241
|
+
# instance_id: "InstanceId", # required
|
13242
|
+
# max_results: 1,
|
13243
|
+
# next_token: "NextToken2500",
|
13244
|
+
# search_criteria: {
|
13245
|
+
# or_conditions: [
|
13246
|
+
# {
|
13247
|
+
# # recursive EmailAddressSearchCriteria
|
13248
|
+
# },
|
13249
|
+
# ],
|
13250
|
+
# and_conditions: [
|
13251
|
+
# {
|
13252
|
+
# # recursive EmailAddressSearchCriteria
|
13253
|
+
# },
|
13254
|
+
# ],
|
13255
|
+
# string_condition: {
|
13256
|
+
# field_name: "String",
|
13257
|
+
# value: "String",
|
13258
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13259
|
+
# },
|
13260
|
+
# },
|
13261
|
+
# search_filter: {
|
13262
|
+
# tag_filter: {
|
13263
|
+
# or_conditions: [
|
13264
|
+
# [
|
13265
|
+
# {
|
13266
|
+
# tag_key: "String",
|
13267
|
+
# tag_value: "String",
|
13268
|
+
# },
|
13269
|
+
# ],
|
13270
|
+
# ],
|
13271
|
+
# and_conditions: [
|
13272
|
+
# {
|
13273
|
+
# tag_key: "String",
|
13274
|
+
# tag_value: "String",
|
13275
|
+
# },
|
13276
|
+
# ],
|
13277
|
+
# tag_condition: {
|
13278
|
+
# tag_key: "String",
|
13279
|
+
# tag_value: "String",
|
13280
|
+
# },
|
13281
|
+
# },
|
13282
|
+
# },
|
13283
|
+
# })
|
13284
|
+
#
|
13285
|
+
# @example Response structure
|
13286
|
+
#
|
13287
|
+
# resp.next_token #=> String
|
13288
|
+
# resp.email_addresses #=> Array
|
13289
|
+
# resp.email_addresses[0].email_address_id #=> String
|
13290
|
+
# resp.email_addresses[0].email_address_arn #=> String
|
13291
|
+
# resp.email_addresses[0].email_address #=> String
|
13292
|
+
# resp.email_addresses[0].description #=> String
|
13293
|
+
# resp.email_addresses[0].display_name #=> String
|
13294
|
+
# resp.approximate_total_count #=> Integer
|
13295
|
+
#
|
13296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEmailAddresses AWS API Documentation
|
13297
|
+
#
|
13298
|
+
# @overload search_email_addresses(params = {})
|
13299
|
+
# @param [Hash] params ({})
|
13300
|
+
def search_email_addresses(params = {}, options = {})
|
13301
|
+
req = build_request(:search_email_addresses, params)
|
13302
|
+
req.send_request(options)
|
13303
|
+
end
|
13304
|
+
|
13305
|
+
# Searches the hours of operation in an Amazon Connect instance, with
|
13306
|
+
# optional filtering.
|
13307
|
+
#
|
13308
|
+
# @option params [required, String] :instance_id
|
13309
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
13310
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
12791
13311
|
#
|
12792
13312
|
#
|
12793
13313
|
#
|
@@ -13171,6 +13691,7 @@ module Aws::Connect
|
|
13171
13691
|
# resp.queues[0].outbound_caller_config.outbound_caller_id_name #=> String
|
13172
13692
|
# resp.queues[0].outbound_caller_config.outbound_caller_id_number_id #=> String
|
13173
13693
|
# resp.queues[0].outbound_caller_config.outbound_flow_id #=> String
|
13694
|
+
# resp.queues[0].outbound_email_config.outbound_email_address_id #=> String
|
13174
13695
|
# resp.queues[0].hours_of_operation_id #=> String
|
13175
13696
|
# resp.queues[0].max_contacts #=> Integer
|
13176
13697
|
# resp.queues[0].status #=> String, one of "ENABLED", "DISABLED"
|
@@ -13476,7 +13997,7 @@ module Aws::Connect
|
|
13476
13997
|
# resp.routing_profiles[0].routing_profile_id #=> String
|
13477
13998
|
# resp.routing_profiles[0].description #=> String
|
13478
13999
|
# resp.routing_profiles[0].media_concurrencies #=> Array
|
13479
|
-
# resp.routing_profiles[0].media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
14000
|
+
# resp.routing_profiles[0].media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
13480
14001
|
# resp.routing_profiles[0].media_concurrencies[0].concurrency #=> Integer
|
13481
14002
|
# resp.routing_profiles[0].media_concurrencies[0].cross_channel_behavior.behavior_type #=> String, one of "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL"
|
13482
14003
|
# resp.routing_profiles[0].default_outbound_queue_id #=> String
|
@@ -14097,6 +14618,81 @@ module Aws::Connect
|
|
14097
14618
|
req.send_request(options)
|
14098
14619
|
end
|
14099
14620
|
|
14621
|
+
# @option params [required, String] :instance_id
|
14622
|
+
#
|
14623
|
+
# @option params [required, Types::EmailAddressInfo] :from_email_address
|
14624
|
+
#
|
14625
|
+
# @option params [required, Types::EmailAddressInfo] :destination_email_address
|
14626
|
+
#
|
14627
|
+
# @option params [Types::OutboundAdditionalRecipients] :additional_recipients
|
14628
|
+
#
|
14629
|
+
# @option params [required, Types::OutboundEmailContent] :email_message
|
14630
|
+
#
|
14631
|
+
# @option params [required, String] :traffic_type
|
14632
|
+
#
|
14633
|
+
# @option params [Types::SourceCampaign] :source_campaign
|
14634
|
+
#
|
14635
|
+
# @option params [String] :client_token
|
14636
|
+
# **A suitable default value is auto-generated.** You should normally
|
14637
|
+
# not need to pass this option.**
|
14638
|
+
#
|
14639
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
14640
|
+
#
|
14641
|
+
# @example Request syntax with placeholder values
|
14642
|
+
#
|
14643
|
+
# resp = client.send_outbound_email({
|
14644
|
+
# instance_id: "InstanceId", # required
|
14645
|
+
# from_email_address: { # required
|
14646
|
+
# email_address: "EmailAddress", # required
|
14647
|
+
# display_name: "EmailAddressDisplayName",
|
14648
|
+
# },
|
14649
|
+
# destination_email_address: { # required
|
14650
|
+
# email_address: "EmailAddress", # required
|
14651
|
+
# display_name: "EmailAddressDisplayName",
|
14652
|
+
# },
|
14653
|
+
# additional_recipients: {
|
14654
|
+
# cc_email_addresses: [
|
14655
|
+
# {
|
14656
|
+
# email_address: "EmailAddress", # required
|
14657
|
+
# display_name: "EmailAddressDisplayName",
|
14658
|
+
# },
|
14659
|
+
# ],
|
14660
|
+
# },
|
14661
|
+
# email_message: { # required
|
14662
|
+
# message_source_type: "TEMPLATE", # required, accepts TEMPLATE, RAW
|
14663
|
+
# templated_message_config: {
|
14664
|
+
# knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
|
14665
|
+
# message_template_id: "MessageTemplateId", # required
|
14666
|
+
# template_attributes: { # required
|
14667
|
+
# custom_attributes: {
|
14668
|
+
# "AttributeName" => "AttributeValue",
|
14669
|
+
# },
|
14670
|
+
# customer_profile_attributes: "CustomerProfileAttributesSerialized",
|
14671
|
+
# },
|
14672
|
+
# },
|
14673
|
+
# raw_message: {
|
14674
|
+
# subject: "OutboundSubject", # required
|
14675
|
+
# body: "Body", # required
|
14676
|
+
# content_type: "EmailMessageContentType", # required
|
14677
|
+
# },
|
14678
|
+
# },
|
14679
|
+
# traffic_type: "GENERAL", # required, accepts GENERAL, CAMPAIGN
|
14680
|
+
# source_campaign: {
|
14681
|
+
# campaign_id: "CampaignId",
|
14682
|
+
# outbound_request_id: "OutboundRequestId",
|
14683
|
+
# },
|
14684
|
+
# client_token: "ClientToken",
|
14685
|
+
# })
|
14686
|
+
#
|
14687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundEmail AWS API Documentation
|
14688
|
+
#
|
14689
|
+
# @overload send_outbound_email(params = {})
|
14690
|
+
# @param [Hash] params ({})
|
14691
|
+
def send_outbound_email(params = {}, options = {})
|
14692
|
+
req = build_request(:send_outbound_email, params)
|
14693
|
+
req.send_request(options)
|
14694
|
+
end
|
14695
|
+
|
14100
14696
|
# Provides a pre-signed Amazon S3 URL in response for uploading your
|
14101
14697
|
# content.
|
14102
14698
|
#
|
@@ -14172,7 +14768,7 @@ module Aws::Connect
|
|
14172
14768
|
# file_name: "FileName", # required
|
14173
14769
|
# file_size_in_bytes: 1, # required
|
14174
14770
|
# url_expiry_in_seconds: 1,
|
14175
|
-
# file_use_case_type: "
|
14771
|
+
# file_use_case_type: "EMAIL_MESSAGE", # required, accepts EMAIL_MESSAGE, ATTACHMENT
|
14176
14772
|
# associated_resource_arn: "ARN", # required
|
14177
14773
|
# created_by: {
|
14178
14774
|
# connect_user_arn: "ARN",
|
@@ -14615,6 +15211,117 @@ module Aws::Connect
|
|
14615
15211
|
req.send_request(options)
|
14616
15212
|
end
|
14617
15213
|
|
15214
|
+
# @option params [required, String] :instance_id
|
15215
|
+
#
|
15216
|
+
# @option params [required, Types::EmailAddressInfo] :from_email_address
|
15217
|
+
#
|
15218
|
+
# @option params [required, String] :destination_email_address
|
15219
|
+
#
|
15220
|
+
# @option params [String] :description
|
15221
|
+
#
|
15222
|
+
# @option params [Hash<String,Types::Reference>] :references
|
15223
|
+
#
|
15224
|
+
# @option params [String] :name
|
15225
|
+
#
|
15226
|
+
# @option params [required, Types::InboundEmailContent] :email_message
|
15227
|
+
#
|
15228
|
+
# @option params [Types::InboundAdditionalRecipients] :additional_recipients
|
15229
|
+
#
|
15230
|
+
# @option params [Array<Types::EmailAttachment>] :attachments
|
15231
|
+
#
|
15232
|
+
# @option params [String] :contact_flow_id
|
15233
|
+
#
|
15234
|
+
# @option params [String] :related_contact_id
|
15235
|
+
#
|
15236
|
+
# @option params [Hash<String,String>] :attributes
|
15237
|
+
#
|
15238
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
15239
|
+
#
|
15240
|
+
# @option params [String] :client_token
|
15241
|
+
# **A suitable default value is auto-generated.** You should normally
|
15242
|
+
# not need to pass this option.**
|
15243
|
+
#
|
15244
|
+
# @return [Types::StartEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15245
|
+
#
|
15246
|
+
# * {Types::StartEmailContactResponse#contact_id #contact_id} => String
|
15247
|
+
#
|
15248
|
+
# @example Request syntax with placeholder values
|
15249
|
+
#
|
15250
|
+
# resp = client.start_email_contact({
|
15251
|
+
# instance_id: "InstanceId", # required
|
15252
|
+
# from_email_address: { # required
|
15253
|
+
# email_address: "EmailAddress", # required
|
15254
|
+
# display_name: "EmailAddressDisplayName",
|
15255
|
+
# },
|
15256
|
+
# destination_email_address: "EmailAddress", # required
|
15257
|
+
# description: "Description",
|
15258
|
+
# references: {
|
15259
|
+
# "ReferenceKey" => {
|
15260
|
+
# value: "ReferenceValue",
|
15261
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
15262
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
15263
|
+
# arn: "ReferenceArn",
|
15264
|
+
# status_reason: "ReferenceStatusReason",
|
15265
|
+
# },
|
15266
|
+
# },
|
15267
|
+
# name: "Name",
|
15268
|
+
# email_message: { # required
|
15269
|
+
# message_source_type: "RAW", # required, accepts RAW
|
15270
|
+
# raw_message: {
|
15271
|
+
# subject: "InboundSubject", # required
|
15272
|
+
# body: "Body", # required
|
15273
|
+
# content_type: "EmailMessageContentType", # required
|
15274
|
+
# headers: {
|
15275
|
+
# "REFERENCES" => "EmailHeaderValue",
|
15276
|
+
# },
|
15277
|
+
# },
|
15278
|
+
# },
|
15279
|
+
# additional_recipients: {
|
15280
|
+
# to_addresses: [
|
15281
|
+
# {
|
15282
|
+
# email_address: "EmailAddress", # required
|
15283
|
+
# display_name: "EmailAddressDisplayName",
|
15284
|
+
# },
|
15285
|
+
# ],
|
15286
|
+
# cc_addresses: [
|
15287
|
+
# {
|
15288
|
+
# email_address: "EmailAddress", # required
|
15289
|
+
# display_name: "EmailAddressDisplayName",
|
15290
|
+
# },
|
15291
|
+
# ],
|
15292
|
+
# },
|
15293
|
+
# attachments: [
|
15294
|
+
# {
|
15295
|
+
# file_name: "FileName", # required
|
15296
|
+
# s3_url: "PreSignedAttachmentUrl", # required
|
15297
|
+
# },
|
15298
|
+
# ],
|
15299
|
+
# contact_flow_id: "ContactFlowId",
|
15300
|
+
# related_contact_id: "ContactId",
|
15301
|
+
# attributes: {
|
15302
|
+
# "AttributeName" => "AttributeValue",
|
15303
|
+
# },
|
15304
|
+
# segment_attributes: {
|
15305
|
+
# "SegmentAttributeName" => {
|
15306
|
+
# value_string: "SegmentAttributeValueString",
|
15307
|
+
# },
|
15308
|
+
# },
|
15309
|
+
# client_token: "ClientToken",
|
15310
|
+
# })
|
15311
|
+
#
|
15312
|
+
# @example Response structure
|
15313
|
+
#
|
15314
|
+
# resp.contact_id #=> String
|
15315
|
+
#
|
15316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEmailContact AWS API Documentation
|
15317
|
+
#
|
15318
|
+
# @overload start_email_contact(params = {})
|
15319
|
+
# @param [Hash] params ({})
|
15320
|
+
def start_email_contact(params = {}, options = {})
|
15321
|
+
req = build_request(:start_email_contact, params)
|
15322
|
+
req.send_request(options)
|
15323
|
+
end
|
15324
|
+
|
14618
15325
|
# Initiates a new outbound SMS contact to a customer. Response of this
|
14619
15326
|
# API provides the ContactId of the outbound SMS contact created.
|
14620
15327
|
#
|
@@ -14740,11 +15447,11 @@ module Aws::Connect
|
|
14740
15447
|
#
|
14741
15448
|
# resp = client.start_outbound_chat_contact({
|
14742
15449
|
# source_endpoint: { # required
|
14743
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
15450
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
14744
15451
|
# address: "EndpointAddress",
|
14745
15452
|
# },
|
14746
15453
|
# destination_endpoint: { # required
|
14747
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
15454
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
14748
15455
|
# address: "EndpointAddress",
|
14749
15456
|
# },
|
14750
15457
|
# instance_id: "InstanceId", # required
|
@@ -14783,6 +15490,81 @@ module Aws::Connect
|
|
14783
15490
|
req.send_request(options)
|
14784
15491
|
end
|
14785
15492
|
|
15493
|
+
# @option params [required, String] :instance_id
|
15494
|
+
#
|
15495
|
+
# @option params [required, String] :contact_id
|
15496
|
+
#
|
15497
|
+
# @option params [Types::EmailAddressInfo] :from_email_address
|
15498
|
+
#
|
15499
|
+
# @option params [required, Types::EmailAddressInfo] :destination_email_address
|
15500
|
+
#
|
15501
|
+
# @option params [Types::OutboundAdditionalRecipients] :additional_recipients
|
15502
|
+
#
|
15503
|
+
# @option params [required, Types::OutboundEmailContent] :email_message
|
15504
|
+
#
|
15505
|
+
# @option params [String] :client_token
|
15506
|
+
# **A suitable default value is auto-generated.** You should normally
|
15507
|
+
# not need to pass this option.**
|
15508
|
+
#
|
15509
|
+
# @return [Types::StartOutboundEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15510
|
+
#
|
15511
|
+
# * {Types::StartOutboundEmailContactResponse#contact_id #contact_id} => String
|
15512
|
+
#
|
15513
|
+
# @example Request syntax with placeholder values
|
15514
|
+
#
|
15515
|
+
# resp = client.start_outbound_email_contact({
|
15516
|
+
# instance_id: "InstanceId", # required
|
15517
|
+
# contact_id: "ContactId", # required
|
15518
|
+
# from_email_address: {
|
15519
|
+
# email_address: "EmailAddress", # required
|
15520
|
+
# display_name: "EmailAddressDisplayName",
|
15521
|
+
# },
|
15522
|
+
# destination_email_address: { # required
|
15523
|
+
# email_address: "EmailAddress", # required
|
15524
|
+
# display_name: "EmailAddressDisplayName",
|
15525
|
+
# },
|
15526
|
+
# additional_recipients: {
|
15527
|
+
# cc_email_addresses: [
|
15528
|
+
# {
|
15529
|
+
# email_address: "EmailAddress", # required
|
15530
|
+
# display_name: "EmailAddressDisplayName",
|
15531
|
+
# },
|
15532
|
+
# ],
|
15533
|
+
# },
|
15534
|
+
# email_message: { # required
|
15535
|
+
# message_source_type: "TEMPLATE", # required, accepts TEMPLATE, RAW
|
15536
|
+
# templated_message_config: {
|
15537
|
+
# knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
|
15538
|
+
# message_template_id: "MessageTemplateId", # required
|
15539
|
+
# template_attributes: { # required
|
15540
|
+
# custom_attributes: {
|
15541
|
+
# "AttributeName" => "AttributeValue",
|
15542
|
+
# },
|
15543
|
+
# customer_profile_attributes: "CustomerProfileAttributesSerialized",
|
15544
|
+
# },
|
15545
|
+
# },
|
15546
|
+
# raw_message: {
|
15547
|
+
# subject: "OutboundSubject", # required
|
15548
|
+
# body: "Body", # required
|
15549
|
+
# content_type: "EmailMessageContentType", # required
|
15550
|
+
# },
|
15551
|
+
# },
|
15552
|
+
# client_token: "ClientToken",
|
15553
|
+
# })
|
15554
|
+
#
|
15555
|
+
# @example Response structure
|
15556
|
+
#
|
15557
|
+
# resp.contact_id #=> String
|
15558
|
+
#
|
15559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundEmailContact AWS API Documentation
|
15560
|
+
#
|
15561
|
+
# @overload start_outbound_email_contact(params = {})
|
15562
|
+
# @param [Hash] params ({})
|
15563
|
+
def start_outbound_email_contact(params = {}, options = {})
|
15564
|
+
req = build_request(:start_outbound_email_contact, params)
|
15565
|
+
req.send_request(options)
|
15566
|
+
end
|
15567
|
+
|
14786
15568
|
# Places an outbound call to a contact, and then initiates the flow. It
|
14787
15569
|
# performs the actions in the flow that's specified (in
|
14788
15570
|
# `ContactFlowId`).
|
@@ -14916,8 +15698,11 @@ module Aws::Connect
|
|
14916
15698
|
# description: "Description",
|
14917
15699
|
# references: {
|
14918
15700
|
# "ReferenceKey" => {
|
14919
|
-
# value: "ReferenceValue",
|
14920
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
15701
|
+
# value: "ReferenceValue",
|
15702
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
15703
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
15704
|
+
# arn: "ReferenceArn",
|
15705
|
+
# status_reason: "ReferenceStatusReason",
|
14921
15706
|
# },
|
14922
15707
|
# },
|
14923
15708
|
# related_contact_id: "ContactId",
|
@@ -15018,7 +15803,6 @@ module Aws::Connect
|
|
15018
15803
|
# * There can be a maximum of 12 linked task contacts in a chain. That
|
15019
15804
|
# is, 12 task contacts can be created that share the same
|
15020
15805
|
# `PreviousContactId`.
|
15021
|
-
#
|
15022
15806
|
# * `RelatedContactId`
|
15023
15807
|
#
|
15024
15808
|
# * Copies contact attributes from the related task contact to the new
|
@@ -15146,6 +15930,8 @@ module Aws::Connect
|
|
15146
15930
|
#
|
15147
15931
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks
|
15148
15932
|
#
|
15933
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
15934
|
+
#
|
15149
15935
|
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15150
15936
|
#
|
15151
15937
|
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
@@ -15162,8 +15948,11 @@ module Aws::Connect
|
|
15162
15948
|
# name: "Name", # required
|
15163
15949
|
# references: {
|
15164
15950
|
# "ReferenceKey" => {
|
15165
|
-
# value: "ReferenceValue",
|
15166
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
15951
|
+
# value: "ReferenceValue",
|
15952
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
15953
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
15954
|
+
# arn: "ReferenceArn",
|
15955
|
+
# status_reason: "ReferenceStatusReason",
|
15167
15956
|
# },
|
15168
15957
|
# },
|
15169
15958
|
# description: "Description",
|
@@ -15172,6 +15961,11 @@ module Aws::Connect
|
|
15172
15961
|
# task_template_id: "TaskTemplateId",
|
15173
15962
|
# quick_connect_id: "QuickConnectId",
|
15174
15963
|
# related_contact_id: "ContactId",
|
15964
|
+
# segment_attributes: {
|
15965
|
+
# "SegmentAttributeName" => {
|
15966
|
+
# value_string: "SegmentAttributeValueString",
|
15967
|
+
# },
|
15968
|
+
# },
|
15175
15969
|
# })
|
15176
15970
|
#
|
15177
15971
|
# @example Response structure
|
@@ -15287,8 +16081,11 @@ module Aws::Connect
|
|
15287
16081
|
# related_contact_id: "ContactId",
|
15288
16082
|
# references: {
|
15289
16083
|
# "ReferenceKey" => {
|
15290
|
-
# value: "ReferenceValue",
|
15291
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
16084
|
+
# value: "ReferenceValue",
|
16085
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
16086
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
16087
|
+
# arn: "ReferenceArn",
|
16088
|
+
# status_reason: "ReferenceStatusReason",
|
15292
16089
|
# },
|
15293
16090
|
# },
|
15294
16091
|
# description: "Description",
|
@@ -15977,6 +16774,8 @@ module Aws::Connect
|
|
15977
16774
|
# Well-formed data on contact, shown to agents on Contact Control Panel
|
15978
16775
|
# (CCP).
|
15979
16776
|
#
|
16777
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
16778
|
+
#
|
15980
16779
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
15981
16780
|
#
|
15982
16781
|
# @example Request syntax with placeholder values
|
@@ -15988,8 +16787,16 @@ module Aws::Connect
|
|
15988
16787
|
# description: "Description",
|
15989
16788
|
# references: {
|
15990
16789
|
# "ReferenceKey" => {
|
15991
|
-
# value: "ReferenceValue",
|
15992
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
16790
|
+
# value: "ReferenceValue",
|
16791
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
16792
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
16793
|
+
# arn: "ReferenceArn",
|
16794
|
+
# status_reason: "ReferenceStatusReason",
|
16795
|
+
# },
|
16796
|
+
# },
|
16797
|
+
# segment_attributes: {
|
16798
|
+
# "SegmentAttributeName" => {
|
16799
|
+
# value_string: "SegmentAttributeValueString",
|
15993
16800
|
# },
|
15994
16801
|
# },
|
15995
16802
|
# })
|
@@ -16507,6 +17314,45 @@ module Aws::Connect
|
|
16507
17314
|
req.send_request(options)
|
16508
17315
|
end
|
16509
17316
|
|
17317
|
+
# @option params [required, String] :instance_id
|
17318
|
+
#
|
17319
|
+
# @option params [required, String] :email_address_id
|
17320
|
+
#
|
17321
|
+
# @option params [String] :description
|
17322
|
+
#
|
17323
|
+
# @option params [String] :display_name
|
17324
|
+
#
|
17325
|
+
# @option params [String] :client_token
|
17326
|
+
#
|
17327
|
+
# @return [Types::UpdateEmailAddressMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
17328
|
+
#
|
17329
|
+
# * {Types::UpdateEmailAddressMetadataResponse#email_address_id #email_address_id} => String
|
17330
|
+
# * {Types::UpdateEmailAddressMetadataResponse#email_address_arn #email_address_arn} => String
|
17331
|
+
#
|
17332
|
+
# @example Request syntax with placeholder values
|
17333
|
+
#
|
17334
|
+
# resp = client.update_email_address_metadata({
|
17335
|
+
# instance_id: "InstanceId", # required
|
17336
|
+
# email_address_id: "EmailAddressId", # required
|
17337
|
+
# description: "Description",
|
17338
|
+
# display_name: "EmailAddressDisplayName",
|
17339
|
+
# client_token: "ClientToken",
|
17340
|
+
# })
|
17341
|
+
#
|
17342
|
+
# @example Response structure
|
17343
|
+
#
|
17344
|
+
# resp.email_address_id #=> String
|
17345
|
+
# resp.email_address_arn #=> String
|
17346
|
+
#
|
17347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadata AWS API Documentation
|
17348
|
+
#
|
17349
|
+
# @overload update_email_address_metadata(params = {})
|
17350
|
+
# @param [Hash] params ({})
|
17351
|
+
def update_email_address_metadata(params = {}, options = {})
|
17352
|
+
req = build_request(:update_email_address_metadata, params)
|
17353
|
+
req.send_request(options)
|
17354
|
+
end
|
17355
|
+
|
16510
17356
|
# Updates details about a specific evaluation form version in the
|
16511
17357
|
# specified Amazon Connect instance. Question and section identifiers
|
16512
17358
|
# cannot be duplicated within the same evaluation form.
|
@@ -16795,7 +17641,7 @@ module Aws::Connect
|
|
16795
17641
|
# resp = client.update_instance_storage_config({
|
16796
17642
|
# instance_id: "InstanceId", # required
|
16797
17643
|
# association_id: "AssociationId", # required
|
16798
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
|
17644
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
|
16799
17645
|
# storage_config: { # required
|
16800
17646
|
# association_id: "AssociationId",
|
16801
17647
|
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
@@ -17312,6 +18158,33 @@ module Aws::Connect
|
|
17312
18158
|
req.send_request(options)
|
17313
18159
|
end
|
17314
18160
|
|
18161
|
+
# @option params [required, String] :instance_id
|
18162
|
+
#
|
18163
|
+
# @option params [required, String] :queue_id
|
18164
|
+
#
|
18165
|
+
# @option params [required, Types::OutboundEmailConfig] :outbound_email_config
|
18166
|
+
#
|
18167
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
18168
|
+
#
|
18169
|
+
# @example Request syntax with placeholder values
|
18170
|
+
#
|
18171
|
+
# resp = client.update_queue_outbound_email_config({
|
18172
|
+
# instance_id: "InstanceId", # required
|
18173
|
+
# queue_id: "QueueId", # required
|
18174
|
+
# outbound_email_config: { # required
|
18175
|
+
# outbound_email_address_id: "EmailAddressId",
|
18176
|
+
# },
|
18177
|
+
# })
|
18178
|
+
#
|
18179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundEmailConfig AWS API Documentation
|
18180
|
+
#
|
18181
|
+
# @overload update_queue_outbound_email_config(params = {})
|
18182
|
+
# @param [Hash] params ({})
|
18183
|
+
def update_queue_outbound_email_config(params = {}, options = {})
|
18184
|
+
req = build_request(:update_queue_outbound_email_config, params)
|
18185
|
+
req.send_request(options)
|
18186
|
+
end
|
18187
|
+
|
17315
18188
|
# This API is in preview release for Amazon Connect and is subject to
|
17316
18189
|
# change.
|
17317
18190
|
#
|
@@ -17505,7 +18378,7 @@ module Aws::Connect
|
|
17505
18378
|
# routing_profile_id: "RoutingProfileId", # required
|
17506
18379
|
# media_concurrencies: [ # required
|
17507
18380
|
# {
|
17508
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
18381
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
17509
18382
|
# concurrency: 1, # required
|
17510
18383
|
# cross_channel_behavior: {
|
17511
18384
|
# behavior_type: "ROUTE_CURRENT_CHANNEL_ONLY", # required, accepts ROUTE_CURRENT_CHANNEL_ONLY, ROUTE_ANY_CHANNEL
|
@@ -17630,7 +18503,7 @@ module Aws::Connect
|
|
17630
18503
|
# {
|
17631
18504
|
# queue_reference: { # required
|
17632
18505
|
# queue_id: "QueueId", # required
|
17633
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
18506
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
17634
18507
|
# },
|
17635
18508
|
# priority: 1, # required
|
17636
18509
|
# delay: 1, # required
|
@@ -17699,8 +18572,11 @@ module Aws::Connect
|
|
17699
18572
|
# contact_flow_id: "ContactFlowId", # required
|
17700
18573
|
# references: {
|
17701
18574
|
# "ReferenceKey" => {
|
17702
|
-
# value: "ReferenceValue",
|
17703
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
18575
|
+
# value: "ReferenceValue",
|
18576
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
18577
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
18578
|
+
# arn: "ReferenceArn",
|
18579
|
+
# status_reason: "ReferenceStatusReason",
|
17704
18580
|
# },
|
17705
18581
|
# },
|
17706
18582
|
# },
|
@@ -17880,6 +18756,8 @@ module Aws::Connect
|
|
17880
18756
|
# The identifier of the flow that runs by default when a task is created
|
17881
18757
|
# by referencing this template.
|
17882
18758
|
#
|
18759
|
+
# @option params [String] :self_assign_flow_id
|
18760
|
+
#
|
17883
18761
|
# @option params [Types::TaskTemplateConstraints] :constraints
|
17884
18762
|
# Constraints that are applicable to the fields listed.
|
17885
18763
|
#
|
@@ -17904,6 +18782,7 @@ module Aws::Connect
|
|
17904
18782
|
# * {Types::UpdateTaskTemplateResponse#name #name} => String
|
17905
18783
|
# * {Types::UpdateTaskTemplateResponse#description #description} => String
|
17906
18784
|
# * {Types::UpdateTaskTemplateResponse#contact_flow_id #contact_flow_id} => String
|
18785
|
+
# * {Types::UpdateTaskTemplateResponse#self_assign_flow_id #self_assign_flow_id} => String
|
17907
18786
|
# * {Types::UpdateTaskTemplateResponse#constraints #constraints} => Types::TaskTemplateConstraints
|
17908
18787
|
# * {Types::UpdateTaskTemplateResponse#defaults #defaults} => Types::TaskTemplateDefaults
|
17909
18788
|
# * {Types::UpdateTaskTemplateResponse#fields #fields} => Array<Types::TaskTemplateField>
|
@@ -17919,6 +18798,7 @@ module Aws::Connect
|
|
17919
18798
|
# name: "TaskTemplateName",
|
17920
18799
|
# description: "TaskTemplateDescription",
|
17921
18800
|
# contact_flow_id: "ContactFlowId",
|
18801
|
+
# self_assign_flow_id: "ContactFlowId",
|
17922
18802
|
# constraints: {
|
17923
18803
|
# required_fields: [
|
17924
18804
|
# {
|
@@ -17959,7 +18839,7 @@ module Aws::Connect
|
|
17959
18839
|
# name: "TaskTemplateFieldName",
|
17960
18840
|
# },
|
17961
18841
|
# description: "TaskTemplateFieldDescription",
|
17962
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
18842
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL, SELF_ASSIGN, EXPIRY_DURATION
|
17963
18843
|
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
17964
18844
|
# },
|
17965
18845
|
# ],
|
@@ -17973,6 +18853,7 @@ module Aws::Connect
|
|
17973
18853
|
# resp.name #=> String
|
17974
18854
|
# resp.description #=> String
|
17975
18855
|
# resp.contact_flow_id #=> String
|
18856
|
+
# resp.self_assign_flow_id #=> String
|
17976
18857
|
# resp.constraints.required_fields #=> Array
|
17977
18858
|
# resp.constraints.required_fields[0].id.name #=> String
|
17978
18859
|
# resp.constraints.read_only_fields #=> Array
|
@@ -17985,7 +18866,7 @@ module Aws::Connect
|
|
17985
18866
|
# resp.fields #=> Array
|
17986
18867
|
# resp.fields[0].id.name #=> String
|
17987
18868
|
# resp.fields[0].description #=> String
|
17988
|
-
# resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL"
|
18869
|
+
# resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL", "SELF_ASSIGN", "EXPIRY_DURATION"
|
17989
18870
|
# resp.fields[0].single_select_options #=> Array
|
17990
18871
|
# resp.fields[0].single_select_options[0] #=> String
|
17991
18872
|
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
@@ -18525,7 +19406,7 @@ module Aws::Connect
|
|
18525
19406
|
tracer: tracer
|
18526
19407
|
)
|
18527
19408
|
context[:gem_name] = 'aws-sdk-connect'
|
18528
|
-
context[:gem_version] = '1.
|
19409
|
+
context[:gem_version] = '1.186.0'
|
18529
19410
|
Seahorse::Client::Request.new(handlers, context)
|
18530
19411
|
end
|
18531
19412
|
|