aws-sdk-connect 1.186.0 → 1.187.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +404 -35
- data/lib/aws-sdk-connect/client_api.rb +7 -1
- data/lib/aws-sdk-connect/types.rb +528 -37
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +18 -6
- data/sig/types.rbs +2 -1
- metadata +2 -2
@@ -88,10 +88,14 @@ module Aws::Connect
|
|
88
88
|
include Aws::Structure
|
89
89
|
end
|
90
90
|
|
91
|
+
# List of additional email addresses for an email contact.
|
92
|
+
#
|
91
93
|
# @!attribute [rw] to_list
|
94
|
+
# List of additional TO email recipients for an email contact.
|
92
95
|
# @return [Array<Types::EmailRecipient>]
|
93
96
|
#
|
94
97
|
# @!attribute [rw] cc_list
|
98
|
+
# List of additional CC email recipients for an email contact.
|
95
99
|
# @return [Array<Types::EmailRecipient>]
|
96
100
|
#
|
97
101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AdditionalEmailRecipients AWS API Documentation
|
@@ -1062,31 +1066,46 @@ module Aws::Connect
|
|
1062
1066
|
include Aws::Structure
|
1063
1067
|
end
|
1064
1068
|
|
1069
|
+
# Contact summary of a contact in contact tree associated with unique
|
1070
|
+
# identifier.
|
1071
|
+
#
|
1065
1072
|
# @!attribute [rw] contact_id
|
1073
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
1066
1074
|
# @return [String]
|
1067
1075
|
#
|
1068
1076
|
# @!attribute [rw] contact_arn
|
1077
|
+
# The Amazon Resource Name (ARN) of the contact
|
1069
1078
|
# @return [String]
|
1070
1079
|
#
|
1071
1080
|
# @!attribute [rw] initiation_timestamp
|
1081
|
+
# The date and time this contact was initiated, in UTC time.
|
1072
1082
|
# @return [Time]
|
1073
1083
|
#
|
1074
1084
|
# @!attribute [rw] disconnect_timestamp
|
1085
|
+
# The timestamp when the customer endpoint disconnected from Amazon
|
1086
|
+
# Connect.
|
1075
1087
|
# @return [Time]
|
1076
1088
|
#
|
1077
1089
|
# @!attribute [rw] initial_contact_id
|
1090
|
+
# If this contact is related to other contacts, this is the ID of the
|
1091
|
+
# initial contact.
|
1078
1092
|
# @return [String]
|
1079
1093
|
#
|
1080
1094
|
# @!attribute [rw] previous_contact_id
|
1095
|
+
# If this contact is not the first contact, this is the ID of the
|
1096
|
+
# previous contact.
|
1081
1097
|
# @return [String]
|
1082
1098
|
#
|
1083
1099
|
# @!attribute [rw] related_contact_id
|
1100
|
+
# The contactId that is related to this contact.
|
1084
1101
|
# @return [String]
|
1085
1102
|
#
|
1086
1103
|
# @!attribute [rw] initiation_method
|
1104
|
+
# Indicates how the contact was initiated.
|
1087
1105
|
# @return [String]
|
1088
1106
|
#
|
1089
1107
|
# @!attribute [rw] channel
|
1108
|
+
# How the contact reached your contact center.
|
1090
1109
|
# @return [String]
|
1091
1110
|
#
|
1092
1111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociatedContactSummary AWS API Documentation
|
@@ -1218,6 +1237,7 @@ module Aws::Connect
|
|
1218
1237
|
# @return [String]
|
1219
1238
|
#
|
1220
1239
|
# @!attribute [rw] arn
|
1240
|
+
# The Amazon Resource Name (ARN) of the attachment reference.
|
1221
1241
|
# @return [String]
|
1222
1242
|
#
|
1223
1243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation
|
@@ -1658,8 +1678,8 @@ module Aws::Connect
|
|
1658
1678
|
# @return [String]
|
1659
1679
|
#
|
1660
1680
|
# @!attribute [rw] associated_resource_arn
|
1661
|
-
# The resource to which the attached file is (being) uploaded to.
|
1662
|
-
# [Cases][1]
|
1681
|
+
# The resource to which the attached file is (being) uploaded to. The
|
1682
|
+
# supported resources are [Cases][1] and [Email][2].
|
1663
1683
|
#
|
1664
1684
|
# <note markdown="1"> This value must be a valid ARN.
|
1665
1685
|
#
|
@@ -1667,7 +1687,8 @@ module Aws::Connect
|
|
1667
1687
|
#
|
1668
1688
|
#
|
1669
1689
|
#
|
1670
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
1690
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
1691
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
1671
1692
|
# @return [String]
|
1672
1693
|
#
|
1673
1694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchGetAttachedFileMetadataRequest AWS API Documentation
|
@@ -2142,8 +2163,8 @@ module Aws::Connect
|
|
2142
2163
|
# @return [String]
|
2143
2164
|
#
|
2144
2165
|
# @!attribute [rw] associated_resource_arn
|
2145
|
-
# The resource to which the attached file is (being) uploaded to.
|
2146
|
-
# [Cases][1]
|
2166
|
+
# The resource to which the attached file is (being) uploaded to. The
|
2167
|
+
# supported resources are [Cases][1] and [Email][2].
|
2147
2168
|
#
|
2148
2169
|
# <note markdown="1"> This value must be a valid ARN.
|
2149
2170
|
#
|
@@ -2151,7 +2172,8 @@ module Aws::Connect
|
|
2151
2172
|
#
|
2152
2173
|
#
|
2153
2174
|
#
|
2154
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
2175
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
2176
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
2155
2177
|
# @return [String]
|
2156
2178
|
#
|
2157
2179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CompleteAttachedFileUploadRequest AWS API Documentation
|
@@ -2197,6 +2219,8 @@ module Aws::Connect
|
|
2197
2219
|
include Aws::Structure
|
2198
2220
|
end
|
2199
2221
|
|
2222
|
+
# A conditional check failed.
|
2223
|
+
#
|
2200
2224
|
# @!attribute [rw] message
|
2201
2225
|
# @return [String]
|
2202
2226
|
#
|
@@ -2262,6 +2286,8 @@ module Aws::Connect
|
|
2262
2286
|
# @return [String]
|
2263
2287
|
#
|
2264
2288
|
# @!attribute [rw] contact_association_id
|
2289
|
+
# This is the root contactId which is used as a unique identifier for
|
2290
|
+
# all subsequent contacts in a contact tree.
|
2265
2291
|
# @return [String]
|
2266
2292
|
#
|
2267
2293
|
# @!attribute [rw] initiation_method
|
@@ -2343,9 +2369,16 @@ module Aws::Connect
|
|
2343
2369
|
# @return [Types::WisdomInfo]
|
2344
2370
|
#
|
2345
2371
|
# @!attribute [rw] customer_endpoint
|
2372
|
+
# The customer or external third party participant endpoint.
|
2346
2373
|
# @return [Types::EndpointInfo]
|
2347
2374
|
#
|
2348
2375
|
# @!attribute [rw] system_endpoint
|
2376
|
+
# The system endpoint. For `INBOUND`, this is the phone number or
|
2377
|
+
# email address that the customer dialed. For `OUTBOUND` and
|
2378
|
+
# `EXTERNAL_OUTBOUND`, this is the outbound caller ID number assigned
|
2379
|
+
# to the outbound queue that is used to dial the customer. For
|
2380
|
+
# callback, this shows up as Softphone for calls handled by agents
|
2381
|
+
# with softphone.
|
2349
2382
|
# @return [Types::EndpointInfo]
|
2350
2383
|
#
|
2351
2384
|
# @!attribute [rw] queue_time_adjustment_seconds
|
@@ -2407,6 +2440,7 @@ module Aws::Connect
|
|
2407
2440
|
# @return [Types::DisconnectDetails]
|
2408
2441
|
#
|
2409
2442
|
# @!attribute [rw] additional_email_recipients
|
2443
|
+
# List of additional email addresses for an email contact.
|
2410
2444
|
# @return [Types::AdditionalEmailRecipients]
|
2411
2445
|
#
|
2412
2446
|
# @!attribute [rw] segment_attributes
|
@@ -2569,7 +2603,7 @@ module Aws::Connect
|
|
2569
2603
|
# @return [String]
|
2570
2604
|
#
|
2571
2605
|
# @!attribute [rw] status
|
2572
|
-
# The status of the
|
2606
|
+
# The status of the flow.
|
2573
2607
|
# @return [String]
|
2574
2608
|
#
|
2575
2609
|
# @!attribute [rw] description
|
@@ -2593,11 +2627,6 @@ module Aws::Connect
|
|
2593
2627
|
# "key2":"value2"} }.
|
2594
2628
|
# @return [Hash<String,String>]
|
2595
2629
|
#
|
2596
|
-
# @!attribute [rw] is_default
|
2597
|
-
# Amazon Connect includes a set of default flows that have already
|
2598
|
-
# been published. It uses them to power your contact center.
|
2599
|
-
# @return [Boolean]
|
2600
|
-
#
|
2601
2630
|
# @!attribute [rw] flow_content_sha_256
|
2602
2631
|
# Indicates the checksum value of the flow content.
|
2603
2632
|
# @return [String]
|
@@ -2611,11 +2640,11 @@ module Aws::Connect
|
|
2611
2640
|
# @return [String]
|
2612
2641
|
#
|
2613
2642
|
# @!attribute [rw] last_modified_time
|
2614
|
-
# The time at which the
|
2643
|
+
# The time at which the flow was last modified.
|
2615
2644
|
# @return [Time]
|
2616
2645
|
#
|
2617
2646
|
# @!attribute [rw] last_modified_region
|
2618
|
-
# The region in which the
|
2647
|
+
# The region in which the flow was last modified
|
2619
2648
|
# @return [String]
|
2620
2649
|
#
|
2621
2650
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlow AWS API Documentation
|
@@ -2630,7 +2659,6 @@ module Aws::Connect
|
|
2630
2659
|
:description,
|
2631
2660
|
:content,
|
2632
2661
|
:tags,
|
2633
|
-
:is_default,
|
2634
2662
|
:flow_content_sha_256,
|
2635
2663
|
:version,
|
2636
2664
|
:version_description,
|
@@ -2787,7 +2815,7 @@ module Aws::Connect
|
|
2787
2815
|
include Aws::Structure
|
2788
2816
|
end
|
2789
2817
|
|
2790
|
-
# The search criteria to be used to return
|
2818
|
+
# The search criteria to be used to return flows.
|
2791
2819
|
#
|
2792
2820
|
# @!attribute [rw] or_conditions
|
2793
2821
|
# A list of conditions which would be applied together with an `OR`
|
@@ -2881,7 +2909,7 @@ module Aws::Connect
|
|
2881
2909
|
# @return [String]
|
2882
2910
|
#
|
2883
2911
|
# @!attribute [rw] contact_flow_status
|
2884
|
-
# The status of the
|
2912
|
+
# The status of the flow.
|
2885
2913
|
# @return [String]
|
2886
2914
|
#
|
2887
2915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowSummary AWS API Documentation
|
@@ -2897,7 +2925,7 @@ module Aws::Connect
|
|
2897
2925
|
include Aws::Structure
|
2898
2926
|
end
|
2899
2927
|
|
2900
|
-
# A summary of a
|
2928
|
+
# A summary of a flow version's metadata.
|
2901
2929
|
#
|
2902
2930
|
# @!attribute [rw] arn
|
2903
2931
|
# The Amazon Resource Name (ARN) of the view version.
|
@@ -2995,6 +3023,7 @@ module Aws::Connect
|
|
2995
3023
|
# @return [Time]
|
2996
3024
|
#
|
2997
3025
|
# @!attribute [rw] segment_attributes
|
3026
|
+
# Set of segment attributes for a contact.
|
2998
3027
|
# @return [Hash<String,Types::ContactSearchSummarySegmentAttributeValue>]
|
2999
3028
|
#
|
3000
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummary AWS API Documentation
|
@@ -3054,7 +3083,13 @@ module Aws::Connect
|
|
3054
3083
|
include Aws::Structure
|
3055
3084
|
end
|
3056
3085
|
|
3086
|
+
# The value of a segment attribute. This is structured as a map with a
|
3087
|
+
# single key-value pair. The key 'valueString' indicates that the
|
3088
|
+
# attribute type is a string, and its corresponding value is the actual
|
3089
|
+
# string value of the segment attribute.
|
3090
|
+
#
|
3057
3091
|
# @!attribute [rw] value_string
|
3092
|
+
# The value of a segment attribute represented as a string.
|
3058
3093
|
# @return [String]
|
3059
3094
|
#
|
3060
3095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummarySegmentAttributeValue AWS API Documentation
|
@@ -3476,44 +3511,95 @@ module Aws::Connect
|
|
3476
3511
|
end
|
3477
3512
|
|
3478
3513
|
# @!attribute [rw] instance_id
|
3514
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3515
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3516
|
+
#
|
3517
|
+
#
|
3518
|
+
#
|
3519
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3479
3520
|
# @return [String]
|
3480
3521
|
#
|
3481
3522
|
# @!attribute [rw] client_token
|
3523
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
3524
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
3525
|
+
# SDK populates this field. For more information about idempotency,
|
3526
|
+
# see [Making retries safe with idempotent APIs][1].
|
3527
|
+
#
|
3482
3528
|
# **A suitable default value is auto-generated.** You should normally
|
3483
3529
|
# not need to pass this option.
|
3530
|
+
#
|
3531
|
+
#
|
3532
|
+
#
|
3533
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
3484
3534
|
# @return [String]
|
3485
3535
|
#
|
3486
3536
|
# @!attribute [rw] related_contact_id
|
3537
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
3487
3538
|
# @return [String]
|
3488
3539
|
#
|
3489
3540
|
# @!attribute [rw] attributes
|
3541
|
+
# A custom key-value pair using an attribute map. The attributes are
|
3542
|
+
# standard Amazon Connect attributes, and can be accessed in flows
|
3543
|
+
# just like any other contact attributes.
|
3544
|
+
#
|
3545
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
3546
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
3547
|
+
# underscore characters.
|
3490
3548
|
# @return [Hash<String,String>]
|
3491
3549
|
#
|
3492
3550
|
# @!attribute [rw] references
|
3551
|
+
# A formatted URL that is shown to an agent in the Contact Control
|
3552
|
+
# Panel (CCP). Tasks can have the following reference types at the
|
3553
|
+
# time of creation: URL \| NUMBER \| STRING \| DATE \| EMAIL \|
|
3554
|
+
# ATTACHMENT.
|
3493
3555
|
# @return [Hash<String,Types::Reference>]
|
3494
3556
|
#
|
3495
3557
|
# @!attribute [rw] channel
|
3558
|
+
# The channel for the contact
|
3496
3559
|
# @return [String]
|
3497
3560
|
#
|
3498
3561
|
# @!attribute [rw] initiation_method
|
3562
|
+
# Indicates how the contact was initiated.
|
3499
3563
|
# @return [String]
|
3500
3564
|
#
|
3501
3565
|
# @!attribute [rw] expiry_duration_in_minutes
|
3566
|
+
# Number of minutes the contact will be active for before expiring
|
3502
3567
|
# @return [Integer]
|
3503
3568
|
#
|
3504
3569
|
# @!attribute [rw] user_info
|
3570
|
+
# User details for the contact
|
3505
3571
|
# @return [Types::UserInfo]
|
3506
3572
|
#
|
3507
3573
|
# @!attribute [rw] initiate_as
|
3574
|
+
# Initial state of the contact when it's created
|
3508
3575
|
# @return [String]
|
3509
3576
|
#
|
3510
3577
|
# @!attribute [rw] name
|
3578
|
+
# The name of a the contact.
|
3511
3579
|
# @return [String]
|
3512
3580
|
#
|
3513
3581
|
# @!attribute [rw] description
|
3582
|
+
# A description of the contact.
|
3514
3583
|
# @return [String]
|
3515
3584
|
#
|
3516
3585
|
# @!attribute [rw] segment_attributes
|
3586
|
+
# A set of system defined key-value pairs stored on individual contact
|
3587
|
+
# segments (unique contact ID) using an attribute map. The attributes
|
3588
|
+
# are standard Amazon Connect attributes. They can be accessed in
|
3589
|
+
# flows.
|
3590
|
+
#
|
3591
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
3592
|
+
#
|
3593
|
+
# This field can be used to set Segment Contact Expiry as a duration
|
3594
|
+
# in minutes.
|
3595
|
+
#
|
3596
|
+
# <note markdown="1"> To set contact expiry, a ValueMap must be specified containing the
|
3597
|
+
# integer number of minutes the contact will be active for before
|
3598
|
+
# expiring, with `SegmentAttributes` like \{ `
|
3599
|
+
# "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": {
|
3600
|
+
# "ValueInteger": 135}}}}`.
|
3601
|
+
#
|
3602
|
+
# </note>
|
3517
3603
|
# @return [Hash<String,Types::SegmentAttributeValue>]
|
3518
3604
|
#
|
3519
3605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactRequest AWS API Documentation
|
@@ -3537,9 +3623,11 @@ module Aws::Connect
|
|
3537
3623
|
end
|
3538
3624
|
|
3539
3625
|
# @!attribute [rw] contact_id
|
3626
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
3540
3627
|
# @return [String]
|
3541
3628
|
#
|
3542
3629
|
# @!attribute [rw] contact_arn
|
3630
|
+
# The Amazon Resource Name (ARN) of the created contact.
|
3543
3631
|
# @return [String]
|
3544
3632
|
#
|
3545
3633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactResponse AWS API Documentation
|
@@ -3552,21 +3640,42 @@ module Aws::Connect
|
|
3552
3640
|
end
|
3553
3641
|
|
3554
3642
|
# @!attribute [rw] description
|
3643
|
+
# The description of the email address.
|
3555
3644
|
# @return [String]
|
3556
3645
|
#
|
3557
3646
|
# @!attribute [rw] instance_id
|
3647
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3648
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3649
|
+
#
|
3650
|
+
#
|
3651
|
+
#
|
3652
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3558
3653
|
# @return [String]
|
3559
3654
|
#
|
3560
3655
|
# @!attribute [rw] email_address
|
3656
|
+
# The email address with the instance, in
|
3657
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
3561
3658
|
# @return [String]
|
3562
3659
|
#
|
3563
3660
|
# @!attribute [rw] display_name
|
3661
|
+
# The display name of email address
|
3564
3662
|
# @return [String]
|
3565
3663
|
#
|
3566
3664
|
# @!attribute [rw] tags
|
3665
|
+
# The tags used to organize, track, or control access for this
|
3666
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
3667
|
+
# "key2":"value2"} }.
|
3567
3668
|
# @return [Hash<String,String>]
|
3568
3669
|
#
|
3569
3670
|
# @!attribute [rw] client_token
|
3671
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
3672
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
3673
|
+
# SDK populates this field. For more information about idempotency,
|
3674
|
+
# see [Making retries safe with idempotent APIs][1].
|
3675
|
+
#
|
3676
|
+
#
|
3677
|
+
#
|
3678
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
3570
3679
|
# @return [String]
|
3571
3680
|
#
|
3572
3681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEmailAddressRequest AWS API Documentation
|
@@ -3583,9 +3692,11 @@ module Aws::Connect
|
|
3583
3692
|
end
|
3584
3693
|
|
3585
3694
|
# @!attribute [rw] email_address_id
|
3695
|
+
# The identifier of the email address.
|
3586
3696
|
# @return [String]
|
3587
3697
|
#
|
3588
3698
|
# @!attribute [rw] email_address_arn
|
3699
|
+
# The Amazon Resource Name (ARN) of the email address.
|
3589
3700
|
# @return [String]
|
3590
3701
|
#
|
3591
3702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEmailAddressResponse AWS API Documentation
|
@@ -4159,6 +4270,7 @@ module Aws::Connect
|
|
4159
4270
|
# @return [Types::OutboundCallerConfig]
|
4160
4271
|
#
|
4161
4272
|
# @!attribute [rw] outbound_email_config
|
4273
|
+
# The outbound email address ID for a specified queue.
|
4162
4274
|
# @return [Types::OutboundEmailConfig]
|
4163
4275
|
#
|
4164
4276
|
# @!attribute [rw] hours_of_operation_id
|
@@ -4547,6 +4659,8 @@ module Aws::Connect
|
|
4547
4659
|
# @return [String]
|
4548
4660
|
#
|
4549
4661
|
# @!attribute [rw] self_assign_flow_id
|
4662
|
+
# The ContactFlowId for the flow that will be run if this template is
|
4663
|
+
# used to create a self-assigned task.
|
4550
4664
|
# @return [String]
|
4551
4665
|
#
|
4552
4666
|
# @!attribute [rw] constraints
|
@@ -5545,9 +5659,16 @@ module Aws::Connect
|
|
5545
5659
|
class DeleteContactFlowResponse < Aws::EmptyStructure; end
|
5546
5660
|
|
5547
5661
|
# @!attribute [rw] instance_id
|
5662
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
5663
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
5664
|
+
#
|
5665
|
+
#
|
5666
|
+
#
|
5667
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
5548
5668
|
# @return [String]
|
5549
5669
|
#
|
5550
5670
|
# @!attribute [rw] email_address_id
|
5671
|
+
# The identifier of the email address.
|
5551
5672
|
# @return [String]
|
5552
5673
|
#
|
5553
5674
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEmailAddressRequest AWS API Documentation
|
@@ -6214,9 +6335,16 @@ module Aws::Connect
|
|
6214
6335
|
end
|
6215
6336
|
|
6216
6337
|
# @!attribute [rw] instance_id
|
6338
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
6339
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
6340
|
+
#
|
6341
|
+
#
|
6342
|
+
#
|
6343
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
6217
6344
|
# @return [String]
|
6218
6345
|
#
|
6219
6346
|
# @!attribute [rw] email_address_id
|
6347
|
+
# The identifier of the email address.
|
6220
6348
|
# @return [String]
|
6221
6349
|
#
|
6222
6350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEmailAddressRequest AWS API Documentation
|
@@ -6229,27 +6357,38 @@ module Aws::Connect
|
|
6229
6357
|
end
|
6230
6358
|
|
6231
6359
|
# @!attribute [rw] email_address_id
|
6360
|
+
# The identifier of the email address.
|
6232
6361
|
# @return [String]
|
6233
6362
|
#
|
6234
6363
|
# @!attribute [rw] email_address_arn
|
6364
|
+
# The Amazon Resource Name (ARN) of the email address.
|
6235
6365
|
# @return [String]
|
6236
6366
|
#
|
6237
6367
|
# @!attribute [rw] email_address
|
6368
|
+
# The email address with the instance, in
|
6369
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
6238
6370
|
# @return [String]
|
6239
6371
|
#
|
6240
6372
|
# @!attribute [rw] display_name
|
6373
|
+
# The display name of email address
|
6241
6374
|
# @return [String]
|
6242
6375
|
#
|
6243
6376
|
# @!attribute [rw] description
|
6377
|
+
# The description of the email address.
|
6244
6378
|
# @return [String]
|
6245
6379
|
#
|
6246
6380
|
# @!attribute [rw] create_timestamp
|
6381
|
+
# The email address creation timestamp in ISO 8601 Datetime.
|
6247
6382
|
# @return [String]
|
6248
6383
|
#
|
6249
6384
|
# @!attribute [rw] modified_timestamp
|
6385
|
+
# The email address last modification timestamp in ISO 8601 Datetime.
|
6250
6386
|
# @return [String]
|
6251
6387
|
#
|
6252
6388
|
# @!attribute [rw] tags
|
6389
|
+
# The tags used to organize, track, or control access for this
|
6390
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
6391
|
+
# "key2":"value2"} }.
|
6253
6392
|
# @return [Hash<String,String>]
|
6254
6393
|
#
|
6255
6394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEmailAddressResponse AWS API Documentation
|
@@ -7431,10 +7570,15 @@ module Aws::Connect
|
|
7431
7570
|
include Aws::Structure
|
7432
7571
|
end
|
7433
7572
|
|
7573
|
+
# Contains information about a source or destination email address
|
7574
|
+
#
|
7434
7575
|
# @!attribute [rw] email_address
|
7576
|
+
# The email address with the instance, in
|
7577
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
7435
7578
|
# @return [String]
|
7436
7579
|
#
|
7437
7580
|
# @!attribute [rw] display_name
|
7581
|
+
# The display name of email address.
|
7438
7582
|
# @return [String]
|
7439
7583
|
#
|
7440
7584
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressInfo AWS API Documentation
|
@@ -7446,19 +7590,27 @@ module Aws::Connect
|
|
7446
7590
|
include Aws::Structure
|
7447
7591
|
end
|
7448
7592
|
|
7593
|
+
# Contains information about an email address for a contact center.
|
7594
|
+
#
|
7449
7595
|
# @!attribute [rw] email_address_id
|
7596
|
+
# The identifier of the email address.
|
7450
7597
|
# @return [String]
|
7451
7598
|
#
|
7452
7599
|
# @!attribute [rw] email_address_arn
|
7600
|
+
# The Amazon Resource Name (ARN) of the email address.
|
7453
7601
|
# @return [String]
|
7454
7602
|
#
|
7455
7603
|
# @!attribute [rw] email_address
|
7604
|
+
# The email address with the instance, in
|
7605
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
7456
7606
|
# @return [String]
|
7457
7607
|
#
|
7458
7608
|
# @!attribute [rw] description
|
7609
|
+
# The description of the email address.
|
7459
7610
|
# @return [String]
|
7460
7611
|
#
|
7461
7612
|
# @!attribute [rw] display_name
|
7613
|
+
# The display name of email address.
|
7462
7614
|
# @return [String]
|
7463
7615
|
#
|
7464
7616
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressMetadata AWS API Documentation
|
@@ -7473,10 +7625,16 @@ module Aws::Connect
|
|
7473
7625
|
include Aws::Structure
|
7474
7626
|
end
|
7475
7627
|
|
7628
|
+
# The search criteria to be used to return email addresses.
|
7629
|
+
#
|
7476
7630
|
# @!attribute [rw] or_conditions
|
7631
|
+
# A list of conditions which would be applied together with an OR
|
7632
|
+
# condition.
|
7477
7633
|
# @return [Array<Types::EmailAddressSearchCriteria>]
|
7478
7634
|
#
|
7479
7635
|
# @!attribute [rw] and_conditions
|
7636
|
+
# A list of conditions which would be applied together with an AND
|
7637
|
+
# condition.
|
7480
7638
|
# @return [Array<Types::EmailAddressSearchCriteria>]
|
7481
7639
|
#
|
7482
7640
|
# @!attribute [rw] string_condition
|
@@ -7494,6 +7652,8 @@ module Aws::Connect
|
|
7494
7652
|
include Aws::Structure
|
7495
7653
|
end
|
7496
7654
|
|
7655
|
+
# Filters to be applied to search results.
|
7656
|
+
#
|
7497
7657
|
# @!attribute [rw] tag_filter
|
7498
7658
|
# An object that can be used to specify Tag conditions inside the
|
7499
7659
|
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
@@ -7514,10 +7674,15 @@ module Aws::Connect
|
|
7514
7674
|
include Aws::Structure
|
7515
7675
|
end
|
7516
7676
|
|
7677
|
+
# Information about the email attachment files.
|
7678
|
+
#
|
7517
7679
|
# @!attribute [rw] file_name
|
7680
|
+
# A case-sensitive name of the attached file being uploaded.
|
7518
7681
|
# @return [String]
|
7519
7682
|
#
|
7520
7683
|
# @!attribute [rw] s3_url
|
7684
|
+
# The pre-signed URLs for the S3 bucket where the email attachment is
|
7685
|
+
# stored.
|
7521
7686
|
# @return [String]
|
7522
7687
|
#
|
7523
7688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAttachment AWS API Documentation
|
@@ -7529,10 +7694,15 @@ module Aws::Connect
|
|
7529
7694
|
include Aws::Structure
|
7530
7695
|
end
|
7531
7696
|
|
7697
|
+
# Information about the reference when the referenceType is
|
7698
|
+
# `EMAIL_MESSAGE`. Otherwise, null.
|
7699
|
+
#
|
7532
7700
|
# @!attribute [rw] name
|
7701
|
+
# The name of the email message reference
|
7533
7702
|
# @return [String]
|
7534
7703
|
#
|
7535
7704
|
# @!attribute [rw] arn
|
7705
|
+
# The Amazon Resource Name (ARN) of the email message reference
|
7536
7706
|
# @return [String]
|
7537
7707
|
#
|
7538
7708
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailMessageReference AWS API Documentation
|
@@ -7544,10 +7714,22 @@ module Aws::Connect
|
|
7544
7714
|
include Aws::Structure
|
7545
7715
|
end
|
7546
7716
|
|
7717
|
+
# Information about the email recipient
|
7718
|
+
#
|
7547
7719
|
# @!attribute [rw] address
|
7720
|
+
# Address of the email recipient.
|
7721
|
+
#
|
7722
|
+
# Type: String
|
7723
|
+
#
|
7724
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256.
|
7548
7725
|
# @return [String]
|
7549
7726
|
#
|
7550
7727
|
# @!attribute [rw] display_name
|
7728
|
+
# Display name of the email recipient.
|
7729
|
+
#
|
7730
|
+
# Type: String
|
7731
|
+
#
|
7732
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256.
|
7551
7733
|
# @return [String]
|
7552
7734
|
#
|
7553
7735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailRecipient AWS API Documentation
|
@@ -7645,13 +7827,18 @@ module Aws::Connect
|
|
7645
7827
|
include Aws::Structure
|
7646
7828
|
end
|
7647
7829
|
|
7830
|
+
# Information about the endpoint.
|
7831
|
+
#
|
7648
7832
|
# @!attribute [rw] type
|
7833
|
+
# Type of endpoint.
|
7649
7834
|
# @return [String]
|
7650
7835
|
#
|
7651
7836
|
# @!attribute [rw] address
|
7837
|
+
# Address of the endpoint.
|
7652
7838
|
# @return [String]
|
7653
7839
|
#
|
7654
7840
|
# @!attribute [rw] display_name
|
7841
|
+
# Display name of the endpoint.
|
7655
7842
|
# @return [String]
|
7656
7843
|
#
|
7657
7844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EndpointInfo AWS API Documentation
|
@@ -8775,7 +8962,7 @@ module Aws::Connect
|
|
8775
8962
|
# Request to GetAttachedFile API.
|
8776
8963
|
#
|
8777
8964
|
# @!attribute [rw] instance_id
|
8778
|
-
# The unique identifier of the Connect instance.
|
8965
|
+
# The unique identifier of the Amazon Connect instance.
|
8779
8966
|
# @return [String]
|
8780
8967
|
#
|
8781
8968
|
# @!attribute [rw] file_id
|
@@ -8788,8 +8975,8 @@ module Aws::Connect
|
|
8788
8975
|
# @return [Integer]
|
8789
8976
|
#
|
8790
8977
|
# @!attribute [rw] associated_resource_arn
|
8791
|
-
# The resource to which the attached file is (being) uploaded to.
|
8792
|
-
# [Cases][1]
|
8978
|
+
# The resource to which the attached file is (being) uploaded to. The
|
8979
|
+
# supported resources are [Cases][1] and [Email][2].
|
8793
8980
|
#
|
8794
8981
|
# <note markdown="1"> This value must be a valid ARN.
|
8795
8982
|
#
|
@@ -8797,7 +8984,8 @@ module Aws::Connect
|
|
8797
8984
|
#
|
8798
8985
|
#
|
8799
8986
|
#
|
8800
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
8987
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
8988
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
8801
8989
|
# @return [String]
|
8802
8990
|
#
|
8803
8991
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetAttachedFileRequest AWS API Documentation
|
@@ -11142,6 +11330,8 @@ module Aws::Connect
|
|
11142
11330
|
# @return [String]
|
11143
11331
|
#
|
11144
11332
|
# @!attribute [rw] self_assign_flow_id
|
11333
|
+
# ContactFlowId for the flow that will be run if this template is used
|
11334
|
+
# to create a self-assigned task
|
11145
11335
|
# @return [String]
|
11146
11336
|
#
|
11147
11337
|
# @!attribute [rw] constraints
|
@@ -11943,10 +12133,14 @@ module Aws::Connect
|
|
11943
12133
|
include Aws::Structure
|
11944
12134
|
end
|
11945
12135
|
|
12136
|
+
# The additional TO CC recipients information of inbound email.
|
12137
|
+
#
|
11946
12138
|
# @!attribute [rw] to_addresses
|
12139
|
+
# The additional recipients information present in to list.
|
11947
12140
|
# @return [Array<Types::EmailAddressInfo>]
|
11948
12141
|
#
|
11949
12142
|
# @!attribute [rw] cc_addresses
|
12143
|
+
# The additional recipients information present in cc list.
|
11950
12144
|
# @return [Array<Types::EmailAddressInfo>]
|
11951
12145
|
#
|
11952
12146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InboundAdditionalRecipients AWS API Documentation
|
@@ -11958,10 +12152,14 @@ module Aws::Connect
|
|
11958
12152
|
include Aws::Structure
|
11959
12153
|
end
|
11960
12154
|
|
12155
|
+
# Information about email body content.
|
12156
|
+
#
|
11961
12157
|
# @!attribute [rw] message_source_type
|
12158
|
+
# The message source type, that is, `RAW`.
|
11962
12159
|
# @return [String]
|
11963
12160
|
#
|
11964
12161
|
# @!attribute [rw] raw_message
|
12162
|
+
# The raw email body content.
|
11965
12163
|
# @return [Types::InboundRawMessage]
|
11966
12164
|
#
|
11967
12165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InboundEmailContent AWS API Documentation
|
@@ -11973,16 +12171,22 @@ module Aws::Connect
|
|
11973
12171
|
include Aws::Structure
|
11974
12172
|
end
|
11975
12173
|
|
12174
|
+
# Information about the raw email body content.
|
12175
|
+
#
|
11976
12176
|
# @!attribute [rw] subject
|
12177
|
+
# The email subject.
|
11977
12178
|
# @return [String]
|
11978
12179
|
#
|
11979
12180
|
# @!attribute [rw] body
|
12181
|
+
# The email message body.
|
11980
12182
|
# @return [String]
|
11981
12183
|
#
|
11982
12184
|
# @!attribute [rw] content_type
|
12185
|
+
# Type of content, that is, `text/plain` or `text/html`.
|
11983
12186
|
# @return [String]
|
11984
12187
|
#
|
11985
12188
|
# @!attribute [rw] headers
|
12189
|
+
# Headers present in inbound email.
|
11986
12190
|
# @return [Hash<String,String>]
|
11987
12191
|
#
|
11988
12192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InboundRawMessage AWS API Documentation
|
@@ -12672,15 +12876,31 @@ module Aws::Connect
|
|
12672
12876
|
end
|
12673
12877
|
|
12674
12878
|
# @!attribute [rw] instance_id
|
12879
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
12880
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
12881
|
+
#
|
12882
|
+
#
|
12883
|
+
#
|
12884
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
12675
12885
|
# @return [String]
|
12676
12886
|
#
|
12677
12887
|
# @!attribute [rw] contact_id
|
12888
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
12678
12889
|
# @return [String]
|
12679
12890
|
#
|
12680
12891
|
# @!attribute [rw] max_results
|
12892
|
+
# The maximum number of results to return per page.
|
12893
|
+
#
|
12894
|
+
# The maximum number of results to return per page. The default
|
12895
|
+
# MaxResult size is 25.
|
12896
|
+
#
|
12897
|
+
# Valid Range: Minimum value of 1. Maximum value of 100.
|
12681
12898
|
# @return [Integer]
|
12682
12899
|
#
|
12683
12900
|
# @!attribute [rw] next_token
|
12901
|
+
# The token for the next set of results. Use the value returned in the
|
12902
|
+
# previous response in the next request to retrieve the next set of
|
12903
|
+
# results.
|
12684
12904
|
# @return [String]
|
12685
12905
|
#
|
12686
12906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAssociatedContactsRequest AWS API Documentation
|
@@ -12695,9 +12915,13 @@ module Aws::Connect
|
|
12695
12915
|
end
|
12696
12916
|
|
12697
12917
|
# @!attribute [rw] contact_summary_list
|
12918
|
+
# List of the contact summary for all the contacts in contact tree
|
12919
|
+
# associated with unique identifier.
|
12698
12920
|
# @return [Array<Types::AssociatedContactSummary>]
|
12699
12921
|
#
|
12700
12922
|
# @!attribute [rw] next_token
|
12923
|
+
# If there are additional results, this is the token for the next set
|
12924
|
+
# of results.
|
12701
12925
|
# @return [String]
|
12702
12926
|
#
|
12703
12927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAssociatedContactsResponse AWS API Documentation
|
@@ -15603,7 +15827,10 @@ module Aws::Connect
|
|
15603
15827
|
include Aws::Structure
|
15604
15828
|
end
|
15605
15829
|
|
15830
|
+
# The additional recipients information of outbound email.
|
15831
|
+
#
|
15606
15832
|
# @!attribute [rw] cc_email_addresses
|
15833
|
+
# The additional CC email address recipients information.
|
15607
15834
|
# @return [Array<Types::EmailAddressInfo>]
|
15608
15835
|
#
|
15609
15836
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundAdditionalRecipients AWS API Documentation
|
@@ -15652,7 +15879,10 @@ module Aws::Connect
|
|
15652
15879
|
include Aws::Structure
|
15653
15880
|
end
|
15654
15881
|
|
15882
|
+
# The outbound email address Id.
|
15883
|
+
#
|
15655
15884
|
# @!attribute [rw] outbound_email_address_id
|
15885
|
+
# The identifier of the email address.
|
15656
15886
|
# @return [String]
|
15657
15887
|
#
|
15658
15888
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundEmailConfig AWS API Documentation
|
@@ -15663,13 +15893,18 @@ module Aws::Connect
|
|
15663
15893
|
include Aws::Structure
|
15664
15894
|
end
|
15665
15895
|
|
15896
|
+
# Information about email body content.
|
15897
|
+
#
|
15666
15898
|
# @!attribute [rw] message_source_type
|
15899
|
+
# The message source type, that is, `RAW` or `TEMPLATE`.
|
15667
15900
|
# @return [String]
|
15668
15901
|
#
|
15669
15902
|
# @!attribute [rw] templated_message_config
|
15903
|
+
# Information about template message configuration.
|
15670
15904
|
# @return [Types::TemplatedMessageConfig]
|
15671
15905
|
#
|
15672
15906
|
# @!attribute [rw] raw_message
|
15907
|
+
# The raw email body content.
|
15673
15908
|
# @return [Types::OutboundRawMessage]
|
15674
15909
|
#
|
15675
15910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundEmailContent AWS API Documentation
|
@@ -15682,13 +15917,18 @@ module Aws::Connect
|
|
15682
15917
|
include Aws::Structure
|
15683
15918
|
end
|
15684
15919
|
|
15920
|
+
# Information about the raw email body content.
|
15921
|
+
#
|
15685
15922
|
# @!attribute [rw] subject
|
15923
|
+
# The email subject.
|
15686
15924
|
# @return [String]
|
15687
15925
|
#
|
15688
15926
|
# @!attribute [rw] body
|
15927
|
+
# The email message body.
|
15689
15928
|
# @return [String]
|
15690
15929
|
#
|
15691
15930
|
# @!attribute [rw] content_type
|
15931
|
+
# Type of content, that is, `text/plain` or `text/html`.
|
15692
15932
|
# @return [String]
|
15693
15933
|
#
|
15694
15934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundRawMessage AWS API Documentation
|
@@ -15703,8 +15943,8 @@ module Aws::Connect
|
|
15703
15943
|
|
15704
15944
|
# Thrown for analyzed content when requested OutputType was not enabled
|
15705
15945
|
# for a given contact. For example, if an OutputType.Raw was requested
|
15706
|
-
# for a contact that had `RedactedOnly` Redaction policy set in
|
15707
|
-
#
|
15946
|
+
# for a contact that had `RedactedOnly` Redaction policy set in the
|
15947
|
+
# flow.
|
15708
15948
|
#
|
15709
15949
|
# @!attribute [rw] message
|
15710
15950
|
# @return [String]
|
@@ -16406,6 +16646,7 @@ module Aws::Connect
|
|
16406
16646
|
# @return [Types::OutboundCallerConfig]
|
16407
16647
|
#
|
16408
16648
|
# @!attribute [rw] outbound_email_config
|
16649
|
+
# The outbound email address ID for a specified queue.
|
16409
16650
|
# @return [Types::OutboundEmailConfig]
|
16410
16651
|
#
|
16411
16652
|
# @!attribute [rw] hours_of_operation_id
|
@@ -17298,12 +17539,15 @@ module Aws::Connect
|
|
17298
17539
|
# @return [String]
|
17299
17540
|
#
|
17300
17541
|
# @!attribute [rw] status
|
17542
|
+
# Status of the attachment reference type.
|
17301
17543
|
# @return [String]
|
17302
17544
|
#
|
17303
17545
|
# @!attribute [rw] arn
|
17546
|
+
# The Amazon Resource Name (ARN) of the reference
|
17304
17547
|
# @return [String]
|
17305
17548
|
#
|
17306
17549
|
# @!attribute [rw] status_reason
|
17550
|
+
# Relevant details why the reference was not successfully created.
|
17307
17551
|
# @return [String]
|
17308
17552
|
#
|
17309
17553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
@@ -17335,6 +17579,8 @@ module Aws::Connect
|
|
17335
17579
|
# @return [Types::AttachmentReference]
|
17336
17580
|
#
|
17337
17581
|
# @!attribute [rw] email_message
|
17582
|
+
# Information about the reference when the referenceType is
|
17583
|
+
# `EMAIL_MESSAGE`. Otherwise, null.
|
17338
17584
|
# @return [Types::EmailMessageReference]
|
17339
17585
|
#
|
17340
17586
|
# @!attribute [rw] string
|
@@ -18513,7 +18759,7 @@ module Aws::Connect
|
|
18513
18759
|
# @return [Types::ContactFlowModuleSearchFilter]
|
18514
18760
|
#
|
18515
18761
|
# @!attribute [rw] search_criteria
|
18516
|
-
# The search criteria to be used to return
|
18762
|
+
# The search criteria to be used to return flow modules.
|
18517
18763
|
#
|
18518
18764
|
# <note markdown="1"> The `name` and `description` fields support "contains" queries
|
18519
18765
|
# with a minimum of 2 characters and a maximum of 25 characters. Any
|
@@ -18536,7 +18782,7 @@ module Aws::Connect
|
|
18536
18782
|
end
|
18537
18783
|
|
18538
18784
|
# @!attribute [rw] contact_flow_modules
|
18539
|
-
# The search criteria to be used to return
|
18785
|
+
# The search criteria to be used to return flow modules.
|
18540
18786
|
# @return [Array<Types::ContactFlowModule>]
|
18541
18787
|
#
|
18542
18788
|
# @!attribute [rw] next_token
|
@@ -18545,7 +18791,7 @@ module Aws::Connect
|
|
18545
18791
|
# @return [String]
|
18546
18792
|
#
|
18547
18793
|
# @!attribute [rw] approximate_total_count
|
18548
|
-
# The total number of
|
18794
|
+
# The total number of flows which matched your search query.
|
18549
18795
|
# @return [Integer]
|
18550
18796
|
#
|
18551
18797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlowModulesResponse AWS API Documentation
|
@@ -18610,7 +18856,7 @@ module Aws::Connect
|
|
18610
18856
|
# @return [String]
|
18611
18857
|
#
|
18612
18858
|
# @!attribute [rw] approximate_total_count
|
18613
|
-
# The total number of
|
18859
|
+
# The total number of flows which matched your search query.
|
18614
18860
|
# @return [Integer]
|
18615
18861
|
#
|
18616
18862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlowsResponse AWS API Documentation
|
@@ -18757,6 +19003,8 @@ module Aws::Connect
|
|
18757
19003
|
# @return [Types::SearchableContactAttributes]
|
18758
19004
|
#
|
18759
19005
|
# @!attribute [rw] searchable_segment_attributes
|
19006
|
+
# The search criteria based on searchable segment attributes of a
|
19007
|
+
# contact.
|
18760
19008
|
# @return [Types::SearchableSegmentAttributes]
|
18761
19009
|
#
|
18762
19010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchCriteria AWS API Documentation
|
@@ -18775,18 +19023,30 @@ module Aws::Connect
|
|
18775
19023
|
end
|
18776
19024
|
|
18777
19025
|
# @!attribute [rw] instance_id
|
19026
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
19027
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
19028
|
+
#
|
19029
|
+
#
|
19030
|
+
#
|
19031
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
18778
19032
|
# @return [String]
|
18779
19033
|
#
|
18780
19034
|
# @!attribute [rw] max_results
|
19035
|
+
# The maximum number of results to return per page.
|
18781
19036
|
# @return [Integer]
|
18782
19037
|
#
|
18783
19038
|
# @!attribute [rw] next_token
|
19039
|
+
# The token for the next set of results. Use the value returned in the
|
19040
|
+
# previous response in the next request to retrieve the next set of
|
19041
|
+
# results.
|
18784
19042
|
# @return [String]
|
18785
19043
|
#
|
18786
19044
|
# @!attribute [rw] search_criteria
|
19045
|
+
# The search criteria to be used to return email addresses.
|
18787
19046
|
# @return [Types::EmailAddressSearchCriteria]
|
18788
19047
|
#
|
18789
19048
|
# @!attribute [rw] search_filter
|
19049
|
+
# Filters to be applied to search results.
|
18790
19050
|
# @return [Types::EmailAddressSearchFilter]
|
18791
19051
|
#
|
18792
19052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEmailAddressesRequest AWS API Documentation
|
@@ -18802,12 +19062,16 @@ module Aws::Connect
|
|
18802
19062
|
end
|
18803
19063
|
|
18804
19064
|
# @!attribute [rw] next_token
|
19065
|
+
# If there are additional results, this is the token for the next set
|
19066
|
+
# of results.
|
18805
19067
|
# @return [String]
|
18806
19068
|
#
|
18807
19069
|
# @!attribute [rw] email_addresses
|
19070
|
+
# List of email addresses matching SearchFilter and SearchCriteria
|
18808
19071
|
# @return [Array<Types::EmailAddressMetadata>]
|
18809
19072
|
#
|
18810
19073
|
# @!attribute [rw] approximate_total_count
|
19074
|
+
# The total number of email addresses which matched your search query.
|
18811
19075
|
# @return [Integer]
|
18812
19076
|
#
|
18813
19077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEmailAddressesResponse AWS API Documentation
|
@@ -19570,7 +19834,7 @@ module Aws::Connect
|
|
19570
19834
|
include Aws::Structure
|
19571
19835
|
end
|
19572
19836
|
|
19573
|
-
# The search criteria based on user-
|
19837
|
+
# The search criteria based on user-defined contact attribute key and
|
19574
19838
|
# values to search on.
|
19575
19839
|
#
|
19576
19840
|
# @!attribute [rw] key
|
@@ -19591,10 +19855,16 @@ module Aws::Connect
|
|
19591
19855
|
include Aws::Structure
|
19592
19856
|
end
|
19593
19857
|
|
19858
|
+
# The search criteria based on searchable segment attributes of a
|
19859
|
+
# contact
|
19860
|
+
#
|
19594
19861
|
# @!attribute [rw] criteria
|
19862
|
+
# The list of criteria based on searchable segment attributes.
|
19595
19863
|
# @return [Array<Types::SearchableSegmentAttributesCriteria>]
|
19596
19864
|
#
|
19597
19865
|
# @!attribute [rw] match_type
|
19866
|
+
# The match type combining search criteria using multiple searchable
|
19867
|
+
# segment attributes.
|
19598
19868
|
# @return [String]
|
19599
19869
|
#
|
19600
19870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableSegmentAttributes AWS API Documentation
|
@@ -19606,10 +19876,16 @@ module Aws::Connect
|
|
19606
19876
|
include Aws::Structure
|
19607
19877
|
end
|
19608
19878
|
|
19879
|
+
# The search criteria based on searchable segment attribute key and
|
19880
|
+
# values to search on.
|
19881
|
+
#
|
19609
19882
|
# @!attribute [rw] key
|
19883
|
+
# The key containing a searchable segment attribute.
|
19610
19884
|
# @return [String]
|
19611
19885
|
#
|
19612
19886
|
# @!attribute [rw] values
|
19887
|
+
# The list of values to search for within a searchable segment
|
19888
|
+
# attribute.
|
19613
19889
|
# @return [Array<String>]
|
19614
19890
|
#
|
19615
19891
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableSegmentAttributesCriteria AWS API Documentation
|
@@ -19861,10 +20137,20 @@ module Aws::Connect
|
|
19861
20137
|
# The value of a segment attribute.
|
19862
20138
|
# @return [String]
|
19863
20139
|
#
|
20140
|
+
# @!attribute [rw] value_map
|
20141
|
+
# The value of a segment attribute.
|
20142
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
20143
|
+
#
|
20144
|
+
# @!attribute [rw] value_integer
|
20145
|
+
# The value of a segment attribute.
|
20146
|
+
# @return [Integer]
|
20147
|
+
#
|
19864
20148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SegmentAttributeValue AWS API Documentation
|
19865
20149
|
#
|
19866
20150
|
class SegmentAttributeValue < Struct.new(
|
19867
|
-
:value_string
|
20151
|
+
:value_string,
|
20152
|
+
:value_map,
|
20153
|
+
:value_integer)
|
19868
20154
|
SENSITIVE = []
|
19869
20155
|
include Aws::Structure
|
19870
20156
|
end
|
@@ -19978,29 +20264,50 @@ module Aws::Connect
|
|
19978
20264
|
end
|
19979
20265
|
|
19980
20266
|
# @!attribute [rw] instance_id
|
20267
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
20268
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
20269
|
+
#
|
20270
|
+
#
|
20271
|
+
#
|
20272
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
19981
20273
|
# @return [String]
|
19982
20274
|
#
|
19983
20275
|
# @!attribute [rw] from_email_address
|
20276
|
+
# The email address to be used for sending email.
|
19984
20277
|
# @return [Types::EmailAddressInfo]
|
19985
20278
|
#
|
19986
20279
|
# @!attribute [rw] destination_email_address
|
20280
|
+
# The email address to send the email to.
|
19987
20281
|
# @return [Types::EmailAddressInfo]
|
19988
20282
|
#
|
19989
20283
|
# @!attribute [rw] additional_recipients
|
20284
|
+
# The additional recipients address of the email in CC.
|
19990
20285
|
# @return [Types::OutboundAdditionalRecipients]
|
19991
20286
|
#
|
19992
20287
|
# @!attribute [rw] email_message
|
20288
|
+
# The email message body to be sent to the newly created email.
|
19993
20289
|
# @return [Types::OutboundEmailContent]
|
19994
20290
|
#
|
19995
20291
|
# @!attribute [rw] traffic_type
|
20292
|
+
# Denotes the class of traffic.
|
19996
20293
|
# @return [String]
|
19997
20294
|
#
|
19998
20295
|
# @!attribute [rw] source_campaign
|
20296
|
+
# A Campaign object need for Campaign traffic type.
|
19999
20297
|
# @return [Types::SourceCampaign]
|
20000
20298
|
#
|
20001
20299
|
# @!attribute [rw] client_token
|
20300
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
20301
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
20302
|
+
# SDK populates this field. For more information about idempotency,
|
20303
|
+
# see [Making retries safe with idempotent APIs][1].
|
20304
|
+
#
|
20002
20305
|
# **A suitable default value is auto-generated.** You should normally
|
20003
20306
|
# not need to pass this option.
|
20307
|
+
#
|
20308
|
+
#
|
20309
|
+
#
|
20310
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
20004
20311
|
# @return [String]
|
20005
20312
|
#
|
20006
20313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundEmailRequest AWS API Documentation
|
@@ -20028,6 +20335,7 @@ module Aws::Connect
|
|
20028
20335
|
# @return [String]
|
20029
20336
|
#
|
20030
20337
|
# @!attribute [rw] reason
|
20338
|
+
# The reason for the exception.
|
20031
20339
|
# @return [Types::ServiceQuotaExceededExceptionReason]
|
20032
20340
|
#
|
20033
20341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ServiceQuotaExceededException AWS API Documentation
|
@@ -20039,7 +20347,11 @@ module Aws::Connect
|
|
20039
20347
|
include Aws::Structure
|
20040
20348
|
end
|
20041
20349
|
|
20350
|
+
# The reason for the exception.
|
20351
|
+
#
|
20042
20352
|
# @!attribute [rw] attached_file_service_quota_exceeded_exception_reason
|
20353
|
+
# Total file size of all files or total number of files exceeds the
|
20354
|
+
# service quota
|
20043
20355
|
# @return [String]
|
20044
20356
|
#
|
20045
20357
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ServiceQuotaExceededExceptionReason AWS API Documentation
|
@@ -20139,10 +20451,14 @@ module Aws::Connect
|
|
20139
20451
|
include Aws::Structure
|
20140
20452
|
end
|
20141
20453
|
|
20454
|
+
# Information about the campaign.
|
20455
|
+
#
|
20142
20456
|
# @!attribute [rw] campaign_id
|
20457
|
+
# A unique identifier for a campaign.
|
20143
20458
|
# @return [String]
|
20144
20459
|
#
|
20145
20460
|
# @!attribute [rw] outbound_request_id
|
20461
|
+
# A unique identifier for a each request part of same campaign.
|
20146
20462
|
# @return [String]
|
20147
20463
|
#
|
20148
20464
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SourceCampaign AWS API Documentation
|
@@ -20187,11 +20503,13 @@ module Aws::Connect
|
|
20187
20503
|
#
|
20188
20504
|
# @!attribute [rw] file_use_case_type
|
20189
20505
|
# The use case for the file.
|
20506
|
+
#
|
20507
|
+
# Only `ATTACHMENTS` are supported.
|
20190
20508
|
# @return [String]
|
20191
20509
|
#
|
20192
20510
|
# @!attribute [rw] associated_resource_arn
|
20193
|
-
# The resource to which the attached file is (being) uploaded to.
|
20194
|
-
# [Cases][1]
|
20511
|
+
# The resource to which the attached file is (being) uploaded to. The
|
20512
|
+
# supported resources are [Cases][1] and [Email][2].
|
20195
20513
|
#
|
20196
20514
|
# <note markdown="1"> This value must be a valid ARN.
|
20197
20515
|
#
|
@@ -20199,7 +20517,8 @@ module Aws::Connect
|
|
20199
20517
|
#
|
20200
20518
|
#
|
20201
20519
|
#
|
20202
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
20520
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html
|
20521
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html
|
20203
20522
|
# @return [String]
|
20204
20523
|
#
|
20205
20524
|
# @!attribute [rw] created_by
|
@@ -20281,8 +20600,8 @@ module Aws::Connect
|
|
20281
20600
|
# @!attribute [rw] contact_flow_id
|
20282
20601
|
# The identifier of the flow for initiating the chat. To see the
|
20283
20602
|
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
20284
|
-
# menu go to **Routing**, **
|
20285
|
-
#
|
20603
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow
|
20604
|
+
# page, under the name of the flow, choose **Show additional flow
|
20286
20605
|
# information**. The ContactFlowId is the last part of the ARN, shown
|
20287
20606
|
# here in bold:
|
20288
20607
|
#
|
@@ -20598,47 +20917,112 @@ module Aws::Connect
|
|
20598
20917
|
end
|
20599
20918
|
|
20600
20919
|
# @!attribute [rw] instance_id
|
20920
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
20921
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
20922
|
+
#
|
20923
|
+
#
|
20924
|
+
#
|
20925
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
20601
20926
|
# @return [String]
|
20602
20927
|
#
|
20603
20928
|
# @!attribute [rw] from_email_address
|
20929
|
+
# The email address of the customer.
|
20604
20930
|
# @return [Types::EmailAddressInfo]
|
20605
20931
|
#
|
20606
20932
|
# @!attribute [rw] destination_email_address
|
20933
|
+
# The email address associated with the instance.
|
20607
20934
|
# @return [String]
|
20608
20935
|
#
|
20609
20936
|
# @!attribute [rw] description
|
20937
|
+
# A description of the email contact.
|
20610
20938
|
# @return [String]
|
20611
20939
|
#
|
20612
20940
|
# @!attribute [rw] references
|
20941
|
+
# A formatted URL that is shown to an agent in the Contact Control
|
20942
|
+
# Panel (CCP). Emails can have the following reference types at the
|
20943
|
+
# time of creation: `URL` \| `NUMBER` \| `STRING` \| `DATE`. `EMAIL`
|
20944
|
+
# \| `EMAIL_MESSAGE` \|`ATTACHMENT` are not a supported reference type
|
20945
|
+
# during email creation.
|
20613
20946
|
# @return [Hash<String,Types::Reference>]
|
20614
20947
|
#
|
20615
20948
|
# @!attribute [rw] name
|
20949
|
+
# The name of a email that is shown to an agent in the Contact Control
|
20950
|
+
# Panel (CCP).
|
20616
20951
|
# @return [String]
|
20617
20952
|
#
|
20618
20953
|
# @!attribute [rw] email_message
|
20954
|
+
# The email message body to be sent to the newly created email.
|
20619
20955
|
# @return [Types::InboundEmailContent]
|
20620
20956
|
#
|
20621
20957
|
# @!attribute [rw] additional_recipients
|
20958
|
+
# The addtional recipients address of the email.
|
20622
20959
|
# @return [Types::InboundAdditionalRecipients]
|
20623
20960
|
#
|
20624
20961
|
# @!attribute [rw] attachments
|
20962
|
+
# List of S3 presigned URLs of email attachments and their file name.
|
20625
20963
|
# @return [Array<Types::EmailAttachment>]
|
20626
20964
|
#
|
20627
20965
|
# @!attribute [rw] contact_flow_id
|
20966
|
+
# The identifier of the flow for initiating the emails. To see the
|
20967
|
+
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
20968
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow
|
20969
|
+
# page, under the name of the flow, choose **Show additional flow
|
20970
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
20971
|
+
# here in bold:
|
20972
|
+
#
|
20973
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
20628
20974
|
# @return [String]
|
20629
20975
|
#
|
20630
20976
|
# @!attribute [rw] related_contact_id
|
20977
|
+
# The contactId that is related to this contact. Linking emails
|
20978
|
+
# together by using `RelatedContactID` copies over contact attributes
|
20979
|
+
# from the related email contact to the new email contact. All updates
|
20980
|
+
# to user-defined attributes in the new email contact are limited to
|
20981
|
+
# the individual contact ID. There are no limits to the number of
|
20982
|
+
# contacts that can be linked by using `RelatedContactId`.
|
20631
20983
|
# @return [String]
|
20632
20984
|
#
|
20633
20985
|
# @!attribute [rw] attributes
|
20986
|
+
# A custom key-value pair using an attribute map. The attributes are
|
20987
|
+
# standard Amazon Connect attributes, and can be accessed in flows
|
20988
|
+
# just like any other contact attributes.
|
20989
|
+
#
|
20990
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
20991
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
20992
|
+
# underscore characters.
|
20634
20993
|
# @return [Hash<String,String>]
|
20635
20994
|
#
|
20636
20995
|
# @!attribute [rw] segment_attributes
|
20996
|
+
# A set of system defined key-value pairs stored on individual contact
|
20997
|
+
# segments using an attribute map. The attributes are standard Amazon
|
20998
|
+
# Connect attributes. They can be accessed in flows.
|
20999
|
+
#
|
21000
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
21001
|
+
#
|
21002
|
+
# This field can be used to show channel subtype, such as
|
21003
|
+
# `connect:Guide`.
|
21004
|
+
#
|
21005
|
+
# <note markdown="1"> To set contact expiry, a `ValueMap` must be specified containing the
|
21006
|
+
# integer number of minutes the contact will be active for before
|
21007
|
+
# expiring, with `SegmentAttributes` like \{ `
|
21008
|
+
# "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": {
|
21009
|
+
# "ValueInteger":135}}}}`.
|
21010
|
+
#
|
21011
|
+
# </note>
|
20637
21012
|
# @return [Hash<String,Types::SegmentAttributeValue>]
|
20638
21013
|
#
|
20639
21014
|
# @!attribute [rw] client_token
|
21015
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
21016
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
21017
|
+
# SDK populates this field. For more information about idempotency,
|
21018
|
+
# see [Making retries safe with idempotent APIs][1].
|
21019
|
+
#
|
20640
21020
|
# **A suitable default value is auto-generated.** You should normally
|
20641
21021
|
# not need to pass this option.
|
21022
|
+
#
|
21023
|
+
#
|
21024
|
+
#
|
21025
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
20642
21026
|
# @return [String]
|
20643
21027
|
#
|
20644
21028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEmailContactRequest AWS API Documentation
|
@@ -20663,6 +21047,7 @@ module Aws::Connect
|
|
20663
21047
|
end
|
20664
21048
|
|
20665
21049
|
# @!attribute [rw] contact_id
|
21050
|
+
# The identifier of this contact within the Amazon Connect instance.
|
20666
21051
|
# @return [String]
|
20667
21052
|
#
|
20668
21053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEmailContactResponse AWS API Documentation
|
@@ -20808,26 +21193,46 @@ module Aws::Connect
|
|
20808
21193
|
end
|
20809
21194
|
|
20810
21195
|
# @!attribute [rw] instance_id
|
21196
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
21197
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
21198
|
+
#
|
21199
|
+
#
|
21200
|
+
#
|
21201
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
20811
21202
|
# @return [String]
|
20812
21203
|
#
|
20813
21204
|
# @!attribute [rw] contact_id
|
21205
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
20814
21206
|
# @return [String]
|
20815
21207
|
#
|
20816
21208
|
# @!attribute [rw] from_email_address
|
21209
|
+
# The email address associated with the instance.
|
20817
21210
|
# @return [Types::EmailAddressInfo]
|
20818
21211
|
#
|
20819
21212
|
# @!attribute [rw] destination_email_address
|
21213
|
+
# The email address of the customer.
|
20820
21214
|
# @return [Types::EmailAddressInfo]
|
20821
21215
|
#
|
20822
21216
|
# @!attribute [rw] additional_recipients
|
21217
|
+
# The addtional recipients address of email in CC.
|
20823
21218
|
# @return [Types::OutboundAdditionalRecipients]
|
20824
21219
|
#
|
20825
21220
|
# @!attribute [rw] email_message
|
21221
|
+
# The email message body to be sent to the newly created email.
|
20826
21222
|
# @return [Types::OutboundEmailContent]
|
20827
21223
|
#
|
20828
21224
|
# @!attribute [rw] client_token
|
21225
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
21226
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
21227
|
+
# SDK populates this field. For more information about idempotency,
|
21228
|
+
# see [Making retries safe with idempotent APIs][1].
|
21229
|
+
#
|
20829
21230
|
# **A suitable default value is auto-generated.** You should normally
|
20830
21231
|
# not need to pass this option.
|
21232
|
+
#
|
21233
|
+
#
|
21234
|
+
#
|
21235
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
20831
21236
|
# @return [String]
|
20832
21237
|
#
|
20833
21238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundEmailContactRequest AWS API Documentation
|
@@ -20845,6 +21250,7 @@ module Aws::Connect
|
|
20845
21250
|
end
|
20846
21251
|
|
20847
21252
|
# @!attribute [rw] contact_id
|
21253
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
20848
21254
|
# @return [String]
|
20849
21255
|
#
|
20850
21256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundEmailContactResponse AWS API Documentation
|
@@ -21054,8 +21460,8 @@ module Aws::Connect
|
|
21054
21460
|
# @!attribute [rw] contact_flow_id
|
21055
21461
|
# The identifier of the flow for initiating the tasks. To see the
|
21056
21462
|
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
21057
|
-
# menu go to **Routing**, **
|
21058
|
-
#
|
21463
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow
|
21464
|
+
# page, under the name of the flow, choose **Show additional flow
|
21059
21465
|
# information**. The ContactFlowId is the last part of the ARN, shown
|
21060
21466
|
# here in bold:
|
21061
21467
|
#
|
@@ -21146,6 +21552,28 @@ module Aws::Connect
|
|
21146
21552
|
# @return [String]
|
21147
21553
|
#
|
21148
21554
|
# @!attribute [rw] segment_attributes
|
21555
|
+
# A set of system defined key-value pairs stored on individual contact
|
21556
|
+
# segments (unique contact ID) using an attribute map. The attributes
|
21557
|
+
# are standard Amazon Connect attributes. They can be accessed in
|
21558
|
+
# flows.
|
21559
|
+
#
|
21560
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
21561
|
+
#
|
21562
|
+
# This field can be used to set Contact Expiry as a duration in
|
21563
|
+
# minutes and set a UserId for the User who created a task.
|
21564
|
+
#
|
21565
|
+
# <note markdown="1"> To set contact expiry, a ValueMap must be specified containing the
|
21566
|
+
# integer number of minutes the contact will be active for before
|
21567
|
+
# expiring, with `SegmentAttributes` like \{ `
|
21568
|
+
# "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": {
|
21569
|
+
# "ValueInteger": 135}}}}`.
|
21570
|
+
#
|
21571
|
+
# To set the created by user, a valid AgentResourceId must be
|
21572
|
+
# supplied, with `SegmentAttributes` like \{ `"connect:CreatedByUser"
|
21573
|
+
# { "ValueString":
|
21574
|
+
# "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}`.
|
21575
|
+
#
|
21576
|
+
# </note>
|
21149
21577
|
# @return [Hash<String,Types::SegmentAttributeValue>]
|
21150
21578
|
#
|
21151
21579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
@@ -21913,10 +22341,20 @@ module Aws::Connect
|
|
21913
22341
|
include Aws::Structure
|
21914
22342
|
end
|
21915
22343
|
|
22344
|
+
# Information about the template attributes.
|
22345
|
+
#
|
21916
22346
|
# @!attribute [rw] custom_attributes
|
22347
|
+
# An object that specifies the custom attributes values to use for
|
22348
|
+
# variables in the message template. This object contains different
|
22349
|
+
# categories of key-value pairs. Each key defines a variable or
|
22350
|
+
# placeholder in the message template.
|
21917
22351
|
# @return [Hash<String,String>]
|
21918
22352
|
#
|
21919
22353
|
# @!attribute [rw] customer_profile_attributes
|
22354
|
+
# An object that specifies the customer profile attributes values to
|
22355
|
+
# use for variables in the message template. This object contains
|
22356
|
+
# different categories of key-value pairs. Each key defines a variable
|
22357
|
+
# or placeholder in the message template.
|
21920
22358
|
# @return [String]
|
21921
22359
|
#
|
21922
22360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TemplateAttributes AWS API Documentation
|
@@ -21928,13 +22366,20 @@ module Aws::Connect
|
|
21928
22366
|
include Aws::Structure
|
21929
22367
|
end
|
21930
22368
|
|
22369
|
+
# Information about template message configuration.
|
22370
|
+
#
|
21931
22371
|
# @!attribute [rw] knowledge_base_id
|
22372
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
22373
|
+
# ARN. URLs cannot contain the ARN.
|
21932
22374
|
# @return [String]
|
21933
22375
|
#
|
21934
22376
|
# @!attribute [rw] message_template_id
|
22377
|
+
# The identifier of the message template Id.
|
21935
22378
|
# @return [String]
|
21936
22379
|
#
|
21937
22380
|
# @!attribute [rw] template_attributes
|
22381
|
+
# Information about template attributes, that is, CustomAttributes or
|
22382
|
+
# CustomerProfileAttributes.
|
21938
22383
|
# @return [Types::TemplateAttributes]
|
21939
22384
|
#
|
21940
22385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TemplatedMessageConfig AWS API Documentation
|
@@ -22812,6 +23257,18 @@ module Aws::Connect
|
|
22812
23257
|
# @return [Hash<String,Types::Reference>]
|
22813
23258
|
#
|
22814
23259
|
# @!attribute [rw] segment_attributes
|
23260
|
+
# A set of system defined key-value pairs stored on individual contact
|
23261
|
+
# segments (unique contact ID) using an attribute map. The attributes
|
23262
|
+
# are standard Amazon Connect attributes. They can be accessed in
|
23263
|
+
# flows.
|
23264
|
+
#
|
23265
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
23266
|
+
#
|
23267
|
+
# This field can be used to show channel subtype, such as
|
23268
|
+
# `connect:Guide`.
|
23269
|
+
#
|
23270
|
+
# Currently Contact Expiry is the only segment attribute which can be
|
23271
|
+
# updated by using the UpdateContact API.
|
22815
23272
|
# @return [Hash<String,Types::SegmentAttributeValue>]
|
22816
23273
|
#
|
22817
23274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRequest AWS API Documentation
|
@@ -22913,18 +23370,35 @@ module Aws::Connect
|
|
22913
23370
|
class UpdateContactScheduleResponse < Aws::EmptyStructure; end
|
22914
23371
|
|
22915
23372
|
# @!attribute [rw] instance_id
|
23373
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
23374
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
23375
|
+
#
|
23376
|
+
#
|
23377
|
+
#
|
23378
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
22916
23379
|
# @return [String]
|
22917
23380
|
#
|
22918
23381
|
# @!attribute [rw] email_address_id
|
23382
|
+
# The identifier of the email address.
|
22919
23383
|
# @return [String]
|
22920
23384
|
#
|
22921
23385
|
# @!attribute [rw] description
|
23386
|
+
# The description of the email address.
|
22922
23387
|
# @return [String]
|
22923
23388
|
#
|
22924
23389
|
# @!attribute [rw] display_name
|
23390
|
+
# The display name of email address.
|
22925
23391
|
# @return [String]
|
22926
23392
|
#
|
22927
23393
|
# @!attribute [rw] client_token
|
23394
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
23395
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
23396
|
+
# SDK populates this field. For more information about idempotency,
|
23397
|
+
# see [Making retries safe with idempotent APIs][1].
|
23398
|
+
#
|
23399
|
+
#
|
23400
|
+
#
|
23401
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
22928
23402
|
# @return [String]
|
22929
23403
|
#
|
22930
23404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadataRequest AWS API Documentation
|
@@ -22940,9 +23414,11 @@ module Aws::Connect
|
|
22940
23414
|
end
|
22941
23415
|
|
22942
23416
|
# @!attribute [rw] email_address_id
|
23417
|
+
# The identifier of the email address.
|
22943
23418
|
# @return [String]
|
22944
23419
|
#
|
22945
23420
|
# @!attribute [rw] email_address_arn
|
23421
|
+
# The Amazon Resource Name (ARN) of the email address.
|
22946
23422
|
# @return [String]
|
22947
23423
|
#
|
22948
23424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadataResponse AWS API Documentation
|
@@ -23498,12 +23974,20 @@ module Aws::Connect
|
|
23498
23974
|
end
|
23499
23975
|
|
23500
23976
|
# @!attribute [rw] instance_id
|
23977
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
23978
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
23979
|
+
#
|
23980
|
+
#
|
23981
|
+
#
|
23982
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
23501
23983
|
# @return [String]
|
23502
23984
|
#
|
23503
23985
|
# @!attribute [rw] queue_id
|
23986
|
+
# The identifier for the queue.
|
23504
23987
|
# @return [String]
|
23505
23988
|
#
|
23506
23989
|
# @!attribute [rw] outbound_email_config
|
23990
|
+
# The outbound email address ID for a specified queue.
|
23507
23991
|
# @return [Types::OutboundEmailConfig]
|
23508
23992
|
#
|
23509
23993
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundEmailConfigRequest AWS API Documentation
|
@@ -23888,6 +24372,8 @@ module Aws::Connect
|
|
23888
24372
|
# @return [String]
|
23889
24373
|
#
|
23890
24374
|
# @!attribute [rw] self_assign_flow_id
|
24375
|
+
# The ContactFlowId for the flow that will be run if this template is
|
24376
|
+
# used to create a self-assigned task.
|
23891
24377
|
# @return [String]
|
23892
24378
|
#
|
23893
24379
|
# @!attribute [rw] constraints
|
@@ -23958,6 +24444,8 @@ module Aws::Connect
|
|
23958
24444
|
# @return [String]
|
23959
24445
|
#
|
23960
24446
|
# @!attribute [rw] self_assign_flow_id
|
24447
|
+
# The ContactFlowId for the flow that will be run if this template is
|
24448
|
+
# used to create a self-assigned task.
|
23961
24449
|
# @return [String]
|
23962
24450
|
#
|
23963
24451
|
# @!attribute [rw] constraints
|
@@ -24706,7 +25194,10 @@ module Aws::Connect
|
|
24706
25194
|
include Aws::Structure
|
24707
25195
|
end
|
24708
25196
|
|
25197
|
+
# The user details for the contact.
|
25198
|
+
#
|
24709
25199
|
# @!attribute [rw] user_id
|
25200
|
+
# The user identifier for the contact.
|
24710
25201
|
# @return [String]
|
24711
25202
|
#
|
24712
25203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserInfo AWS API Documentation
|