aws-sdk-connect 1.186.0 → 1.187.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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] are the only current supported resource.
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/APIReference/API_connect-cases_CreateCase.html
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
  #
@@ -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] are the only current supported resource.
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/APIReference/API_connect-cases_CreateCase.html
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,33 +1650,83 @@ module Aws::Connect
1648
1650
  req.send_request(options)
1649
1651
  end
1650
1652
 
1653
+ # Creates a new contact.
1654
+ #
1651
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
1652
1662
  #
1653
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
+ #
1654
1669
  # **A suitable default value is auto-generated.** You should normally
1655
1670
  # not need to pass this option.**
1656
1671
  #
1672
+ #
1673
+ #
1674
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1675
+ #
1657
1676
  # @option params [String] :related_contact_id
1677
+ # The identifier of the contact in this instance of Amazon Connect.
1658
1678
  #
1659
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.
1660
1687
  #
1661
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.
1662
1692
  #
1663
1693
  # @option params [required, String] :channel
1694
+ # The channel for the contact
1664
1695
  #
1665
1696
  # @option params [required, String] :initiation_method
1697
+ # Indicates how the contact was initiated.
1666
1698
  #
1667
1699
  # @option params [Integer] :expiry_duration_in_minutes
1700
+ # Number of minutes the contact will be active for before expiring
1668
1701
  #
1669
1702
  # @option params [Types::UserInfo] :user_info
1703
+ # User details for the contact
1670
1704
  #
1671
1705
  # @option params [String] :initiate_as
1706
+ # Initial state of the contact when it's created
1672
1707
  #
1673
1708
  # @option params [String] :name
1709
+ # The name of a the contact.
1674
1710
  #
1675
1711
  # @option params [String] :description
1712
+ # A description of the contact.
1676
1713
  #
1677
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>
1678
1730
  #
1679
1731
  # @return [Types::CreateContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1680
1732
  #
@@ -1711,6 +1763,12 @@ module Aws::Connect
1711
1763
  # segment_attributes: {
1712
1764
  # "SegmentAttributeName" => {
1713
1765
  # value_string: "SegmentAttributeValueString",
1766
+ # value_map: {
1767
+ # "SegmentAttributeName" => {
1768
+ # # recursive SegmentAttributeValue
1769
+ # },
1770
+ # },
1771
+ # value_integer: 1,
1714
1772
  # },
1715
1773
  # },
1716
1774
  # })
@@ -1941,17 +1999,46 @@ module Aws::Connect
1941
1999
  req.send_request(options)
1942
2000
  end
1943
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
+ #
1944
2010
  # @option params [String] :description
2011
+ # The description of the email address.
1945
2012
  #
1946
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
1947
2020
  #
1948
2021
  # @option params [required, String] :email_address
2022
+ # The email address with the instance, in
2023
+ # \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
1949
2024
  #
1950
2025
  # @option params [String] :display_name
2026
+ # The display name of email address
1951
2027
  #
1952
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
+ # }.
1953
2032
  #
1954
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/
1955
2042
  #
1956
2043
  # @return [Types::CreateEmailAddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1957
2044
  #
@@ -2696,6 +2783,7 @@ module Aws::Connect
2696
2783
  # The outbound caller ID name, number, and outbound whisper flow.
2697
2784
  #
2698
2785
  # @option params [Types::OutboundEmailConfig] :outbound_email_config
2786
+ # The outbound email address ID for a specified queue.
2699
2787
  #
2700
2788
  # @option params [required, String] :hours_of_operation_id
2701
2789
  # The identifier for the hours of operation.
@@ -3192,6 +3280,8 @@ module Aws::Connect
3192
3280
  # by referencing this template.
3193
3281
  #
3194
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.
3195
3285
  #
3196
3286
  # @option params [Types::TaskTemplateConstraints] :constraints
3197
3287
  # Constraints that are applicable to the fields listed.
@@ -4033,9 +4123,18 @@ module Aws::Connect
4033
4123
  req.send_request(options)
4034
4124
  end
4035
4125
 
4126
+ # Deletes email address from the specified Amazon Connect instance.
4127
+ #
4036
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
4037
4135
  #
4038
4136
  # @option params [required, String] :email_address_id
4137
+ # The identifier of the email address.
4039
4138
  #
4040
4139
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4041
4140
  #
@@ -4945,6 +5044,9 @@ module Aws::Connect
4945
5044
  # resp.contact.additional_email_recipients.cc_list[0].display_name #=> String
4946
5045
  # resp.contact.segment_attributes #=> Hash
4947
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
4948
5050
  #
4949
5051
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContact AWS API Documentation
4950
5052
  #
@@ -5063,8 +5165,8 @@ module Aws::Connect
5063
5165
  # language][1].
5064
5166
  #
5065
5167
  # Use the `$SAVED` alias in the request to describe the `SAVED` content
5066
- # of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. Once a
5067
- # contact flow is published, `$SAVED` needs to be supplied to view saved
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
5068
5170
  # content that has not been published.
5069
5171
  #
5070
5172
  # In the response, **Status** indicates the flow status as either
@@ -5105,7 +5207,6 @@ module Aws::Connect
5105
5207
  # resp.contact_flow.content #=> String
5106
5208
  # resp.contact_flow.tags #=> Hash
5107
5209
  # resp.contact_flow.tags["TagKey"] #=> String
5108
- # resp.contact_flow.is_default #=> Boolean
5109
5210
  # resp.contact_flow.flow_content_sha_256 #=> String
5110
5211
  # resp.contact_flow.version #=> Integer
5111
5212
  # resp.contact_flow.version_description #=> String
@@ -5124,8 +5225,8 @@ module Aws::Connect
5124
5225
  # Describes the specified flow module.
5125
5226
  #
5126
5227
  # Use the `$SAVED` alias in the request to describe the `SAVED` content
5127
- # of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. Once a
5128
- # contact flow is published, `$SAVED` needs to be supplied to view saved
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
5129
5230
  # content that has not been published.
5130
5231
  #
5131
5232
  # @option params [required, String] :instance_id
@@ -5171,9 +5272,18 @@ module Aws::Connect
5171
5272
  req.send_request(options)
5172
5273
  end
5173
5274
 
5275
+ # Describe email address form the specified Amazon Connect instance.
5276
+ #
5174
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
5175
5284
  #
5176
5285
  # @option params [required, String] :email_address_id
5286
+ # The identifier of the email address.
5177
5287
  #
5178
5288
  # @return [Types::DescribeEmailAddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5179
5289
  #
@@ -6838,7 +6948,7 @@ module Aws::Connect
6838
6948
  # return a downloadURL if the status of the attached file is `APPROVED`.
6839
6949
  #
6840
6950
  # @option params [required, String] :instance_id
6841
- # The unique identifier of the Connect instance.
6951
+ # The unique identifier of the Amazon Connect instance.
6842
6952
  #
6843
6953
  # @option params [required, String] :file_id
6844
6954
  # The unique identifier of the attached file resource.
@@ -6848,8 +6958,8 @@ module Aws::Connect
6848
6958
  # The default value is 300.
6849
6959
  #
6850
6960
  # @option params [required, String] :associated_resource_arn
6851
- # The resource to which the attached file is (being) uploaded to.
6852
- # [Cases][1] are the only current supported resource.
6961
+ # The resource to which the attached file is (being) uploaded to. The
6962
+ # supported resources are [Cases][1] and [Email][2].
6853
6963
  #
6854
6964
  # <note markdown="1"> This value must be a valid ARN.
6855
6965
  #
@@ -6857,7 +6967,8 @@ module Aws::Connect
6857
6967
  #
6858
6968
  #
6859
6969
  #
6860
- # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html
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
6861
6972
  #
6862
6973
  # @return [Types::GetAttachedFileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6863
6974
  #
@@ -9641,13 +9752,32 @@ module Aws::Connect
9641
9752
  req.send_request(options)
9642
9753
  end
9643
9754
 
9755
+ # Provides information about contact tree, a list of associated contacts
9756
+ # with a unique identifier.
9757
+ #
9644
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
9645
9765
  #
9646
9766
  # @option params [required, String] :contact_id
9767
+ # The identifier of the contact in this instance of Amazon Connect.
9647
9768
  #
9648
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.
9649
9776
  #
9650
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.
9651
9781
  #
9652
9782
  # @return [Types::ListAssociatedContactsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9653
9783
  #
@@ -12893,7 +13023,7 @@ module Aws::Connect
12893
13023
  # Filters to be applied to search results.
12894
13024
  #
12895
13025
  # @option params [Types::ContactFlowModuleSearchCriteria] :search_criteria
12896
- # The search criteria to be used to return contact flow modules.
13026
+ # The search criteria to be used to return flow modules.
12897
13027
  #
12898
13028
  # <note markdown="1"> The `name` and `description` fields support "contains" queries with
12899
13029
  # a minimum of 2 characters and a maximum of 25 characters. Any queries
@@ -12981,8 +13111,8 @@ module Aws::Connect
12981
13111
  req.send_request(options)
12982
13112
  end
12983
13113
 
12984
- # Searches the contact flows in an Amazon Connect instance, with
12985
- # optional filtering.
13114
+ # Searches the flows in an Amazon Connect instance, with optional
13115
+ # filtering.
12986
13116
  #
12987
13117
  # @option params [required, String] :instance_id
12988
13118
  # The identifier of the Amazon Connect instance. You can find the
@@ -13080,7 +13210,6 @@ module Aws::Connect
13080
13210
  # resp.contact_flows[0].content #=> String
13081
13211
  # resp.contact_flows[0].tags #=> Hash
13082
13212
  # resp.contact_flows[0].tags["TagKey"] #=> String
13083
- # resp.contact_flows[0].is_default #=> Boolean
13084
13213
  # resp.contact_flows[0].flow_content_sha_256 #=> String
13085
13214
  # resp.contact_flows[0].version #=> Integer
13086
13215
  # resp.contact_flows[0].version_description #=> String
@@ -13219,15 +13348,29 @@ module Aws::Connect
13219
13348
  req.send_request(options)
13220
13349
  end
13221
13350
 
13351
+ # Searches email address in an instance, with optional filtering.
13352
+ #
13222
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
13223
13360
  #
13224
13361
  # @option params [Integer] :max_results
13362
+ # The maximum number of results to return per page.
13225
13363
  #
13226
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.
13227
13368
  #
13228
13369
  # @option params [Types::EmailAddressSearchCriteria] :search_criteria
13370
+ # The search criteria to be used to return email addresses.
13229
13371
  #
13230
13372
  # @option params [Types::EmailAddressSearchFilter] :search_filter
13373
+ # Filters to be applied to search results.
13231
13374
  #
13232
13375
  # @return [Types::SearchEmailAddressesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
13233
13376
  #
@@ -14618,24 +14761,57 @@ module Aws::Connect
14618
14761
  req.send_request(options)
14619
14762
  end
14620
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
+ #
14621
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
14622
14783
  #
14623
14784
  # @option params [required, Types::EmailAddressInfo] :from_email_address
14785
+ # The email address to be used for sending email.
14624
14786
  #
14625
14787
  # @option params [required, Types::EmailAddressInfo] :destination_email_address
14788
+ # The email address to send the email to.
14626
14789
  #
14627
14790
  # @option params [Types::OutboundAdditionalRecipients] :additional_recipients
14791
+ # The additional recipients address of the email in CC.
14628
14792
  #
14629
14793
  # @option params [required, Types::OutboundEmailContent] :email_message
14794
+ # The email message body to be sent to the newly created email.
14630
14795
  #
14631
14796
  # @option params [required, String] :traffic_type
14797
+ # Denotes the class of traffic.
14632
14798
  #
14633
14799
  # @option params [Types::SourceCampaign] :source_campaign
14800
+ # A Campaign object need for Campaign traffic type.
14634
14801
  #
14635
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
+ #
14636
14808
  # **A suitable default value is auto-generated.** You should normally
14637
14809
  # not need to pass this option.**
14638
14810
  #
14811
+ #
14812
+ #
14813
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
14814
+ #
14639
14815
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
14640
14816
  #
14641
14817
  # @example Request syntax with placeholder values
@@ -14697,11 +14873,12 @@ module Aws::Connect
14697
14873
  # content.
14698
14874
  #
14699
14875
  # You may only use this API to upload attachments to an [Amazon Connect
14700
- # Case][1].
14876
+ # Case][1] or [Amazon Connect Email][2].
14701
14877
  #
14702
14878
  #
14703
14879
  #
14704
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
14705
14882
  #
14706
14883
  # @option params [String] :client_token
14707
14884
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -14732,9 +14909,11 @@ module Aws::Connect
14732
14909
  # @option params [required, String] :file_use_case_type
14733
14910
  # The use case for the file.
14734
14911
  #
14912
+ # Only `ATTACHMENTS` are supported.
14913
+ #
14735
14914
  # @option params [required, String] :associated_resource_arn
14736
- # The resource to which the attached file is (being) uploaded to.
14737
- # [Cases][1] are the only current supported resource.
14915
+ # The resource to which the attached file is (being) uploaded to. The
14916
+ # supported resources are [Cases][1] and [Email][2].
14738
14917
  #
14739
14918
  # <note markdown="1"> This value must be a valid ARN.
14740
14919
  #
@@ -14742,7 +14921,8 @@ module Aws::Connect
14742
14921
  #
14743
14922
  #
14744
14923
  #
14745
- # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html
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
14746
14926
  #
14747
14927
  # @option params [Types::CreatedByInfo] :created_by
14748
14928
  # Represents the identity that created the file.
@@ -14851,8 +15031,8 @@ module Aws::Connect
14851
15031
  # @option params [required, String] :contact_flow_id
14852
15032
  # The identifier of the flow for initiating the chat. To see the
14853
15033
  # ContactFlowId in the Amazon Connect admin website, on the navigation
14854
- # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
14855
- # flow page, under the name of the flow, choose **Show additional flow
15034
+ # menu go to **Routing**, **Flows**. Choose the flow. On the flow page,
15035
+ # under the name of the flow, choose **Show additional flow
14856
15036
  # information**. The ContactFlowId is the last part of the ARN, shown
14857
15037
  # here in bold:
14858
15038
  #
@@ -14984,6 +15164,12 @@ module Aws::Connect
14984
15164
  # segment_attributes: {
14985
15165
  # "SegmentAttributeName" => {
14986
15166
  # value_string: "SegmentAttributeValueString",
15167
+ # value_map: {
15168
+ # "SegmentAttributeName" => {
15169
+ # # recursive SegmentAttributeValue
15170
+ # },
15171
+ # },
15172
+ # value_integer: 1,
14987
15173
  # },
14988
15174
  # },
14989
15175
  # })
@@ -15211,36 +15397,104 @@ module Aws::Connect
15211
15397
  req.send_request(options)
15212
15398
  end
15213
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
+ #
15214
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
15215
15411
  #
15216
15412
  # @option params [required, Types::EmailAddressInfo] :from_email_address
15413
+ # The email address of the customer.
15217
15414
  #
15218
15415
  # @option params [required, String] :destination_email_address
15416
+ # The email address associated with the instance.
15219
15417
  #
15220
15418
  # @option params [String] :description
15419
+ # A description of the email contact.
15221
15420
  #
15222
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.
15223
15427
  #
15224
15428
  # @option params [String] :name
15429
+ # The name of a email that is shown to an agent in the Contact Control
15430
+ # Panel (CCP).
15225
15431
  #
15226
15432
  # @option params [required, Types::InboundEmailContent] :email_message
15433
+ # The email message body to be sent to the newly created email.
15227
15434
  #
15228
15435
  # @option params [Types::InboundAdditionalRecipients] :additional_recipients
15436
+ # The addtional recipients address of the email.
15229
15437
  #
15230
15438
  # @option params [Array<Types::EmailAttachment>] :attachments
15439
+ # List of S3 presigned URLs of email attachments and their file name.
15231
15440
  #
15232
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**
15233
15450
  #
15234
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`.
15235
15458
  #
15236
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.
15237
15467
  #
15238
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>
15239
15484
  #
15240
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
+ #
15241
15491
  # **A suitable default value is auto-generated.** You should normally
15242
15492
  # not need to pass this option.**
15243
15493
  #
15494
+ #
15495
+ #
15496
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
15497
+ #
15244
15498
  # @return [Types::StartEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
15245
15499
  #
15246
15500
  # * {Types::StartEmailContactResponse#contact_id #contact_id} => String
@@ -15304,6 +15558,12 @@ module Aws::Connect
15304
15558
  # segment_attributes: {
15305
15559
  # "SegmentAttributeName" => {
15306
15560
  # value_string: "SegmentAttributeValueString",
15561
+ # value_map: {
15562
+ # "SegmentAttributeName" => {
15563
+ # # recursive SegmentAttributeValue
15564
+ # },
15565
+ # },
15566
+ # value_integer: 1,
15307
15567
  # },
15308
15568
  # },
15309
15569
  # client_token: "ClientToken",
@@ -15458,6 +15718,12 @@ module Aws::Connect
15458
15718
  # segment_attributes: { # required
15459
15719
  # "SegmentAttributeName" => {
15460
15720
  # value_string: "SegmentAttributeValueString",
15721
+ # value_map: {
15722
+ # "SegmentAttributeName" => {
15723
+ # # recursive SegmentAttributeValue
15724
+ # },
15725
+ # },
15726
+ # value_integer: 1,
15461
15727
  # },
15462
15728
  # },
15463
15729
  # attributes: {
@@ -15490,22 +15756,45 @@ module Aws::Connect
15490
15756
  req.send_request(options)
15491
15757
  end
15492
15758
 
15759
+ # Initiates a flow to send an agent reply or outbound email contact
15760
+ # (created from the CreateContact API) to a customer.
15761
+ #
15493
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
15494
15769
  #
15495
15770
  # @option params [required, String] :contact_id
15771
+ # The identifier of the contact in this instance of Amazon Connect.
15496
15772
  #
15497
15773
  # @option params [Types::EmailAddressInfo] :from_email_address
15774
+ # The email address associated with the instance.
15498
15775
  #
15499
15776
  # @option params [required, Types::EmailAddressInfo] :destination_email_address
15777
+ # The email address of the customer.
15500
15778
  #
15501
15779
  # @option params [Types::OutboundAdditionalRecipients] :additional_recipients
15780
+ # The addtional recipients address of email in CC.
15502
15781
  #
15503
15782
  # @option params [required, Types::OutboundEmailContent] :email_message
15783
+ # The email message body to be sent to the newly created email.
15504
15784
  #
15505
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
+ #
15506
15791
  # **A suitable default value is auto-generated.** You should normally
15507
15792
  # not need to pass this option.**
15508
15793
  #
15794
+ #
15795
+ #
15796
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
15797
+ #
15509
15798
  # @return [Types::StartOutboundEmailContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
15510
15799
  #
15511
15800
  # * {Types::StartOutboundEmailContactResponse#contact_id #contact_id} => String
@@ -15850,8 +16139,8 @@ module Aws::Connect
15850
16139
  # @option params [String] :contact_flow_id
15851
16140
  # The identifier of the flow for initiating the tasks. To see the
15852
16141
  # ContactFlowId in the Amazon Connect admin website, on the navigation
15853
- # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15854
- # flow page, under the name of the flow, choose **Show additional flow
16142
+ # menu go to **Routing**, **Flows**. Choose the flow. On the flow page,
16143
+ # under the name of the flow, choose **Show additional flow
15855
16144
  # information**. The ContactFlowId is the last part of the ARN, shown
15856
16145
  # here in bold:
15857
16146
  #
@@ -15931,6 +16220,26 @@ module Aws::Connect
15931
16220
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks
15932
16221
  #
15933
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>
15934
16243
  #
15935
16244
  # @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
15936
16245
  #
@@ -15964,6 +16273,12 @@ module Aws::Connect
15964
16273
  # segment_attributes: {
15965
16274
  # "SegmentAttributeName" => {
15966
16275
  # value_string: "SegmentAttributeValueString",
16276
+ # value_map: {
16277
+ # "SegmentAttributeName" => {
16278
+ # # recursive SegmentAttributeValue
16279
+ # },
16280
+ # },
16281
+ # value_integer: 1,
15967
16282
  # },
15968
16283
  # },
15969
16284
  # })
@@ -16418,9 +16733,9 @@ module Aws::Connect
16418
16733
  # Adds the specified tags to the specified resource.
16419
16734
  #
16420
16735
  # Some of the supported resource types are agents, routing profiles,
16421
- # queues, quick connects, contact flows, agent statuses, hours of
16422
- # operation, phone numbers, security profiles, and task templates. For a
16423
- # complete list, see [Tagging resources in Amazon Connect][1].
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].
16424
16739
  #
16425
16740
  # For sample policies that use tags, see [Amazon Connect Identity-Based
16426
16741
  # Policy Examples][2] in the *Amazon Connect Administrator Guide*.
@@ -16775,6 +17090,17 @@ module Aws::Connect
16775
17090
  # (CCP).
16776
17091
  #
16777
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.
16778
17104
  #
16779
17105
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
16780
17106
  #
@@ -16797,6 +17123,12 @@ module Aws::Connect
16797
17123
  # segment_attributes: {
16798
17124
  # "SegmentAttributeName" => {
16799
17125
  # value_string: "SegmentAttributeValueString",
17126
+ # value_map: {
17127
+ # "SegmentAttributeName" => {
17128
+ # # recursive SegmentAttributeValue
17129
+ # },
17130
+ # },
17131
+ # value_integer: 1,
16800
17132
  # },
16801
17133
  # },
16802
17134
  # })
@@ -16960,8 +17292,8 @@ module Aws::Connect
16960
17292
  # language][1].
16961
17293
  #
16962
17294
  # Use the `$SAVED` alias in the request to describe the `SAVED` content
16963
- # of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. Once a
16964
- # contact flow is published, `$SAVED` needs to be supplied to view saved
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
16965
17297
  # content that has not been published.
16966
17298
  #
16967
17299
  #
@@ -17050,8 +17382,8 @@ module Aws::Connect
17050
17382
  # instance.
17051
17383
  #
17052
17384
  # Use the `$SAVED` alias in the request to describe the `SAVED` content
17053
- # of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. Once a
17054
- # contact flow is published, `$SAVED` needs to be supplied to view saved
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
17055
17387
  # content that has not been published.
17056
17388
  #
17057
17389
  # @option params [required, String] :instance_id
@@ -17314,15 +17646,40 @@ module Aws::Connect
17314
17646
  req.send_request(options)
17315
17647
  end
17316
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
+ #
17317
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
17318
17664
  #
17319
17665
  # @option params [required, String] :email_address_id
17666
+ # The identifier of the email address.
17320
17667
  #
17321
17668
  # @option params [String] :description
17669
+ # The description of the email address.
17322
17670
  #
17323
17671
  # @option params [String] :display_name
17672
+ # The display name of email address.
17324
17673
  #
17325
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/
17326
17683
  #
17327
17684
  # @return [Types::UpdateEmailAddressMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
17328
17685
  #
@@ -18158,11 +18515,21 @@ module Aws::Connect
18158
18515
  req.send_request(options)
18159
18516
  end
18160
18517
 
18518
+ # Updates the outbound email address Id for a specified queue.
18519
+ #
18161
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
18162
18527
  #
18163
18528
  # @option params [required, String] :queue_id
18529
+ # The identifier for the queue.
18164
18530
  #
18165
18531
  # @option params [required, Types::OutboundEmailConfig] :outbound_email_config
18532
+ # The outbound email address ID for a specified queue.
18166
18533
  #
18167
18534
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
18168
18535
  #
@@ -18757,6 +19124,8 @@ module Aws::Connect
18757
19124
  # by referencing this template.
18758
19125
  #
18759
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.
18760
19129
  #
18761
19130
  # @option params [Types::TaskTemplateConstraints] :constraints
18762
19131
  # Constraints that are applicable to the fields listed.
@@ -19406,7 +19775,7 @@ module Aws::Connect
19406
19775
  tracer: tracer
19407
19776
  )
19408
19777
  context[:gem_name] = 'aws-sdk-connect'
19409
- context[:gem_version] = '1.186.0'
19778
+ context[:gem_version] = '1.187.0'
19410
19779
  Seahorse::Client::Request.new(handlers, context)
19411
19780
  end
19412
19781