aws-sdk-connect 1.185.0 → 1.187.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 +1196 -103
- data/lib/aws-sdk-connect/client_api.rb +549 -2
- data/lib/aws-sdk-connect/errors.rb +21 -0
- data/lib/aws-sdk-connect/types.rb +1726 -199
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +415 -47
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +407 -40
- 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
|
@@ -1242,8 +1242,8 @@ module Aws::Connect
|
|
1242
1242
|
# The unique identifier of the Connect instance.
|
1243
1243
|
#
|
1244
1244
|
# @option params [required, String] :associated_resource_arn
|
1245
|
-
# The resource to which the attached file is (being) uploaded to.
|
1246
|
-
# [Cases][1]
|
1245
|
+
# The resource to which the attached file is (being) uploaded to. The
|
1246
|
+
# supported resources are [Cases][1] and [Email][2].
|
1247
1247
|
#
|
1248
1248
|
# <note markdown="1"> This value must be a valid ARN.
|
1249
1249
|
#
|
@@ -1251,7 +1251,8 @@ module Aws::Connect
|
|
1251
1251
|
#
|
1252
1252
|
#
|
1253
1253
|
#
|
1254
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
1254
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
1255
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
1255
1256
|
#
|
1256
1257
|
# @return [Types::BatchGetAttachedFileMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1257
1258
|
#
|
@@ -1277,7 +1278,7 @@ module Aws::Connect
|
|
1277
1278
|
# resp.files[0].file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
1278
1279
|
# resp.files[0].created_by.connect_user_arn #=> String
|
1279
1280
|
# resp.files[0].created_by.aws_identity_arn #=> String
|
1280
|
-
# resp.files[0].file_use_case_type #=> String, one of "ATTACHMENT"
|
1281
|
+
# resp.files[0].file_use_case_type #=> String, one of "EMAIL_MESSAGE", "ATTACHMENT"
|
1281
1282
|
# resp.files[0].associated_resource_arn #=> String
|
1282
1283
|
# resp.files[0].tags #=> Hash
|
1283
1284
|
# resp.files[0].tags["TagKey"] #=> String
|
@@ -1320,7 +1321,7 @@ module Aws::Connect
|
|
1320
1321
|
# resp = client.batch_get_flow_association({
|
1321
1322
|
# instance_id: "InstanceId", # required
|
1322
1323
|
# resource_ids: ["ARN"], # required
|
1323
|
-
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER
|
1324
|
+
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
1324
1325
|
# })
|
1325
1326
|
#
|
1326
1327
|
# @example Response structure
|
@@ -1328,7 +1329,7 @@ module Aws::Connect
|
|
1328
1329
|
# resp.flow_association_summary_list #=> Array
|
1329
1330
|
# resp.flow_association_summary_list[0].resource_id #=> String
|
1330
1331
|
# resp.flow_association_summary_list[0].flow_id #=> String
|
1331
|
-
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER"
|
1332
|
+
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL"
|
1332
1333
|
#
|
1333
1334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchGetFlowAssociation AWS API Documentation
|
1334
1335
|
#
|
@@ -1393,11 +1394,11 @@ module Aws::Connect
|
|
1393
1394
|
# contact_data_request_list: [ # required
|
1394
1395
|
# {
|
1395
1396
|
# system_endpoint: {
|
1396
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
1397
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
1397
1398
|
# address: "EndpointAddress",
|
1398
1399
|
# },
|
1399
1400
|
# customer_endpoint: {
|
1400
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
1401
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
1401
1402
|
# address: "EndpointAddress",
|
1402
1403
|
# },
|
1403
1404
|
# request_identifier: "RequestIdentifier",
|
@@ -1556,8 +1557,8 @@ module Aws::Connect
|
|
1556
1557
|
# The unique identifier of the attached file resource.
|
1557
1558
|
#
|
1558
1559
|
# @option params [required, String] :associated_resource_arn
|
1559
|
-
# The resource to which the attached file is (being) uploaded to.
|
1560
|
-
# [Cases][1]
|
1560
|
+
# The resource to which the attached file is (being) uploaded to. The
|
1561
|
+
# supported resources are [Cases][1] and [Email][2].
|
1561
1562
|
#
|
1562
1563
|
# <note markdown="1"> This value must be a valid ARN.
|
1563
1564
|
#
|
@@ -1565,7 +1566,8 @@ module Aws::Connect
|
|
1565
1566
|
#
|
1566
1567
|
#
|
1567
1568
|
#
|
1568
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
1569
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
1570
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
1569
1571
|
#
|
1570
1572
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1571
1573
|
#
|
@@ -1648,6 +1650,143 @@ module Aws::Connect
|
|
1648
1650
|
req.send_request(options)
|
1649
1651
|
end
|
1650
1652
|
|
1653
|
+
# Creates a new contact.
|
1654
|
+
#
|
1655
|
+
# @option params [required, String] :instance_id
|
1656
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
1657
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
1658
|
+
#
|
1659
|
+
#
|
1660
|
+
#
|
1661
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
1662
|
+
#
|
1663
|
+
# @option params [String] :client_token
|
1664
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1665
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1666
|
+
# SDK populates this field. For more information about idempotency, see
|
1667
|
+
# [Making retries safe with idempotent APIs][1].
|
1668
|
+
#
|
1669
|
+
# **A suitable default value is auto-generated.** You should normally
|
1670
|
+
# not need to pass this option.**
|
1671
|
+
#
|
1672
|
+
#
|
1673
|
+
#
|
1674
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1675
|
+
#
|
1676
|
+
# @option params [String] :related_contact_id
|
1677
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
1678
|
+
#
|
1679
|
+
# @option params [Hash<String,String>] :attributes
|
1680
|
+
# A custom key-value pair using an attribute map. The attributes are
|
1681
|
+
# standard Amazon Connect attributes, and can be accessed in flows just
|
1682
|
+
# like any other contact attributes.
|
1683
|
+
#
|
1684
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
1685
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
1686
|
+
# underscore characters.
|
1687
|
+
#
|
1688
|
+
# @option params [Hash<String,Types::Reference>] :references
|
1689
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
1690
|
+
# (CCP). Tasks can have the following reference types at the time of
|
1691
|
+
# creation: URL \| NUMBER \| STRING \| DATE \| EMAIL \| ATTACHMENT.
|
1692
|
+
#
|
1693
|
+
# @option params [required, String] :channel
|
1694
|
+
# The channel for the contact
|
1695
|
+
#
|
1696
|
+
# @option params [required, String] :initiation_method
|
1697
|
+
# Indicates how the contact was initiated.
|
1698
|
+
#
|
1699
|
+
# @option params [Integer] :expiry_duration_in_minutes
|
1700
|
+
# Number of minutes the contact will be active for before expiring
|
1701
|
+
#
|
1702
|
+
# @option params [Types::UserInfo] :user_info
|
1703
|
+
# User details for the contact
|
1704
|
+
#
|
1705
|
+
# @option params [String] :initiate_as
|
1706
|
+
# Initial state of the contact when it's created
|
1707
|
+
#
|
1708
|
+
# @option params [String] :name
|
1709
|
+
# The name of a the contact.
|
1710
|
+
#
|
1711
|
+
# @option params [String] :description
|
1712
|
+
# A description of the contact.
|
1713
|
+
#
|
1714
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
1715
|
+
# A set of system defined key-value pairs stored on individual contact
|
1716
|
+
# segments (unique contact ID) using an attribute map. The attributes
|
1717
|
+
# are standard Amazon Connect attributes. They can be accessed in flows.
|
1718
|
+
#
|
1719
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
1720
|
+
#
|
1721
|
+
# This field can be used to set Segment Contact Expiry as a duration in
|
1722
|
+
# minutes.
|
1723
|
+
#
|
1724
|
+
# <note markdown="1"> To set contact expiry, a ValueMap must be specified containing the
|
1725
|
+
# integer number of minutes the contact will be active for before
|
1726
|
+
# expiring, with `SegmentAttributes` like \{ ` "connect:ContactExpiry":
|
1727
|
+
# {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}`.
|
1728
|
+
#
|
1729
|
+
# </note>
|
1730
|
+
#
|
1731
|
+
# @return [Types::CreateContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1732
|
+
#
|
1733
|
+
# * {Types::CreateContactResponse#contact_id #contact_id} => String
|
1734
|
+
# * {Types::CreateContactResponse#contact_arn #contact_arn} => String
|
1735
|
+
#
|
1736
|
+
# @example Request syntax with placeholder values
|
1737
|
+
#
|
1738
|
+
# resp = client.create_contact({
|
1739
|
+
# instance_id: "InstanceId", # required
|
1740
|
+
# client_token: "ClientToken",
|
1741
|
+
# related_contact_id: "ContactId",
|
1742
|
+
# attributes: {
|
1743
|
+
# "AttributeName" => "AttributeValue",
|
1744
|
+
# },
|
1745
|
+
# references: {
|
1746
|
+
# "ReferenceKey" => {
|
1747
|
+
# value: "ReferenceValue",
|
1748
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
1749
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
1750
|
+
# arn: "ReferenceArn",
|
1751
|
+
# status_reason: "ReferenceStatusReason",
|
1752
|
+
# },
|
1753
|
+
# },
|
1754
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
1755
|
+
# initiation_method: "INBOUND", # required, accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
|
1756
|
+
# expiry_duration_in_minutes: 1,
|
1757
|
+
# user_info: {
|
1758
|
+
# user_id: "AgentResourceId",
|
1759
|
+
# },
|
1760
|
+
# initiate_as: "CONNECTED_TO_USER", # accepts CONNECTED_TO_USER
|
1761
|
+
# name: "Name",
|
1762
|
+
# description: "Description",
|
1763
|
+
# segment_attributes: {
|
1764
|
+
# "SegmentAttributeName" => {
|
1765
|
+
# value_string: "SegmentAttributeValueString",
|
1766
|
+
# value_map: {
|
1767
|
+
# "SegmentAttributeName" => {
|
1768
|
+
# # recursive SegmentAttributeValue
|
1769
|
+
# },
|
1770
|
+
# },
|
1771
|
+
# value_integer: 1,
|
1772
|
+
# },
|
1773
|
+
# },
|
1774
|
+
# })
|
1775
|
+
#
|
1776
|
+
# @example Response structure
|
1777
|
+
#
|
1778
|
+
# resp.contact_id #=> String
|
1779
|
+
# resp.contact_arn #=> String
|
1780
|
+
#
|
1781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContact AWS API Documentation
|
1782
|
+
#
|
1783
|
+
# @overload create_contact(params = {})
|
1784
|
+
# @param [Hash] params ({})
|
1785
|
+
def create_contact(params = {}, options = {})
|
1786
|
+
req = build_request(:create_contact, params)
|
1787
|
+
req.send_request(options)
|
1788
|
+
end
|
1789
|
+
|
1651
1790
|
# Creates a flow for the specified Amazon Connect instance.
|
1652
1791
|
#
|
1653
1792
|
# You can also create and update flows using the [Amazon Connect Flow
|
@@ -1860,6 +1999,79 @@ module Aws::Connect
|
|
1860
1999
|
req.send_request(options)
|
1861
2000
|
end
|
1862
2001
|
|
2002
|
+
# Create new email address in the specified Amazon Connect instance. For
|
2003
|
+
# more information about email addresses, see [Create email
|
2004
|
+
# addresses][1] in the Amazon Connect Administrator Guide.
|
2005
|
+
#
|
2006
|
+
#
|
2007
|
+
#
|
2008
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html
|
2009
|
+
#
|
2010
|
+
# @option params [String] :description
|
2011
|
+
# The description of the email address.
|
2012
|
+
#
|
2013
|
+
# @option params [required, String] :instance_id
|
2014
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2015
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2016
|
+
#
|
2017
|
+
#
|
2018
|
+
#
|
2019
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2020
|
+
#
|
2021
|
+
# @option params [required, String] :email_address
|
2022
|
+
# The email address with the instance, in
|
2023
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
2024
|
+
#
|
2025
|
+
# @option params [String] :display_name
|
2026
|
+
# The display name of email address
|
2027
|
+
#
|
2028
|
+
# @option params [Hash<String,String>] :tags
|
2029
|
+
# The tags used to organize, track, or control access for this resource.
|
2030
|
+
# For example, \{ "Tags": \{"key1":"value1", "key2":"value2"}
|
2031
|
+
# }.
|
2032
|
+
#
|
2033
|
+
# @option params [String] :client_token
|
2034
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2035
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2036
|
+
# SDK populates this field. For more information about idempotency, see
|
2037
|
+
# [Making retries safe with idempotent APIs][1].
|
2038
|
+
#
|
2039
|
+
#
|
2040
|
+
#
|
2041
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2042
|
+
#
|
2043
|
+
# @return [Types::CreateEmailAddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2044
|
+
#
|
2045
|
+
# * {Types::CreateEmailAddressResponse#email_address_id #email_address_id} => String
|
2046
|
+
# * {Types::CreateEmailAddressResponse#email_address_arn #email_address_arn} => String
|
2047
|
+
#
|
2048
|
+
# @example Request syntax with placeholder values
|
2049
|
+
#
|
2050
|
+
# resp = client.create_email_address({
|
2051
|
+
# description: "Description",
|
2052
|
+
# instance_id: "InstanceId", # required
|
2053
|
+
# email_address: "EmailAddress", # required
|
2054
|
+
# display_name: "EmailAddressDisplayName",
|
2055
|
+
# tags: {
|
2056
|
+
# "TagKey" => "TagValue",
|
2057
|
+
# },
|
2058
|
+
# client_token: "ClientToken",
|
2059
|
+
# })
|
2060
|
+
#
|
2061
|
+
# @example Response structure
|
2062
|
+
#
|
2063
|
+
# resp.email_address_id #=> String
|
2064
|
+
# resp.email_address_arn #=> String
|
2065
|
+
#
|
2066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEmailAddress AWS API Documentation
|
2067
|
+
#
|
2068
|
+
# @overload create_email_address(params = {})
|
2069
|
+
# @param [Hash] params ({})
|
2070
|
+
def create_email_address(params = {}, options = {})
|
2071
|
+
req = build_request(:create_email_address, params)
|
2072
|
+
req.send_request(options)
|
2073
|
+
end
|
2074
|
+
|
1863
2075
|
# Creates an evaluation form in the specified Amazon Connect instance.
|
1864
2076
|
# The form can be used to define questions related to agent performance,
|
1865
2077
|
# and create sections to organize such questions. Question and section
|
@@ -2195,7 +2407,7 @@ module Aws::Connect
|
|
2195
2407
|
#
|
2196
2408
|
# resp = client.create_integration_association({
|
2197
2409
|
# instance_id: "InstanceId", # required
|
2198
|
-
# 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
|
2410
|
+
# 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
|
2199
2411
|
# integration_arn: "ARN", # required
|
2200
2412
|
# source_application_url: "URI",
|
2201
2413
|
# source_application_name: "SourceApplicationName",
|
@@ -2570,6 +2782,9 @@ module Aws::Connect
|
|
2570
2782
|
# @option params [Types::OutboundCallerConfig] :outbound_caller_config
|
2571
2783
|
# The outbound caller ID name, number, and outbound whisper flow.
|
2572
2784
|
#
|
2785
|
+
# @option params [Types::OutboundEmailConfig] :outbound_email_config
|
2786
|
+
# The outbound email address ID for a specified queue.
|
2787
|
+
#
|
2573
2788
|
# @option params [required, String] :hours_of_operation_id
|
2574
2789
|
# The identifier for the hours of operation.
|
2575
2790
|
#
|
@@ -2601,6 +2816,9 @@ module Aws::Connect
|
|
2601
2816
|
# outbound_caller_id_number_id: "PhoneNumberId",
|
2602
2817
|
# outbound_flow_id: "ContactFlowId",
|
2603
2818
|
# },
|
2819
|
+
# outbound_email_config: {
|
2820
|
+
# outbound_email_address_id: "EmailAddressId",
|
2821
|
+
# },
|
2604
2822
|
# hours_of_operation_id: "HoursOfOperationId", # required
|
2605
2823
|
# max_contacts: 1,
|
2606
2824
|
# quick_connect_ids: ["QuickConnectId"],
|
@@ -2755,7 +2973,7 @@ module Aws::Connect
|
|
2755
2973
|
# {
|
2756
2974
|
# queue_reference: { # required
|
2757
2975
|
# queue_id: "QueueId", # required
|
2758
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2976
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
2759
2977
|
# },
|
2760
2978
|
# priority: 1, # required
|
2761
2979
|
# delay: 1, # required
|
@@ -2763,7 +2981,7 @@ module Aws::Connect
|
|
2763
2981
|
# ],
|
2764
2982
|
# media_concurrencies: [ # required
|
2765
2983
|
# {
|
2766
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2984
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
2767
2985
|
# concurrency: 1, # required
|
2768
2986
|
# cross_channel_behavior: {
|
2769
2987
|
# behavior_type: "ROUTE_CURRENT_CHANNEL_ONLY", # required, accepts ROUTE_CURRENT_CHANNEL_ONLY, ROUTE_ANY_CHANNEL
|
@@ -2858,8 +3076,11 @@ module Aws::Connect
|
|
2858
3076
|
# contact_flow_id: "ContactFlowId", # required
|
2859
3077
|
# references: {
|
2860
3078
|
# "ReferenceKey" => {
|
2861
|
-
# value: "ReferenceValue",
|
2862
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
3079
|
+
# value: "ReferenceValue",
|
3080
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
3081
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
3082
|
+
# arn: "ReferenceArn",
|
3083
|
+
# status_reason: "ReferenceStatusReason",
|
2863
3084
|
# },
|
2864
3085
|
# },
|
2865
3086
|
# },
|
@@ -3058,6 +3279,10 @@ module Aws::Connect
|
|
3058
3279
|
# The identifier of the flow that runs by default when a task is created
|
3059
3280
|
# by referencing this template.
|
3060
3281
|
#
|
3282
|
+
# @option params [String] :self_assign_flow_id
|
3283
|
+
# The ContactFlowId for the flow that will be run if this template is
|
3284
|
+
# used to create a self-assigned task.
|
3285
|
+
#
|
3061
3286
|
# @option params [Types::TaskTemplateConstraints] :constraints
|
3062
3287
|
# Constraints that are applicable to the fields listed.
|
3063
3288
|
#
|
@@ -3099,6 +3324,7 @@ module Aws::Connect
|
|
3099
3324
|
# name: "TaskTemplateName", # required
|
3100
3325
|
# description: "TaskTemplateDescription",
|
3101
3326
|
# contact_flow_id: "ContactFlowId",
|
3327
|
+
# self_assign_flow_id: "ContactFlowId",
|
3102
3328
|
# constraints: {
|
3103
3329
|
# required_fields: [
|
3104
3330
|
# {
|
@@ -3139,7 +3365,7 @@ module Aws::Connect
|
|
3139
3365
|
# name: "TaskTemplateFieldName",
|
3140
3366
|
# },
|
3141
3367
|
# description: "TaskTemplateFieldDescription",
|
3142
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
3368
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL, SELF_ASSIGN, EXPIRY_DURATION
|
3143
3369
|
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
3144
3370
|
# },
|
3145
3371
|
# ],
|
@@ -3897,6 +4123,37 @@ module Aws::Connect
|
|
3897
4123
|
req.send_request(options)
|
3898
4124
|
end
|
3899
4125
|
|
4126
|
+
# Deletes email address from the specified Amazon Connect instance.
|
4127
|
+
#
|
4128
|
+
# @option params [required, String] :instance_id
|
4129
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
4130
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
4131
|
+
#
|
4132
|
+
#
|
4133
|
+
#
|
4134
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
4135
|
+
#
|
4136
|
+
# @option params [required, String] :email_address_id
|
4137
|
+
# The identifier of the email address.
|
4138
|
+
#
|
4139
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4140
|
+
#
|
4141
|
+
# @example Request syntax with placeholder values
|
4142
|
+
#
|
4143
|
+
# resp = client.delete_email_address({
|
4144
|
+
# instance_id: "InstanceId", # required
|
4145
|
+
# email_address_id: "EmailAddressId", # required
|
4146
|
+
# })
|
4147
|
+
#
|
4148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEmailAddress AWS API Documentation
|
4149
|
+
#
|
4150
|
+
# @overload delete_email_address(params = {})
|
4151
|
+
# @param [Hash] params ({})
|
4152
|
+
def delete_email_address(params = {}, options = {})
|
4153
|
+
req = build_request(:delete_email_address, params)
|
4154
|
+
req.send_request(options)
|
4155
|
+
end
|
4156
|
+
|
3900
4157
|
# Deletes an evaluation form in the specified Amazon Connect instance.
|
3901
4158
|
#
|
3902
4159
|
# * If the version property is provided, only the specified version of
|
@@ -4706,10 +4963,11 @@ module Aws::Connect
|
|
4706
4963
|
# resp.contact.id #=> String
|
4707
4964
|
# resp.contact.initial_contact_id #=> String
|
4708
4965
|
# resp.contact.previous_contact_id #=> String
|
4709
|
-
# resp.contact.
|
4966
|
+
# resp.contact.contact_association_id #=> String
|
4967
|
+
# resp.contact.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
|
4710
4968
|
# resp.contact.name #=> String
|
4711
4969
|
# resp.contact.description #=> String
|
4712
|
-
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
4970
|
+
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
4713
4971
|
# resp.contact.queue_info.id #=> String
|
4714
4972
|
# resp.contact.queue_info.enqueue_timestamp #=> Time
|
4715
4973
|
# resp.contact.agent_info.id #=> String
|
@@ -4735,6 +4993,12 @@ module Aws::Connect
|
|
4735
4993
|
# resp.contact.scheduled_timestamp #=> Time
|
4736
4994
|
# resp.contact.related_contact_id #=> String
|
4737
4995
|
# resp.contact.wisdom_info.session_arn #=> String
|
4996
|
+
# resp.contact.customer_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
|
4997
|
+
# resp.contact.customer_endpoint.address #=> String
|
4998
|
+
# resp.contact.customer_endpoint.display_name #=> String
|
4999
|
+
# resp.contact.system_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
|
5000
|
+
# resp.contact.system_endpoint.address #=> String
|
5001
|
+
# resp.contact.system_endpoint.display_name #=> String
|
4738
5002
|
# resp.contact.queue_time_adjustment_seconds #=> Integer
|
4739
5003
|
# resp.contact.queue_priority #=> Integer
|
4740
5004
|
# resp.contact.tags #=> Hash
|
@@ -4772,8 +5036,17 @@ module Aws::Connect
|
|
4772
5036
|
# resp.contact.quality_metrics.customer.audio.potential_quality_issues #=> Array
|
4773
5037
|
# resp.contact.quality_metrics.customer.audio.potential_quality_issues[0] #=> String
|
4774
5038
|
# resp.contact.disconnect_details.potential_disconnect_issue #=> String
|
5039
|
+
# resp.contact.additional_email_recipients.to_list #=> Array
|
5040
|
+
# resp.contact.additional_email_recipients.to_list[0].address #=> String
|
5041
|
+
# resp.contact.additional_email_recipients.to_list[0].display_name #=> String
|
5042
|
+
# resp.contact.additional_email_recipients.cc_list #=> Array
|
5043
|
+
# resp.contact.additional_email_recipients.cc_list[0].address #=> String
|
5044
|
+
# resp.contact.additional_email_recipients.cc_list[0].display_name #=> String
|
4775
5045
|
# resp.contact.segment_attributes #=> Hash
|
4776
5046
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_string #=> String
|
5047
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_map #=> Hash
|
5048
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"] #=> Types::SegmentAttributeValue
|
5049
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_integer #=> Integer
|
4777
5050
|
#
|
4778
5051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContact AWS API Documentation
|
4779
5052
|
#
|
@@ -4892,8 +5165,8 @@ module Aws::Connect
|
|
4892
5165
|
# language][1].
|
4893
5166
|
#
|
4894
5167
|
# Use the `$SAVED` alias in the request to describe the `SAVED` content
|
4895
|
-
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`.
|
4896
|
-
#
|
5168
|
+
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After
|
5169
|
+
# a flow is published, `$SAVED` needs to be supplied to view saved
|
4897
5170
|
# content that has not been published.
|
4898
5171
|
#
|
4899
5172
|
# In the response, **Status** indicates the flow status as either
|
@@ -4934,7 +5207,6 @@ module Aws::Connect
|
|
4934
5207
|
# resp.contact_flow.content #=> String
|
4935
5208
|
# resp.contact_flow.tags #=> Hash
|
4936
5209
|
# resp.contact_flow.tags["TagKey"] #=> String
|
4937
|
-
# resp.contact_flow.is_default #=> Boolean
|
4938
5210
|
# resp.contact_flow.flow_content_sha_256 #=> String
|
4939
5211
|
# resp.contact_flow.version #=> Integer
|
4940
5212
|
# resp.contact_flow.version_description #=> String
|
@@ -4953,8 +5225,8 @@ module Aws::Connect
|
|
4953
5225
|
# Describes the specified flow module.
|
4954
5226
|
#
|
4955
5227
|
# Use the `$SAVED` alias in the request to describe the `SAVED` content
|
4956
|
-
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`.
|
4957
|
-
#
|
5228
|
+
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After
|
5229
|
+
# a flow is published, `$SAVED` needs to be supplied to view saved
|
4958
5230
|
# content that has not been published.
|
4959
5231
|
#
|
4960
5232
|
# @option params [required, String] :instance_id
|
@@ -5000,6 +5272,58 @@ module Aws::Connect
|
|
5000
5272
|
req.send_request(options)
|
5001
5273
|
end
|
5002
5274
|
|
5275
|
+
# Describe email address form the specified Amazon Connect instance.
|
5276
|
+
#
|
5277
|
+
# @option params [required, String] :instance_id
|
5278
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
5279
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
5280
|
+
#
|
5281
|
+
#
|
5282
|
+
#
|
5283
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
5284
|
+
#
|
5285
|
+
# @option params [required, String] :email_address_id
|
5286
|
+
# The identifier of the email address.
|
5287
|
+
#
|
5288
|
+
# @return [Types::DescribeEmailAddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5289
|
+
#
|
5290
|
+
# * {Types::DescribeEmailAddressResponse#email_address_id #email_address_id} => String
|
5291
|
+
# * {Types::DescribeEmailAddressResponse#email_address_arn #email_address_arn} => String
|
5292
|
+
# * {Types::DescribeEmailAddressResponse#email_address #email_address} => String
|
5293
|
+
# * {Types::DescribeEmailAddressResponse#display_name #display_name} => String
|
5294
|
+
# * {Types::DescribeEmailAddressResponse#description #description} => String
|
5295
|
+
# * {Types::DescribeEmailAddressResponse#create_timestamp #create_timestamp} => String
|
5296
|
+
# * {Types::DescribeEmailAddressResponse#modified_timestamp #modified_timestamp} => String
|
5297
|
+
# * {Types::DescribeEmailAddressResponse#tags #tags} => Hash<String,String>
|
5298
|
+
#
|
5299
|
+
# @example Request syntax with placeholder values
|
5300
|
+
#
|
5301
|
+
# resp = client.describe_email_address({
|
5302
|
+
# instance_id: "InstanceId", # required
|
5303
|
+
# email_address_id: "EmailAddressId", # required
|
5304
|
+
# })
|
5305
|
+
#
|
5306
|
+
# @example Response structure
|
5307
|
+
#
|
5308
|
+
# resp.email_address_id #=> String
|
5309
|
+
# resp.email_address_arn #=> String
|
5310
|
+
# resp.email_address #=> String
|
5311
|
+
# resp.display_name #=> String
|
5312
|
+
# resp.description #=> String
|
5313
|
+
# resp.create_timestamp #=> String
|
5314
|
+
# resp.modified_timestamp #=> String
|
5315
|
+
# resp.tags #=> Hash
|
5316
|
+
# resp.tags["TagKey"] #=> String
|
5317
|
+
#
|
5318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEmailAddress AWS API Documentation
|
5319
|
+
#
|
5320
|
+
# @overload describe_email_address(params = {})
|
5321
|
+
# @param [Hash] params ({})
|
5322
|
+
def describe_email_address(params = {}, options = {})
|
5323
|
+
req = build_request(:describe_email_address, params)
|
5324
|
+
req.send_request(options)
|
5325
|
+
end
|
5326
|
+
|
5003
5327
|
# Describes an evaluation form in the specified Amazon Connect instance.
|
5004
5328
|
# If the version property is not provided, the latest version of the
|
5005
5329
|
# evaluation form is described.
|
@@ -5275,7 +5599,7 @@ module Aws::Connect
|
|
5275
5599
|
# resp = client.describe_instance_storage_config({
|
5276
5600
|
# instance_id: "InstanceId", # required
|
5277
5601
|
# association_id: "AssociationId", # required
|
5278
|
-
# 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
|
5602
|
+
# 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
|
5279
5603
|
# })
|
5280
5604
|
#
|
5281
5605
|
# @example Response structure
|
@@ -5478,6 +5802,7 @@ module Aws::Connect
|
|
5478
5802
|
# resp.queue.outbound_caller_config.outbound_caller_id_name #=> String
|
5479
5803
|
# resp.queue.outbound_caller_config.outbound_caller_id_number_id #=> String
|
5480
5804
|
# resp.queue.outbound_caller_config.outbound_flow_id #=> String
|
5805
|
+
# resp.queue.outbound_email_config.outbound_email_address_id #=> String
|
5481
5806
|
# resp.queue.hours_of_operation_id #=> String
|
5482
5807
|
# resp.queue.max_contacts #=> Integer
|
5483
5808
|
# resp.queue.status #=> String, one of "ENABLED", "DISABLED"
|
@@ -5577,7 +5902,7 @@ module Aws::Connect
|
|
5577
5902
|
# resp.routing_profile.routing_profile_id #=> String
|
5578
5903
|
# resp.routing_profile.description #=> String
|
5579
5904
|
# resp.routing_profile.media_concurrencies #=> Array
|
5580
|
-
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
5905
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
5581
5906
|
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
5582
5907
|
# resp.routing_profile.media_concurrencies[0].cross_channel_behavior.behavior_type #=> String, one of "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL"
|
5583
5908
|
# resp.routing_profile.default_outbound_queue_id #=> String
|
@@ -5640,7 +5965,10 @@ module Aws::Connect
|
|
5640
5965
|
# resp.rule.actions[0].task_action.contact_flow_id #=> String
|
5641
5966
|
# resp.rule.actions[0].task_action.references #=> Hash
|
5642
5967
|
# resp.rule.actions[0].task_action.references["ReferenceKey"].value #=> String
|
5643
|
-
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "NUMBER", "STRING", "DATE", "EMAIL"
|
5968
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "CONTACT_ANALYSIS", "NUMBER", "STRING", "DATE", "EMAIL", "EMAIL_MESSAGE"
|
5969
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
5970
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].arn #=> String
|
5971
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].status_reason #=> String
|
5644
5972
|
# resp.rule.actions[0].event_bridge_action.name #=> String
|
5645
5973
|
# resp.rule.actions[0].send_notification_action.delivery_method #=> String, one of "EMAIL"
|
5646
5974
|
# resp.rule.actions[0].send_notification_action.subject #=> String
|
@@ -6218,7 +6546,7 @@ module Aws::Connect
|
|
6218
6546
|
# resp = client.disassociate_flow({
|
6219
6547
|
# instance_id: "InstanceId", # required
|
6220
6548
|
# resource_id: "ARN", # required
|
6221
|
-
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
6549
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
6222
6550
|
# })
|
6223
6551
|
#
|
6224
6552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlow AWS API Documentation
|
@@ -6258,7 +6586,7 @@ module Aws::Connect
|
|
6258
6586
|
# resp = client.disassociate_instance_storage_config({
|
6259
6587
|
# instance_id: "InstanceId", # required
|
6260
6588
|
# association_id: "AssociationId", # required
|
6261
|
-
# 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
|
6589
|
+
# 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
|
6262
6590
|
# })
|
6263
6591
|
#
|
6264
6592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfig AWS API Documentation
|
@@ -6453,7 +6781,7 @@ module Aws::Connect
|
|
6453
6781
|
# queue_references: [ # required
|
6454
6782
|
# {
|
6455
6783
|
# queue_id: "QueueId", # required
|
6456
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
6784
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
6457
6785
|
# },
|
6458
6786
|
# ],
|
6459
6787
|
# })
|
@@ -6620,7 +6948,7 @@ module Aws::Connect
|
|
6620
6948
|
# return a downloadURL if the status of the attached file is `APPROVED`.
|
6621
6949
|
#
|
6622
6950
|
# @option params [required, String] :instance_id
|
6623
|
-
# The unique identifier of the Connect instance.
|
6951
|
+
# The unique identifier of the Amazon Connect instance.
|
6624
6952
|
#
|
6625
6953
|
# @option params [required, String] :file_id
|
6626
6954
|
# The unique identifier of the attached file resource.
|
@@ -6630,8 +6958,8 @@ module Aws::Connect
|
|
6630
6958
|
# The default value is 300.
|
6631
6959
|
#
|
6632
6960
|
# @option params [required, String] :associated_resource_arn
|
6633
|
-
# The resource to which the attached file is (being) uploaded to.
|
6634
|
-
# [Cases][1]
|
6961
|
+
# The resource to which the attached file is (being) uploaded to. The
|
6962
|
+
# supported resources are [Cases][1] and [Email][2].
|
6635
6963
|
#
|
6636
6964
|
# <note markdown="1"> This value must be a valid ARN.
|
6637
6965
|
#
|
@@ -6639,7 +6967,8 @@ module Aws::Connect
|
|
6639
6967
|
#
|
6640
6968
|
#
|
6641
6969
|
#
|
6642
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
6970
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
6971
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
6643
6972
|
#
|
6644
6973
|
# @return [Types::GetAttachedFileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6645
6974
|
#
|
@@ -6673,7 +7002,7 @@ module Aws::Connect
|
|
6673
7002
|
# resp.file_name #=> String
|
6674
7003
|
# resp.file_size_in_bytes #=> Integer
|
6675
7004
|
# resp.associated_resource_arn #=> String
|
6676
|
-
# resp.file_use_case_type #=> String, one of "ATTACHMENT"
|
7005
|
+
# resp.file_use_case_type #=> String, one of "EMAIL_MESSAGE", "ATTACHMENT"
|
6677
7006
|
# resp.created_by.connect_user_arn #=> String
|
6678
7007
|
# resp.created_by.aws_identity_arn #=> String
|
6679
7008
|
# resp.download_url_metadata.url #=> String
|
@@ -6942,7 +7271,7 @@ module Aws::Connect
|
|
6942
7271
|
# instance_id: "InstanceId", # required
|
6943
7272
|
# filters: { # required
|
6944
7273
|
# queues: ["QueueId"],
|
6945
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
7274
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
6946
7275
|
# routing_profiles: ["RoutingProfileId"],
|
6947
7276
|
# routing_step_expressions: ["RoutingExpression"],
|
6948
7277
|
# },
|
@@ -6969,7 +7298,7 @@ module Aws::Connect
|
|
6969
7298
|
# resp.metric_results #=> Array
|
6970
7299
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
6971
7300
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
6972
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
7301
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
6973
7302
|
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
6974
7303
|
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
6975
7304
|
# resp.metric_results[0].dimensions.routing_step_expression #=> String
|
@@ -7083,8 +7412,8 @@ module Aws::Connect
|
|
7083
7412
|
# resp.user_data_list[0].active_slots_by_channel["Channel"] #=> Integer
|
7084
7413
|
# resp.user_data_list[0].contacts #=> Array
|
7085
7414
|
# resp.user_data_list[0].contacts[0].contact_id #=> String
|
7086
|
-
# resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
7087
|
-
# resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND"
|
7415
|
+
# resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
7416
|
+
# 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"
|
7088
7417
|
# resp.user_data_list[0].contacts[0].agent_contact_state #=> String, one of "INCOMING", "PENDING", "CONNECTING", "CONNECTED", "CONNECTED_ONHOLD", "MISSED", "ERROR", "ENDED", "REJECTED"
|
7089
7418
|
# resp.user_data_list[0].contacts[0].state_start_timestamp #=> Time
|
7090
7419
|
# resp.user_data_list[0].contacts[0].connected_to_agent_timestamp #=> Time
|
@@ -7190,14 +7519,14 @@ module Aws::Connect
|
|
7190
7519
|
# resp = client.get_flow_association({
|
7191
7520
|
# instance_id: "InstanceId", # required
|
7192
7521
|
# resource_id: "ARN", # required
|
7193
|
-
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
7522
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
7194
7523
|
# })
|
7195
7524
|
#
|
7196
7525
|
# @example Response structure
|
7197
7526
|
#
|
7198
7527
|
# resp.resource_id #=> String
|
7199
7528
|
# resp.flow_id #=> String
|
7200
|
-
# resp.resource_type #=> String, one of "SMS_PHONE_NUMBER"
|
7529
|
+
# resp.resource_type #=> String, one of "SMS_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL"
|
7201
7530
|
#
|
7202
7531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociation AWS API Documentation
|
7203
7532
|
#
|
@@ -7477,7 +7806,7 @@ module Aws::Connect
|
|
7477
7806
|
# end_time: Time.now, # required
|
7478
7807
|
# filters: { # required
|
7479
7808
|
# queues: ["QueueId"],
|
7480
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
7809
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
7481
7810
|
# routing_profiles: ["RoutingProfileId"],
|
7482
7811
|
# routing_step_expressions: ["RoutingExpression"],
|
7483
7812
|
# },
|
@@ -7503,7 +7832,7 @@ module Aws::Connect
|
|
7503
7832
|
# resp.metric_results #=> Array
|
7504
7833
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
7505
7834
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
7506
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
7835
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
7507
7836
|
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
7508
7837
|
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
7509
7838
|
# resp.metric_results[0].dimensions.routing_step_expression #=> String
|
@@ -9059,6 +9388,7 @@ module Aws::Connect
|
|
9059
9388
|
# * {Types::GetTaskTemplateResponse#name #name} => String
|
9060
9389
|
# * {Types::GetTaskTemplateResponse#description #description} => String
|
9061
9390
|
# * {Types::GetTaskTemplateResponse#contact_flow_id #contact_flow_id} => String
|
9391
|
+
# * {Types::GetTaskTemplateResponse#self_assign_flow_id #self_assign_flow_id} => String
|
9062
9392
|
# * {Types::GetTaskTemplateResponse#constraints #constraints} => Types::TaskTemplateConstraints
|
9063
9393
|
# * {Types::GetTaskTemplateResponse#defaults #defaults} => Types::TaskTemplateDefaults
|
9064
9394
|
# * {Types::GetTaskTemplateResponse#fields #fields} => Array<Types::TaskTemplateField>
|
@@ -9083,6 +9413,7 @@ module Aws::Connect
|
|
9083
9413
|
# resp.name #=> String
|
9084
9414
|
# resp.description #=> String
|
9085
9415
|
# resp.contact_flow_id #=> String
|
9416
|
+
# resp.self_assign_flow_id #=> String
|
9086
9417
|
# resp.constraints.required_fields #=> Array
|
9087
9418
|
# resp.constraints.required_fields[0].id.name #=> String
|
9088
9419
|
# resp.constraints.read_only_fields #=> Array
|
@@ -9095,7 +9426,7 @@ module Aws::Connect
|
|
9095
9426
|
# resp.fields #=> Array
|
9096
9427
|
# resp.fields[0].id.name #=> String
|
9097
9428
|
# resp.fields[0].description #=> String
|
9098
|
-
# resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL"
|
9429
|
+
# 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"
|
9099
9430
|
# resp.fields[0].single_select_options #=> Array
|
9100
9431
|
# resp.fields[0].single_select_options[0] #=> String
|
9101
9432
|
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
@@ -9421,6 +9752,70 @@ module Aws::Connect
|
|
9421
9752
|
req.send_request(options)
|
9422
9753
|
end
|
9423
9754
|
|
9755
|
+
# Provides information about contact tree, a list of associated contacts
|
9756
|
+
# with a unique identifier.
|
9757
|
+
#
|
9758
|
+
# @option params [required, String] :instance_id
|
9759
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
9760
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
9761
|
+
#
|
9762
|
+
#
|
9763
|
+
#
|
9764
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
9765
|
+
#
|
9766
|
+
# @option params [required, String] :contact_id
|
9767
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9768
|
+
#
|
9769
|
+
# @option params [Integer] :max_results
|
9770
|
+
# The maximum number of results to return per page.
|
9771
|
+
#
|
9772
|
+
# The maximum number of results to return per page. The default
|
9773
|
+
# MaxResult size is 25.
|
9774
|
+
#
|
9775
|
+
# Valid Range: Minimum value of 1. Maximum value of 100.
|
9776
|
+
#
|
9777
|
+
# @option params [String] :next_token
|
9778
|
+
# The token for the next set of results. Use the value returned in the
|
9779
|
+
# previous response in the next request to retrieve the next set of
|
9780
|
+
# results.
|
9781
|
+
#
|
9782
|
+
# @return [Types::ListAssociatedContactsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9783
|
+
#
|
9784
|
+
# * {Types::ListAssociatedContactsResponse#contact_summary_list #contact_summary_list} => Array<Types::AssociatedContactSummary>
|
9785
|
+
# * {Types::ListAssociatedContactsResponse#next_token #next_token} => String
|
9786
|
+
#
|
9787
|
+
# @example Request syntax with placeholder values
|
9788
|
+
#
|
9789
|
+
# resp = client.list_associated_contacts({
|
9790
|
+
# instance_id: "InstanceId", # required
|
9791
|
+
# contact_id: "ContactId", # required
|
9792
|
+
# max_results: 1,
|
9793
|
+
# next_token: "NextToken",
|
9794
|
+
# })
|
9795
|
+
#
|
9796
|
+
# @example Response structure
|
9797
|
+
#
|
9798
|
+
# resp.contact_summary_list #=> Array
|
9799
|
+
# resp.contact_summary_list[0].contact_id #=> String
|
9800
|
+
# resp.contact_summary_list[0].contact_arn #=> String
|
9801
|
+
# resp.contact_summary_list[0].initiation_timestamp #=> Time
|
9802
|
+
# resp.contact_summary_list[0].disconnect_timestamp #=> Time
|
9803
|
+
# resp.contact_summary_list[0].initial_contact_id #=> String
|
9804
|
+
# resp.contact_summary_list[0].previous_contact_id #=> String
|
9805
|
+
# resp.contact_summary_list[0].related_contact_id #=> String
|
9806
|
+
# 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"
|
9807
|
+
# resp.contact_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
9808
|
+
# resp.next_token #=> String
|
9809
|
+
#
|
9810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAssociatedContacts AWS API Documentation
|
9811
|
+
#
|
9812
|
+
# @overload list_associated_contacts(params = {})
|
9813
|
+
# @param [Hash] params ({})
|
9814
|
+
def list_associated_contacts(params = {}, options = {})
|
9815
|
+
req = build_request(:list_associated_contacts, params)
|
9816
|
+
req.send_request(options)
|
9817
|
+
end
|
9818
|
+
|
9424
9819
|
# This API is in preview release for Amazon Connect and is subject to
|
9425
9820
|
# change. To request access to this API, contact Amazon Web Services
|
9426
9821
|
# Support.
|
@@ -9817,7 +10212,7 @@ module Aws::Connect
|
|
9817
10212
|
# resp = client.list_contact_references({
|
9818
10213
|
# instance_id: "InstanceId", # required
|
9819
10214
|
# contact_id: "ContactId", # required
|
9820
|
-
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
10215
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
9821
10216
|
# next_token: "NextToken",
|
9822
10217
|
# })
|
9823
10218
|
#
|
@@ -9828,7 +10223,10 @@ module Aws::Connect
|
|
9828
10223
|
# resp.reference_summary_list[0].url.value #=> String
|
9829
10224
|
# resp.reference_summary_list[0].attachment.name #=> String
|
9830
10225
|
# resp.reference_summary_list[0].attachment.value #=> String
|
9831
|
-
# resp.reference_summary_list[0].attachment.status #=> String, one of "APPROVED", "REJECTED"
|
10226
|
+
# resp.reference_summary_list[0].attachment.status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
10227
|
+
# resp.reference_summary_list[0].attachment.arn #=> String
|
10228
|
+
# resp.reference_summary_list[0].email_message.name #=> String
|
10229
|
+
# resp.reference_summary_list[0].email_message.arn #=> String
|
9832
10230
|
# resp.reference_summary_list[0].string.name #=> String
|
9833
10231
|
# resp.reference_summary_list[0].string.value #=> String
|
9834
10232
|
# resp.reference_summary_list[0].number.name #=> String
|
@@ -10061,7 +10459,7 @@ module Aws::Connect
|
|
10061
10459
|
#
|
10062
10460
|
# resp = client.list_flow_associations({
|
10063
10461
|
# instance_id: "InstanceId", # required
|
10064
|
-
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER
|
10462
|
+
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL
|
10065
10463
|
# next_token: "NextToken",
|
10066
10464
|
# max_results: 1,
|
10067
10465
|
# })
|
@@ -10071,7 +10469,7 @@ module Aws::Connect
|
|
10071
10469
|
# resp.flow_association_summary_list #=> Array
|
10072
10470
|
# resp.flow_association_summary_list[0].resource_id #=> String
|
10073
10471
|
# resp.flow_association_summary_list[0].flow_id #=> String
|
10074
|
-
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER"
|
10472
|
+
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL"
|
10075
10473
|
# resp.next_token #=> String
|
10076
10474
|
#
|
10077
10475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociations AWS API Documentation
|
@@ -10233,7 +10631,7 @@ module Aws::Connect
|
|
10233
10631
|
#
|
10234
10632
|
# resp = client.list_instance_storage_configs({
|
10235
10633
|
# instance_id: "InstanceId", # required
|
10236
|
-
# 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
|
10634
|
+
# 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
|
10237
10635
|
# next_token: "NextToken",
|
10238
10636
|
# max_results: 1,
|
10239
10637
|
# })
|
@@ -10354,7 +10752,7 @@ module Aws::Connect
|
|
10354
10752
|
#
|
10355
10753
|
# resp = client.list_integration_associations({
|
10356
10754
|
# instance_id: "InstanceId", # required
|
10357
|
-
# 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
|
10755
|
+
# 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
|
10358
10756
|
# next_token: "NextToken",
|
10359
10757
|
# max_results: 1,
|
10360
10758
|
# integration_arn: "ARN",
|
@@ -10366,7 +10764,7 @@ module Aws::Connect
|
|
10366
10764
|
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
10367
10765
|
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
10368
10766
|
# resp.integration_association_summary_list[0].instance_id #=> String
|
10369
|
-
# 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"
|
10767
|
+
# 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"
|
10370
10768
|
# resp.integration_association_summary_list[0].integration_arn #=> String
|
10371
10769
|
# resp.integration_association_summary_list[0].source_application_url #=> String
|
10372
10770
|
# resp.integration_association_summary_list[0].source_application_name #=> String
|
@@ -11148,7 +11546,7 @@ module Aws::Connect
|
|
11148
11546
|
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
11149
11547
|
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
11150
11548
|
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
11151
|
-
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
11549
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
11152
11550
|
# resp.last_modified_time #=> Time
|
11153
11551
|
# resp.last_modified_region #=> String
|
11154
11552
|
#
|
@@ -12625,7 +13023,7 @@ module Aws::Connect
|
|
12625
13023
|
# Filters to be applied to search results.
|
12626
13024
|
#
|
12627
13025
|
# @option params [Types::ContactFlowModuleSearchCriteria] :search_criteria
|
12628
|
-
# The search criteria to be used to return
|
13026
|
+
# The search criteria to be used to return flow modules.
|
12629
13027
|
#
|
12630
13028
|
# <note markdown="1"> The `name` and `description` fields support "contains" queries with
|
12631
13029
|
# a minimum of 2 characters and a maximum of 25 characters. Any queries
|
@@ -12713,8 +13111,8 @@ module Aws::Connect
|
|
12713
13111
|
req.send_request(options)
|
12714
13112
|
end
|
12715
13113
|
|
12716
|
-
# Searches the
|
12717
|
-
#
|
13114
|
+
# Searches the flows in an Amazon Connect instance, with optional
|
13115
|
+
# filtering.
|
12718
13116
|
#
|
12719
13117
|
# @option params [required, String] :instance_id
|
12720
13118
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -12812,7 +13210,6 @@ module Aws::Connect
|
|
12812
13210
|
# resp.contact_flows[0].content #=> String
|
12813
13211
|
# resp.contact_flows[0].tags #=> Hash
|
12814
13212
|
# resp.contact_flows[0].tags["TagKey"] #=> String
|
12815
|
-
# resp.contact_flows[0].is_default #=> Boolean
|
12816
13213
|
# resp.contact_flows[0].flow_content_sha_256 #=> String
|
12817
13214
|
# resp.contact_flows[0].version #=> Integer
|
12818
13215
|
# resp.contact_flows[0].version_description #=> String
|
@@ -12879,7 +13276,7 @@ module Aws::Connect
|
|
12879
13276
|
# l4_ids: ["HierarchyGroupId"],
|
12880
13277
|
# l5_ids: ["HierarchyGroupId"],
|
12881
13278
|
# },
|
12882
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
13279
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
12883
13280
|
# contact_analysis: {
|
12884
13281
|
# transcript: {
|
12885
13282
|
# criteria: [ # required
|
@@ -12892,7 +13289,7 @@ module Aws::Connect
|
|
12892
13289
|
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
12893
13290
|
# },
|
12894
13291
|
# },
|
12895
|
-
# initiation_methods: ["INBOUND"], # accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND
|
13292
|
+
# initiation_methods: ["INBOUND"], # accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
|
12896
13293
|
# queue_ids: ["QueueId"],
|
12897
13294
|
# searchable_contact_attributes: {
|
12898
13295
|
# criteria: [ # required
|
@@ -12903,11 +13300,20 @@ module Aws::Connect
|
|
12903
13300
|
# ],
|
12904
13301
|
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
12905
13302
|
# },
|
12906
|
-
#
|
12907
|
-
#
|
12908
|
-
#
|
12909
|
-
#
|
12910
|
-
#
|
13303
|
+
# searchable_segment_attributes: {
|
13304
|
+
# criteria: [ # required
|
13305
|
+
# {
|
13306
|
+
# key: "SearchableSegmentAttributeKey", # required
|
13307
|
+
# values: ["SearchableSegmentAttributeValue"], # required
|
13308
|
+
# },
|
13309
|
+
# ],
|
13310
|
+
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
13311
|
+
# },
|
13312
|
+
# },
|
13313
|
+
# max_results: 1,
|
13314
|
+
# next_token: "LargeNextToken",
|
13315
|
+
# sort: {
|
13316
|
+
# field_name: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, INITIATION_METHOD, CHANNEL
|
12911
13317
|
# order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
|
12912
13318
|
# },
|
12913
13319
|
# })
|
@@ -12919,8 +13325,8 @@ module Aws::Connect
|
|
12919
13325
|
# resp.contacts[0].id #=> String
|
12920
13326
|
# resp.contacts[0].initial_contact_id #=> String
|
12921
13327
|
# resp.contacts[0].previous_contact_id #=> String
|
12922
|
-
# resp.contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND"
|
12923
|
-
# resp.contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
13328
|
+
# resp.contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
|
13329
|
+
# resp.contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
12924
13330
|
# resp.contacts[0].queue_info.id #=> String
|
12925
13331
|
# resp.contacts[0].queue_info.enqueue_timestamp #=> Time
|
12926
13332
|
# resp.contacts[0].agent_info.id #=> String
|
@@ -12928,6 +13334,8 @@ module Aws::Connect
|
|
12928
13334
|
# resp.contacts[0].initiation_timestamp #=> Time
|
12929
13335
|
# resp.contacts[0].disconnect_timestamp #=> Time
|
12930
13336
|
# resp.contacts[0].scheduled_timestamp #=> Time
|
13337
|
+
# resp.contacts[0].segment_attributes #=> Hash
|
13338
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_string #=> String
|
12931
13339
|
# resp.next_token #=> String
|
12932
13340
|
# resp.total_count #=> Integer
|
12933
13341
|
#
|
@@ -12940,6 +13348,103 @@ module Aws::Connect
|
|
12940
13348
|
req.send_request(options)
|
12941
13349
|
end
|
12942
13350
|
|
13351
|
+
# Searches email address in an instance, with optional filtering.
|
13352
|
+
#
|
13353
|
+
# @option params [required, String] :instance_id
|
13354
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
13355
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
13356
|
+
#
|
13357
|
+
#
|
13358
|
+
#
|
13359
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
13360
|
+
#
|
13361
|
+
# @option params [Integer] :max_results
|
13362
|
+
# The maximum number of results to return per page.
|
13363
|
+
#
|
13364
|
+
# @option params [String] :next_token
|
13365
|
+
# The token for the next set of results. Use the value returned in the
|
13366
|
+
# previous response in the next request to retrieve the next set of
|
13367
|
+
# results.
|
13368
|
+
#
|
13369
|
+
# @option params [Types::EmailAddressSearchCriteria] :search_criteria
|
13370
|
+
# The search criteria to be used to return email addresses.
|
13371
|
+
#
|
13372
|
+
# @option params [Types::EmailAddressSearchFilter] :search_filter
|
13373
|
+
# Filters to be applied to search results.
|
13374
|
+
#
|
13375
|
+
# @return [Types::SearchEmailAddressesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13376
|
+
#
|
13377
|
+
# * {Types::SearchEmailAddressesResponse#next_token #next_token} => String
|
13378
|
+
# * {Types::SearchEmailAddressesResponse#email_addresses #email_addresses} => Array<Types::EmailAddressMetadata>
|
13379
|
+
# * {Types::SearchEmailAddressesResponse#approximate_total_count #approximate_total_count} => Integer
|
13380
|
+
#
|
13381
|
+
# @example Request syntax with placeholder values
|
13382
|
+
#
|
13383
|
+
# resp = client.search_email_addresses({
|
13384
|
+
# instance_id: "InstanceId", # required
|
13385
|
+
# max_results: 1,
|
13386
|
+
# next_token: "NextToken2500",
|
13387
|
+
# search_criteria: {
|
13388
|
+
# or_conditions: [
|
13389
|
+
# {
|
13390
|
+
# # recursive EmailAddressSearchCriteria
|
13391
|
+
# },
|
13392
|
+
# ],
|
13393
|
+
# and_conditions: [
|
13394
|
+
# {
|
13395
|
+
# # recursive EmailAddressSearchCriteria
|
13396
|
+
# },
|
13397
|
+
# ],
|
13398
|
+
# string_condition: {
|
13399
|
+
# field_name: "String",
|
13400
|
+
# value: "String",
|
13401
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13402
|
+
# },
|
13403
|
+
# },
|
13404
|
+
# search_filter: {
|
13405
|
+
# tag_filter: {
|
13406
|
+
# or_conditions: [
|
13407
|
+
# [
|
13408
|
+
# {
|
13409
|
+
# tag_key: "String",
|
13410
|
+
# tag_value: "String",
|
13411
|
+
# },
|
13412
|
+
# ],
|
13413
|
+
# ],
|
13414
|
+
# and_conditions: [
|
13415
|
+
# {
|
13416
|
+
# tag_key: "String",
|
13417
|
+
# tag_value: "String",
|
13418
|
+
# },
|
13419
|
+
# ],
|
13420
|
+
# tag_condition: {
|
13421
|
+
# tag_key: "String",
|
13422
|
+
# tag_value: "String",
|
13423
|
+
# },
|
13424
|
+
# },
|
13425
|
+
# },
|
13426
|
+
# })
|
13427
|
+
#
|
13428
|
+
# @example Response structure
|
13429
|
+
#
|
13430
|
+
# resp.next_token #=> String
|
13431
|
+
# resp.email_addresses #=> Array
|
13432
|
+
# resp.email_addresses[0].email_address_id #=> String
|
13433
|
+
# resp.email_addresses[0].email_address_arn #=> String
|
13434
|
+
# resp.email_addresses[0].email_address #=> String
|
13435
|
+
# resp.email_addresses[0].description #=> String
|
13436
|
+
# resp.email_addresses[0].display_name #=> String
|
13437
|
+
# resp.approximate_total_count #=> Integer
|
13438
|
+
#
|
13439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEmailAddresses AWS API Documentation
|
13440
|
+
#
|
13441
|
+
# @overload search_email_addresses(params = {})
|
13442
|
+
# @param [Hash] params ({})
|
13443
|
+
def search_email_addresses(params = {}, options = {})
|
13444
|
+
req = build_request(:search_email_addresses, params)
|
13445
|
+
req.send_request(options)
|
13446
|
+
end
|
13447
|
+
|
12943
13448
|
# Searches the hours of operation in an Amazon Connect instance, with
|
12944
13449
|
# optional filtering.
|
12945
13450
|
#
|
@@ -13329,6 +13834,7 @@ module Aws::Connect
|
|
13329
13834
|
# resp.queues[0].outbound_caller_config.outbound_caller_id_name #=> String
|
13330
13835
|
# resp.queues[0].outbound_caller_config.outbound_caller_id_number_id #=> String
|
13331
13836
|
# resp.queues[0].outbound_caller_config.outbound_flow_id #=> String
|
13837
|
+
# resp.queues[0].outbound_email_config.outbound_email_address_id #=> String
|
13332
13838
|
# resp.queues[0].hours_of_operation_id #=> String
|
13333
13839
|
# resp.queues[0].max_contacts #=> Integer
|
13334
13840
|
# resp.queues[0].status #=> String, one of "ENABLED", "DISABLED"
|
@@ -13634,7 +14140,7 @@ module Aws::Connect
|
|
13634
14140
|
# resp.routing_profiles[0].routing_profile_id #=> String
|
13635
14141
|
# resp.routing_profiles[0].description #=> String
|
13636
14142
|
# resp.routing_profiles[0].media_concurrencies #=> Array
|
13637
|
-
# resp.routing_profiles[0].media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
14143
|
+
# resp.routing_profiles[0].media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
13638
14144
|
# resp.routing_profiles[0].media_concurrencies[0].concurrency #=> Integer
|
13639
14145
|
# resp.routing_profiles[0].media_concurrencies[0].cross_channel_behavior.behavior_type #=> String, one of "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL"
|
13640
14146
|
# resp.routing_profiles[0].default_outbound_queue_id #=> String
|
@@ -14255,15 +14761,124 @@ module Aws::Connect
|
|
14255
14761
|
req.send_request(options)
|
14256
14762
|
end
|
14257
14763
|
|
14764
|
+
# Send outbound email for outbound campaigns. For more information about
|
14765
|
+
# outbound campaigns, see [Set up Amazon Connect outbound campaigns][1].
|
14766
|
+
#
|
14767
|
+
# <note markdown="1"> Only the Amazon Connect outbound campaigns service principal is
|
14768
|
+
# allowed to assume a role in your account and call this API.
|
14769
|
+
#
|
14770
|
+
# </note>
|
14771
|
+
#
|
14772
|
+
#
|
14773
|
+
#
|
14774
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-outbound-campaigns.html
|
14775
|
+
#
|
14776
|
+
# @option params [required, String] :instance_id
|
14777
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
14778
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
14779
|
+
#
|
14780
|
+
#
|
14781
|
+
#
|
14782
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
14783
|
+
#
|
14784
|
+
# @option params [required, Types::EmailAddressInfo] :from_email_address
|
14785
|
+
# The email address to be used for sending email.
|
14786
|
+
#
|
14787
|
+
# @option params [required, Types::EmailAddressInfo] :destination_email_address
|
14788
|
+
# The email address to send the email to.
|
14789
|
+
#
|
14790
|
+
# @option params [Types::OutboundAdditionalRecipients] :additional_recipients
|
14791
|
+
# The additional recipients address of the email in CC.
|
14792
|
+
#
|
14793
|
+
# @option params [required, Types::OutboundEmailContent] :email_message
|
14794
|
+
# The email message body to be sent to the newly created email.
|
14795
|
+
#
|
14796
|
+
# @option params [required, String] :traffic_type
|
14797
|
+
# Denotes the class of traffic.
|
14798
|
+
#
|
14799
|
+
# @option params [Types::SourceCampaign] :source_campaign
|
14800
|
+
# A Campaign object need for Campaign traffic type.
|
14801
|
+
#
|
14802
|
+
# @option params [String] :client_token
|
14803
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
14804
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
14805
|
+
# SDK populates this field. For more information about idempotency, see
|
14806
|
+
# [Making retries safe with idempotent APIs][1].
|
14807
|
+
#
|
14808
|
+
# **A suitable default value is auto-generated.** You should normally
|
14809
|
+
# not need to pass this option.**
|
14810
|
+
#
|
14811
|
+
#
|
14812
|
+
#
|
14813
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
14814
|
+
#
|
14815
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
14816
|
+
#
|
14817
|
+
# @example Request syntax with placeholder values
|
14818
|
+
#
|
14819
|
+
# resp = client.send_outbound_email({
|
14820
|
+
# instance_id: "InstanceId", # required
|
14821
|
+
# from_email_address: { # required
|
14822
|
+
# email_address: "EmailAddress", # required
|
14823
|
+
# display_name: "EmailAddressDisplayName",
|
14824
|
+
# },
|
14825
|
+
# destination_email_address: { # required
|
14826
|
+
# email_address: "EmailAddress", # required
|
14827
|
+
# display_name: "EmailAddressDisplayName",
|
14828
|
+
# },
|
14829
|
+
# additional_recipients: {
|
14830
|
+
# cc_email_addresses: [
|
14831
|
+
# {
|
14832
|
+
# email_address: "EmailAddress", # required
|
14833
|
+
# display_name: "EmailAddressDisplayName",
|
14834
|
+
# },
|
14835
|
+
# ],
|
14836
|
+
# },
|
14837
|
+
# email_message: { # required
|
14838
|
+
# message_source_type: "TEMPLATE", # required, accepts TEMPLATE, RAW
|
14839
|
+
# templated_message_config: {
|
14840
|
+
# knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
|
14841
|
+
# message_template_id: "MessageTemplateId", # required
|
14842
|
+
# template_attributes: { # required
|
14843
|
+
# custom_attributes: {
|
14844
|
+
# "AttributeName" => "AttributeValue",
|
14845
|
+
# },
|
14846
|
+
# customer_profile_attributes: "CustomerProfileAttributesSerialized",
|
14847
|
+
# },
|
14848
|
+
# },
|
14849
|
+
# raw_message: {
|
14850
|
+
# subject: "OutboundSubject", # required
|
14851
|
+
# body: "Body", # required
|
14852
|
+
# content_type: "EmailMessageContentType", # required
|
14853
|
+
# },
|
14854
|
+
# },
|
14855
|
+
# traffic_type: "GENERAL", # required, accepts GENERAL, CAMPAIGN
|
14856
|
+
# source_campaign: {
|
14857
|
+
# campaign_id: "CampaignId",
|
14858
|
+
# outbound_request_id: "OutboundRequestId",
|
14859
|
+
# },
|
14860
|
+
# client_token: "ClientToken",
|
14861
|
+
# })
|
14862
|
+
#
|
14863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundEmail AWS API Documentation
|
14864
|
+
#
|
14865
|
+
# @overload send_outbound_email(params = {})
|
14866
|
+
# @param [Hash] params ({})
|
14867
|
+
def send_outbound_email(params = {}, options = {})
|
14868
|
+
req = build_request(:send_outbound_email, params)
|
14869
|
+
req.send_request(options)
|
14870
|
+
end
|
14871
|
+
|
14258
14872
|
# Provides a pre-signed Amazon S3 URL in response for uploading your
|
14259
14873
|
# content.
|
14260
14874
|
#
|
14261
14875
|
# You may only use this API to upload attachments to an [Amazon Connect
|
14262
|
-
# Case][1].
|
14876
|
+
# Case][1] or [Amazon Connect Email][2].
|
14263
14877
|
#
|
14264
14878
|
#
|
14265
14879
|
#
|
14266
14880
|
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html
|
14881
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
14267
14882
|
#
|
14268
14883
|
# @option params [String] :client_token
|
14269
14884
|
# A unique, case-sensitive identifier that you provide to ensure the
|
@@ -14294,9 +14909,11 @@ module Aws::Connect
|
|
14294
14909
|
# @option params [required, String] :file_use_case_type
|
14295
14910
|
# The use case for the file.
|
14296
14911
|
#
|
14912
|
+
# Only `ATTACHMENTS` are supported.
|
14913
|
+
#
|
14297
14914
|
# @option params [required, String] :associated_resource_arn
|
14298
|
-
# The resource to which the attached file is (being) uploaded to.
|
14299
|
-
# [Cases][1]
|
14915
|
+
# The resource to which the attached file is (being) uploaded to. The
|
14916
|
+
# supported resources are [Cases][1] and [Email][2].
|
14300
14917
|
#
|
14301
14918
|
# <note markdown="1"> This value must be a valid ARN.
|
14302
14919
|
#
|
@@ -14304,7 +14921,8 @@ module Aws::Connect
|
|
14304
14921
|
#
|
14305
14922
|
#
|
14306
14923
|
#
|
14307
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
14924
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
14925
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
14308
14926
|
#
|
14309
14927
|
# @option params [Types::CreatedByInfo] :created_by
|
14310
14928
|
# Represents the identity that created the file.
|
@@ -14330,7 +14948,7 @@ module Aws::Connect
|
|
14330
14948
|
# file_name: "FileName", # required
|
14331
14949
|
# file_size_in_bytes: 1, # required
|
14332
14950
|
# url_expiry_in_seconds: 1,
|
14333
|
-
# file_use_case_type: "
|
14951
|
+
# file_use_case_type: "EMAIL_MESSAGE", # required, accepts EMAIL_MESSAGE, ATTACHMENT
|
14334
14952
|
# associated_resource_arn: "ARN", # required
|
14335
14953
|
# created_by: {
|
14336
14954
|
# connect_user_arn: "ARN",
|
@@ -14413,8 +15031,8 @@ module Aws::Connect
|
|
14413
15031
|
# @option params [required, String] :contact_flow_id
|
14414
15032
|
# The identifier of the flow for initiating the chat. To see the
|
14415
15033
|
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
14416
|
-
# menu go to **Routing**, **
|
14417
|
-
#
|
15034
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow page,
|
15035
|
+
# under the name of the flow, choose **Show additional flow
|
14418
15036
|
# information**. The ContactFlowId is the last part of the ARN, shown
|
14419
15037
|
# here in bold:
|
14420
15038
|
#
|
@@ -14546,6 +15164,12 @@ module Aws::Connect
|
|
14546
15164
|
# segment_attributes: {
|
14547
15165
|
# "SegmentAttributeName" => {
|
14548
15166
|
# value_string: "SegmentAttributeValueString",
|
15167
|
+
# value_map: {
|
15168
|
+
# "SegmentAttributeName" => {
|
15169
|
+
# # recursive SegmentAttributeValue
|
15170
|
+
# },
|
15171
|
+
# },
|
15172
|
+
# value_integer: 1,
|
14549
15173
|
# },
|
14550
15174
|
# },
|
14551
15175
|
# })
|
@@ -14773,6 +15397,191 @@ module Aws::Connect
|
|
14773
15397
|
req.send_request(options)
|
14774
15398
|
end
|
14775
15399
|
|
15400
|
+
# Creates an inbound email contact and initiates a flow to start the
|
15401
|
+
# email contact for the customer. Response of this API provides the
|
15402
|
+
# ContactId of the email contact created.
|
15403
|
+
#
|
15404
|
+
# @option params [required, String] :instance_id
|
15405
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
15406
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
15407
|
+
#
|
15408
|
+
#
|
15409
|
+
#
|
15410
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
15411
|
+
#
|
15412
|
+
# @option params [required, Types::EmailAddressInfo] :from_email_address
|
15413
|
+
# The email address of the customer.
|
15414
|
+
#
|
15415
|
+
# @option params [required, String] :destination_email_address
|
15416
|
+
# The email address associated with the instance.
|
15417
|
+
#
|
15418
|
+
# @option params [String] :description
|
15419
|
+
# A description of the email contact.
|
15420
|
+
#
|
15421
|
+
# @option params [Hash<String,Types::Reference>] :references
|
15422
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
15423
|
+
# (CCP). Emails can have the following reference types at the time of
|
15424
|
+
# creation: `URL` \| `NUMBER` \| `STRING` \| `DATE`. `EMAIL` \|
|
15425
|
+
# `EMAIL_MESSAGE` \|`ATTACHMENT` are not a supported reference type
|
15426
|
+
# during email creation.
|
15427
|
+
#
|
15428
|
+
# @option params [String] :name
|
15429
|
+
# The name of a email that is shown to an agent in the Contact Control
|
15430
|
+
# Panel (CCP).
|
15431
|
+
#
|
15432
|
+
# @option params [required, Types::InboundEmailContent] :email_message
|
15433
|
+
# The email message body to be sent to the newly created email.
|
15434
|
+
#
|
15435
|
+
# @option params [Types::InboundAdditionalRecipients] :additional_recipients
|
15436
|
+
# The addtional recipients address of the email.
|
15437
|
+
#
|
15438
|
+
# @option params [Array<Types::EmailAttachment>] :attachments
|
15439
|
+
# List of S3 presigned URLs of email attachments and their file name.
|
15440
|
+
#
|
15441
|
+
# @option params [String] :contact_flow_id
|
15442
|
+
# The identifier of the flow for initiating the emails. To see the
|
15443
|
+
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
15444
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow page,
|
15445
|
+
# under the name of the flow, choose **Show additional flow
|
15446
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
15447
|
+
# here in bold:
|
15448
|
+
#
|
15449
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
15450
|
+
#
|
15451
|
+
# @option params [String] :related_contact_id
|
15452
|
+
# The contactId that is related to this contact. Linking emails together
|
15453
|
+
# by using `RelatedContactID` copies over contact attributes from the
|
15454
|
+
# related email contact to the new email contact. All updates to
|
15455
|
+
# user-defined attributes in the new email contact are limited to the
|
15456
|
+
# individual contact ID. There are no limits to the number of contacts
|
15457
|
+
# that can be linked by using `RelatedContactId`.
|
15458
|
+
#
|
15459
|
+
# @option params [Hash<String,String>] :attributes
|
15460
|
+
# A custom key-value pair using an attribute map. The attributes are
|
15461
|
+
# standard Amazon Connect attributes, and can be accessed in flows just
|
15462
|
+
# like any other contact attributes.
|
15463
|
+
#
|
15464
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
15465
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
15466
|
+
# underscore characters.
|
15467
|
+
#
|
15468
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
15469
|
+
# A set of system defined key-value pairs stored on individual contact
|
15470
|
+
# segments using an attribute map. The attributes are standard Amazon
|
15471
|
+
# Connect attributes. They can be accessed in flows.
|
15472
|
+
#
|
15473
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
15474
|
+
#
|
15475
|
+
# This field can be used to show channel subtype, such as
|
15476
|
+
# `connect:Guide`.
|
15477
|
+
#
|
15478
|
+
# <note markdown="1"> To set contact expiry, a `ValueMap` must be specified containing the
|
15479
|
+
# integer number of minutes the contact will be active for before
|
15480
|
+
# expiring, with `SegmentAttributes` like \{ ` "connect:ContactExpiry":
|
15481
|
+
# {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}`.
|
15482
|
+
#
|
15483
|
+
# </note>
|
15484
|
+
#
|
15485
|
+
# @option params [String] :client_token
|
15486
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
15487
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
15488
|
+
# SDK populates this field. For more information about idempotency, see
|
15489
|
+
# [Making retries safe with idempotent APIs][1].
|
15490
|
+
#
|
15491
|
+
# **A suitable default value is auto-generated.** You should normally
|
15492
|
+
# not need to pass this option.**
|
15493
|
+
#
|
15494
|
+
#
|
15495
|
+
#
|
15496
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
15497
|
+
#
|
15498
|
+
# @return [Types::StartEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15499
|
+
#
|
15500
|
+
# * {Types::StartEmailContactResponse#contact_id #contact_id} => String
|
15501
|
+
#
|
15502
|
+
# @example Request syntax with placeholder values
|
15503
|
+
#
|
15504
|
+
# resp = client.start_email_contact({
|
15505
|
+
# instance_id: "InstanceId", # required
|
15506
|
+
# from_email_address: { # required
|
15507
|
+
# email_address: "EmailAddress", # required
|
15508
|
+
# display_name: "EmailAddressDisplayName",
|
15509
|
+
# },
|
15510
|
+
# destination_email_address: "EmailAddress", # required
|
15511
|
+
# description: "Description",
|
15512
|
+
# references: {
|
15513
|
+
# "ReferenceKey" => {
|
15514
|
+
# value: "ReferenceValue",
|
15515
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
15516
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
15517
|
+
# arn: "ReferenceArn",
|
15518
|
+
# status_reason: "ReferenceStatusReason",
|
15519
|
+
# },
|
15520
|
+
# },
|
15521
|
+
# name: "Name",
|
15522
|
+
# email_message: { # required
|
15523
|
+
# message_source_type: "RAW", # required, accepts RAW
|
15524
|
+
# raw_message: {
|
15525
|
+
# subject: "InboundSubject", # required
|
15526
|
+
# body: "Body", # required
|
15527
|
+
# content_type: "EmailMessageContentType", # required
|
15528
|
+
# headers: {
|
15529
|
+
# "REFERENCES" => "EmailHeaderValue",
|
15530
|
+
# },
|
15531
|
+
# },
|
15532
|
+
# },
|
15533
|
+
# additional_recipients: {
|
15534
|
+
# to_addresses: [
|
15535
|
+
# {
|
15536
|
+
# email_address: "EmailAddress", # required
|
15537
|
+
# display_name: "EmailAddressDisplayName",
|
15538
|
+
# },
|
15539
|
+
# ],
|
15540
|
+
# cc_addresses: [
|
15541
|
+
# {
|
15542
|
+
# email_address: "EmailAddress", # required
|
15543
|
+
# display_name: "EmailAddressDisplayName",
|
15544
|
+
# },
|
15545
|
+
# ],
|
15546
|
+
# },
|
15547
|
+
# attachments: [
|
15548
|
+
# {
|
15549
|
+
# file_name: "FileName", # required
|
15550
|
+
# s3_url: "PreSignedAttachmentUrl", # required
|
15551
|
+
# },
|
15552
|
+
# ],
|
15553
|
+
# contact_flow_id: "ContactFlowId",
|
15554
|
+
# related_contact_id: "ContactId",
|
15555
|
+
# attributes: {
|
15556
|
+
# "AttributeName" => "AttributeValue",
|
15557
|
+
# },
|
15558
|
+
# segment_attributes: {
|
15559
|
+
# "SegmentAttributeName" => {
|
15560
|
+
# value_string: "SegmentAttributeValueString",
|
15561
|
+
# value_map: {
|
15562
|
+
# "SegmentAttributeName" => {
|
15563
|
+
# # recursive SegmentAttributeValue
|
15564
|
+
# },
|
15565
|
+
# },
|
15566
|
+
# value_integer: 1,
|
15567
|
+
# },
|
15568
|
+
# },
|
15569
|
+
# client_token: "ClientToken",
|
15570
|
+
# })
|
15571
|
+
#
|
15572
|
+
# @example Response structure
|
15573
|
+
#
|
15574
|
+
# resp.contact_id #=> String
|
15575
|
+
#
|
15576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEmailContact AWS API Documentation
|
15577
|
+
#
|
15578
|
+
# @overload start_email_contact(params = {})
|
15579
|
+
# @param [Hash] params ({})
|
15580
|
+
def start_email_contact(params = {}, options = {})
|
15581
|
+
req = build_request(:start_email_contact, params)
|
15582
|
+
req.send_request(options)
|
15583
|
+
end
|
15584
|
+
|
14776
15585
|
# Initiates a new outbound SMS contact to a customer. Response of this
|
14777
15586
|
# API provides the ContactId of the outbound SMS contact created.
|
14778
15587
|
#
|
@@ -14898,17 +15707,23 @@ module Aws::Connect
|
|
14898
15707
|
#
|
14899
15708
|
# resp = client.start_outbound_chat_contact({
|
14900
15709
|
# source_endpoint: { # required
|
14901
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
15710
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
14902
15711
|
# address: "EndpointAddress",
|
14903
15712
|
# },
|
14904
15713
|
# destination_endpoint: { # required
|
14905
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
15714
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
|
14906
15715
|
# address: "EndpointAddress",
|
14907
15716
|
# },
|
14908
15717
|
# instance_id: "InstanceId", # required
|
14909
15718
|
# segment_attributes: { # required
|
14910
15719
|
# "SegmentAttributeName" => {
|
14911
15720
|
# value_string: "SegmentAttributeValueString",
|
15721
|
+
# value_map: {
|
15722
|
+
# "SegmentAttributeName" => {
|
15723
|
+
# # recursive SegmentAttributeValue
|
15724
|
+
# },
|
15725
|
+
# },
|
15726
|
+
# value_integer: 1,
|
14912
15727
|
# },
|
14913
15728
|
# },
|
14914
15729
|
# attributes: {
|
@@ -14941,6 +15756,104 @@ module Aws::Connect
|
|
14941
15756
|
req.send_request(options)
|
14942
15757
|
end
|
14943
15758
|
|
15759
|
+
# Initiates a flow to send an agent reply or outbound email contact
|
15760
|
+
# (created from the CreateContact API) to a customer.
|
15761
|
+
#
|
15762
|
+
# @option params [required, String] :instance_id
|
15763
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
15764
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
15765
|
+
#
|
15766
|
+
#
|
15767
|
+
#
|
15768
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
15769
|
+
#
|
15770
|
+
# @option params [required, String] :contact_id
|
15771
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
15772
|
+
#
|
15773
|
+
# @option params [Types::EmailAddressInfo] :from_email_address
|
15774
|
+
# The email address associated with the instance.
|
15775
|
+
#
|
15776
|
+
# @option params [required, Types::EmailAddressInfo] :destination_email_address
|
15777
|
+
# The email address of the customer.
|
15778
|
+
#
|
15779
|
+
# @option params [Types::OutboundAdditionalRecipients] :additional_recipients
|
15780
|
+
# The addtional recipients address of email in CC.
|
15781
|
+
#
|
15782
|
+
# @option params [required, Types::OutboundEmailContent] :email_message
|
15783
|
+
# The email message body to be sent to the newly created email.
|
15784
|
+
#
|
15785
|
+
# @option params [String] :client_token
|
15786
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
15787
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
15788
|
+
# SDK populates this field. For more information about idempotency, see
|
15789
|
+
# [Making retries safe with idempotent APIs][1].
|
15790
|
+
#
|
15791
|
+
# **A suitable default value is auto-generated.** You should normally
|
15792
|
+
# not need to pass this option.**
|
15793
|
+
#
|
15794
|
+
#
|
15795
|
+
#
|
15796
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
15797
|
+
#
|
15798
|
+
# @return [Types::StartOutboundEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15799
|
+
#
|
15800
|
+
# * {Types::StartOutboundEmailContactResponse#contact_id #contact_id} => String
|
15801
|
+
#
|
15802
|
+
# @example Request syntax with placeholder values
|
15803
|
+
#
|
15804
|
+
# resp = client.start_outbound_email_contact({
|
15805
|
+
# instance_id: "InstanceId", # required
|
15806
|
+
# contact_id: "ContactId", # required
|
15807
|
+
# from_email_address: {
|
15808
|
+
# email_address: "EmailAddress", # required
|
15809
|
+
# display_name: "EmailAddressDisplayName",
|
15810
|
+
# },
|
15811
|
+
# destination_email_address: { # required
|
15812
|
+
# email_address: "EmailAddress", # required
|
15813
|
+
# display_name: "EmailAddressDisplayName",
|
15814
|
+
# },
|
15815
|
+
# additional_recipients: {
|
15816
|
+
# cc_email_addresses: [
|
15817
|
+
# {
|
15818
|
+
# email_address: "EmailAddress", # required
|
15819
|
+
# display_name: "EmailAddressDisplayName",
|
15820
|
+
# },
|
15821
|
+
# ],
|
15822
|
+
# },
|
15823
|
+
# email_message: { # required
|
15824
|
+
# message_source_type: "TEMPLATE", # required, accepts TEMPLATE, RAW
|
15825
|
+
# templated_message_config: {
|
15826
|
+
# knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
|
15827
|
+
# message_template_id: "MessageTemplateId", # required
|
15828
|
+
# template_attributes: { # required
|
15829
|
+
# custom_attributes: {
|
15830
|
+
# "AttributeName" => "AttributeValue",
|
15831
|
+
# },
|
15832
|
+
# customer_profile_attributes: "CustomerProfileAttributesSerialized",
|
15833
|
+
# },
|
15834
|
+
# },
|
15835
|
+
# raw_message: {
|
15836
|
+
# subject: "OutboundSubject", # required
|
15837
|
+
# body: "Body", # required
|
15838
|
+
# content_type: "EmailMessageContentType", # required
|
15839
|
+
# },
|
15840
|
+
# },
|
15841
|
+
# client_token: "ClientToken",
|
15842
|
+
# })
|
15843
|
+
#
|
15844
|
+
# @example Response structure
|
15845
|
+
#
|
15846
|
+
# resp.contact_id #=> String
|
15847
|
+
#
|
15848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundEmailContact AWS API Documentation
|
15849
|
+
#
|
15850
|
+
# @overload start_outbound_email_contact(params = {})
|
15851
|
+
# @param [Hash] params ({})
|
15852
|
+
def start_outbound_email_contact(params = {}, options = {})
|
15853
|
+
req = build_request(:start_outbound_email_contact, params)
|
15854
|
+
req.send_request(options)
|
15855
|
+
end
|
15856
|
+
|
14944
15857
|
# Places an outbound call to a contact, and then initiates the flow. It
|
14945
15858
|
# performs the actions in the flow that's specified (in
|
14946
15859
|
# `ContactFlowId`).
|
@@ -15074,8 +15987,11 @@ module Aws::Connect
|
|
15074
15987
|
# description: "Description",
|
15075
15988
|
# references: {
|
15076
15989
|
# "ReferenceKey" => {
|
15077
|
-
# value: "ReferenceValue",
|
15078
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
15990
|
+
# value: "ReferenceValue",
|
15991
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
15992
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
15993
|
+
# arn: "ReferenceArn",
|
15994
|
+
# status_reason: "ReferenceStatusReason",
|
15079
15995
|
# },
|
15080
15996
|
# },
|
15081
15997
|
# related_contact_id: "ContactId",
|
@@ -15223,8 +16139,8 @@ module Aws::Connect
|
|
15223
16139
|
# @option params [String] :contact_flow_id
|
15224
16140
|
# The identifier of the flow for initiating the tasks. To see the
|
15225
16141
|
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
15226
|
-
# menu go to **Routing**, **
|
15227
|
-
#
|
16142
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow page,
|
16143
|
+
# under the name of the flow, choose **Show additional flow
|
15228
16144
|
# information**. The ContactFlowId is the last part of the ARN, shown
|
15229
16145
|
# here in bold:
|
15230
16146
|
#
|
@@ -15303,6 +16219,28 @@ module Aws::Connect
|
|
15303
16219
|
#
|
15304
16220
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks
|
15305
16221
|
#
|
16222
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
16223
|
+
# A set of system defined key-value pairs stored on individual contact
|
16224
|
+
# segments (unique contact ID) using an attribute map. The attributes
|
16225
|
+
# are standard Amazon Connect attributes. They can be accessed in flows.
|
16226
|
+
#
|
16227
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
16228
|
+
#
|
16229
|
+
# This field can be used to set Contact Expiry as a duration in minutes
|
16230
|
+
# and set a UserId for the User who created a task.
|
16231
|
+
#
|
16232
|
+
# <note markdown="1"> To set contact expiry, a ValueMap must be specified containing the
|
16233
|
+
# integer number of minutes the contact will be active for before
|
16234
|
+
# expiring, with `SegmentAttributes` like \{ ` "connect:ContactExpiry":
|
16235
|
+
# {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}`.
|
16236
|
+
#
|
16237
|
+
# To set the created by user, a valid AgentResourceId must be supplied,
|
16238
|
+
# with `SegmentAttributes` like \{ `"connect:CreatedByUser" {
|
16239
|
+
# "ValueString":
|
16240
|
+
# "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}`.
|
16241
|
+
#
|
16242
|
+
# </note>
|
16243
|
+
#
|
15306
16244
|
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15307
16245
|
#
|
15308
16246
|
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
@@ -15319,8 +16257,11 @@ module Aws::Connect
|
|
15319
16257
|
# name: "Name", # required
|
15320
16258
|
# references: {
|
15321
16259
|
# "ReferenceKey" => {
|
15322
|
-
# value: "ReferenceValue",
|
15323
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
16260
|
+
# value: "ReferenceValue",
|
16261
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
16262
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
16263
|
+
# arn: "ReferenceArn",
|
16264
|
+
# status_reason: "ReferenceStatusReason",
|
15324
16265
|
# },
|
15325
16266
|
# },
|
15326
16267
|
# description: "Description",
|
@@ -15329,6 +16270,17 @@ module Aws::Connect
|
|
15329
16270
|
# task_template_id: "TaskTemplateId",
|
15330
16271
|
# quick_connect_id: "QuickConnectId",
|
15331
16272
|
# related_contact_id: "ContactId",
|
16273
|
+
# segment_attributes: {
|
16274
|
+
# "SegmentAttributeName" => {
|
16275
|
+
# value_string: "SegmentAttributeValueString",
|
16276
|
+
# value_map: {
|
16277
|
+
# "SegmentAttributeName" => {
|
16278
|
+
# # recursive SegmentAttributeValue
|
16279
|
+
# },
|
16280
|
+
# },
|
16281
|
+
# value_integer: 1,
|
16282
|
+
# },
|
16283
|
+
# },
|
15332
16284
|
# })
|
15333
16285
|
#
|
15334
16286
|
# @example Response structure
|
@@ -15444,8 +16396,11 @@ module Aws::Connect
|
|
15444
16396
|
# related_contact_id: "ContactId",
|
15445
16397
|
# references: {
|
15446
16398
|
# "ReferenceKey" => {
|
15447
|
-
# value: "ReferenceValue",
|
15448
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
16399
|
+
# value: "ReferenceValue",
|
16400
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
16401
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
16402
|
+
# arn: "ReferenceArn",
|
16403
|
+
# status_reason: "ReferenceStatusReason",
|
15449
16404
|
# },
|
15450
16405
|
# },
|
15451
16406
|
# description: "Description",
|
@@ -15778,9 +16733,9 @@ module Aws::Connect
|
|
15778
16733
|
# Adds the specified tags to the specified resource.
|
15779
16734
|
#
|
15780
16735
|
# Some of the supported resource types are agents, routing profiles,
|
15781
|
-
# queues, quick connects,
|
15782
|
-
#
|
15783
|
-
#
|
16736
|
+
# queues, quick connects, flows, agent statuses, hours of operation,
|
16737
|
+
# phone numbers, security profiles, and task templates. For a complete
|
16738
|
+
# list, see [Tagging resources in Amazon Connect][1].
|
15784
16739
|
#
|
15785
16740
|
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
15786
16741
|
# Policy Examples][2] in the *Amazon Connect Administrator Guide*.
|
@@ -16134,6 +17089,19 @@ module Aws::Connect
|
|
16134
17089
|
# Well-formed data on contact, shown to agents on Contact Control Panel
|
16135
17090
|
# (CCP).
|
16136
17091
|
#
|
17092
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
17093
|
+
# A set of system defined key-value pairs stored on individual contact
|
17094
|
+
# segments (unique contact ID) using an attribute map. The attributes
|
17095
|
+
# are standard Amazon Connect attributes. They can be accessed in flows.
|
17096
|
+
#
|
17097
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
17098
|
+
#
|
17099
|
+
# This field can be used to show channel subtype, such as
|
17100
|
+
# `connect:Guide`.
|
17101
|
+
#
|
17102
|
+
# Currently Contact Expiry is the only segment attribute which can be
|
17103
|
+
# updated by using the UpdateContact API.
|
17104
|
+
#
|
16137
17105
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
16138
17106
|
#
|
16139
17107
|
# @example Request syntax with placeholder values
|
@@ -16145,8 +17113,22 @@ module Aws::Connect
|
|
16145
17113
|
# description: "Description",
|
16146
17114
|
# references: {
|
16147
17115
|
# "ReferenceKey" => {
|
16148
|
-
# value: "ReferenceValue",
|
16149
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
17116
|
+
# value: "ReferenceValue",
|
17117
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
17118
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
17119
|
+
# arn: "ReferenceArn",
|
17120
|
+
# status_reason: "ReferenceStatusReason",
|
17121
|
+
# },
|
17122
|
+
# },
|
17123
|
+
# segment_attributes: {
|
17124
|
+
# "SegmentAttributeName" => {
|
17125
|
+
# value_string: "SegmentAttributeValueString",
|
17126
|
+
# value_map: {
|
17127
|
+
# "SegmentAttributeName" => {
|
17128
|
+
# # recursive SegmentAttributeValue
|
17129
|
+
# },
|
17130
|
+
# },
|
17131
|
+
# value_integer: 1,
|
16150
17132
|
# },
|
16151
17133
|
# },
|
16152
17134
|
# })
|
@@ -16310,8 +17292,8 @@ module Aws::Connect
|
|
16310
17292
|
# language][1].
|
16311
17293
|
#
|
16312
17294
|
# Use the `$SAVED` alias in the request to describe the `SAVED` content
|
16313
|
-
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`.
|
16314
|
-
#
|
17295
|
+
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After
|
17296
|
+
# a flow is published, `$SAVED` needs to be supplied to view saved
|
16315
17297
|
# content that has not been published.
|
16316
17298
|
#
|
16317
17299
|
#
|
@@ -16400,8 +17382,8 @@ module Aws::Connect
|
|
16400
17382
|
# instance.
|
16401
17383
|
#
|
16402
17384
|
# Use the `$SAVED` alias in the request to describe the `SAVED` content
|
16403
|
-
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`.
|
16404
|
-
#
|
17385
|
+
# of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After
|
17386
|
+
# a flow is published, `$SAVED` needs to be supplied to view saved
|
16405
17387
|
# content that has not been published.
|
16406
17388
|
#
|
16407
17389
|
# @option params [required, String] :instance_id
|
@@ -16664,6 +17646,70 @@ module Aws::Connect
|
|
16664
17646
|
req.send_request(options)
|
16665
17647
|
end
|
16666
17648
|
|
17649
|
+
# Updates an email address metadata. For more information about email
|
17650
|
+
# addresses, see [Create email addresses][1] in the Amazon Connect
|
17651
|
+
# Administrator Guide.
|
17652
|
+
#
|
17653
|
+
#
|
17654
|
+
#
|
17655
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html
|
17656
|
+
#
|
17657
|
+
# @option params [required, String] :instance_id
|
17658
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
17659
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
17660
|
+
#
|
17661
|
+
#
|
17662
|
+
#
|
17663
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
17664
|
+
#
|
17665
|
+
# @option params [required, String] :email_address_id
|
17666
|
+
# The identifier of the email address.
|
17667
|
+
#
|
17668
|
+
# @option params [String] :description
|
17669
|
+
# The description of the email address.
|
17670
|
+
#
|
17671
|
+
# @option params [String] :display_name
|
17672
|
+
# The display name of email address.
|
17673
|
+
#
|
17674
|
+
# @option params [String] :client_token
|
17675
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
17676
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
17677
|
+
# SDK populates this field. For more information about idempotency, see
|
17678
|
+
# [Making retries safe with idempotent APIs][1].
|
17679
|
+
#
|
17680
|
+
#
|
17681
|
+
#
|
17682
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
17683
|
+
#
|
17684
|
+
# @return [Types::UpdateEmailAddressMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
17685
|
+
#
|
17686
|
+
# * {Types::UpdateEmailAddressMetadataResponse#email_address_id #email_address_id} => String
|
17687
|
+
# * {Types::UpdateEmailAddressMetadataResponse#email_address_arn #email_address_arn} => String
|
17688
|
+
#
|
17689
|
+
# @example Request syntax with placeholder values
|
17690
|
+
#
|
17691
|
+
# resp = client.update_email_address_metadata({
|
17692
|
+
# instance_id: "InstanceId", # required
|
17693
|
+
# email_address_id: "EmailAddressId", # required
|
17694
|
+
# description: "Description",
|
17695
|
+
# display_name: "EmailAddressDisplayName",
|
17696
|
+
# client_token: "ClientToken",
|
17697
|
+
# })
|
17698
|
+
#
|
17699
|
+
# @example Response structure
|
17700
|
+
#
|
17701
|
+
# resp.email_address_id #=> String
|
17702
|
+
# resp.email_address_arn #=> String
|
17703
|
+
#
|
17704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadata AWS API Documentation
|
17705
|
+
#
|
17706
|
+
# @overload update_email_address_metadata(params = {})
|
17707
|
+
# @param [Hash] params ({})
|
17708
|
+
def update_email_address_metadata(params = {}, options = {})
|
17709
|
+
req = build_request(:update_email_address_metadata, params)
|
17710
|
+
req.send_request(options)
|
17711
|
+
end
|
17712
|
+
|
16667
17713
|
# Updates details about a specific evaluation form version in the
|
16668
17714
|
# specified Amazon Connect instance. Question and section identifiers
|
16669
17715
|
# cannot be duplicated within the same evaluation form.
|
@@ -16952,7 +17998,7 @@ module Aws::Connect
|
|
16952
17998
|
# resp = client.update_instance_storage_config({
|
16953
17999
|
# instance_id: "InstanceId", # required
|
16954
18000
|
# association_id: "AssociationId", # required
|
16955
|
-
# 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
|
18001
|
+
# 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
|
16956
18002
|
# storage_config: { # required
|
16957
18003
|
# association_id: "AssociationId",
|
16958
18004
|
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
@@ -17469,6 +18515,43 @@ module Aws::Connect
|
|
17469
18515
|
req.send_request(options)
|
17470
18516
|
end
|
17471
18517
|
|
18518
|
+
# Updates the outbound email address Id for a specified queue.
|
18519
|
+
#
|
18520
|
+
# @option params [required, String] :instance_id
|
18521
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
18522
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
18523
|
+
#
|
18524
|
+
#
|
18525
|
+
#
|
18526
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
18527
|
+
#
|
18528
|
+
# @option params [required, String] :queue_id
|
18529
|
+
# The identifier for the queue.
|
18530
|
+
#
|
18531
|
+
# @option params [required, Types::OutboundEmailConfig] :outbound_email_config
|
18532
|
+
# The outbound email address ID for a specified queue.
|
18533
|
+
#
|
18534
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
18535
|
+
#
|
18536
|
+
# @example Request syntax with placeholder values
|
18537
|
+
#
|
18538
|
+
# resp = client.update_queue_outbound_email_config({
|
18539
|
+
# instance_id: "InstanceId", # required
|
18540
|
+
# queue_id: "QueueId", # required
|
18541
|
+
# outbound_email_config: { # required
|
18542
|
+
# outbound_email_address_id: "EmailAddressId",
|
18543
|
+
# },
|
18544
|
+
# })
|
18545
|
+
#
|
18546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundEmailConfig AWS API Documentation
|
18547
|
+
#
|
18548
|
+
# @overload update_queue_outbound_email_config(params = {})
|
18549
|
+
# @param [Hash] params ({})
|
18550
|
+
def update_queue_outbound_email_config(params = {}, options = {})
|
18551
|
+
req = build_request(:update_queue_outbound_email_config, params)
|
18552
|
+
req.send_request(options)
|
18553
|
+
end
|
18554
|
+
|
17472
18555
|
# This API is in preview release for Amazon Connect and is subject to
|
17473
18556
|
# change.
|
17474
18557
|
#
|
@@ -17662,7 +18745,7 @@ module Aws::Connect
|
|
17662
18745
|
# routing_profile_id: "RoutingProfileId", # required
|
17663
18746
|
# media_concurrencies: [ # required
|
17664
18747
|
# {
|
17665
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
18748
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
17666
18749
|
# concurrency: 1, # required
|
17667
18750
|
# cross_channel_behavior: {
|
17668
18751
|
# behavior_type: "ROUTE_CURRENT_CHANNEL_ONLY", # required, accepts ROUTE_CURRENT_CHANNEL_ONLY, ROUTE_ANY_CHANNEL
|
@@ -17787,7 +18870,7 @@ module Aws::Connect
|
|
17787
18870
|
# {
|
17788
18871
|
# queue_reference: { # required
|
17789
18872
|
# queue_id: "QueueId", # required
|
17790
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
18873
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
17791
18874
|
# },
|
17792
18875
|
# priority: 1, # required
|
17793
18876
|
# delay: 1, # required
|
@@ -17856,8 +18939,11 @@ module Aws::Connect
|
|
17856
18939
|
# contact_flow_id: "ContactFlowId", # required
|
17857
18940
|
# references: {
|
17858
18941
|
# "ReferenceKey" => {
|
17859
|
-
# value: "ReferenceValue",
|
17860
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
18942
|
+
# value: "ReferenceValue",
|
18943
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
18944
|
+
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
18945
|
+
# arn: "ReferenceArn",
|
18946
|
+
# status_reason: "ReferenceStatusReason",
|
17861
18947
|
# },
|
17862
18948
|
# },
|
17863
18949
|
# },
|
@@ -18037,6 +19123,10 @@ module Aws::Connect
|
|
18037
19123
|
# The identifier of the flow that runs by default when a task is created
|
18038
19124
|
# by referencing this template.
|
18039
19125
|
#
|
19126
|
+
# @option params [String] :self_assign_flow_id
|
19127
|
+
# The ContactFlowId for the flow that will be run if this template is
|
19128
|
+
# used to create a self-assigned task.
|
19129
|
+
#
|
18040
19130
|
# @option params [Types::TaskTemplateConstraints] :constraints
|
18041
19131
|
# Constraints that are applicable to the fields listed.
|
18042
19132
|
#
|
@@ -18061,6 +19151,7 @@ module Aws::Connect
|
|
18061
19151
|
# * {Types::UpdateTaskTemplateResponse#name #name} => String
|
18062
19152
|
# * {Types::UpdateTaskTemplateResponse#description #description} => String
|
18063
19153
|
# * {Types::UpdateTaskTemplateResponse#contact_flow_id #contact_flow_id} => String
|
19154
|
+
# * {Types::UpdateTaskTemplateResponse#self_assign_flow_id #self_assign_flow_id} => String
|
18064
19155
|
# * {Types::UpdateTaskTemplateResponse#constraints #constraints} => Types::TaskTemplateConstraints
|
18065
19156
|
# * {Types::UpdateTaskTemplateResponse#defaults #defaults} => Types::TaskTemplateDefaults
|
18066
19157
|
# * {Types::UpdateTaskTemplateResponse#fields #fields} => Array<Types::TaskTemplateField>
|
@@ -18076,6 +19167,7 @@ module Aws::Connect
|
|
18076
19167
|
# name: "TaskTemplateName",
|
18077
19168
|
# description: "TaskTemplateDescription",
|
18078
19169
|
# contact_flow_id: "ContactFlowId",
|
19170
|
+
# self_assign_flow_id: "ContactFlowId",
|
18079
19171
|
# constraints: {
|
18080
19172
|
# required_fields: [
|
18081
19173
|
# {
|
@@ -18116,7 +19208,7 @@ module Aws::Connect
|
|
18116
19208
|
# name: "TaskTemplateFieldName",
|
18117
19209
|
# },
|
18118
19210
|
# description: "TaskTemplateFieldDescription",
|
18119
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
19211
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL, SELF_ASSIGN, EXPIRY_DURATION
|
18120
19212
|
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
18121
19213
|
# },
|
18122
19214
|
# ],
|
@@ -18130,6 +19222,7 @@ module Aws::Connect
|
|
18130
19222
|
# resp.name #=> String
|
18131
19223
|
# resp.description #=> String
|
18132
19224
|
# resp.contact_flow_id #=> String
|
19225
|
+
# resp.self_assign_flow_id #=> String
|
18133
19226
|
# resp.constraints.required_fields #=> Array
|
18134
19227
|
# resp.constraints.required_fields[0].id.name #=> String
|
18135
19228
|
# resp.constraints.read_only_fields #=> Array
|
@@ -18142,7 +19235,7 @@ module Aws::Connect
|
|
18142
19235
|
# resp.fields #=> Array
|
18143
19236
|
# resp.fields[0].id.name #=> String
|
18144
19237
|
# resp.fields[0].description #=> String
|
18145
|
-
# resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL"
|
19238
|
+
# 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"
|
18146
19239
|
# resp.fields[0].single_select_options #=> Array
|
18147
19240
|
# resp.fields[0].single_select_options[0] #=> String
|
18148
19241
|
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
@@ -18682,7 +19775,7 @@ module Aws::Connect
|
|
18682
19775
|
tracer: tracer
|
18683
19776
|
)
|
18684
19777
|
context[:gem_name] = 'aws-sdk-connect'
|
18685
|
-
context[:gem_version] = '1.
|
19778
|
+
context[:gem_version] = '1.187.0'
|
18686
19779
|
Seahorse::Client::Request.new(handlers, context)
|
18687
19780
|
end
|
18688
19781
|
|