aws-sdk-connect 1.185.0 → 1.187.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +1196 -103
- data/lib/aws-sdk-connect/client_api.rb +549 -2
- data/lib/aws-sdk-connect/errors.rb +21 -0
- data/lib/aws-sdk-connect/types.rb +1726 -199
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +415 -47
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +407 -40
- metadata +2 -2
@@ -88,6 +88,25 @@ module Aws::Connect
|
|
88
88
|
include Aws::Structure
|
89
89
|
end
|
90
90
|
|
91
|
+
# List of additional email addresses for an email contact.
|
92
|
+
#
|
93
|
+
# @!attribute [rw] to_list
|
94
|
+
# List of additional TO email recipients for an email contact.
|
95
|
+
# @return [Array<Types::EmailRecipient>]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] cc_list
|
98
|
+
# List of additional CC email recipients for an email contact.
|
99
|
+
# @return [Array<Types::EmailRecipient>]
|
100
|
+
#
|
101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AdditionalEmailRecipients AWS API Documentation
|
102
|
+
#
|
103
|
+
class AdditionalEmailRecipients < Struct.new(
|
104
|
+
:to_list,
|
105
|
+
:cc_list)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
91
110
|
# The distribution of agents between the instance and its replica(s).
|
92
111
|
#
|
93
112
|
# @!attribute [rw] distributions
|
@@ -1047,6 +1066,64 @@ module Aws::Connect
|
|
1047
1066
|
include Aws::Structure
|
1048
1067
|
end
|
1049
1068
|
|
1069
|
+
# Contact summary of a contact in contact tree associated with unique
|
1070
|
+
# identifier.
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] contact_id
|
1073
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] contact_arn
|
1077
|
+
# The Amazon Resource Name (ARN) of the contact
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] initiation_timestamp
|
1081
|
+
# The date and time this contact was initiated, in UTC time.
|
1082
|
+
# @return [Time]
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] disconnect_timestamp
|
1085
|
+
# The timestamp when the customer endpoint disconnected from Amazon
|
1086
|
+
# Connect.
|
1087
|
+
# @return [Time]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] initial_contact_id
|
1090
|
+
# If this contact is related to other contacts, this is the ID of the
|
1091
|
+
# initial contact.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] previous_contact_id
|
1095
|
+
# If this contact is not the first contact, this is the ID of the
|
1096
|
+
# previous contact.
|
1097
|
+
# @return [String]
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] related_contact_id
|
1100
|
+
# The contactId that is related to this contact.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] initiation_method
|
1104
|
+
# Indicates how the contact was initiated.
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @!attribute [rw] channel
|
1108
|
+
# How the contact reached your contact center.
|
1109
|
+
# @return [String]
|
1110
|
+
#
|
1111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociatedContactSummary AWS API Documentation
|
1112
|
+
#
|
1113
|
+
class AssociatedContactSummary < Struct.new(
|
1114
|
+
:contact_id,
|
1115
|
+
:contact_arn,
|
1116
|
+
:initiation_timestamp,
|
1117
|
+
:disconnect_timestamp,
|
1118
|
+
:initial_contact_id,
|
1119
|
+
:previous_contact_id,
|
1120
|
+
:related_contact_id,
|
1121
|
+
:initiation_method,
|
1122
|
+
:channel)
|
1123
|
+
SENSITIVE = []
|
1124
|
+
include Aws::Structure
|
1125
|
+
end
|
1126
|
+
|
1050
1127
|
# Information about the attached file.
|
1051
1128
|
#
|
1052
1129
|
# @!attribute [rw] creation_time
|
@@ -1159,12 +1236,17 @@ module Aws::Connect
|
|
1159
1236
|
# Status of the attachment reference type.
|
1160
1237
|
# @return [String]
|
1161
1238
|
#
|
1239
|
+
# @!attribute [rw] arn
|
1240
|
+
# The Amazon Resource Name (ARN) of the attachment reference.
|
1241
|
+
# @return [String]
|
1242
|
+
#
|
1162
1243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation
|
1163
1244
|
#
|
1164
1245
|
class AttachmentReference < Struct.new(
|
1165
1246
|
:name,
|
1166
1247
|
:value,
|
1167
|
-
:status
|
1248
|
+
:status,
|
1249
|
+
:arn)
|
1168
1250
|
SENSITIVE = []
|
1169
1251
|
include Aws::Structure
|
1170
1252
|
end
|
@@ -1596,8 +1678,8 @@ module Aws::Connect
|
|
1596
1678
|
# @return [String]
|
1597
1679
|
#
|
1598
1680
|
# @!attribute [rw] associated_resource_arn
|
1599
|
-
# The resource to which the attached file is (being) uploaded to.
|
1600
|
-
# [Cases][1]
|
1681
|
+
# The resource to which the attached file is (being) uploaded to. The
|
1682
|
+
# supported resources are [Cases][1] and [Email][2].
|
1601
1683
|
#
|
1602
1684
|
# <note markdown="1"> This value must be a valid ARN.
|
1603
1685
|
#
|
@@ -1605,7 +1687,8 @@ module Aws::Connect
|
|
1605
1687
|
#
|
1606
1688
|
#
|
1607
1689
|
#
|
1608
|
-
# [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
|
1609
1692
|
# @return [String]
|
1610
1693
|
#
|
1611
1694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchGetAttachedFileMetadataRequest AWS API Documentation
|
@@ -2080,8 +2163,8 @@ module Aws::Connect
|
|
2080
2163
|
# @return [String]
|
2081
2164
|
#
|
2082
2165
|
# @!attribute [rw] associated_resource_arn
|
2083
|
-
# The resource to which the attached file is (being) uploaded to.
|
2084
|
-
# [Cases][1]
|
2166
|
+
# The resource to which the attached file is (being) uploaded to. The
|
2167
|
+
# supported resources are [Cases][1] and [Email][2].
|
2085
2168
|
#
|
2086
2169
|
# <note markdown="1"> This value must be a valid ARN.
|
2087
2170
|
#
|
@@ -2089,7 +2172,8 @@ module Aws::Connect
|
|
2089
2172
|
#
|
2090
2173
|
#
|
2091
2174
|
#
|
2092
|
-
# [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
|
2093
2177
|
# @return [String]
|
2094
2178
|
#
|
2095
2179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CompleteAttachedFileUploadRequest AWS API Documentation
|
@@ -2135,6 +2219,19 @@ module Aws::Connect
|
|
2135
2219
|
include Aws::Structure
|
2136
2220
|
end
|
2137
2221
|
|
2222
|
+
# A conditional check failed.
|
2223
|
+
#
|
2224
|
+
# @!attribute [rw] message
|
2225
|
+
# @return [String]
|
2226
|
+
#
|
2227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ConditionalOperationFailedException AWS API Documentation
|
2228
|
+
#
|
2229
|
+
class ConditionalOperationFailedException < Struct.new(
|
2230
|
+
:message)
|
2231
|
+
SENSITIVE = []
|
2232
|
+
include Aws::Structure
|
2233
|
+
end
|
2234
|
+
|
2138
2235
|
# Operation cannot be performed at this time as there is a conflict with
|
2139
2236
|
# another operation or contact state.
|
2140
2237
|
#
|
@@ -2188,6 +2285,11 @@ module Aws::Connect
|
|
2188
2285
|
# previous contact.
|
2189
2286
|
# @return [String]
|
2190
2287
|
#
|
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.
|
2291
|
+
# @return [String]
|
2292
|
+
#
|
2191
2293
|
# @!attribute [rw] initiation_method
|
2192
2294
|
# Indicates how the contact was initiated.
|
2193
2295
|
# @return [String]
|
@@ -2266,6 +2368,19 @@ module Aws::Connect
|
|
2266
2368
|
# Information about Amazon Connect Wisdom.
|
2267
2369
|
# @return [Types::WisdomInfo]
|
2268
2370
|
#
|
2371
|
+
# @!attribute [rw] customer_endpoint
|
2372
|
+
# The customer or external third party participant endpoint.
|
2373
|
+
# @return [Types::EndpointInfo]
|
2374
|
+
#
|
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.
|
2382
|
+
# @return [Types::EndpointInfo]
|
2383
|
+
#
|
2269
2384
|
# @!attribute [rw] queue_time_adjustment_seconds
|
2270
2385
|
# An integer that represents the queue time adjust to be applied to
|
2271
2386
|
# the contact, in seconds (longer / larger queue time are routed
|
@@ -2324,6 +2439,10 @@ module Aws::Connect
|
|
2324
2439
|
# Information about the call disconnect experience.
|
2325
2440
|
# @return [Types::DisconnectDetails]
|
2326
2441
|
#
|
2442
|
+
# @!attribute [rw] additional_email_recipients
|
2443
|
+
# List of additional email addresses for an email contact.
|
2444
|
+
# @return [Types::AdditionalEmailRecipients]
|
2445
|
+
#
|
2327
2446
|
# @!attribute [rw] segment_attributes
|
2328
2447
|
# A set of system defined key-value pairs stored on individual contact
|
2329
2448
|
# segments using an attribute map. The attributes are standard Amazon
|
@@ -2340,6 +2459,7 @@ module Aws::Connect
|
|
2340
2459
|
:id,
|
2341
2460
|
:initial_contact_id,
|
2342
2461
|
:previous_contact_id,
|
2462
|
+
:contact_association_id,
|
2343
2463
|
:initiation_method,
|
2344
2464
|
:name,
|
2345
2465
|
:description,
|
@@ -2356,6 +2476,8 @@ module Aws::Connect
|
|
2356
2476
|
:scheduled_timestamp,
|
2357
2477
|
:related_contact_id,
|
2358
2478
|
:wisdom_info,
|
2479
|
+
:customer_endpoint,
|
2480
|
+
:system_endpoint,
|
2359
2481
|
:queue_time_adjustment_seconds,
|
2360
2482
|
:queue_priority,
|
2361
2483
|
:tags,
|
@@ -2367,6 +2489,7 @@ module Aws::Connect
|
|
2367
2489
|
:customer_voice_activity,
|
2368
2490
|
:quality_metrics,
|
2369
2491
|
:disconnect_details,
|
2492
|
+
:additional_email_recipients,
|
2370
2493
|
:segment_attributes)
|
2371
2494
|
SENSITIVE = [:name, :description]
|
2372
2495
|
include Aws::Structure
|
@@ -2480,7 +2603,7 @@ module Aws::Connect
|
|
2480
2603
|
# @return [String]
|
2481
2604
|
#
|
2482
2605
|
# @!attribute [rw] status
|
2483
|
-
# The status of the
|
2606
|
+
# The status of the flow.
|
2484
2607
|
# @return [String]
|
2485
2608
|
#
|
2486
2609
|
# @!attribute [rw] description
|
@@ -2504,11 +2627,6 @@ module Aws::Connect
|
|
2504
2627
|
# "key2":"value2"} }.
|
2505
2628
|
# @return [Hash<String,String>]
|
2506
2629
|
#
|
2507
|
-
# @!attribute [rw] is_default
|
2508
|
-
# Amazon Connect includes a set of default flows that have already
|
2509
|
-
# been published. It uses them to power your contact center.
|
2510
|
-
# @return [Boolean]
|
2511
|
-
#
|
2512
2630
|
# @!attribute [rw] flow_content_sha_256
|
2513
2631
|
# Indicates the checksum value of the flow content.
|
2514
2632
|
# @return [String]
|
@@ -2522,11 +2640,11 @@ module Aws::Connect
|
|
2522
2640
|
# @return [String]
|
2523
2641
|
#
|
2524
2642
|
# @!attribute [rw] last_modified_time
|
2525
|
-
# The time at which the
|
2643
|
+
# The time at which the flow was last modified.
|
2526
2644
|
# @return [Time]
|
2527
2645
|
#
|
2528
2646
|
# @!attribute [rw] last_modified_region
|
2529
|
-
# The region in which the
|
2647
|
+
# The region in which the flow was last modified
|
2530
2648
|
# @return [String]
|
2531
2649
|
#
|
2532
2650
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlow AWS API Documentation
|
@@ -2541,7 +2659,6 @@ module Aws::Connect
|
|
2541
2659
|
:description,
|
2542
2660
|
:content,
|
2543
2661
|
:tags,
|
2544
|
-
:is_default,
|
2545
2662
|
:flow_content_sha_256,
|
2546
2663
|
:version,
|
2547
2664
|
:version_description,
|
@@ -2698,7 +2815,7 @@ module Aws::Connect
|
|
2698
2815
|
include Aws::Structure
|
2699
2816
|
end
|
2700
2817
|
|
2701
|
-
# The search criteria to be used to return
|
2818
|
+
# The search criteria to be used to return flows.
|
2702
2819
|
#
|
2703
2820
|
# @!attribute [rw] or_conditions
|
2704
2821
|
# A list of conditions which would be applied together with an `OR`
|
@@ -2792,7 +2909,7 @@ module Aws::Connect
|
|
2792
2909
|
# @return [String]
|
2793
2910
|
#
|
2794
2911
|
# @!attribute [rw] contact_flow_status
|
2795
|
-
# The status of the
|
2912
|
+
# The status of the flow.
|
2796
2913
|
# @return [String]
|
2797
2914
|
#
|
2798
2915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowSummary AWS API Documentation
|
@@ -2808,7 +2925,7 @@ module Aws::Connect
|
|
2808
2925
|
include Aws::Structure
|
2809
2926
|
end
|
2810
2927
|
|
2811
|
-
# A summary of a
|
2928
|
+
# A summary of a flow version's metadata.
|
2812
2929
|
#
|
2813
2930
|
# @!attribute [rw] arn
|
2814
2931
|
# The Amazon Resource Name (ARN) of the view version.
|
@@ -2905,6 +3022,10 @@ module Aws::Connect
|
|
2905
3022
|
# the inbound flow.
|
2906
3023
|
# @return [Time]
|
2907
3024
|
#
|
3025
|
+
# @!attribute [rw] segment_attributes
|
3026
|
+
# Set of segment attributes for a contact.
|
3027
|
+
# @return [Hash<String,Types::ContactSearchSummarySegmentAttributeValue>]
|
3028
|
+
#
|
2908
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummary AWS API Documentation
|
2909
3030
|
#
|
2910
3031
|
class ContactSearchSummary < Struct.new(
|
@@ -2918,7 +3039,8 @@ module Aws::Connect
|
|
2918
3039
|
:agent_info,
|
2919
3040
|
:initiation_timestamp,
|
2920
3041
|
:disconnect_timestamp,
|
2921
|
-
:scheduled_timestamp
|
3042
|
+
:scheduled_timestamp,
|
3043
|
+
:segment_attributes)
|
2922
3044
|
SENSITIVE = []
|
2923
3045
|
include Aws::Structure
|
2924
3046
|
end
|
@@ -2961,6 +3083,23 @@ module Aws::Connect
|
|
2961
3083
|
include Aws::Structure
|
2962
3084
|
end
|
2963
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
|
+
#
|
3091
|
+
# @!attribute [rw] value_string
|
3092
|
+
# The value of a segment attribute represented as a string.
|
3093
|
+
# @return [String]
|
3094
|
+
#
|
3095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummarySegmentAttributeValue AWS API Documentation
|
3096
|
+
#
|
3097
|
+
class ContactSearchSummarySegmentAttributeValue < Struct.new(
|
3098
|
+
:value_string)
|
3099
|
+
SENSITIVE = []
|
3100
|
+
include Aws::Structure
|
3101
|
+
end
|
3102
|
+
|
2964
3103
|
# An object that can be used to specify Tag conditions inside the
|
2965
3104
|
# `SearchFilter`. This accepts an `OR` or `AND` (List of List) input
|
2966
3105
|
# where:
|
@@ -3380,24 +3519,6 @@ module Aws::Connect
|
|
3380
3519
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3381
3520
|
# @return [String]
|
3382
3521
|
#
|
3383
|
-
# @!attribute [rw] title
|
3384
|
-
# A title of the evaluation form.
|
3385
|
-
# @return [String]
|
3386
|
-
#
|
3387
|
-
# @!attribute [rw] description
|
3388
|
-
# The description of the evaluation form.
|
3389
|
-
# @return [String]
|
3390
|
-
#
|
3391
|
-
# @!attribute [rw] items
|
3392
|
-
# Items that are part of the evaluation form. The total number of
|
3393
|
-
# sections and questions must not exceed 100 each. Questions must be
|
3394
|
-
# contained in a section.
|
3395
|
-
# @return [Array<Types::EvaluationFormItem>]
|
3396
|
-
#
|
3397
|
-
# @!attribute [rw] scoring_strategy
|
3398
|
-
# A scoring strategy of the evaluation form.
|
3399
|
-
# @return [Types::EvaluationFormScoringStrategy]
|
3400
|
-
#
|
3401
3522
|
# @!attribute [rw] client_token
|
3402
3523
|
# A unique, case-sensitive identifier that you provide to ensure the
|
3403
3524
|
# idempotency of the request. If not provided, the Amazon Web Services
|
@@ -3412,36 +3533,116 @@ module Aws::Connect
|
|
3412
3533
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
3413
3534
|
# @return [String]
|
3414
3535
|
#
|
3415
|
-
#
|
3536
|
+
# @!attribute [rw] related_contact_id
|
3537
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
3538
|
+
# @return [String]
|
3416
3539
|
#
|
3417
|
-
|
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.
|
3548
|
+
# @return [Hash<String,String>]
|
3549
|
+
#
|
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.
|
3555
|
+
# @return [Hash<String,Types::Reference>]
|
3556
|
+
#
|
3557
|
+
# @!attribute [rw] channel
|
3558
|
+
# The channel for the contact
|
3559
|
+
# @return [String]
|
3560
|
+
#
|
3561
|
+
# @!attribute [rw] initiation_method
|
3562
|
+
# Indicates how the contact was initiated.
|
3563
|
+
# @return [String]
|
3564
|
+
#
|
3565
|
+
# @!attribute [rw] expiry_duration_in_minutes
|
3566
|
+
# Number of minutes the contact will be active for before expiring
|
3567
|
+
# @return [Integer]
|
3568
|
+
#
|
3569
|
+
# @!attribute [rw] user_info
|
3570
|
+
# User details for the contact
|
3571
|
+
# @return [Types::UserInfo]
|
3572
|
+
#
|
3573
|
+
# @!attribute [rw] initiate_as
|
3574
|
+
# Initial state of the contact when it's created
|
3575
|
+
# @return [String]
|
3576
|
+
#
|
3577
|
+
# @!attribute [rw] name
|
3578
|
+
# The name of a the contact.
|
3579
|
+
# @return [String]
|
3580
|
+
#
|
3581
|
+
# @!attribute [rw] description
|
3582
|
+
# A description of the contact.
|
3583
|
+
# @return [String]
|
3584
|
+
#
|
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>
|
3603
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
3604
|
+
#
|
3605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactRequest AWS API Documentation
|
3606
|
+
#
|
3607
|
+
class CreateContactRequest < Struct.new(
|
3418
3608
|
:instance_id,
|
3419
|
-
:
|
3609
|
+
:client_token,
|
3610
|
+
:related_contact_id,
|
3611
|
+
:attributes,
|
3612
|
+
:references,
|
3613
|
+
:channel,
|
3614
|
+
:initiation_method,
|
3615
|
+
:expiry_duration_in_minutes,
|
3616
|
+
:user_info,
|
3617
|
+
:initiate_as,
|
3618
|
+
:name,
|
3420
3619
|
:description,
|
3421
|
-
:
|
3422
|
-
:
|
3423
|
-
:client_token)
|
3424
|
-
SENSITIVE = []
|
3620
|
+
:segment_attributes)
|
3621
|
+
SENSITIVE = [:name, :description]
|
3425
3622
|
include Aws::Structure
|
3426
3623
|
end
|
3427
3624
|
|
3428
|
-
# @!attribute [rw]
|
3429
|
-
# The
|
3625
|
+
# @!attribute [rw] contact_id
|
3626
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
3430
3627
|
# @return [String]
|
3431
3628
|
#
|
3432
|
-
# @!attribute [rw]
|
3433
|
-
# The Amazon Resource Name (ARN)
|
3629
|
+
# @!attribute [rw] contact_arn
|
3630
|
+
# The Amazon Resource Name (ARN) of the created contact.
|
3434
3631
|
# @return [String]
|
3435
3632
|
#
|
3436
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactResponse AWS API Documentation
|
3437
3634
|
#
|
3438
|
-
class
|
3439
|
-
:
|
3440
|
-
:
|
3635
|
+
class CreateContactResponse < Struct.new(
|
3636
|
+
:contact_id,
|
3637
|
+
:contact_arn)
|
3441
3638
|
SENSITIVE = []
|
3442
3639
|
include Aws::Structure
|
3443
3640
|
end
|
3444
3641
|
|
3642
|
+
# @!attribute [rw] description
|
3643
|
+
# The description of the email address.
|
3644
|
+
# @return [String]
|
3645
|
+
#
|
3445
3646
|
# @!attribute [rw] instance_id
|
3446
3647
|
# The identifier of the Amazon Connect instance. You can [find the
|
3447
3648
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -3451,64 +3652,200 @@ module Aws::Connect
|
|
3451
3652
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3452
3653
|
# @return [String]
|
3453
3654
|
#
|
3454
|
-
# @!attribute [rw]
|
3455
|
-
# The
|
3456
|
-
#
|
3457
|
-
#
|
3458
|
-
# @!attribute [rw] description
|
3459
|
-
# The description of the hours of operation.
|
3655
|
+
# @!attribute [rw] email_address
|
3656
|
+
# The email address with the instance, in
|
3657
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
3460
3658
|
# @return [String]
|
3461
3659
|
#
|
3462
|
-
# @!attribute [rw]
|
3463
|
-
# The
|
3660
|
+
# @!attribute [rw] display_name
|
3661
|
+
# The display name of email address
|
3464
3662
|
# @return [String]
|
3465
3663
|
#
|
3466
|
-
# @!attribute [rw] config
|
3467
|
-
# Configuration information for the hours of operation: day, start
|
3468
|
-
# time, and end time.
|
3469
|
-
# @return [Array<Types::HoursOfOperationConfig>]
|
3470
|
-
#
|
3471
3664
|
# @!attribute [rw] tags
|
3472
3665
|
# The tags used to organize, track, or control access for this
|
3473
3666
|
# resource. For example, \{ "Tags": \{"key1":"value1",
|
3474
3667
|
# "key2":"value2"} }.
|
3475
3668
|
# @return [Hash<String,String>]
|
3476
3669
|
#
|
3477
|
-
#
|
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].
|
3478
3675
|
#
|
3479
|
-
|
3480
|
-
|
3481
|
-
|
3676
|
+
#
|
3677
|
+
#
|
3678
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
3679
|
+
# @return [String]
|
3680
|
+
#
|
3681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEmailAddressRequest AWS API Documentation
|
3682
|
+
#
|
3683
|
+
class CreateEmailAddressRequest < Struct.new(
|
3482
3684
|
:description,
|
3483
|
-
:
|
3484
|
-
:
|
3485
|
-
:
|
3486
|
-
|
3685
|
+
:instance_id,
|
3686
|
+
:email_address,
|
3687
|
+
:display_name,
|
3688
|
+
:tags,
|
3689
|
+
:client_token)
|
3690
|
+
SENSITIVE = [:description, :email_address, :display_name]
|
3487
3691
|
include Aws::Structure
|
3488
3692
|
end
|
3489
3693
|
|
3490
|
-
# @!attribute [rw]
|
3491
|
-
# The identifier
|
3694
|
+
# @!attribute [rw] email_address_id
|
3695
|
+
# The identifier of the email address.
|
3492
3696
|
# @return [String]
|
3493
3697
|
#
|
3494
|
-
# @!attribute [rw]
|
3495
|
-
# The Amazon Resource Name (ARN)
|
3698
|
+
# @!attribute [rw] email_address_arn
|
3699
|
+
# The Amazon Resource Name (ARN) of the email address.
|
3496
3700
|
# @return [String]
|
3497
3701
|
#
|
3498
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEmailAddressResponse AWS API Documentation
|
3499
3703
|
#
|
3500
|
-
class
|
3501
|
-
:
|
3502
|
-
:
|
3704
|
+
class CreateEmailAddressResponse < Struct.new(
|
3705
|
+
:email_address_id,
|
3706
|
+
:email_address_arn)
|
3503
3707
|
SENSITIVE = []
|
3504
3708
|
include Aws::Structure
|
3505
3709
|
end
|
3506
3710
|
|
3507
|
-
# @!attribute [rw]
|
3508
|
-
# The
|
3509
|
-
#
|
3510
|
-
#
|
3511
|
-
#
|
3711
|
+
# @!attribute [rw] instance_id
|
3712
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3713
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3714
|
+
#
|
3715
|
+
#
|
3716
|
+
#
|
3717
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3718
|
+
# @return [String]
|
3719
|
+
#
|
3720
|
+
# @!attribute [rw] title
|
3721
|
+
# A title of the evaluation form.
|
3722
|
+
# @return [String]
|
3723
|
+
#
|
3724
|
+
# @!attribute [rw] description
|
3725
|
+
# The description of the evaluation form.
|
3726
|
+
# @return [String]
|
3727
|
+
#
|
3728
|
+
# @!attribute [rw] items
|
3729
|
+
# Items that are part of the evaluation form. The total number of
|
3730
|
+
# sections and questions must not exceed 100 each. Questions must be
|
3731
|
+
# contained in a section.
|
3732
|
+
# @return [Array<Types::EvaluationFormItem>]
|
3733
|
+
#
|
3734
|
+
# @!attribute [rw] scoring_strategy
|
3735
|
+
# A scoring strategy of the evaluation form.
|
3736
|
+
# @return [Types::EvaluationFormScoringStrategy]
|
3737
|
+
#
|
3738
|
+
# @!attribute [rw] client_token
|
3739
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
3740
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
3741
|
+
# SDK populates this field. For more information about idempotency,
|
3742
|
+
# see [Making retries safe with idempotent APIs][1].
|
3743
|
+
#
|
3744
|
+
# **A suitable default value is auto-generated.** You should normally
|
3745
|
+
# not need to pass this option.
|
3746
|
+
#
|
3747
|
+
#
|
3748
|
+
#
|
3749
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
3750
|
+
# @return [String]
|
3751
|
+
#
|
3752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEvaluationFormRequest AWS API Documentation
|
3753
|
+
#
|
3754
|
+
class CreateEvaluationFormRequest < Struct.new(
|
3755
|
+
:instance_id,
|
3756
|
+
:title,
|
3757
|
+
:description,
|
3758
|
+
:items,
|
3759
|
+
:scoring_strategy,
|
3760
|
+
:client_token)
|
3761
|
+
SENSITIVE = []
|
3762
|
+
include Aws::Structure
|
3763
|
+
end
|
3764
|
+
|
3765
|
+
# @!attribute [rw] evaluation_form_id
|
3766
|
+
# The unique identifier for the evaluation form.
|
3767
|
+
# @return [String]
|
3768
|
+
#
|
3769
|
+
# @!attribute [rw] evaluation_form_arn
|
3770
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
3771
|
+
# @return [String]
|
3772
|
+
#
|
3773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEvaluationFormResponse AWS API Documentation
|
3774
|
+
#
|
3775
|
+
class CreateEvaluationFormResponse < Struct.new(
|
3776
|
+
:evaluation_form_id,
|
3777
|
+
:evaluation_form_arn)
|
3778
|
+
SENSITIVE = []
|
3779
|
+
include Aws::Structure
|
3780
|
+
end
|
3781
|
+
|
3782
|
+
# @!attribute [rw] instance_id
|
3783
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3784
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3785
|
+
#
|
3786
|
+
#
|
3787
|
+
#
|
3788
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3789
|
+
# @return [String]
|
3790
|
+
#
|
3791
|
+
# @!attribute [rw] name
|
3792
|
+
# The name of the hours of operation.
|
3793
|
+
# @return [String]
|
3794
|
+
#
|
3795
|
+
# @!attribute [rw] description
|
3796
|
+
# The description of the hours of operation.
|
3797
|
+
# @return [String]
|
3798
|
+
#
|
3799
|
+
# @!attribute [rw] time_zone
|
3800
|
+
# The time zone of the hours of operation.
|
3801
|
+
# @return [String]
|
3802
|
+
#
|
3803
|
+
# @!attribute [rw] config
|
3804
|
+
# Configuration information for the hours of operation: day, start
|
3805
|
+
# time, and end time.
|
3806
|
+
# @return [Array<Types::HoursOfOperationConfig>]
|
3807
|
+
#
|
3808
|
+
# @!attribute [rw] tags
|
3809
|
+
# The tags used to organize, track, or control access for this
|
3810
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
3811
|
+
# "key2":"value2"} }.
|
3812
|
+
# @return [Hash<String,String>]
|
3813
|
+
#
|
3814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperationRequest AWS API Documentation
|
3815
|
+
#
|
3816
|
+
class CreateHoursOfOperationRequest < Struct.new(
|
3817
|
+
:instance_id,
|
3818
|
+
:name,
|
3819
|
+
:description,
|
3820
|
+
:time_zone,
|
3821
|
+
:config,
|
3822
|
+
:tags)
|
3823
|
+
SENSITIVE = []
|
3824
|
+
include Aws::Structure
|
3825
|
+
end
|
3826
|
+
|
3827
|
+
# @!attribute [rw] hours_of_operation_id
|
3828
|
+
# The identifier for the hours of operation.
|
3829
|
+
# @return [String]
|
3830
|
+
#
|
3831
|
+
# @!attribute [rw] hours_of_operation_arn
|
3832
|
+
# The Amazon Resource Name (ARN) for the hours of operation.
|
3833
|
+
# @return [String]
|
3834
|
+
#
|
3835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperationResponse AWS API Documentation
|
3836
|
+
#
|
3837
|
+
class CreateHoursOfOperationResponse < Struct.new(
|
3838
|
+
:hours_of_operation_id,
|
3839
|
+
:hours_of_operation_arn)
|
3840
|
+
SENSITIVE = []
|
3841
|
+
include Aws::Structure
|
3842
|
+
end
|
3843
|
+
|
3844
|
+
# @!attribute [rw] client_token
|
3845
|
+
# The idempotency token.
|
3846
|
+
# @return [String]
|
3847
|
+
#
|
3848
|
+
# @!attribute [rw] identity_management_type
|
3512
3849
|
# The type of identity management for your Amazon Connect users.
|
3513
3850
|
# @return [String]
|
3514
3851
|
#
|
@@ -3932,6 +4269,10 @@ module Aws::Connect
|
|
3932
4269
|
# The outbound caller ID name, number, and outbound whisper flow.
|
3933
4270
|
# @return [Types::OutboundCallerConfig]
|
3934
4271
|
#
|
4272
|
+
# @!attribute [rw] outbound_email_config
|
4273
|
+
# The outbound email address ID for a specified queue.
|
4274
|
+
# @return [Types::OutboundEmailConfig]
|
4275
|
+
#
|
3935
4276
|
# @!attribute [rw] hours_of_operation_id
|
3936
4277
|
# The identifier for the hours of operation.
|
3937
4278
|
# @return [String]
|
@@ -3958,6 +4299,7 @@ module Aws::Connect
|
|
3958
4299
|
:name,
|
3959
4300
|
:description,
|
3960
4301
|
:outbound_caller_config,
|
4302
|
+
:outbound_email_config,
|
3961
4303
|
:hours_of_operation_id,
|
3962
4304
|
:max_contacts,
|
3963
4305
|
:quick_connect_ids,
|
@@ -4316,6 +4658,11 @@ module Aws::Connect
|
|
4316
4658
|
# created by referencing this template.
|
4317
4659
|
# @return [String]
|
4318
4660
|
#
|
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.
|
4664
|
+
# @return [String]
|
4665
|
+
#
|
4319
4666
|
# @!attribute [rw] constraints
|
4320
4667
|
# Constraints that are applicable to the fields listed.
|
4321
4668
|
# @return [Types::TaskTemplateConstraints]
|
@@ -4357,6 +4704,7 @@ module Aws::Connect
|
|
4357
4704
|
:name,
|
4358
4705
|
:description,
|
4359
4706
|
:contact_flow_id,
|
4707
|
+
:self_assign_flow_id,
|
4360
4708
|
:constraints,
|
4361
4709
|
:defaults,
|
4362
4710
|
:status,
|
@@ -5310,6 +5658,32 @@ module Aws::Connect
|
|
5310
5658
|
#
|
5311
5659
|
class DeleteContactFlowResponse < Aws::EmptyStructure; end
|
5312
5660
|
|
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
|
5668
|
+
# @return [String]
|
5669
|
+
#
|
5670
|
+
# @!attribute [rw] email_address_id
|
5671
|
+
# The identifier of the email address.
|
5672
|
+
# @return [String]
|
5673
|
+
#
|
5674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEmailAddressRequest AWS API Documentation
|
5675
|
+
#
|
5676
|
+
class DeleteEmailAddressRequest < Struct.new(
|
5677
|
+
:instance_id,
|
5678
|
+
:email_address_id)
|
5679
|
+
SENSITIVE = []
|
5680
|
+
include Aws::Structure
|
5681
|
+
end
|
5682
|
+
|
5683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEmailAddressResponse AWS API Documentation
|
5684
|
+
#
|
5685
|
+
class DeleteEmailAddressResponse < Aws::EmptyStructure; end
|
5686
|
+
|
5313
5687
|
# @!attribute [rw] instance_id
|
5314
5688
|
# The identifier of the Amazon Connect instance. You can [find the
|
5315
5689
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -5960,6 +6334,78 @@ module Aws::Connect
|
|
5960
6334
|
include Aws::Structure
|
5961
6335
|
end
|
5962
6336
|
|
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
|
6344
|
+
# @return [String]
|
6345
|
+
#
|
6346
|
+
# @!attribute [rw] email_address_id
|
6347
|
+
# The identifier of the email address.
|
6348
|
+
# @return [String]
|
6349
|
+
#
|
6350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEmailAddressRequest AWS API Documentation
|
6351
|
+
#
|
6352
|
+
class DescribeEmailAddressRequest < Struct.new(
|
6353
|
+
:instance_id,
|
6354
|
+
:email_address_id)
|
6355
|
+
SENSITIVE = []
|
6356
|
+
include Aws::Structure
|
6357
|
+
end
|
6358
|
+
|
6359
|
+
# @!attribute [rw] email_address_id
|
6360
|
+
# The identifier of the email address.
|
6361
|
+
# @return [String]
|
6362
|
+
#
|
6363
|
+
# @!attribute [rw] email_address_arn
|
6364
|
+
# The Amazon Resource Name (ARN) of the email address.
|
6365
|
+
# @return [String]
|
6366
|
+
#
|
6367
|
+
# @!attribute [rw] email_address
|
6368
|
+
# The email address with the instance, in
|
6369
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
6370
|
+
# @return [String]
|
6371
|
+
#
|
6372
|
+
# @!attribute [rw] display_name
|
6373
|
+
# The display name of email address
|
6374
|
+
# @return [String]
|
6375
|
+
#
|
6376
|
+
# @!attribute [rw] description
|
6377
|
+
# The description of the email address.
|
6378
|
+
# @return [String]
|
6379
|
+
#
|
6380
|
+
# @!attribute [rw] create_timestamp
|
6381
|
+
# The email address creation timestamp in ISO 8601 Datetime.
|
6382
|
+
# @return [String]
|
6383
|
+
#
|
6384
|
+
# @!attribute [rw] modified_timestamp
|
6385
|
+
# The email address last modification timestamp in ISO 8601 Datetime.
|
6386
|
+
# @return [String]
|
6387
|
+
#
|
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"} }.
|
6392
|
+
# @return [Hash<String,String>]
|
6393
|
+
#
|
6394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEmailAddressResponse AWS API Documentation
|
6395
|
+
#
|
6396
|
+
class DescribeEmailAddressResponse < Struct.new(
|
6397
|
+
:email_address_id,
|
6398
|
+
:email_address_arn,
|
6399
|
+
:email_address,
|
6400
|
+
:display_name,
|
6401
|
+
:description,
|
6402
|
+
:create_timestamp,
|
6403
|
+
:modified_timestamp,
|
6404
|
+
:tags)
|
6405
|
+
SENSITIVE = [:email_address, :display_name, :description]
|
6406
|
+
include Aws::Structure
|
6407
|
+
end
|
6408
|
+
|
5963
6409
|
# @!attribute [rw] instance_id
|
5964
6410
|
# The identifier of the Amazon Connect instance. You can [find the
|
5965
6411
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -7124,68 +7570,239 @@ module Aws::Connect
|
|
7124
7570
|
include Aws::Structure
|
7125
7571
|
end
|
7126
7572
|
|
7127
|
-
#
|
7128
|
-
# Otherwise, null.
|
7573
|
+
# Contains information about a source or destination email address
|
7129
7574
|
#
|
7130
|
-
# @!attribute [rw]
|
7131
|
-
#
|
7575
|
+
# @!attribute [rw] email_address
|
7576
|
+
# The email address with the instance, in
|
7577
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
7132
7578
|
# @return [String]
|
7133
7579
|
#
|
7134
|
-
# @!attribute [rw]
|
7135
|
-
#
|
7580
|
+
# @!attribute [rw] display_name
|
7581
|
+
# The display name of email address.
|
7136
7582
|
# @return [String]
|
7137
7583
|
#
|
7138
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressInfo AWS API Documentation
|
7139
7585
|
#
|
7140
|
-
class
|
7141
|
-
:
|
7142
|
-
:
|
7143
|
-
SENSITIVE = []
|
7586
|
+
class EmailAddressInfo < Struct.new(
|
7587
|
+
:email_address,
|
7588
|
+
:display_name)
|
7589
|
+
SENSITIVE = [:email_address, :display_name]
|
7144
7590
|
include Aws::Structure
|
7145
7591
|
end
|
7146
7592
|
|
7147
|
-
#
|
7148
|
-
#
|
7149
|
-
# @api private
|
7150
|
-
#
|
7151
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmptyFieldValue AWS API Documentation
|
7152
|
-
#
|
7153
|
-
class EmptyFieldValue < Aws::EmptyStructure; end
|
7154
|
-
|
7155
|
-
# The encryption configuration.
|
7593
|
+
# Contains information about an email address for a contact center.
|
7156
7594
|
#
|
7157
|
-
# @!attribute [rw]
|
7158
|
-
# The
|
7595
|
+
# @!attribute [rw] email_address_id
|
7596
|
+
# The identifier of the email address.
|
7159
7597
|
# @return [String]
|
7160
7598
|
#
|
7161
|
-
# @!attribute [rw]
|
7162
|
-
# The
|
7163
|
-
#
|
7164
|
-
# <note markdown="1"> Be sure to provide the full ARN of the encryption key, not just the
|
7165
|
-
# ID.
|
7166
|
-
#
|
7167
|
-
# Amazon Connect supports only KMS keys with the default key spec of [
|
7168
|
-
# `SYMMETRIC_DEFAULT` ][1].
|
7169
|
-
#
|
7170
|
-
# </note>
|
7599
|
+
# @!attribute [rw] email_address_arn
|
7600
|
+
# The Amazon Resource Name (ARN) of the email address.
|
7601
|
+
# @return [String]
|
7171
7602
|
#
|
7603
|
+
# @!attribute [rw] email_address
|
7604
|
+
# The email address with the instance, in
|
7605
|
+
# \[^\\s@\]+@\[^\\s@\]+\\.\[^\\s@\]+ format.
|
7606
|
+
# @return [String]
|
7172
7607
|
#
|
7608
|
+
# @!attribute [rw] description
|
7609
|
+
# The description of the email address.
|
7610
|
+
# @return [String]
|
7173
7611
|
#
|
7174
|
-
#
|
7612
|
+
# @!attribute [rw] display_name
|
7613
|
+
# The display name of email address.
|
7175
7614
|
# @return [String]
|
7176
7615
|
#
|
7177
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressMetadata AWS API Documentation
|
7178
7617
|
#
|
7179
|
-
class
|
7180
|
-
:
|
7181
|
-
:
|
7182
|
-
|
7618
|
+
class EmailAddressMetadata < Struct.new(
|
7619
|
+
:email_address_id,
|
7620
|
+
:email_address_arn,
|
7621
|
+
:email_address,
|
7622
|
+
:description,
|
7623
|
+
:display_name)
|
7624
|
+
SENSITIVE = [:email_address, :description, :display_name]
|
7183
7625
|
include Aws::Structure
|
7184
7626
|
end
|
7185
7627
|
|
7186
|
-
#
|
7187
|
-
#
|
7188
|
-
#
|
7628
|
+
# The search criteria to be used to return email addresses.
|
7629
|
+
#
|
7630
|
+
# @!attribute [rw] or_conditions
|
7631
|
+
# A list of conditions which would be applied together with an OR
|
7632
|
+
# condition.
|
7633
|
+
# @return [Array<Types::EmailAddressSearchCriteria>]
|
7634
|
+
#
|
7635
|
+
# @!attribute [rw] and_conditions
|
7636
|
+
# A list of conditions which would be applied together with an AND
|
7637
|
+
# condition.
|
7638
|
+
# @return [Array<Types::EmailAddressSearchCriteria>]
|
7639
|
+
#
|
7640
|
+
# @!attribute [rw] string_condition
|
7641
|
+
# A leaf node condition which can be used to specify a string
|
7642
|
+
# condition.
|
7643
|
+
# @return [Types::StringCondition]
|
7644
|
+
#
|
7645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressSearchCriteria AWS API Documentation
|
7646
|
+
#
|
7647
|
+
class EmailAddressSearchCriteria < Struct.new(
|
7648
|
+
:or_conditions,
|
7649
|
+
:and_conditions,
|
7650
|
+
:string_condition)
|
7651
|
+
SENSITIVE = []
|
7652
|
+
include Aws::Structure
|
7653
|
+
end
|
7654
|
+
|
7655
|
+
# Filters to be applied to search results.
|
7656
|
+
#
|
7657
|
+
# @!attribute [rw] tag_filter
|
7658
|
+
# An object that can be used to specify Tag conditions inside the
|
7659
|
+
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
7660
|
+
# where:
|
7661
|
+
#
|
7662
|
+
# * Top level list specifies conditions that need to be applied with
|
7663
|
+
# `OR` operator
|
7664
|
+
#
|
7665
|
+
# * Inner list specifies conditions that need to be applied with `AND`
|
7666
|
+
# operator.
|
7667
|
+
# @return [Types::ControlPlaneTagFilter]
|
7668
|
+
#
|
7669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressSearchFilter AWS API Documentation
|
7670
|
+
#
|
7671
|
+
class EmailAddressSearchFilter < Struct.new(
|
7672
|
+
:tag_filter)
|
7673
|
+
SENSITIVE = []
|
7674
|
+
include Aws::Structure
|
7675
|
+
end
|
7676
|
+
|
7677
|
+
# Information about the email attachment files.
|
7678
|
+
#
|
7679
|
+
# @!attribute [rw] file_name
|
7680
|
+
# A case-sensitive name of the attached file being uploaded.
|
7681
|
+
# @return [String]
|
7682
|
+
#
|
7683
|
+
# @!attribute [rw] s3_url
|
7684
|
+
# The pre-signed URLs for the S3 bucket where the email attachment is
|
7685
|
+
# stored.
|
7686
|
+
# @return [String]
|
7687
|
+
#
|
7688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAttachment AWS API Documentation
|
7689
|
+
#
|
7690
|
+
class EmailAttachment < Struct.new(
|
7691
|
+
:file_name,
|
7692
|
+
:s3_url)
|
7693
|
+
SENSITIVE = []
|
7694
|
+
include Aws::Structure
|
7695
|
+
end
|
7696
|
+
|
7697
|
+
# Information about the reference when the referenceType is
|
7698
|
+
# `EMAIL_MESSAGE`. Otherwise, null.
|
7699
|
+
#
|
7700
|
+
# @!attribute [rw] name
|
7701
|
+
# The name of the email message reference
|
7702
|
+
# @return [String]
|
7703
|
+
#
|
7704
|
+
# @!attribute [rw] arn
|
7705
|
+
# The Amazon Resource Name (ARN) of the email message reference
|
7706
|
+
# @return [String]
|
7707
|
+
#
|
7708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailMessageReference AWS API Documentation
|
7709
|
+
#
|
7710
|
+
class EmailMessageReference < Struct.new(
|
7711
|
+
:name,
|
7712
|
+
:arn)
|
7713
|
+
SENSITIVE = []
|
7714
|
+
include Aws::Structure
|
7715
|
+
end
|
7716
|
+
|
7717
|
+
# Information about the email recipient
|
7718
|
+
#
|
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.
|
7725
|
+
# @return [String]
|
7726
|
+
#
|
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.
|
7733
|
+
# @return [String]
|
7734
|
+
#
|
7735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailRecipient AWS API Documentation
|
7736
|
+
#
|
7737
|
+
class EmailRecipient < Struct.new(
|
7738
|
+
:address,
|
7739
|
+
:display_name)
|
7740
|
+
SENSITIVE = []
|
7741
|
+
include Aws::Structure
|
7742
|
+
end
|
7743
|
+
|
7744
|
+
# Information about a reference when the `referenceType` is `EMAIL`.
|
7745
|
+
# Otherwise, null.
|
7746
|
+
#
|
7747
|
+
# @!attribute [rw] name
|
7748
|
+
# Identifier of the email reference.
|
7749
|
+
# @return [String]
|
7750
|
+
#
|
7751
|
+
# @!attribute [rw] value
|
7752
|
+
# A valid email address.
|
7753
|
+
# @return [String]
|
7754
|
+
#
|
7755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailReference AWS API Documentation
|
7756
|
+
#
|
7757
|
+
class EmailReference < Struct.new(
|
7758
|
+
:name,
|
7759
|
+
:value)
|
7760
|
+
SENSITIVE = []
|
7761
|
+
include Aws::Structure
|
7762
|
+
end
|
7763
|
+
|
7764
|
+
# An empty value.
|
7765
|
+
#
|
7766
|
+
# @api private
|
7767
|
+
#
|
7768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmptyFieldValue AWS API Documentation
|
7769
|
+
#
|
7770
|
+
class EmptyFieldValue < Aws::EmptyStructure; end
|
7771
|
+
|
7772
|
+
# The encryption configuration.
|
7773
|
+
#
|
7774
|
+
# @!attribute [rw] encryption_type
|
7775
|
+
# The type of encryption.
|
7776
|
+
# @return [String]
|
7777
|
+
#
|
7778
|
+
# @!attribute [rw] key_id
|
7779
|
+
# The full ARN of the encryption key.
|
7780
|
+
#
|
7781
|
+
# <note markdown="1"> Be sure to provide the full ARN of the encryption key, not just the
|
7782
|
+
# ID.
|
7783
|
+
#
|
7784
|
+
# Amazon Connect supports only KMS keys with the default key spec of [
|
7785
|
+
# `SYMMETRIC_DEFAULT` ][1].
|
7786
|
+
#
|
7787
|
+
# </note>
|
7788
|
+
#
|
7789
|
+
#
|
7790
|
+
#
|
7791
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default
|
7792
|
+
# @return [String]
|
7793
|
+
#
|
7794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EncryptionConfig AWS API Documentation
|
7795
|
+
#
|
7796
|
+
class EncryptionConfig < Struct.new(
|
7797
|
+
:encryption_type,
|
7798
|
+
:key_id)
|
7799
|
+
SENSITIVE = []
|
7800
|
+
include Aws::Structure
|
7801
|
+
end
|
7802
|
+
|
7803
|
+
# End associated tasks related to a case.
|
7804
|
+
#
|
7805
|
+
# @api private
|
7189
7806
|
#
|
7190
7807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EndAssociatedTasksActionDefinition AWS API Documentation
|
7191
7808
|
#
|
@@ -7210,6 +7827,30 @@ module Aws::Connect
|
|
7210
7827
|
include Aws::Structure
|
7211
7828
|
end
|
7212
7829
|
|
7830
|
+
# Information about the endpoint.
|
7831
|
+
#
|
7832
|
+
# @!attribute [rw] type
|
7833
|
+
# Type of endpoint.
|
7834
|
+
# @return [String]
|
7835
|
+
#
|
7836
|
+
# @!attribute [rw] address
|
7837
|
+
# Address of the endpoint.
|
7838
|
+
# @return [String]
|
7839
|
+
#
|
7840
|
+
# @!attribute [rw] display_name
|
7841
|
+
# Display name of the endpoint.
|
7842
|
+
# @return [String]
|
7843
|
+
#
|
7844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EndpointInfo AWS API Documentation
|
7845
|
+
#
|
7846
|
+
class EndpointInfo < Struct.new(
|
7847
|
+
:type,
|
7848
|
+
:address,
|
7849
|
+
:display_name)
|
7850
|
+
SENSITIVE = []
|
7851
|
+
include Aws::Structure
|
7852
|
+
end
|
7853
|
+
|
7213
7854
|
# This API is in preview release for Amazon Connect and is subject to
|
7214
7855
|
# change.
|
7215
7856
|
#
|
@@ -8321,7 +8962,7 @@ module Aws::Connect
|
|
8321
8962
|
# Request to GetAttachedFile API.
|
8322
8963
|
#
|
8323
8964
|
# @!attribute [rw] instance_id
|
8324
|
-
# The unique identifier of the Connect instance.
|
8965
|
+
# The unique identifier of the Amazon Connect instance.
|
8325
8966
|
# @return [String]
|
8326
8967
|
#
|
8327
8968
|
# @!attribute [rw] file_id
|
@@ -8334,8 +8975,8 @@ module Aws::Connect
|
|
8334
8975
|
# @return [Integer]
|
8335
8976
|
#
|
8336
8977
|
# @!attribute [rw] associated_resource_arn
|
8337
|
-
# The resource to which the attached file is (being) uploaded to.
|
8338
|
-
# [Cases][1]
|
8978
|
+
# The resource to which the attached file is (being) uploaded to. The
|
8979
|
+
# supported resources are [Cases][1] and [Email][2].
|
8339
8980
|
#
|
8340
8981
|
# <note markdown="1"> This value must be a valid ARN.
|
8341
8982
|
#
|
@@ -8343,7 +8984,8 @@ module Aws::Connect
|
|
8343
8984
|
#
|
8344
8985
|
#
|
8345
8986
|
#
|
8346
|
-
# [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
|
8347
8989
|
# @return [String]
|
8348
8990
|
#
|
8349
8991
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetAttachedFileRequest AWS API Documentation
|
@@ -10687,6 +11329,11 @@ module Aws::Connect
|
|
10687
11329
|
# created by referencing this template.
|
10688
11330
|
# @return [String]
|
10689
11331
|
#
|
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
|
11335
|
+
# @return [String]
|
11336
|
+
#
|
10690
11337
|
# @!attribute [rw] constraints
|
10691
11338
|
# Constraints that are applicable to the fields listed.
|
10692
11339
|
# @return [Types::TaskTemplateConstraints]
|
@@ -10730,6 +11377,7 @@ module Aws::Connect
|
|
10730
11377
|
:name,
|
10731
11378
|
:description,
|
10732
11379
|
:contact_flow_id,
|
11380
|
+
:self_assign_flow_id,
|
10733
11381
|
:constraints,
|
10734
11382
|
:defaults,
|
10735
11383
|
:fields,
|
@@ -11485,6 +12133,73 @@ module Aws::Connect
|
|
11485
12133
|
include Aws::Structure
|
11486
12134
|
end
|
11487
12135
|
|
12136
|
+
# The additional TO CC recipients information of inbound email.
|
12137
|
+
#
|
12138
|
+
# @!attribute [rw] to_addresses
|
12139
|
+
# The additional recipients information present in to list.
|
12140
|
+
# @return [Array<Types::EmailAddressInfo>]
|
12141
|
+
#
|
12142
|
+
# @!attribute [rw] cc_addresses
|
12143
|
+
# The additional recipients information present in cc list.
|
12144
|
+
# @return [Array<Types::EmailAddressInfo>]
|
12145
|
+
#
|
12146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InboundAdditionalRecipients AWS API Documentation
|
12147
|
+
#
|
12148
|
+
class InboundAdditionalRecipients < Struct.new(
|
12149
|
+
:to_addresses,
|
12150
|
+
:cc_addresses)
|
12151
|
+
SENSITIVE = []
|
12152
|
+
include Aws::Structure
|
12153
|
+
end
|
12154
|
+
|
12155
|
+
# Information about email body content.
|
12156
|
+
#
|
12157
|
+
# @!attribute [rw] message_source_type
|
12158
|
+
# The message source type, that is, `RAW`.
|
12159
|
+
# @return [String]
|
12160
|
+
#
|
12161
|
+
# @!attribute [rw] raw_message
|
12162
|
+
# The raw email body content.
|
12163
|
+
# @return [Types::InboundRawMessage]
|
12164
|
+
#
|
12165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InboundEmailContent AWS API Documentation
|
12166
|
+
#
|
12167
|
+
class InboundEmailContent < Struct.new(
|
12168
|
+
:message_source_type,
|
12169
|
+
:raw_message)
|
12170
|
+
SENSITIVE = []
|
12171
|
+
include Aws::Structure
|
12172
|
+
end
|
12173
|
+
|
12174
|
+
# Information about the raw email body content.
|
12175
|
+
#
|
12176
|
+
# @!attribute [rw] subject
|
12177
|
+
# The email subject.
|
12178
|
+
# @return [String]
|
12179
|
+
#
|
12180
|
+
# @!attribute [rw] body
|
12181
|
+
# The email message body.
|
12182
|
+
# @return [String]
|
12183
|
+
#
|
12184
|
+
# @!attribute [rw] content_type
|
12185
|
+
# Type of content, that is, `text/plain` or `text/html`.
|
12186
|
+
# @return [String]
|
12187
|
+
#
|
12188
|
+
# @!attribute [rw] headers
|
12189
|
+
# Headers present in inbound email.
|
12190
|
+
# @return [Hash<String,String>]
|
12191
|
+
#
|
12192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InboundRawMessage AWS API Documentation
|
12193
|
+
#
|
12194
|
+
class InboundRawMessage < Struct.new(
|
12195
|
+
:subject,
|
12196
|
+
:body,
|
12197
|
+
:content_type,
|
12198
|
+
:headers)
|
12199
|
+
SENSITIVE = [:subject, :body]
|
12200
|
+
include Aws::Structure
|
12201
|
+
end
|
12202
|
+
|
11488
12203
|
# The Amazon Connect instance.
|
11489
12204
|
#
|
11490
12205
|
# @!attribute [rw] id
|
@@ -12160,6 +12875,64 @@ module Aws::Connect
|
|
12160
12875
|
include Aws::Structure
|
12161
12876
|
end
|
12162
12877
|
|
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
|
12885
|
+
# @return [String]
|
12886
|
+
#
|
12887
|
+
# @!attribute [rw] contact_id
|
12888
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
12889
|
+
# @return [String]
|
12890
|
+
#
|
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.
|
12898
|
+
# @return [Integer]
|
12899
|
+
#
|
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.
|
12904
|
+
# @return [String]
|
12905
|
+
#
|
12906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAssociatedContactsRequest AWS API Documentation
|
12907
|
+
#
|
12908
|
+
class ListAssociatedContactsRequest < Struct.new(
|
12909
|
+
:instance_id,
|
12910
|
+
:contact_id,
|
12911
|
+
:max_results,
|
12912
|
+
:next_token)
|
12913
|
+
SENSITIVE = []
|
12914
|
+
include Aws::Structure
|
12915
|
+
end
|
12916
|
+
|
12917
|
+
# @!attribute [rw] contact_summary_list
|
12918
|
+
# List of the contact summary for all the contacts in contact tree
|
12919
|
+
# associated with unique identifier.
|
12920
|
+
# @return [Array<Types::AssociatedContactSummary>]
|
12921
|
+
#
|
12922
|
+
# @!attribute [rw] next_token
|
12923
|
+
# If there are additional results, this is the token for the next set
|
12924
|
+
# of results.
|
12925
|
+
# @return [String]
|
12926
|
+
#
|
12927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAssociatedContactsResponse AWS API Documentation
|
12928
|
+
#
|
12929
|
+
class ListAssociatedContactsResponse < Struct.new(
|
12930
|
+
:contact_summary_list,
|
12931
|
+
:next_token)
|
12932
|
+
SENSITIVE = []
|
12933
|
+
include Aws::Structure
|
12934
|
+
end
|
12935
|
+
|
12163
12936
|
# @!attribute [rw] instance_id
|
12164
12937
|
# The identifier of the Amazon Connect instance. You can [find the
|
12165
12938
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -15054,7 +15827,21 @@ module Aws::Connect
|
|
15054
15827
|
include Aws::Structure
|
15055
15828
|
end
|
15056
15829
|
|
15057
|
-
# The
|
15830
|
+
# The additional recipients information of outbound email.
|
15831
|
+
#
|
15832
|
+
# @!attribute [rw] cc_email_addresses
|
15833
|
+
# The additional CC email address recipients information.
|
15834
|
+
# @return [Array<Types::EmailAddressInfo>]
|
15835
|
+
#
|
15836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundAdditionalRecipients AWS API Documentation
|
15837
|
+
#
|
15838
|
+
class OutboundAdditionalRecipients < Struct.new(
|
15839
|
+
:cc_email_addresses)
|
15840
|
+
SENSITIVE = []
|
15841
|
+
include Aws::Structure
|
15842
|
+
end
|
15843
|
+
|
15844
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
15058
15845
|
#
|
15059
15846
|
# @!attribute [rw] outbound_caller_id_name
|
15060
15847
|
# The caller ID name.
|
@@ -15092,10 +15879,72 @@ module Aws::Connect
|
|
15092
15879
|
include Aws::Structure
|
15093
15880
|
end
|
15094
15881
|
|
15882
|
+
# The outbound email address Id.
|
15883
|
+
#
|
15884
|
+
# @!attribute [rw] outbound_email_address_id
|
15885
|
+
# The identifier of the email address.
|
15886
|
+
# @return [String]
|
15887
|
+
#
|
15888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundEmailConfig AWS API Documentation
|
15889
|
+
#
|
15890
|
+
class OutboundEmailConfig < Struct.new(
|
15891
|
+
:outbound_email_address_id)
|
15892
|
+
SENSITIVE = []
|
15893
|
+
include Aws::Structure
|
15894
|
+
end
|
15895
|
+
|
15896
|
+
# Information about email body content.
|
15897
|
+
#
|
15898
|
+
# @!attribute [rw] message_source_type
|
15899
|
+
# The message source type, that is, `RAW` or `TEMPLATE`.
|
15900
|
+
# @return [String]
|
15901
|
+
#
|
15902
|
+
# @!attribute [rw] templated_message_config
|
15903
|
+
# Information about template message configuration.
|
15904
|
+
# @return [Types::TemplatedMessageConfig]
|
15905
|
+
#
|
15906
|
+
# @!attribute [rw] raw_message
|
15907
|
+
# The raw email body content.
|
15908
|
+
# @return [Types::OutboundRawMessage]
|
15909
|
+
#
|
15910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundEmailContent AWS API Documentation
|
15911
|
+
#
|
15912
|
+
class OutboundEmailContent < Struct.new(
|
15913
|
+
:message_source_type,
|
15914
|
+
:templated_message_config,
|
15915
|
+
:raw_message)
|
15916
|
+
SENSITIVE = []
|
15917
|
+
include Aws::Structure
|
15918
|
+
end
|
15919
|
+
|
15920
|
+
# Information about the raw email body content.
|
15921
|
+
#
|
15922
|
+
# @!attribute [rw] subject
|
15923
|
+
# The email subject.
|
15924
|
+
# @return [String]
|
15925
|
+
#
|
15926
|
+
# @!attribute [rw] body
|
15927
|
+
# The email message body.
|
15928
|
+
# @return [String]
|
15929
|
+
#
|
15930
|
+
# @!attribute [rw] content_type
|
15931
|
+
# Type of content, that is, `text/plain` or `text/html`.
|
15932
|
+
# @return [String]
|
15933
|
+
#
|
15934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundRawMessage AWS API Documentation
|
15935
|
+
#
|
15936
|
+
class OutboundRawMessage < Struct.new(
|
15937
|
+
:subject,
|
15938
|
+
:body,
|
15939
|
+
:content_type)
|
15940
|
+
SENSITIVE = [:subject, :body]
|
15941
|
+
include Aws::Structure
|
15942
|
+
end
|
15943
|
+
|
15095
15944
|
# Thrown for analyzed content when requested OutputType was not enabled
|
15096
15945
|
# for a given contact. For example, if an OutputType.Raw was requested
|
15097
|
-
# for a contact that had `RedactedOnly` Redaction policy set in
|
15098
|
-
#
|
15946
|
+
# for a contact that had `RedactedOnly` Redaction policy set in the
|
15947
|
+
# flow.
|
15099
15948
|
#
|
15100
15949
|
# @!attribute [rw] message
|
15101
15950
|
# @return [String]
|
@@ -15796,6 +16645,10 @@ module Aws::Connect
|
|
15796
16645
|
# The outbound caller ID name, number, and outbound whisper flow.
|
15797
16646
|
# @return [Types::OutboundCallerConfig]
|
15798
16647
|
#
|
16648
|
+
# @!attribute [rw] outbound_email_config
|
16649
|
+
# The outbound email address ID for a specified queue.
|
16650
|
+
# @return [Types::OutboundEmailConfig]
|
16651
|
+
#
|
15799
16652
|
# @!attribute [rw] hours_of_operation_id
|
15800
16653
|
# The identifier for the hours of operation.
|
15801
16654
|
# @return [String]
|
@@ -15832,6 +16685,7 @@ module Aws::Connect
|
|
15832
16685
|
:queue_id,
|
15833
16686
|
:description,
|
15834
16687
|
:outbound_caller_config,
|
16688
|
+
:outbound_email_config,
|
15835
16689
|
:hours_of_operation_id,
|
15836
16690
|
:max_contacts,
|
15837
16691
|
:status,
|
@@ -16684,11 +17538,26 @@ module Aws::Connect
|
|
16684
17538
|
# The type of the reference. `DATE` must be of type Epoch timestamp.
|
16685
17539
|
# @return [String]
|
16686
17540
|
#
|
17541
|
+
# @!attribute [rw] status
|
17542
|
+
# Status of the attachment reference type.
|
17543
|
+
# @return [String]
|
17544
|
+
#
|
17545
|
+
# @!attribute [rw] arn
|
17546
|
+
# The Amazon Resource Name (ARN) of the reference
|
17547
|
+
# @return [String]
|
17548
|
+
#
|
17549
|
+
# @!attribute [rw] status_reason
|
17550
|
+
# Relevant details why the reference was not successfully created.
|
17551
|
+
# @return [String]
|
17552
|
+
#
|
16687
17553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
16688
17554
|
#
|
16689
17555
|
class Reference < Struct.new(
|
16690
17556
|
:value,
|
16691
|
-
:type
|
17557
|
+
:type,
|
17558
|
+
:status,
|
17559
|
+
:arn,
|
17560
|
+
:status_reason)
|
16692
17561
|
SENSITIVE = []
|
16693
17562
|
include Aws::Structure
|
16694
17563
|
end
|
@@ -16709,6 +17578,11 @@ module Aws::Connect
|
|
16709
17578
|
# `ATTACHMENT`. Otherwise, null.
|
16710
17579
|
# @return [Types::AttachmentReference]
|
16711
17580
|
#
|
17581
|
+
# @!attribute [rw] email_message
|
17582
|
+
# Information about the reference when the referenceType is
|
17583
|
+
# `EMAIL_MESSAGE`. Otherwise, null.
|
17584
|
+
# @return [Types::EmailMessageReference]
|
17585
|
+
#
|
16712
17586
|
# @!attribute [rw] string
|
16713
17587
|
# Information about a reference when the `referenceType` is `STRING`.
|
16714
17588
|
# Otherwise, null.
|
@@ -16734,6 +17608,7 @@ module Aws::Connect
|
|
16734
17608
|
class ReferenceSummary < Struct.new(
|
16735
17609
|
:url,
|
16736
17610
|
:attachment,
|
17611
|
+
:email_message,
|
16737
17612
|
:string,
|
16738
17613
|
:number,
|
16739
17614
|
:date,
|
@@ -16745,6 +17620,7 @@ module Aws::Connect
|
|
16745
17620
|
|
16746
17621
|
class Url < ReferenceSummary; end
|
16747
17622
|
class Attachment < ReferenceSummary; end
|
17623
|
+
class EmailMessage < ReferenceSummary; end
|
16748
17624
|
class String < ReferenceSummary; end
|
16749
17625
|
class Number < ReferenceSummary; end
|
16750
17626
|
class Date < ReferenceSummary; end
|
@@ -17883,7 +18759,7 @@ module Aws::Connect
|
|
17883
18759
|
# @return [Types::ContactFlowModuleSearchFilter]
|
17884
18760
|
#
|
17885
18761
|
# @!attribute [rw] search_criteria
|
17886
|
-
# The search criteria to be used to return
|
18762
|
+
# The search criteria to be used to return flow modules.
|
17887
18763
|
#
|
17888
18764
|
# <note markdown="1"> The `name` and `description` fields support "contains" queries
|
17889
18765
|
# with a minimum of 2 characters and a maximum of 25 characters. Any
|
@@ -17906,7 +18782,7 @@ module Aws::Connect
|
|
17906
18782
|
end
|
17907
18783
|
|
17908
18784
|
# @!attribute [rw] contact_flow_modules
|
17909
|
-
# The search criteria to be used to return
|
18785
|
+
# The search criteria to be used to return flow modules.
|
17910
18786
|
# @return [Array<Types::ContactFlowModule>]
|
17911
18787
|
#
|
17912
18788
|
# @!attribute [rw] next_token
|
@@ -17915,7 +18791,7 @@ module Aws::Connect
|
|
17915
18791
|
# @return [String]
|
17916
18792
|
#
|
17917
18793
|
# @!attribute [rw] approximate_total_count
|
17918
|
-
# The total number of
|
18794
|
+
# The total number of flows which matched your search query.
|
17919
18795
|
# @return [Integer]
|
17920
18796
|
#
|
17921
18797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlowModulesResponse AWS API Documentation
|
@@ -17980,7 +18856,7 @@ module Aws::Connect
|
|
17980
18856
|
# @return [String]
|
17981
18857
|
#
|
17982
18858
|
# @!attribute [rw] approximate_total_count
|
17983
|
-
# The total number of
|
18859
|
+
# The total number of flows which matched your search query.
|
17984
18860
|
# @return [Integer]
|
17985
18861
|
#
|
17986
18862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlowsResponse AWS API Documentation
|
@@ -18126,6 +19002,11 @@ module Aws::Connect
|
|
18126
19002
|
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions
|
18127
19003
|
# @return [Types::SearchableContactAttributes]
|
18128
19004
|
#
|
19005
|
+
# @!attribute [rw] searchable_segment_attributes
|
19006
|
+
# The search criteria based on searchable segment attributes of a
|
19007
|
+
# contact.
|
19008
|
+
# @return [Types::SearchableSegmentAttributes]
|
19009
|
+
#
|
18129
19010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchCriteria AWS API Documentation
|
18130
19011
|
#
|
18131
19012
|
class SearchCriteria < Struct.new(
|
@@ -18135,7 +19016,70 @@ module Aws::Connect
|
|
18135
19016
|
:contact_analysis,
|
18136
19017
|
:initiation_methods,
|
18137
19018
|
:queue_ids,
|
18138
|
-
:searchable_contact_attributes
|
19019
|
+
:searchable_contact_attributes,
|
19020
|
+
:searchable_segment_attributes)
|
19021
|
+
SENSITIVE = []
|
19022
|
+
include Aws::Structure
|
19023
|
+
end
|
19024
|
+
|
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
|
19032
|
+
# @return [String]
|
19033
|
+
#
|
19034
|
+
# @!attribute [rw] max_results
|
19035
|
+
# The maximum number of results to return per page.
|
19036
|
+
# @return [Integer]
|
19037
|
+
#
|
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.
|
19042
|
+
# @return [String]
|
19043
|
+
#
|
19044
|
+
# @!attribute [rw] search_criteria
|
19045
|
+
# The search criteria to be used to return email addresses.
|
19046
|
+
# @return [Types::EmailAddressSearchCriteria]
|
19047
|
+
#
|
19048
|
+
# @!attribute [rw] search_filter
|
19049
|
+
# Filters to be applied to search results.
|
19050
|
+
# @return [Types::EmailAddressSearchFilter]
|
19051
|
+
#
|
19052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEmailAddressesRequest AWS API Documentation
|
19053
|
+
#
|
19054
|
+
class SearchEmailAddressesRequest < Struct.new(
|
19055
|
+
:instance_id,
|
19056
|
+
:max_results,
|
19057
|
+
:next_token,
|
19058
|
+
:search_criteria,
|
19059
|
+
:search_filter)
|
19060
|
+
SENSITIVE = []
|
19061
|
+
include Aws::Structure
|
19062
|
+
end
|
19063
|
+
|
19064
|
+
# @!attribute [rw] next_token
|
19065
|
+
# If there are additional results, this is the token for the next set
|
19066
|
+
# of results.
|
19067
|
+
# @return [String]
|
19068
|
+
#
|
19069
|
+
# @!attribute [rw] email_addresses
|
19070
|
+
# List of email addresses matching SearchFilter and SearchCriteria
|
19071
|
+
# @return [Array<Types::EmailAddressMetadata>]
|
19072
|
+
#
|
19073
|
+
# @!attribute [rw] approximate_total_count
|
19074
|
+
# The total number of email addresses which matched your search query.
|
19075
|
+
# @return [Integer]
|
19076
|
+
#
|
19077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEmailAddressesResponse AWS API Documentation
|
19078
|
+
#
|
19079
|
+
class SearchEmailAddressesResponse < Struct.new(
|
19080
|
+
:next_token,
|
19081
|
+
:email_addresses,
|
19082
|
+
:approximate_total_count)
|
18139
19083
|
SENSITIVE = []
|
18140
19084
|
include Aws::Structure
|
18141
19085
|
end
|
@@ -18890,7 +19834,7 @@ module Aws::Connect
|
|
18890
19834
|
include Aws::Structure
|
18891
19835
|
end
|
18892
19836
|
|
18893
|
-
# The search criteria based on user-
|
19837
|
+
# The search criteria based on user-defined contact attribute key and
|
18894
19838
|
# values to search on.
|
18895
19839
|
#
|
18896
19840
|
# @!attribute [rw] key
|
@@ -18911,6 +19855,48 @@ module Aws::Connect
|
|
18911
19855
|
include Aws::Structure
|
18912
19856
|
end
|
18913
19857
|
|
19858
|
+
# The search criteria based on searchable segment attributes of a
|
19859
|
+
# contact
|
19860
|
+
#
|
19861
|
+
# @!attribute [rw] criteria
|
19862
|
+
# The list of criteria based on searchable segment attributes.
|
19863
|
+
# @return [Array<Types::SearchableSegmentAttributesCriteria>]
|
19864
|
+
#
|
19865
|
+
# @!attribute [rw] match_type
|
19866
|
+
# The match type combining search criteria using multiple searchable
|
19867
|
+
# segment attributes.
|
19868
|
+
# @return [String]
|
19869
|
+
#
|
19870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableSegmentAttributes AWS API Documentation
|
19871
|
+
#
|
19872
|
+
class SearchableSegmentAttributes < Struct.new(
|
19873
|
+
:criteria,
|
19874
|
+
:match_type)
|
19875
|
+
SENSITIVE = []
|
19876
|
+
include Aws::Structure
|
19877
|
+
end
|
19878
|
+
|
19879
|
+
# The search criteria based on searchable segment attribute key and
|
19880
|
+
# values to search on.
|
19881
|
+
#
|
19882
|
+
# @!attribute [rw] key
|
19883
|
+
# The key containing a searchable segment attribute.
|
19884
|
+
# @return [String]
|
19885
|
+
#
|
19886
|
+
# @!attribute [rw] values
|
19887
|
+
# The list of values to search for within a searchable segment
|
19888
|
+
# attribute.
|
19889
|
+
# @return [Array<String>]
|
19890
|
+
#
|
19891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableSegmentAttributesCriteria AWS API Documentation
|
19892
|
+
#
|
19893
|
+
class SearchableSegmentAttributesCriteria < Struct.new(
|
19894
|
+
:key,
|
19895
|
+
:values)
|
19896
|
+
SENSITIVE = [:key, :values]
|
19897
|
+
include Aws::Structure
|
19898
|
+
end
|
19899
|
+
|
18914
19900
|
# Configuration information of the security key.
|
18915
19901
|
#
|
18916
19902
|
# @!attribute [rw] association_id
|
@@ -19151,10 +20137,20 @@ module Aws::Connect
|
|
19151
20137
|
# The value of a segment attribute.
|
19152
20138
|
# @return [String]
|
19153
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
|
+
#
|
19154
20148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SegmentAttributeValue AWS API Documentation
|
19155
20149
|
#
|
19156
20150
|
class SegmentAttributeValue < Struct.new(
|
19157
|
-
:value_string
|
20151
|
+
:value_string,
|
20152
|
+
:value_map,
|
20153
|
+
:value_integer)
|
19158
20154
|
SENSITIVE = []
|
19159
20155
|
include Aws::Structure
|
19160
20156
|
end
|
@@ -19267,19 +20263,110 @@ module Aws::Connect
|
|
19267
20263
|
include Aws::Structure
|
19268
20264
|
end
|
19269
20265
|
|
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
|
20273
|
+
# @return [String]
|
20274
|
+
#
|
20275
|
+
# @!attribute [rw] from_email_address
|
20276
|
+
# The email address to be used for sending email.
|
20277
|
+
# @return [Types::EmailAddressInfo]
|
20278
|
+
#
|
20279
|
+
# @!attribute [rw] destination_email_address
|
20280
|
+
# The email address to send the email to.
|
20281
|
+
# @return [Types::EmailAddressInfo]
|
20282
|
+
#
|
20283
|
+
# @!attribute [rw] additional_recipients
|
20284
|
+
# The additional recipients address of the email in CC.
|
20285
|
+
# @return [Types::OutboundAdditionalRecipients]
|
20286
|
+
#
|
20287
|
+
# @!attribute [rw] email_message
|
20288
|
+
# The email message body to be sent to the newly created email.
|
20289
|
+
# @return [Types::OutboundEmailContent]
|
20290
|
+
#
|
20291
|
+
# @!attribute [rw] traffic_type
|
20292
|
+
# Denotes the class of traffic.
|
20293
|
+
# @return [String]
|
20294
|
+
#
|
20295
|
+
# @!attribute [rw] source_campaign
|
20296
|
+
# A Campaign object need for Campaign traffic type.
|
20297
|
+
# @return [Types::SourceCampaign]
|
20298
|
+
#
|
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
|
+
#
|
20305
|
+
# **A suitable default value is auto-generated.** You should normally
|
20306
|
+
# not need to pass this option.
|
20307
|
+
#
|
20308
|
+
#
|
20309
|
+
#
|
20310
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
20311
|
+
# @return [String]
|
20312
|
+
#
|
20313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundEmailRequest AWS API Documentation
|
20314
|
+
#
|
20315
|
+
class SendOutboundEmailRequest < Struct.new(
|
20316
|
+
:instance_id,
|
20317
|
+
:from_email_address,
|
20318
|
+
:destination_email_address,
|
20319
|
+
:additional_recipients,
|
20320
|
+
:email_message,
|
20321
|
+
:traffic_type,
|
20322
|
+
:source_campaign,
|
20323
|
+
:client_token)
|
20324
|
+
SENSITIVE = []
|
20325
|
+
include Aws::Structure
|
20326
|
+
end
|
20327
|
+
|
20328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundEmailResponse AWS API Documentation
|
20329
|
+
#
|
20330
|
+
class SendOutboundEmailResponse < Aws::EmptyStructure; end
|
20331
|
+
|
19270
20332
|
# The service quota has been exceeded.
|
19271
20333
|
#
|
19272
20334
|
# @!attribute [rw] message
|
19273
20335
|
# @return [String]
|
19274
20336
|
#
|
20337
|
+
# @!attribute [rw] reason
|
20338
|
+
# The reason for the exception.
|
20339
|
+
# @return [Types::ServiceQuotaExceededExceptionReason]
|
20340
|
+
#
|
19275
20341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ServiceQuotaExceededException AWS API Documentation
|
19276
20342
|
#
|
19277
20343
|
class ServiceQuotaExceededException < Struct.new(
|
19278
|
-
:message
|
20344
|
+
:message,
|
20345
|
+
:reason)
|
19279
20346
|
SENSITIVE = []
|
19280
20347
|
include Aws::Structure
|
19281
20348
|
end
|
19282
20349
|
|
20350
|
+
# The reason for the exception.
|
20351
|
+
#
|
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
|
20355
|
+
# @return [String]
|
20356
|
+
#
|
20357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ServiceQuotaExceededExceptionReason AWS API Documentation
|
20358
|
+
#
|
20359
|
+
class ServiceQuotaExceededExceptionReason < Struct.new(
|
20360
|
+
:attached_file_service_quota_exceeded_exception_reason,
|
20361
|
+
:unknown)
|
20362
|
+
SENSITIVE = []
|
20363
|
+
include Aws::Structure
|
20364
|
+
include Aws::Structure::Union
|
20365
|
+
|
20366
|
+
class AttachedFileServiceQuotaExceededExceptionReason < ServiceQuotaExceededExceptionReason; end
|
20367
|
+
class Unknown < ServiceQuotaExceededExceptionReason; end
|
20368
|
+
end
|
20369
|
+
|
19283
20370
|
# The distribution that determines which Amazon Web Services Regions
|
19284
20371
|
# should be used to sign in agents in to both the instance and its
|
19285
20372
|
# replica(s).
|
@@ -19364,6 +20451,25 @@ module Aws::Connect
|
|
19364
20451
|
include Aws::Structure
|
19365
20452
|
end
|
19366
20453
|
|
20454
|
+
# Information about the campaign.
|
20455
|
+
#
|
20456
|
+
# @!attribute [rw] campaign_id
|
20457
|
+
# A unique identifier for a campaign.
|
20458
|
+
# @return [String]
|
20459
|
+
#
|
20460
|
+
# @!attribute [rw] outbound_request_id
|
20461
|
+
# A unique identifier for a each request part of same campaign.
|
20462
|
+
# @return [String]
|
20463
|
+
#
|
20464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SourceCampaign AWS API Documentation
|
20465
|
+
#
|
20466
|
+
class SourceCampaign < Struct.new(
|
20467
|
+
:campaign_id,
|
20468
|
+
:outbound_request_id)
|
20469
|
+
SENSITIVE = []
|
20470
|
+
include Aws::Structure
|
20471
|
+
end
|
20472
|
+
|
19367
20473
|
# @!attribute [rw] client_token
|
19368
20474
|
# A unique, case-sensitive identifier that you provide to ensure the
|
19369
20475
|
# idempotency of the request. If not provided, the Amazon Web Services
|
@@ -19397,11 +20503,13 @@ module Aws::Connect
|
|
19397
20503
|
#
|
19398
20504
|
# @!attribute [rw] file_use_case_type
|
19399
20505
|
# The use case for the file.
|
20506
|
+
#
|
20507
|
+
# Only `ATTACHMENTS` are supported.
|
19400
20508
|
# @return [String]
|
19401
20509
|
#
|
19402
20510
|
# @!attribute [rw] associated_resource_arn
|
19403
|
-
# The resource to which the attached file is (being) uploaded to.
|
19404
|
-
# [Cases][1]
|
20511
|
+
# The resource to which the attached file is (being) uploaded to. The
|
20512
|
+
# supported resources are [Cases][1] and [Email][2].
|
19405
20513
|
#
|
19406
20514
|
# <note markdown="1"> This value must be a valid ARN.
|
19407
20515
|
#
|
@@ -19409,7 +20517,8 @@ module Aws::Connect
|
|
19409
20517
|
#
|
19410
20518
|
#
|
19411
20519
|
#
|
19412
|
-
# [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
|
19413
20522
|
# @return [String]
|
19414
20523
|
#
|
19415
20524
|
# @!attribute [rw] created_by
|
@@ -19491,8 +20600,8 @@ module Aws::Connect
|
|
19491
20600
|
# @!attribute [rw] contact_flow_id
|
19492
20601
|
# The identifier of the flow for initiating the chat. To see the
|
19493
20602
|
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
19494
|
-
# menu go to **Routing**, **
|
19495
|
-
#
|
20603
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow
|
20604
|
+
# page, under the name of the flow, choose **Show additional flow
|
19496
20605
|
# information**. The ContactFlowId is the last part of the ARN, shown
|
19497
20606
|
# here in bold:
|
19498
20607
|
#
|
@@ -19723,52 +20832,184 @@ module Aws::Connect
|
|
19723
20832
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
19724
20833
|
# @return [String]
|
19725
20834
|
#
|
19726
|
-
# @!attribute [rw] contact_id
|
19727
|
-
# The identifier of the contact.
|
20835
|
+
# @!attribute [rw] contact_id
|
20836
|
+
# The identifier of the contact.
|
20837
|
+
# @return [String]
|
20838
|
+
#
|
20839
|
+
# @!attribute [rw] initial_contact_id
|
20840
|
+
# The identifier of the contact. This is the identifier of the contact
|
20841
|
+
# associated with the first interaction with the contact center.
|
20842
|
+
# @return [String]
|
20843
|
+
#
|
20844
|
+
# @!attribute [rw] voice_recording_configuration
|
20845
|
+
# The person being recorded.
|
20846
|
+
# @return [Types::VoiceRecordingConfiguration]
|
20847
|
+
#
|
20848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingRequest AWS API Documentation
|
20849
|
+
#
|
20850
|
+
class StartContactRecordingRequest < Struct.new(
|
20851
|
+
:instance_id,
|
20852
|
+
:contact_id,
|
20853
|
+
:initial_contact_id,
|
20854
|
+
:voice_recording_configuration)
|
20855
|
+
SENSITIVE = []
|
20856
|
+
include Aws::Structure
|
20857
|
+
end
|
20858
|
+
|
20859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingResponse AWS API Documentation
|
20860
|
+
#
|
20861
|
+
class StartContactRecordingResponse < Aws::EmptyStructure; end
|
20862
|
+
|
20863
|
+
# @!attribute [rw] instance_id
|
20864
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
20865
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
20866
|
+
#
|
20867
|
+
#
|
20868
|
+
#
|
20869
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
20870
|
+
# @return [String]
|
20871
|
+
#
|
20872
|
+
# @!attribute [rw] contact_id
|
20873
|
+
# The identifier of the contact. This is the identifier of the contact
|
20874
|
+
# associated with the first interaction with the contact center.
|
20875
|
+
# @return [String]
|
20876
|
+
#
|
20877
|
+
# @!attribute [rw] chat_streaming_configuration
|
20878
|
+
# The streaming configuration, such as the Amazon SNS streaming
|
20879
|
+
# endpoint.
|
20880
|
+
# @return [Types::ChatStreamingConfiguration]
|
20881
|
+
#
|
20882
|
+
# @!attribute [rw] client_token
|
20883
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
20884
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
20885
|
+
# SDK populates this field. For more information about idempotency,
|
20886
|
+
# see [Making retries safe with idempotent APIs][1].
|
20887
|
+
#
|
20888
|
+
# **A suitable default value is auto-generated.** You should normally
|
20889
|
+
# not need to pass this option.
|
20890
|
+
#
|
20891
|
+
#
|
20892
|
+
#
|
20893
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
20894
|
+
# @return [String]
|
20895
|
+
#
|
20896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreamingRequest AWS API Documentation
|
20897
|
+
#
|
20898
|
+
class StartContactStreamingRequest < Struct.new(
|
20899
|
+
:instance_id,
|
20900
|
+
:contact_id,
|
20901
|
+
:chat_streaming_configuration,
|
20902
|
+
:client_token)
|
20903
|
+
SENSITIVE = []
|
20904
|
+
include Aws::Structure
|
20905
|
+
end
|
20906
|
+
|
20907
|
+
# @!attribute [rw] streaming_id
|
20908
|
+
# The identifier of the streaming configuration enabled.
|
20909
|
+
# @return [String]
|
20910
|
+
#
|
20911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreamingResponse AWS API Documentation
|
20912
|
+
#
|
20913
|
+
class StartContactStreamingResponse < Struct.new(
|
20914
|
+
:streaming_id)
|
20915
|
+
SENSITIVE = []
|
20916
|
+
include Aws::Structure
|
20917
|
+
end
|
20918
|
+
|
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
|
20926
|
+
# @return [String]
|
20927
|
+
#
|
20928
|
+
# @!attribute [rw] from_email_address
|
20929
|
+
# The email address of the customer.
|
20930
|
+
# @return [Types::EmailAddressInfo]
|
20931
|
+
#
|
20932
|
+
# @!attribute [rw] destination_email_address
|
20933
|
+
# The email address associated with the instance.
|
20934
|
+
# @return [String]
|
20935
|
+
#
|
20936
|
+
# @!attribute [rw] description
|
20937
|
+
# A description of the email contact.
|
20938
|
+
# @return [String]
|
20939
|
+
#
|
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.
|
20946
|
+
# @return [Hash<String,Types::Reference>]
|
20947
|
+
#
|
20948
|
+
# @!attribute [rw] name
|
20949
|
+
# The name of a email that is shown to an agent in the Contact Control
|
20950
|
+
# Panel (CCP).
|
20951
|
+
# @return [String]
|
20952
|
+
#
|
20953
|
+
# @!attribute [rw] email_message
|
20954
|
+
# The email message body to be sent to the newly created email.
|
20955
|
+
# @return [Types::InboundEmailContent]
|
20956
|
+
#
|
20957
|
+
# @!attribute [rw] additional_recipients
|
20958
|
+
# The addtional recipients address of the email.
|
20959
|
+
# @return [Types::InboundAdditionalRecipients]
|
20960
|
+
#
|
20961
|
+
# @!attribute [rw] attachments
|
20962
|
+
# List of S3 presigned URLs of email attachments and their file name.
|
20963
|
+
# @return [Array<Types::EmailAttachment>]
|
20964
|
+
#
|
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**
|
19728
20974
|
# @return [String]
|
19729
20975
|
#
|
19730
|
-
# @!attribute [rw]
|
19731
|
-
# The
|
19732
|
-
#
|
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`.
|
19733
20983
|
# @return [String]
|
19734
20984
|
#
|
19735
|
-
# @!attribute [rw]
|
19736
|
-
#
|
19737
|
-
#
|
19738
|
-
#
|
19739
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingRequest AWS API Documentation
|
19740
|
-
#
|
19741
|
-
class StartContactRecordingRequest < Struct.new(
|
19742
|
-
:instance_id,
|
19743
|
-
:contact_id,
|
19744
|
-
:initial_contact_id,
|
19745
|
-
:voice_recording_configuration)
|
19746
|
-
SENSITIVE = []
|
19747
|
-
include Aws::Structure
|
19748
|
-
end
|
19749
|
-
|
19750
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingResponse AWS API Documentation
|
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.
|
19751
20989
|
#
|
19752
|
-
|
19753
|
-
|
19754
|
-
#
|
19755
|
-
#
|
19756
|
-
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
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.
|
20993
|
+
# @return [Hash<String,String>]
|
19757
20994
|
#
|
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.
|
19758
20999
|
#
|
21000
|
+
# Attribute keys can include only alphanumeric, -, and \_.
|
19759
21001
|
#
|
19760
|
-
#
|
19761
|
-
#
|
21002
|
+
# This field can be used to show channel subtype, such as
|
21003
|
+
# `connect:Guide`.
|
19762
21004
|
#
|
19763
|
-
#
|
19764
|
-
#
|
19765
|
-
#
|
19766
|
-
#
|
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}}}}`.
|
19767
21010
|
#
|
19768
|
-
#
|
19769
|
-
#
|
19770
|
-
# endpoint.
|
19771
|
-
# @return [Types::ChatStreamingConfiguration]
|
21011
|
+
# </note>
|
21012
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
19772
21013
|
#
|
19773
21014
|
# @!attribute [rw] client_token
|
19774
21015
|
# A unique, case-sensitive identifier that you provide to ensure the
|
@@ -19784,25 +21025,35 @@ module Aws::Connect
|
|
19784
21025
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
19785
21026
|
# @return [String]
|
19786
21027
|
#
|
19787
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
21028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEmailContactRequest AWS API Documentation
|
19788
21029
|
#
|
19789
|
-
class
|
21030
|
+
class StartEmailContactRequest < Struct.new(
|
19790
21031
|
:instance_id,
|
19791
|
-
:
|
19792
|
-
:
|
21032
|
+
:from_email_address,
|
21033
|
+
:destination_email_address,
|
21034
|
+
:description,
|
21035
|
+
:references,
|
21036
|
+
:name,
|
21037
|
+
:email_message,
|
21038
|
+
:additional_recipients,
|
21039
|
+
:attachments,
|
21040
|
+
:contact_flow_id,
|
21041
|
+
:related_contact_id,
|
21042
|
+
:attributes,
|
21043
|
+
:segment_attributes,
|
19793
21044
|
:client_token)
|
19794
|
-
SENSITIVE = []
|
21045
|
+
SENSITIVE = [:destination_email_address, :description, :name, :attachments]
|
19795
21046
|
include Aws::Structure
|
19796
21047
|
end
|
19797
21048
|
|
19798
|
-
# @!attribute [rw]
|
19799
|
-
# The identifier of the
|
21049
|
+
# @!attribute [rw] contact_id
|
21050
|
+
# The identifier of this contact within the Amazon Connect instance.
|
19800
21051
|
# @return [String]
|
19801
21052
|
#
|
19802
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
21053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEmailContactResponse AWS API Documentation
|
19803
21054
|
#
|
19804
|
-
class
|
19805
|
-
:
|
21055
|
+
class StartEmailContactResponse < Struct.new(
|
21056
|
+
:contact_id)
|
19806
21057
|
SENSITIVE = []
|
19807
21058
|
include Aws::Structure
|
19808
21059
|
end
|
@@ -19941,6 +21192,75 @@ module Aws::Connect
|
|
19941
21192
|
include Aws::Structure
|
19942
21193
|
end
|
19943
21194
|
|
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
|
21202
|
+
# @return [String]
|
21203
|
+
#
|
21204
|
+
# @!attribute [rw] contact_id
|
21205
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
21206
|
+
# @return [String]
|
21207
|
+
#
|
21208
|
+
# @!attribute [rw] from_email_address
|
21209
|
+
# The email address associated with the instance.
|
21210
|
+
# @return [Types::EmailAddressInfo]
|
21211
|
+
#
|
21212
|
+
# @!attribute [rw] destination_email_address
|
21213
|
+
# The email address of the customer.
|
21214
|
+
# @return [Types::EmailAddressInfo]
|
21215
|
+
#
|
21216
|
+
# @!attribute [rw] additional_recipients
|
21217
|
+
# The addtional recipients address of email in CC.
|
21218
|
+
# @return [Types::OutboundAdditionalRecipients]
|
21219
|
+
#
|
21220
|
+
# @!attribute [rw] email_message
|
21221
|
+
# The email message body to be sent to the newly created email.
|
21222
|
+
# @return [Types::OutboundEmailContent]
|
21223
|
+
#
|
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
|
+
#
|
21230
|
+
# **A suitable default value is auto-generated.** You should normally
|
21231
|
+
# not need to pass this option.
|
21232
|
+
#
|
21233
|
+
#
|
21234
|
+
#
|
21235
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
21236
|
+
# @return [String]
|
21237
|
+
#
|
21238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundEmailContactRequest AWS API Documentation
|
21239
|
+
#
|
21240
|
+
class StartOutboundEmailContactRequest < Struct.new(
|
21241
|
+
:instance_id,
|
21242
|
+
:contact_id,
|
21243
|
+
:from_email_address,
|
21244
|
+
:destination_email_address,
|
21245
|
+
:additional_recipients,
|
21246
|
+
:email_message,
|
21247
|
+
:client_token)
|
21248
|
+
SENSITIVE = []
|
21249
|
+
include Aws::Structure
|
21250
|
+
end
|
21251
|
+
|
21252
|
+
# @!attribute [rw] contact_id
|
21253
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
21254
|
+
# @return [String]
|
21255
|
+
#
|
21256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundEmailContactResponse AWS API Documentation
|
21257
|
+
#
|
21258
|
+
class StartOutboundEmailContactResponse < Struct.new(
|
21259
|
+
:contact_id)
|
21260
|
+
SENSITIVE = []
|
21261
|
+
include Aws::Structure
|
21262
|
+
end
|
21263
|
+
|
19944
21264
|
# @!attribute [rw] name
|
19945
21265
|
# The name of a voice contact that is shown to an agent in the Contact
|
19946
21266
|
# Control Panel (CCP).
|
@@ -20140,8 +21460,8 @@ module Aws::Connect
|
|
20140
21460
|
# @!attribute [rw] contact_flow_id
|
20141
21461
|
# The identifier of the flow for initiating the tasks. To see the
|
20142
21462
|
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
20143
|
-
# menu go to **Routing**, **
|
20144
|
-
#
|
21463
|
+
# menu go to **Routing**, **Flows**. Choose the flow. On the flow
|
21464
|
+
# page, under the name of the flow, choose **Show additional flow
|
20145
21465
|
# information**. The ContactFlowId is the last part of the ARN, shown
|
20146
21466
|
# here in bold:
|
20147
21467
|
#
|
@@ -20231,6 +21551,31 @@ module Aws::Connect
|
|
20231
21551
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks
|
20232
21552
|
# @return [String]
|
20233
21553
|
#
|
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>
|
21577
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
21578
|
+
#
|
20234
21579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
20235
21580
|
#
|
20236
21581
|
class StartTaskContactRequest < Struct.new(
|
@@ -20245,7 +21590,8 @@ module Aws::Connect
|
|
20245
21590
|
:scheduled_time,
|
20246
21591
|
:task_template_id,
|
20247
21592
|
:quick_connect_id,
|
20248
|
-
:related_contact_id
|
21593
|
+
:related_contact_id,
|
21594
|
+
:segment_attributes)
|
20249
21595
|
SENSITIVE = [:name, :description]
|
20250
21596
|
include Aws::Structure
|
20251
21597
|
end
|
@@ -20995,6 +22341,57 @@ module Aws::Connect
|
|
20995
22341
|
include Aws::Structure
|
20996
22342
|
end
|
20997
22343
|
|
22344
|
+
# Information about the template attributes.
|
22345
|
+
#
|
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.
|
22351
|
+
# @return [Hash<String,String>]
|
22352
|
+
#
|
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.
|
22358
|
+
# @return [String]
|
22359
|
+
#
|
22360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TemplateAttributes AWS API Documentation
|
22361
|
+
#
|
22362
|
+
class TemplateAttributes < Struct.new(
|
22363
|
+
:custom_attributes,
|
22364
|
+
:customer_profile_attributes)
|
22365
|
+
SENSITIVE = []
|
22366
|
+
include Aws::Structure
|
22367
|
+
end
|
22368
|
+
|
22369
|
+
# Information about template message configuration.
|
22370
|
+
#
|
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.
|
22374
|
+
# @return [String]
|
22375
|
+
#
|
22376
|
+
# @!attribute [rw] message_template_id
|
22377
|
+
# The identifier of the message template Id.
|
22378
|
+
# @return [String]
|
22379
|
+
#
|
22380
|
+
# @!attribute [rw] template_attributes
|
22381
|
+
# Information about template attributes, that is, CustomAttributes or
|
22382
|
+
# CustomerProfileAttributes.
|
22383
|
+
# @return [Types::TemplateAttributes]
|
22384
|
+
#
|
22385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TemplatedMessageConfig AWS API Documentation
|
22386
|
+
#
|
22387
|
+
class TemplatedMessageConfig < Struct.new(
|
22388
|
+
:knowledge_base_id,
|
22389
|
+
:message_template_id,
|
22390
|
+
:template_attributes)
|
22391
|
+
SENSITIVE = []
|
22392
|
+
include Aws::Structure
|
22393
|
+
end
|
22394
|
+
|
20998
22395
|
# Contains information about the threshold for service level metrics.
|
20999
22396
|
#
|
21000
22397
|
# @!attribute [rw] comparison
|
@@ -21859,6 +23256,21 @@ module Aws::Connect
|
|
21859
23256
|
# Panel (CCP).
|
21860
23257
|
# @return [Hash<String,Types::Reference>]
|
21861
23258
|
#
|
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.
|
23272
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
23273
|
+
#
|
21862
23274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRequest AWS API Documentation
|
21863
23275
|
#
|
21864
23276
|
class UpdateContactRequest < Struct.new(
|
@@ -21866,7 +23278,8 @@ module Aws::Connect
|
|
21866
23278
|
:contact_id,
|
21867
23279
|
:name,
|
21868
23280
|
:description,
|
21869
|
-
:references
|
23281
|
+
:references,
|
23282
|
+
:segment_attributes)
|
21870
23283
|
SENSITIVE = [:name, :description]
|
21871
23284
|
include Aws::Structure
|
21872
23285
|
end
|
@@ -21956,6 +23369,67 @@ module Aws::Connect
|
|
21956
23369
|
#
|
21957
23370
|
class UpdateContactScheduleResponse < Aws::EmptyStructure; end
|
21958
23371
|
|
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
|
23379
|
+
# @return [String]
|
23380
|
+
#
|
23381
|
+
# @!attribute [rw] email_address_id
|
23382
|
+
# The identifier of the email address.
|
23383
|
+
# @return [String]
|
23384
|
+
#
|
23385
|
+
# @!attribute [rw] description
|
23386
|
+
# The description of the email address.
|
23387
|
+
# @return [String]
|
23388
|
+
#
|
23389
|
+
# @!attribute [rw] display_name
|
23390
|
+
# The display name of email address.
|
23391
|
+
# @return [String]
|
23392
|
+
#
|
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/
|
23402
|
+
# @return [String]
|
23403
|
+
#
|
23404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadataRequest AWS API Documentation
|
23405
|
+
#
|
23406
|
+
class UpdateEmailAddressMetadataRequest < Struct.new(
|
23407
|
+
:instance_id,
|
23408
|
+
:email_address_id,
|
23409
|
+
:description,
|
23410
|
+
:display_name,
|
23411
|
+
:client_token)
|
23412
|
+
SENSITIVE = [:description, :display_name]
|
23413
|
+
include Aws::Structure
|
23414
|
+
end
|
23415
|
+
|
23416
|
+
# @!attribute [rw] email_address_id
|
23417
|
+
# The identifier of the email address.
|
23418
|
+
# @return [String]
|
23419
|
+
#
|
23420
|
+
# @!attribute [rw] email_address_arn
|
23421
|
+
# The Amazon Resource Name (ARN) of the email address.
|
23422
|
+
# @return [String]
|
23423
|
+
#
|
23424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadataResponse AWS API Documentation
|
23425
|
+
#
|
23426
|
+
class UpdateEmailAddressMetadataResponse < Struct.new(
|
23427
|
+
:email_address_id,
|
23428
|
+
:email_address_arn)
|
23429
|
+
SENSITIVE = []
|
23430
|
+
include Aws::Structure
|
23431
|
+
end
|
23432
|
+
|
21959
23433
|
# @!attribute [rw] instance_id
|
21960
23434
|
# The identifier of the Amazon Connect instance. You can [find the
|
21961
23435
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -22499,6 +23973,33 @@ module Aws::Connect
|
|
22499
23973
|
include Aws::Structure
|
22500
23974
|
end
|
22501
23975
|
|
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
|
23983
|
+
# @return [String]
|
23984
|
+
#
|
23985
|
+
# @!attribute [rw] queue_id
|
23986
|
+
# The identifier for the queue.
|
23987
|
+
# @return [String]
|
23988
|
+
#
|
23989
|
+
# @!attribute [rw] outbound_email_config
|
23990
|
+
# The outbound email address ID for a specified queue.
|
23991
|
+
# @return [Types::OutboundEmailConfig]
|
23992
|
+
#
|
23993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundEmailConfigRequest AWS API Documentation
|
23994
|
+
#
|
23995
|
+
class UpdateQueueOutboundEmailConfigRequest < Struct.new(
|
23996
|
+
:instance_id,
|
23997
|
+
:queue_id,
|
23998
|
+
:outbound_email_config)
|
23999
|
+
SENSITIVE = []
|
24000
|
+
include Aws::Structure
|
24001
|
+
end
|
24002
|
+
|
22502
24003
|
# @!attribute [rw] instance_id
|
22503
24004
|
# The identifier of the Amazon Connect instance. You can [find the
|
22504
24005
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -22870,6 +24371,11 @@ module Aws::Connect
|
|
22870
24371
|
# created by referencing this template.
|
22871
24372
|
# @return [String]
|
22872
24373
|
#
|
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.
|
24377
|
+
# @return [String]
|
24378
|
+
#
|
22873
24379
|
# @!attribute [rw] constraints
|
22874
24380
|
# Constraints that are applicable to the fields listed.
|
22875
24381
|
# @return [Types::TaskTemplateConstraints]
|
@@ -22898,6 +24404,7 @@ module Aws::Connect
|
|
22898
24404
|
:name,
|
22899
24405
|
:description,
|
22900
24406
|
:contact_flow_id,
|
24407
|
+
:self_assign_flow_id,
|
22901
24408
|
:constraints,
|
22902
24409
|
:defaults,
|
22903
24410
|
:status,
|
@@ -22936,6 +24443,11 @@ module Aws::Connect
|
|
22936
24443
|
# created by referencing this template.
|
22937
24444
|
# @return [String]
|
22938
24445
|
#
|
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.
|
24449
|
+
# @return [String]
|
24450
|
+
#
|
22939
24451
|
# @!attribute [rw] constraints
|
22940
24452
|
# Constraints that are applicable to the fields listed.
|
22941
24453
|
# @return [Types::TaskTemplateConstraints]
|
@@ -22973,6 +24485,7 @@ module Aws::Connect
|
|
22973
24485
|
:name,
|
22974
24486
|
:description,
|
22975
24487
|
:contact_flow_id,
|
24488
|
+
:self_assign_flow_id,
|
22976
24489
|
:constraints,
|
22977
24490
|
:defaults,
|
22978
24491
|
:fields,
|
@@ -23681,6 +25194,20 @@ module Aws::Connect
|
|
23681
25194
|
include Aws::Structure
|
23682
25195
|
end
|
23683
25196
|
|
25197
|
+
# The user details for the contact.
|
25198
|
+
#
|
25199
|
+
# @!attribute [rw] user_id
|
25200
|
+
# The user identifier for the contact.
|
25201
|
+
# @return [String]
|
25202
|
+
#
|
25203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserInfo AWS API Documentation
|
25204
|
+
#
|
25205
|
+
class UserInfo < Struct.new(
|
25206
|
+
:user_id)
|
25207
|
+
SENSITIVE = []
|
25208
|
+
include Aws::Structure
|
25209
|
+
end
|
25210
|
+
|
23684
25211
|
# No user with the specified credentials was found in the Amazon Connect
|
23685
25212
|
# instance.
|
23686
25213
|
#
|