aws-sdk-customerprofiles 1.56.0 → 1.58.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-customerprofiles/client.rb +1784 -72
- data/lib/aws-sdk-customerprofiles/client_api.rb +845 -0
- data/lib/aws-sdk-customerprofiles/types.rb +2016 -126
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- data/sig/client.rbs +769 -2
- data/sig/types.rbs +533 -1
- metadata +2 -2
@@ -160,6 +160,45 @@ module Aws::CustomerProfiles
|
|
160
160
|
include Aws::Structure
|
161
161
|
end
|
162
162
|
|
163
|
+
# Object that segments on Customer Profile's address object.
|
164
|
+
#
|
165
|
+
# @!attribute [rw] city
|
166
|
+
# The city belonging to the address.
|
167
|
+
# @return [Types::ProfileDimension]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] country
|
170
|
+
# The country belonging to the address.
|
171
|
+
# @return [Types::ProfileDimension]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] county
|
174
|
+
# The county belonging to the address.
|
175
|
+
# @return [Types::ProfileDimension]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] postal_code
|
178
|
+
# The postal code belonging to the address.
|
179
|
+
# @return [Types::ProfileDimension]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] province
|
182
|
+
# The province belonging to the address.
|
183
|
+
# @return [Types::ProfileDimension]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] state
|
186
|
+
# The state belonging to the address.
|
187
|
+
# @return [Types::ProfileDimension]
|
188
|
+
#
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AddressDimension AWS API Documentation
|
190
|
+
#
|
191
|
+
class AddressDimension < Struct.new(
|
192
|
+
:city,
|
193
|
+
:country,
|
194
|
+
:county,
|
195
|
+
:postal_code,
|
196
|
+
:province,
|
197
|
+
:state)
|
198
|
+
SENSITIVE = []
|
199
|
+
include Aws::Structure
|
200
|
+
end
|
201
|
+
|
163
202
|
# Details for workflow of type `APPFLOW_INTEGRATION`.
|
164
203
|
#
|
165
204
|
# @!attribute [rw] flow_definition
|
@@ -314,6 +353,25 @@ module Aws::CustomerProfiles
|
|
314
353
|
include Aws::Structure
|
315
354
|
end
|
316
355
|
|
356
|
+
# Object that segments on various Customer Profile's fields.
|
357
|
+
#
|
358
|
+
# @!attribute [rw] dimension_type
|
359
|
+
# The action to segment with.
|
360
|
+
# @return [String]
|
361
|
+
#
|
362
|
+
# @!attribute [rw] values
|
363
|
+
# The values to apply the DimensionType on.
|
364
|
+
# @return [Array<String>]
|
365
|
+
#
|
366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeDimension AWS API Documentation
|
367
|
+
#
|
368
|
+
class AttributeDimension < Struct.new(
|
369
|
+
:dimension_type,
|
370
|
+
:values)
|
371
|
+
SENSITIVE = []
|
372
|
+
include Aws::Structure
|
373
|
+
end
|
374
|
+
|
317
375
|
# The details of a single attribute item specified in the mathematical
|
318
376
|
# expression.
|
319
377
|
#
|
@@ -340,13 +398,11 @@ module Aws::CustomerProfiles
|
|
340
398
|
# * You can choose from `Email`, `BusinessEmail`, and `PersonalEmail`
|
341
399
|
#
|
342
400
|
# ^
|
343
|
-
#
|
344
401
|
# * Phone number type
|
345
402
|
#
|
346
403
|
# * You can choose from `Phone`, `HomePhone`, and `MobilePhone`
|
347
404
|
#
|
348
405
|
# ^
|
349
|
-
#
|
350
406
|
# * Address type
|
351
407
|
#
|
352
408
|
# * You can choose from `Address`, `BusinessAddress`,
|
@@ -415,6 +471,20 @@ module Aws::CustomerProfiles
|
|
415
471
|
include Aws::Structure
|
416
472
|
end
|
417
473
|
|
474
|
+
# List containing the values for the given attribute.
|
475
|
+
#
|
476
|
+
# @!attribute [rw] value
|
477
|
+
# An individual value belonging to the given attribute.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeValueItem AWS API Documentation
|
481
|
+
#
|
482
|
+
class AttributeValueItem < Struct.new(
|
483
|
+
:value)
|
484
|
+
SENSITIVE = []
|
485
|
+
include Aws::Structure
|
486
|
+
end
|
487
|
+
|
418
488
|
# Configuration settings for how to perform the auto-merging of
|
419
489
|
# profiles.
|
420
490
|
#
|
@@ -487,6 +557,225 @@ module Aws::CustomerProfiles
|
|
487
557
|
include Aws::Structure
|
488
558
|
end
|
489
559
|
|
560
|
+
# Error object describing why a specific profile and calculated
|
561
|
+
# attribute failed.
|
562
|
+
#
|
563
|
+
# @!attribute [rw] code
|
564
|
+
# Status code for why a specific profile and calculated attribute
|
565
|
+
# failed.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] message
|
569
|
+
# Message describing why a specific profile and calculated attribute
|
570
|
+
# failed.
|
571
|
+
# @return [String]
|
572
|
+
#
|
573
|
+
# @!attribute [rw] profile_id
|
574
|
+
# The profile id that failed.
|
575
|
+
# @return [String]
|
576
|
+
#
|
577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfileError AWS API Documentation
|
578
|
+
#
|
579
|
+
class BatchGetCalculatedAttributeForProfileError < Struct.new(
|
580
|
+
:code,
|
581
|
+
:message,
|
582
|
+
:profile_id)
|
583
|
+
SENSITIVE = []
|
584
|
+
include Aws::Structure
|
585
|
+
end
|
586
|
+
|
587
|
+
# @!attribute [rw] calculated_attribute_name
|
588
|
+
# The unique name of the calculated attribute.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] domain_name
|
592
|
+
# The unique name of the domain.
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] profile_ids
|
596
|
+
# List of unique identifiers for customer profiles to retrieve.
|
597
|
+
# @return [Array<String>]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] condition_overrides
|
600
|
+
# Overrides the condition block within the original calculated
|
601
|
+
# attribute definition.
|
602
|
+
# @return [Types::ConditionOverrides]
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfileRequest AWS API Documentation
|
605
|
+
#
|
606
|
+
class BatchGetCalculatedAttributeForProfileRequest < Struct.new(
|
607
|
+
:calculated_attribute_name,
|
608
|
+
:domain_name,
|
609
|
+
:profile_ids,
|
610
|
+
:condition_overrides)
|
611
|
+
SENSITIVE = [:condition_overrides]
|
612
|
+
include Aws::Structure
|
613
|
+
end
|
614
|
+
|
615
|
+
# @!attribute [rw] errors
|
616
|
+
# List of errors for calculated attribute values that could not be
|
617
|
+
# retrieved.
|
618
|
+
# @return [Array<Types::BatchGetCalculatedAttributeForProfileError>]
|
619
|
+
#
|
620
|
+
# @!attribute [rw] calculated_attribute_values
|
621
|
+
# List of calculated attribute values retrieved.
|
622
|
+
# @return [Array<Types::CalculatedAttributeValue>]
|
623
|
+
#
|
624
|
+
# @!attribute [rw] condition_overrides
|
625
|
+
# Overrides the condition block within the original calculated
|
626
|
+
# attribute definition.
|
627
|
+
# @return [Types::ConditionOverrides]
|
628
|
+
#
|
629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfileResponse AWS API Documentation
|
630
|
+
#
|
631
|
+
class BatchGetCalculatedAttributeForProfileResponse < Struct.new(
|
632
|
+
:errors,
|
633
|
+
:calculated_attribute_values,
|
634
|
+
:condition_overrides)
|
635
|
+
SENSITIVE = [:condition_overrides]
|
636
|
+
include Aws::Structure
|
637
|
+
end
|
638
|
+
|
639
|
+
# Error object describing why a specific profile failed.
|
640
|
+
#
|
641
|
+
# @!attribute [rw] code
|
642
|
+
# Status code for why a specific profile failed.
|
643
|
+
# @return [String]
|
644
|
+
#
|
645
|
+
# @!attribute [rw] message
|
646
|
+
# Message describing why a specific profile failed.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
|
+
# @!attribute [rw] profile_id
|
650
|
+
# The profile id that failed.
|
651
|
+
# @return [String]
|
652
|
+
#
|
653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfileError AWS API Documentation
|
654
|
+
#
|
655
|
+
class BatchGetProfileError < Struct.new(
|
656
|
+
:code,
|
657
|
+
:message,
|
658
|
+
:profile_id)
|
659
|
+
SENSITIVE = []
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# @!attribute [rw] domain_name
|
664
|
+
# The unique name of the domain.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @!attribute [rw] profile_ids
|
668
|
+
# List of unique identifiers for customer profiles to retrieve.
|
669
|
+
# @return [Array<String>]
|
670
|
+
#
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfileRequest AWS API Documentation
|
672
|
+
#
|
673
|
+
class BatchGetProfileRequest < Struct.new(
|
674
|
+
:domain_name,
|
675
|
+
:profile_ids)
|
676
|
+
SENSITIVE = []
|
677
|
+
include Aws::Structure
|
678
|
+
end
|
679
|
+
|
680
|
+
# @!attribute [rw] errors
|
681
|
+
# For information about the errors that are common to all actions, see
|
682
|
+
# [Common Errors][1].
|
683
|
+
#
|
684
|
+
#
|
685
|
+
#
|
686
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html
|
687
|
+
# @return [Array<Types::BatchGetProfileError>]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] profiles
|
690
|
+
# Array of Profile Objects.
|
691
|
+
# @return [Array<Types::Profile>]
|
692
|
+
#
|
693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfileResponse AWS API Documentation
|
694
|
+
#
|
695
|
+
class BatchGetProfileResponse < Struct.new(
|
696
|
+
:errors,
|
697
|
+
:profiles)
|
698
|
+
SENSITIVE = []
|
699
|
+
include Aws::Structure
|
700
|
+
end
|
701
|
+
|
702
|
+
# Object that segments on Customer Profile's Calculated Attributes.
|
703
|
+
#
|
704
|
+
# @!attribute [rw] dimension_type
|
705
|
+
# The action to segment with.
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] values
|
709
|
+
# The values to apply the DimensionType with.
|
710
|
+
# @return [Array<String>]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] condition_overrides
|
713
|
+
# Applies the given condition over the initial Calculated Attribute's
|
714
|
+
# definition.
|
715
|
+
# @return [Types::ConditionOverrides]
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CalculatedAttributeDimension AWS API Documentation
|
718
|
+
#
|
719
|
+
class CalculatedAttributeDimension < Struct.new(
|
720
|
+
:dimension_type,
|
721
|
+
:values,
|
722
|
+
:condition_overrides)
|
723
|
+
SENSITIVE = [:condition_overrides]
|
724
|
+
include Aws::Structure
|
725
|
+
end
|
726
|
+
|
727
|
+
# The object containing the values of a single calculated attribute
|
728
|
+
# value.
|
729
|
+
#
|
730
|
+
# @!attribute [rw] calculated_attribute_name
|
731
|
+
# The unique name of the calculated attribute.
|
732
|
+
# @return [String]
|
733
|
+
#
|
734
|
+
# @!attribute [rw] display_name
|
735
|
+
# The display name of the calculated attribute.
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] is_data_partial
|
739
|
+
# Indicates whether the calculated attribute's value is based on
|
740
|
+
# partial data. If the data is partial, it is set to true.
|
741
|
+
# @return [String]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] profile_id
|
744
|
+
# The profile id belonging to this calculated attribute value.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] value
|
748
|
+
# The value of the calculated attribute.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CalculatedAttributeValue AWS API Documentation
|
752
|
+
#
|
753
|
+
class CalculatedAttributeValue < Struct.new(
|
754
|
+
:calculated_attribute_name,
|
755
|
+
:display_name,
|
756
|
+
:is_data_partial,
|
757
|
+
:profile_id,
|
758
|
+
:value)
|
759
|
+
SENSITIVE = []
|
760
|
+
include Aws::Structure
|
761
|
+
end
|
762
|
+
|
763
|
+
# An object to override the original condition block of a calculated
|
764
|
+
# attribute.
|
765
|
+
#
|
766
|
+
# @!attribute [rw] range
|
767
|
+
# The relative time period over which data is included in the
|
768
|
+
# aggregation for this override.
|
769
|
+
# @return [Types::RangeOverride]
|
770
|
+
#
|
771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ConditionOverrides AWS API Documentation
|
772
|
+
#
|
773
|
+
class ConditionOverrides < Struct.new(
|
774
|
+
:range)
|
775
|
+
SENSITIVE = []
|
776
|
+
include Aws::Structure
|
777
|
+
end
|
778
|
+
|
490
779
|
# The conditions including range, object count, and threshold for the
|
491
780
|
# calculated attribute.
|
492
781
|
#
|
@@ -619,6 +908,11 @@ module Aws::CustomerProfiles
|
|
619
908
|
# calculated attribute.
|
620
909
|
# @return [Types::Conditions]
|
621
910
|
#
|
911
|
+
# @!attribute [rw] filter
|
912
|
+
# Defines how to filter incoming objects to include part of the
|
913
|
+
# Calculated Attribute.
|
914
|
+
# @return [Types::Filter]
|
915
|
+
#
|
622
916
|
# @!attribute [rw] statistic
|
623
917
|
# The aggregation operation to perform for the calculated attribute.
|
624
918
|
# @return [String]
|
@@ -637,6 +931,7 @@ module Aws::CustomerProfiles
|
|
637
931
|
:description,
|
638
932
|
:attribute_details,
|
639
933
|
:conditions,
|
934
|
+
:filter,
|
640
935
|
:statistic,
|
641
936
|
:tags)
|
642
937
|
SENSITIVE = [:description, :attribute_details, :conditions, :statistic]
|
@@ -665,6 +960,10 @@ module Aws::CustomerProfiles
|
|
665
960
|
# calculated attribute.
|
666
961
|
# @return [Types::Conditions]
|
667
962
|
#
|
963
|
+
# @!attribute [rw] filter
|
964
|
+
# The filter that was used as part of the request.
|
965
|
+
# @return [Types::Filter]
|
966
|
+
#
|
668
967
|
# @!attribute [rw] statistic
|
669
968
|
# The aggregation operation to perform for the calculated attribute.
|
670
969
|
# @return [String]
|
@@ -692,6 +991,7 @@ module Aws::CustomerProfiles
|
|
692
991
|
:description,
|
693
992
|
:attribute_details,
|
694
993
|
:conditions,
|
994
|
+
:filter,
|
695
995
|
:statistic,
|
696
996
|
:created_at,
|
697
997
|
:last_updated_at,
|
@@ -894,6 +1194,113 @@ module Aws::CustomerProfiles
|
|
894
1194
|
include Aws::Structure
|
895
1195
|
end
|
896
1196
|
|
1197
|
+
# @!attribute [rw] domain_name
|
1198
|
+
# The unique name of the domain.
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] event_trigger_name
|
1202
|
+
# The unique name of the event trigger.
|
1203
|
+
# @return [String]
|
1204
|
+
#
|
1205
|
+
# @!attribute [rw] object_type_name
|
1206
|
+
# The unique name of the object type.
|
1207
|
+
# @return [String]
|
1208
|
+
#
|
1209
|
+
# @!attribute [rw] description
|
1210
|
+
# The description of the event trigger.
|
1211
|
+
# @return [String]
|
1212
|
+
#
|
1213
|
+
# @!attribute [rw] event_trigger_conditions
|
1214
|
+
# A list of conditions that determine when an event should trigger the
|
1215
|
+
# destination.
|
1216
|
+
# @return [Array<Types::EventTriggerCondition>]
|
1217
|
+
#
|
1218
|
+
# @!attribute [rw] segment_filter
|
1219
|
+
# The destination is triggered only for profiles that meet the
|
1220
|
+
# criteria of a segment definition.
|
1221
|
+
# @return [String]
|
1222
|
+
#
|
1223
|
+
# @!attribute [rw] event_trigger_limits
|
1224
|
+
# Defines limits controlling whether an event triggers the
|
1225
|
+
# destination, based on ingestion latency and the number of
|
1226
|
+
# invocations per profile over specific time periods.
|
1227
|
+
# @return [Types::EventTriggerLimits]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] tags
|
1230
|
+
# An array of key-value pairs to apply to this resource.
|
1231
|
+
# @return [Hash<String,String>]
|
1232
|
+
#
|
1233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateEventTriggerRequest AWS API Documentation
|
1234
|
+
#
|
1235
|
+
class CreateEventTriggerRequest < Struct.new(
|
1236
|
+
:domain_name,
|
1237
|
+
:event_trigger_name,
|
1238
|
+
:object_type_name,
|
1239
|
+
:description,
|
1240
|
+
:event_trigger_conditions,
|
1241
|
+
:segment_filter,
|
1242
|
+
:event_trigger_limits,
|
1243
|
+
:tags)
|
1244
|
+
SENSITIVE = [:description, :event_trigger_conditions]
|
1245
|
+
include Aws::Structure
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# @!attribute [rw] event_trigger_name
|
1249
|
+
# The unique name of the event trigger.
|
1250
|
+
# @return [String]
|
1251
|
+
#
|
1252
|
+
# @!attribute [rw] object_type_name
|
1253
|
+
# The unique name of the object type.
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] description
|
1257
|
+
# The description of the event trigger.
|
1258
|
+
# @return [String]
|
1259
|
+
#
|
1260
|
+
# @!attribute [rw] event_trigger_conditions
|
1261
|
+
# A list of conditions that determine when an event should trigger the
|
1262
|
+
# destination.
|
1263
|
+
# @return [Array<Types::EventTriggerCondition>]
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] segment_filter
|
1266
|
+
# The destination is triggered only for profiles that meet the
|
1267
|
+
# criteria of a segment definition.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] event_trigger_limits
|
1271
|
+
# Defines limits controlling whether an event triggers the
|
1272
|
+
# destination, based on ingestion latency and the number of
|
1273
|
+
# invocations per profile over specific time periods.
|
1274
|
+
# @return [Types::EventTriggerLimits]
|
1275
|
+
#
|
1276
|
+
# @!attribute [rw] created_at
|
1277
|
+
# The timestamp of when the event trigger was created.
|
1278
|
+
# @return [Time]
|
1279
|
+
#
|
1280
|
+
# @!attribute [rw] last_updated_at
|
1281
|
+
# The timestamp of when the event trigger was most recently updated.
|
1282
|
+
# @return [Time]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] tags
|
1285
|
+
# An array of key-value pairs to apply to this resource.
|
1286
|
+
# @return [Hash<String,String>]
|
1287
|
+
#
|
1288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateEventTriggerResponse AWS API Documentation
|
1289
|
+
#
|
1290
|
+
class CreateEventTriggerResponse < Struct.new(
|
1291
|
+
:event_trigger_name,
|
1292
|
+
:object_type_name,
|
1293
|
+
:description,
|
1294
|
+
:event_trigger_conditions,
|
1295
|
+
:segment_filter,
|
1296
|
+
:event_trigger_limits,
|
1297
|
+
:created_at,
|
1298
|
+
:last_updated_at,
|
1299
|
+
:tags)
|
1300
|
+
SENSITIVE = [:description, :event_trigger_conditions]
|
1301
|
+
include Aws::Structure
|
1302
|
+
end
|
1303
|
+
|
897
1304
|
# @!attribute [rw] domain_name
|
898
1305
|
# The unique name of the domain.
|
899
1306
|
# @return [String]
|
@@ -1098,25 +1505,216 @@ module Aws::CustomerProfiles
|
|
1098
1505
|
# The unique name of the domain.
|
1099
1506
|
# @return [String]
|
1100
1507
|
#
|
1101
|
-
# @!attribute [rw]
|
1102
|
-
# The unique name of the
|
1508
|
+
# @!attribute [rw] segment_definition_name
|
1509
|
+
# The unique name of the segment definition.
|
1103
1510
|
# @return [String]
|
1104
1511
|
#
|
1105
|
-
#
|
1106
|
-
#
|
1107
|
-
|
1108
|
-
:domain_name,
|
1109
|
-
:calculated_attribute_name)
|
1110
|
-
SENSITIVE = []
|
1111
|
-
include Aws::Structure
|
1112
|
-
end
|
1113
|
-
|
1114
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinitionResponse AWS API Documentation
|
1512
|
+
# @!attribute [rw] display_name
|
1513
|
+
# The display name of the segment definition.
|
1514
|
+
# @return [String]
|
1115
1515
|
#
|
1116
|
-
|
1117
|
-
|
1118
|
-
#
|
1119
|
-
#
|
1516
|
+
# @!attribute [rw] description
|
1517
|
+
# The description of the segment definition.
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] segment_groups
|
1521
|
+
# Specifies the base segments and dimensions for a segment definition
|
1522
|
+
# along with their respective relationship.
|
1523
|
+
# @return [Types::SegmentGroup]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] tags
|
1526
|
+
# The tags used to organize, track, or control access for this
|
1527
|
+
# resource.
|
1528
|
+
# @return [Hash<String,String>]
|
1529
|
+
#
|
1530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentDefinitionRequest AWS API Documentation
|
1531
|
+
#
|
1532
|
+
class CreateSegmentDefinitionRequest < Struct.new(
|
1533
|
+
:domain_name,
|
1534
|
+
:segment_definition_name,
|
1535
|
+
:display_name,
|
1536
|
+
:description,
|
1537
|
+
:segment_groups,
|
1538
|
+
:tags)
|
1539
|
+
SENSITIVE = [:description, :segment_groups]
|
1540
|
+
include Aws::Structure
|
1541
|
+
end
|
1542
|
+
|
1543
|
+
# @!attribute [rw] segment_definition_name
|
1544
|
+
# The name of the segment definition.
|
1545
|
+
# @return [String]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] display_name
|
1548
|
+
# The display name of the segment definition.
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1551
|
+
# @!attribute [rw] description
|
1552
|
+
# The description of the segment definition.
|
1553
|
+
# @return [String]
|
1554
|
+
#
|
1555
|
+
# @!attribute [rw] created_at
|
1556
|
+
# The timestamp of when the segment definition was created.
|
1557
|
+
# @return [Time]
|
1558
|
+
#
|
1559
|
+
# @!attribute [rw] segment_definition_arn
|
1560
|
+
# The arn of the segment definition.
|
1561
|
+
# @return [String]
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] tags
|
1564
|
+
# The tags used to organize, track, or control access for this
|
1565
|
+
# resource.
|
1566
|
+
# @return [Hash<String,String>]
|
1567
|
+
#
|
1568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentDefinitionResponse AWS API Documentation
|
1569
|
+
#
|
1570
|
+
class CreateSegmentDefinitionResponse < Struct.new(
|
1571
|
+
:segment_definition_name,
|
1572
|
+
:display_name,
|
1573
|
+
:description,
|
1574
|
+
:created_at,
|
1575
|
+
:segment_definition_arn,
|
1576
|
+
:tags)
|
1577
|
+
SENSITIVE = [:description]
|
1578
|
+
include Aws::Structure
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
# @!attribute [rw] domain_name
|
1582
|
+
# The unique name of the domain.
|
1583
|
+
# @return [String]
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] segment_query
|
1586
|
+
# The segment query for calculating a segment estimate.
|
1587
|
+
# @return [Types::SegmentGroupStructure]
|
1588
|
+
#
|
1589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentEstimateRequest AWS API Documentation
|
1590
|
+
#
|
1591
|
+
class CreateSegmentEstimateRequest < Struct.new(
|
1592
|
+
:domain_name,
|
1593
|
+
:segment_query)
|
1594
|
+
SENSITIVE = []
|
1595
|
+
include Aws::Structure
|
1596
|
+
end
|
1597
|
+
|
1598
|
+
# @!attribute [rw] domain_name
|
1599
|
+
# The unique name of the domain.
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] estimate_id
|
1603
|
+
# A unique identifier for the resource. The value can be passed to
|
1604
|
+
# `GetSegmentEstimate` to retrieve the result of segment estimate
|
1605
|
+
# status.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] status_code
|
1609
|
+
# The status code for the response.
|
1610
|
+
# @return [Integer]
|
1611
|
+
#
|
1612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentEstimateResponse AWS API Documentation
|
1613
|
+
#
|
1614
|
+
class CreateSegmentEstimateResponse < Struct.new(
|
1615
|
+
:domain_name,
|
1616
|
+
:estimate_id,
|
1617
|
+
:status_code)
|
1618
|
+
SENSITIVE = []
|
1619
|
+
include Aws::Structure
|
1620
|
+
end
|
1621
|
+
|
1622
|
+
# @!attribute [rw] domain_name
|
1623
|
+
# The unique name of the domain.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] segment_definition_name
|
1627
|
+
# The name of the segment definition used in this snapshot request.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @!attribute [rw] data_format
|
1631
|
+
# The format in which the segment will be exported.
|
1632
|
+
# @return [String]
|
1633
|
+
#
|
1634
|
+
# @!attribute [rw] encryption_key
|
1635
|
+
# The Amazon Resource Name (ARN) of the KMS key used to encrypt the
|
1636
|
+
# exported segment.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] role_arn
|
1640
|
+
# The Amazon Resource Name (ARN) of the IAM role that allows Customer
|
1641
|
+
# Profiles service principal to assume the role for conducting KMS and
|
1642
|
+
# S3 operations.
|
1643
|
+
# @return [String]
|
1644
|
+
#
|
1645
|
+
# @!attribute [rw] destination_uri
|
1646
|
+
# The destination to which the segment will be exported. This field
|
1647
|
+
# must be provided if the request is not submitted from the Amazon
|
1648
|
+
# Connect Admin Website.
|
1649
|
+
# @return [String]
|
1650
|
+
#
|
1651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentSnapshotRequest AWS API Documentation
|
1652
|
+
#
|
1653
|
+
class CreateSegmentSnapshotRequest < Struct.new(
|
1654
|
+
:domain_name,
|
1655
|
+
:segment_definition_name,
|
1656
|
+
:data_format,
|
1657
|
+
:encryption_key,
|
1658
|
+
:role_arn,
|
1659
|
+
:destination_uri)
|
1660
|
+
SENSITIVE = []
|
1661
|
+
include Aws::Structure
|
1662
|
+
end
|
1663
|
+
|
1664
|
+
# @!attribute [rw] snapshot_id
|
1665
|
+
# The unique identifier of the segment snapshot.
|
1666
|
+
# @return [String]
|
1667
|
+
#
|
1668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentSnapshotResponse AWS API Documentation
|
1669
|
+
#
|
1670
|
+
class CreateSegmentSnapshotResponse < Struct.new(
|
1671
|
+
:snapshot_id)
|
1672
|
+
SENSITIVE = []
|
1673
|
+
include Aws::Structure
|
1674
|
+
end
|
1675
|
+
|
1676
|
+
# Object that segments on various Customer Profile's date fields.
|
1677
|
+
#
|
1678
|
+
# @!attribute [rw] dimension_type
|
1679
|
+
# The action to segment with.
|
1680
|
+
# @return [String]
|
1681
|
+
#
|
1682
|
+
# @!attribute [rw] values
|
1683
|
+
# The values to apply the DimensionType on.
|
1684
|
+
# @return [Array<String>]
|
1685
|
+
#
|
1686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DateDimension AWS API Documentation
|
1687
|
+
#
|
1688
|
+
class DateDimension < Struct.new(
|
1689
|
+
:dimension_type,
|
1690
|
+
:values)
|
1691
|
+
SENSITIVE = []
|
1692
|
+
include Aws::Structure
|
1693
|
+
end
|
1694
|
+
|
1695
|
+
# @!attribute [rw] domain_name
|
1696
|
+
# The unique name of the domain.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] calculated_attribute_name
|
1700
|
+
# The unique name of the calculated attribute.
|
1701
|
+
# @return [String]
|
1702
|
+
#
|
1703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinitionRequest AWS API Documentation
|
1704
|
+
#
|
1705
|
+
class DeleteCalculatedAttributeDefinitionRequest < Struct.new(
|
1706
|
+
:domain_name,
|
1707
|
+
:calculated_attribute_name)
|
1708
|
+
SENSITIVE = []
|
1709
|
+
include Aws::Structure
|
1710
|
+
end
|
1711
|
+
|
1712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinitionResponse AWS API Documentation
|
1713
|
+
#
|
1714
|
+
class DeleteCalculatedAttributeDefinitionResponse < Aws::EmptyStructure; end
|
1715
|
+
|
1716
|
+
# @!attribute [rw] domain_name
|
1717
|
+
# The unique name of the domain.
|
1120
1718
|
# @return [String]
|
1121
1719
|
#
|
1122
1720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainRequest AWS API Documentation
|
@@ -1160,6 +1758,35 @@ module Aws::CustomerProfiles
|
|
1160
1758
|
#
|
1161
1759
|
class DeleteEventStreamResponse < Aws::EmptyStructure; end
|
1162
1760
|
|
1761
|
+
# @!attribute [rw] domain_name
|
1762
|
+
# The unique name of the domain.
|
1763
|
+
# @return [String]
|
1764
|
+
#
|
1765
|
+
# @!attribute [rw] event_trigger_name
|
1766
|
+
# The unique name of the event trigger.
|
1767
|
+
# @return [String]
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteEventTriggerRequest AWS API Documentation
|
1770
|
+
#
|
1771
|
+
class DeleteEventTriggerRequest < Struct.new(
|
1772
|
+
:domain_name,
|
1773
|
+
:event_trigger_name)
|
1774
|
+
SENSITIVE = []
|
1775
|
+
include Aws::Structure
|
1776
|
+
end
|
1777
|
+
|
1778
|
+
# @!attribute [rw] message
|
1779
|
+
# A message that indicates the delete request is done.
|
1780
|
+
# @return [String]
|
1781
|
+
#
|
1782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteEventTriggerResponse AWS API Documentation
|
1783
|
+
#
|
1784
|
+
class DeleteEventTriggerResponse < Struct.new(
|
1785
|
+
:message)
|
1786
|
+
SENSITIVE = []
|
1787
|
+
include Aws::Structure
|
1788
|
+
end
|
1789
|
+
|
1163
1790
|
# @!attribute [rw] domain_name
|
1164
1791
|
# The unique name of the domain.
|
1165
1792
|
# @return [String]
|
@@ -1326,6 +1953,35 @@ module Aws::CustomerProfiles
|
|
1326
1953
|
include Aws::Structure
|
1327
1954
|
end
|
1328
1955
|
|
1956
|
+
# @!attribute [rw] domain_name
|
1957
|
+
# The unique name of the domain.
|
1958
|
+
# @return [String]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] segment_definition_name
|
1961
|
+
# The unique name of the segment definition.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteSegmentDefinitionRequest AWS API Documentation
|
1965
|
+
#
|
1966
|
+
class DeleteSegmentDefinitionRequest < Struct.new(
|
1967
|
+
:domain_name,
|
1968
|
+
:segment_definition_name)
|
1969
|
+
SENSITIVE = []
|
1970
|
+
include Aws::Structure
|
1971
|
+
end
|
1972
|
+
|
1973
|
+
# @!attribute [rw] message
|
1974
|
+
# A message that indicates the delete request is done.
|
1975
|
+
# @return [String]
|
1976
|
+
#
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteSegmentDefinitionResponse AWS API Documentation
|
1978
|
+
#
|
1979
|
+
class DeleteSegmentDefinitionResponse < Struct.new(
|
1980
|
+
:message)
|
1981
|
+
SENSITIVE = []
|
1982
|
+
include Aws::Structure
|
1983
|
+
end
|
1984
|
+
|
1329
1985
|
# @!attribute [rw] domain_name
|
1330
1986
|
# The unique name of the domain.
|
1331
1987
|
# @return [String]
|
@@ -1428,6 +2084,36 @@ module Aws::CustomerProfiles
|
|
1428
2084
|
include Aws::Structure
|
1429
2085
|
end
|
1430
2086
|
|
2087
|
+
# Object that holds what profile and calculated attributes to segment
|
2088
|
+
# on.
|
2089
|
+
#
|
2090
|
+
# @note Dimension is a union - when making an API calls you must set exactly one of the members.
|
2091
|
+
#
|
2092
|
+
# @note Dimension is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Dimension corresponding to the set member.
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] profile_attributes
|
2095
|
+
# Object that holds the profile attributes to segment on.
|
2096
|
+
# @return [Types::ProfileAttributes]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] calculated_attributes
|
2099
|
+
# Object that holds the calculated attributes to segment on.
|
2100
|
+
# @return [Hash<String,Types::CalculatedAttributeDimension>]
|
2101
|
+
#
|
2102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Dimension AWS API Documentation
|
2103
|
+
#
|
2104
|
+
class Dimension < Struct.new(
|
2105
|
+
:profile_attributes,
|
2106
|
+
:calculated_attributes,
|
2107
|
+
:unknown)
|
2108
|
+
SENSITIVE = [:profile_attributes]
|
2109
|
+
include Aws::Structure
|
2110
|
+
include Aws::Structure::Union
|
2111
|
+
|
2112
|
+
class ProfileAttributes < Dimension; end
|
2113
|
+
class CalculatedAttributes < Dimension; end
|
2114
|
+
class Unknown < Dimension; end
|
2115
|
+
end
|
2116
|
+
|
1431
2117
|
# Usage-specific statistics about the domain.
|
1432
2118
|
#
|
1433
2119
|
# @!attribute [rw] profile_count
|
@@ -1537,6 +2223,101 @@ module Aws::CustomerProfiles
|
|
1537
2223
|
include Aws::Structure
|
1538
2224
|
end
|
1539
2225
|
|
2226
|
+
# Specifies the circumstances under which the event should trigger the
|
2227
|
+
# destination.
|
2228
|
+
#
|
2229
|
+
# @!attribute [rw] event_trigger_dimensions
|
2230
|
+
# A list of dimensions to be evaluated for the event.
|
2231
|
+
# @return [Array<Types::EventTriggerDimension>]
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] logical_operator
|
2234
|
+
# The operator used to combine multiple dimensions.
|
2235
|
+
# @return [String]
|
2236
|
+
#
|
2237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/EventTriggerCondition AWS API Documentation
|
2238
|
+
#
|
2239
|
+
class EventTriggerCondition < Struct.new(
|
2240
|
+
:event_trigger_dimensions,
|
2241
|
+
:logical_operator)
|
2242
|
+
SENSITIVE = []
|
2243
|
+
include Aws::Structure
|
2244
|
+
end
|
2245
|
+
|
2246
|
+
# A specific event dimension to be assessed.
|
2247
|
+
#
|
2248
|
+
# @!attribute [rw] object_attributes
|
2249
|
+
# A list of object attributes to be evaluated.
|
2250
|
+
# @return [Array<Types::ObjectAttribute>]
|
2251
|
+
#
|
2252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/EventTriggerDimension AWS API Documentation
|
2253
|
+
#
|
2254
|
+
class EventTriggerDimension < Struct.new(
|
2255
|
+
:object_attributes)
|
2256
|
+
SENSITIVE = []
|
2257
|
+
include Aws::Structure
|
2258
|
+
end
|
2259
|
+
|
2260
|
+
# Defines limits controlling whether an event triggers the destination,
|
2261
|
+
# based on ingestion latency and the number of invocations per profile
|
2262
|
+
# over specific time periods.
|
2263
|
+
#
|
2264
|
+
# @!attribute [rw] event_expiration
|
2265
|
+
# In milliseconds. Specifies that an event will only trigger the
|
2266
|
+
# destination if it is processed within a certain latency period.
|
2267
|
+
# @return [Integer]
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] periods
|
2270
|
+
# A list of time periods during which the limits apply.
|
2271
|
+
# @return [Array<Types::Period>]
|
2272
|
+
#
|
2273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/EventTriggerLimits AWS API Documentation
|
2274
|
+
#
|
2275
|
+
class EventTriggerLimits < Struct.new(
|
2276
|
+
:event_expiration,
|
2277
|
+
:periods)
|
2278
|
+
SENSITIVE = []
|
2279
|
+
include Aws::Structure
|
2280
|
+
end
|
2281
|
+
|
2282
|
+
# The summary of the event trigger.
|
2283
|
+
#
|
2284
|
+
# @!attribute [rw] object_type_name
|
2285
|
+
# The unique name of the object type.
|
2286
|
+
# @return [String]
|
2287
|
+
#
|
2288
|
+
# @!attribute [rw] event_trigger_name
|
2289
|
+
# The unique name of the event trigger.
|
2290
|
+
# @return [String]
|
2291
|
+
#
|
2292
|
+
# @!attribute [rw] description
|
2293
|
+
# The description of the event trigger.
|
2294
|
+
# @return [String]
|
2295
|
+
#
|
2296
|
+
# @!attribute [rw] created_at
|
2297
|
+
# The timestamp of when the event trigger was created.
|
2298
|
+
# @return [Time]
|
2299
|
+
#
|
2300
|
+
# @!attribute [rw] last_updated_at
|
2301
|
+
# The timestamp of when the event trigger was most recently updated.
|
2302
|
+
# @return [Time]
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] tags
|
2305
|
+
# An array of key-value pairs to apply to this resource.
|
2306
|
+
# @return [Hash<String,String>]
|
2307
|
+
#
|
2308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/EventTriggerSummaryItem AWS API Documentation
|
2309
|
+
#
|
2310
|
+
class EventTriggerSummaryItem < Struct.new(
|
2311
|
+
:object_type_name,
|
2312
|
+
:event_trigger_name,
|
2313
|
+
:description,
|
2314
|
+
:created_at,
|
2315
|
+
:last_updated_at,
|
2316
|
+
:tags)
|
2317
|
+
SENSITIVE = []
|
2318
|
+
include Aws::Structure
|
2319
|
+
end
|
2320
|
+
|
1540
2321
|
# Configuration information about the S3 bucket where Identity
|
1541
2322
|
# Resolution Jobs writes result files.
|
1542
2323
|
#
|
@@ -1578,6 +2359,26 @@ module Aws::CustomerProfiles
|
|
1578
2359
|
include Aws::Structure
|
1579
2360
|
end
|
1580
2361
|
|
2362
|
+
# Object that segments on various Customer profile's fields that are
|
2363
|
+
# larger than normal.
|
2364
|
+
#
|
2365
|
+
# @!attribute [rw] dimension_type
|
2366
|
+
# The action to segment with.
|
2367
|
+
# @return [String]
|
2368
|
+
#
|
2369
|
+
# @!attribute [rw] values
|
2370
|
+
# The values to apply the DimensionType on.
|
2371
|
+
# @return [Array<String>]
|
2372
|
+
#
|
2373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ExtraLengthValueProfileDimension AWS API Documentation
|
2374
|
+
#
|
2375
|
+
class ExtraLengthValueProfileDimension < Struct.new(
|
2376
|
+
:dimension_type,
|
2377
|
+
:values)
|
2378
|
+
SENSITIVE = []
|
2379
|
+
include Aws::Structure
|
2380
|
+
end
|
2381
|
+
|
1581
2382
|
# A duplicate customer profile that is to be merged into a main profile.
|
1582
2383
|
#
|
1583
2384
|
# @!attribute [rw] account_number
|
@@ -1695,6 +2496,80 @@ module Aws::CustomerProfiles
|
|
1695
2496
|
include Aws::Structure
|
1696
2497
|
end
|
1697
2498
|
|
2499
|
+
# Defines how to filter the objects coming in for calculated attributes.
|
2500
|
+
#
|
2501
|
+
# @!attribute [rw] include
|
2502
|
+
# Define whether to include or exclude objects for Calculated
|
2503
|
+
# Attributed calculation that fit the filter groups criteria.
|
2504
|
+
# @return [String]
|
2505
|
+
#
|
2506
|
+
# @!attribute [rw] groups
|
2507
|
+
# Holds the list of Filter groups within the Filter definition.
|
2508
|
+
# @return [Array<Types::FilterGroup>]
|
2509
|
+
#
|
2510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Filter AWS API Documentation
|
2511
|
+
#
|
2512
|
+
class Filter < Struct.new(
|
2513
|
+
:include,
|
2514
|
+
:groups)
|
2515
|
+
SENSITIVE = []
|
2516
|
+
include Aws::Structure
|
2517
|
+
end
|
2518
|
+
|
2519
|
+
# Object that defines how to filter the incoming objects for the
|
2520
|
+
# calculated attribute.
|
2521
|
+
#
|
2522
|
+
# @!attribute [rw] dimension_type
|
2523
|
+
# The action to filter with.
|
2524
|
+
# @return [String]
|
2525
|
+
#
|
2526
|
+
# @!attribute [rw] values
|
2527
|
+
# The values to apply the DimensionType on.
|
2528
|
+
# @return [Array<String>]
|
2529
|
+
#
|
2530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FilterAttributeDimension AWS API Documentation
|
2531
|
+
#
|
2532
|
+
class FilterAttributeDimension < Struct.new(
|
2533
|
+
:dimension_type,
|
2534
|
+
:values)
|
2535
|
+
SENSITIVE = []
|
2536
|
+
include Aws::Structure
|
2537
|
+
end
|
2538
|
+
|
2539
|
+
# Contains the map of attribute names to attribute dimensions.
|
2540
|
+
#
|
2541
|
+
# @!attribute [rw] attributes
|
2542
|
+
# Is the attribute within the FilterDimension map
|
2543
|
+
# @return [Hash<String,Types::FilterAttributeDimension>]
|
2544
|
+
#
|
2545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FilterDimension AWS API Documentation
|
2546
|
+
#
|
2547
|
+
class FilterDimension < Struct.new(
|
2548
|
+
:attributes)
|
2549
|
+
SENSITIVE = []
|
2550
|
+
include Aws::Structure
|
2551
|
+
end
|
2552
|
+
|
2553
|
+
# Object that holds the dimensions to filter on.
|
2554
|
+
#
|
2555
|
+
# @!attribute [rw] type
|
2556
|
+
# The type of logical relationship between the dimensions of the
|
2557
|
+
# Filter group.
|
2558
|
+
# @return [String]
|
2559
|
+
#
|
2560
|
+
# @!attribute [rw] dimensions
|
2561
|
+
# Object that holds the attributes to filter on.
|
2562
|
+
# @return [Array<Types::FilterDimension>]
|
2563
|
+
#
|
2564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FilterGroup AWS API Documentation
|
2565
|
+
#
|
2566
|
+
class FilterGroup < Struct.new(
|
2567
|
+
:type,
|
2568
|
+
:dimensions)
|
2569
|
+
SENSITIVE = []
|
2570
|
+
include Aws::Structure
|
2571
|
+
end
|
2572
|
+
|
1698
2573
|
# The configurations that control how Customer Profiles retrieves data
|
1699
2574
|
# from the source, Amazon AppFlow. Customer Profiles uses this
|
1700
2575
|
# information to create an AppFlow flow on behalf of customers.
|
@@ -1866,6 +2741,10 @@ module Aws::CustomerProfiles
|
|
1866
2741
|
# The aggregation operation to perform for the calculated attribute.
|
1867
2742
|
# @return [String]
|
1868
2743
|
#
|
2744
|
+
# @!attribute [rw] filter
|
2745
|
+
# The filter assigned to this calculated attribute definition.
|
2746
|
+
# @return [Types::Filter]
|
2747
|
+
#
|
1869
2748
|
# @!attribute [rw] conditions
|
1870
2749
|
# The conditions including range, object count, and threshold for the
|
1871
2750
|
# calculated attribute.
|
@@ -1890,6 +2769,7 @@ module Aws::CustomerProfiles
|
|
1890
2769
|
:created_at,
|
1891
2770
|
:last_updated_at,
|
1892
2771
|
:statistic,
|
2772
|
+
:filter,
|
1893
2773
|
:conditions,
|
1894
2774
|
:attribute_details,
|
1895
2775
|
:tags)
|
@@ -2083,21 +2963,94 @@ module Aws::CustomerProfiles
|
|
2083
2963
|
# @return [Types::EventStreamDestinationDetails]
|
2084
2964
|
#
|
2085
2965
|
# @!attribute [rw] tags
|
2086
|
-
# The tags used to organize, track, or control access for this
|
2087
|
-
# resource.
|
2966
|
+
# The tags used to organize, track, or control access for this
|
2967
|
+
# resource.
|
2968
|
+
# @return [Hash<String,String>]
|
2969
|
+
#
|
2970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetEventStreamResponse AWS API Documentation
|
2971
|
+
#
|
2972
|
+
class GetEventStreamResponse < Struct.new(
|
2973
|
+
:domain_name,
|
2974
|
+
:event_stream_arn,
|
2975
|
+
:created_at,
|
2976
|
+
:state,
|
2977
|
+
:stopped_since,
|
2978
|
+
:destination_details,
|
2979
|
+
:tags)
|
2980
|
+
SENSITIVE = []
|
2981
|
+
include Aws::Structure
|
2982
|
+
end
|
2983
|
+
|
2984
|
+
# @!attribute [rw] domain_name
|
2985
|
+
# The unique name of the domain.
|
2986
|
+
# @return [String]
|
2987
|
+
#
|
2988
|
+
# @!attribute [rw] event_trigger_name
|
2989
|
+
# The unique name of the event trigger.
|
2990
|
+
# @return [String]
|
2991
|
+
#
|
2992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetEventTriggerRequest AWS API Documentation
|
2993
|
+
#
|
2994
|
+
class GetEventTriggerRequest < Struct.new(
|
2995
|
+
:domain_name,
|
2996
|
+
:event_trigger_name)
|
2997
|
+
SENSITIVE = []
|
2998
|
+
include Aws::Structure
|
2999
|
+
end
|
3000
|
+
|
3001
|
+
# @!attribute [rw] event_trigger_name
|
3002
|
+
# The unique name of the event trigger.
|
3003
|
+
# @return [String]
|
3004
|
+
#
|
3005
|
+
# @!attribute [rw] object_type_name
|
3006
|
+
# The unique name of the object type.
|
3007
|
+
# @return [String]
|
3008
|
+
#
|
3009
|
+
# @!attribute [rw] description
|
3010
|
+
# The description of the event trigger.
|
3011
|
+
# @return [String]
|
3012
|
+
#
|
3013
|
+
# @!attribute [rw] event_trigger_conditions
|
3014
|
+
# A list of conditions that determine when an event should trigger the
|
3015
|
+
# destination.
|
3016
|
+
# @return [Array<Types::EventTriggerCondition>]
|
3017
|
+
#
|
3018
|
+
# @!attribute [rw] segment_filter
|
3019
|
+
# The destination is triggered only for profiles that meet the
|
3020
|
+
# criteria of a segment definition.
|
3021
|
+
# @return [String]
|
3022
|
+
#
|
3023
|
+
# @!attribute [rw] event_trigger_limits
|
3024
|
+
# Defines limits controlling whether an event triggers the
|
3025
|
+
# destination, based on ingestion latency and the number of
|
3026
|
+
# invocations per profile over specific time periods.
|
3027
|
+
# @return [Types::EventTriggerLimits]
|
3028
|
+
#
|
3029
|
+
# @!attribute [rw] created_at
|
3030
|
+
# The timestamp of when the event trigger was created.
|
3031
|
+
# @return [Time]
|
3032
|
+
#
|
3033
|
+
# @!attribute [rw] last_updated_at
|
3034
|
+
# The timestamp of when the event trigger was most recently updated.
|
3035
|
+
# @return [Time]
|
3036
|
+
#
|
3037
|
+
# @!attribute [rw] tags
|
3038
|
+
# An array of key-value pairs to apply to this resource.
|
2088
3039
|
# @return [Hash<String,String>]
|
2089
3040
|
#
|
2090
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/
|
3041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetEventTriggerResponse AWS API Documentation
|
2091
3042
|
#
|
2092
|
-
class
|
2093
|
-
:
|
2094
|
-
:
|
3043
|
+
class GetEventTriggerResponse < Struct.new(
|
3044
|
+
:event_trigger_name,
|
3045
|
+
:object_type_name,
|
3046
|
+
:description,
|
3047
|
+
:event_trigger_conditions,
|
3048
|
+
:segment_filter,
|
3049
|
+
:event_trigger_limits,
|
2095
3050
|
:created_at,
|
2096
|
-
:
|
2097
|
-
:stopped_since,
|
2098
|
-
:destination_details,
|
3051
|
+
:last_updated_at,
|
2099
3052
|
:tags)
|
2100
|
-
SENSITIVE = []
|
3053
|
+
SENSITIVE = [:description, :event_trigger_conditions]
|
2101
3054
|
include Aws::Structure
|
2102
3055
|
end
|
2103
3056
|
|
@@ -2274,6 +3227,12 @@ module Aws::CustomerProfiles
|
|
2274
3227
|
# this role to make Customer Profiles requests on your behalf.
|
2275
3228
|
# @return [String]
|
2276
3229
|
#
|
3230
|
+
# @!attribute [rw] event_trigger_names
|
3231
|
+
# A list of unique names for active event triggers associated with the
|
3232
|
+
# integration. This list would be empty if no Event Trigger is
|
3233
|
+
# associated with the integration.
|
3234
|
+
# @return [Array<String>]
|
3235
|
+
#
|
2277
3236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegrationResponse AWS API Documentation
|
2278
3237
|
#
|
2279
3238
|
class GetIntegrationResponse < Struct.new(
|
@@ -2286,7 +3245,8 @@ module Aws::CustomerProfiles
|
|
2286
3245
|
:object_type_names,
|
2287
3246
|
:workflow_id,
|
2288
3247
|
:is_unstructured,
|
2289
|
-
:role_arn
|
3248
|
+
:role_arn,
|
3249
|
+
:event_trigger_names)
|
2290
3250
|
SENSITIVE = []
|
2291
3251
|
include Aws::Structure
|
2292
3252
|
end
|
@@ -2505,6 +3465,238 @@ module Aws::CustomerProfiles
|
|
2505
3465
|
include Aws::Structure
|
2506
3466
|
end
|
2507
3467
|
|
3468
|
+
# @!attribute [rw] domain_name
|
3469
|
+
# The unique name of the domain.
|
3470
|
+
# @return [String]
|
3471
|
+
#
|
3472
|
+
# @!attribute [rw] segment_definition_name
|
3473
|
+
# The unique name of the segment definition.
|
3474
|
+
# @return [String]
|
3475
|
+
#
|
3476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinitionRequest AWS API Documentation
|
3477
|
+
#
|
3478
|
+
class GetSegmentDefinitionRequest < Struct.new(
|
3479
|
+
:domain_name,
|
3480
|
+
:segment_definition_name)
|
3481
|
+
SENSITIVE = []
|
3482
|
+
include Aws::Structure
|
3483
|
+
end
|
3484
|
+
|
3485
|
+
# @!attribute [rw] segment_definition_name
|
3486
|
+
# The name of the segment definition.
|
3487
|
+
# @return [String]
|
3488
|
+
#
|
3489
|
+
# @!attribute [rw] display_name
|
3490
|
+
# The display name of the segment definition.
|
3491
|
+
# @return [String]
|
3492
|
+
#
|
3493
|
+
# @!attribute [rw] description
|
3494
|
+
# The description of the segment definition.
|
3495
|
+
# @return [String]
|
3496
|
+
#
|
3497
|
+
# @!attribute [rw] segment_groups
|
3498
|
+
# The segment criteria associated with this definition.
|
3499
|
+
# @return [Types::SegmentGroup]
|
3500
|
+
#
|
3501
|
+
# @!attribute [rw] segment_definition_arn
|
3502
|
+
# The arn of the segment definition.
|
3503
|
+
# @return [String]
|
3504
|
+
#
|
3505
|
+
# @!attribute [rw] created_at
|
3506
|
+
# The timestamp of when the segment definition was created.
|
3507
|
+
# @return [Time]
|
3508
|
+
#
|
3509
|
+
# @!attribute [rw] tags
|
3510
|
+
# The tags used to organize, track, or control access for this
|
3511
|
+
# resource.
|
3512
|
+
# @return [Hash<String,String>]
|
3513
|
+
#
|
3514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinitionResponse AWS API Documentation
|
3515
|
+
#
|
3516
|
+
class GetSegmentDefinitionResponse < Struct.new(
|
3517
|
+
:segment_definition_name,
|
3518
|
+
:display_name,
|
3519
|
+
:description,
|
3520
|
+
:segment_groups,
|
3521
|
+
:segment_definition_arn,
|
3522
|
+
:created_at,
|
3523
|
+
:tags)
|
3524
|
+
SENSITIVE = [:description, :segment_groups]
|
3525
|
+
include Aws::Structure
|
3526
|
+
end
|
3527
|
+
|
3528
|
+
# @!attribute [rw] domain_name
|
3529
|
+
# The unique name of the domain.
|
3530
|
+
# @return [String]
|
3531
|
+
#
|
3532
|
+
# @!attribute [rw] estimate_id
|
3533
|
+
# The query Id passed by a previous `CreateSegmentEstimate` operation.
|
3534
|
+
# @return [String]
|
3535
|
+
#
|
3536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentEstimateRequest AWS API Documentation
|
3537
|
+
#
|
3538
|
+
class GetSegmentEstimateRequest < Struct.new(
|
3539
|
+
:domain_name,
|
3540
|
+
:estimate_id)
|
3541
|
+
SENSITIVE = []
|
3542
|
+
include Aws::Structure
|
3543
|
+
end
|
3544
|
+
|
3545
|
+
# @!attribute [rw] domain_name
|
3546
|
+
# The unique name of the domain.
|
3547
|
+
# @return [String]
|
3548
|
+
#
|
3549
|
+
# @!attribute [rw] estimate_id
|
3550
|
+
# The `QueryId` which is the same as the value passed in `QueryId`.
|
3551
|
+
# @return [String]
|
3552
|
+
#
|
3553
|
+
# @!attribute [rw] status
|
3554
|
+
# The current status of the query.
|
3555
|
+
# @return [String]
|
3556
|
+
#
|
3557
|
+
# @!attribute [rw] estimate
|
3558
|
+
# The estimated number of profiles contained in the segment.
|
3559
|
+
# @return [String]
|
3560
|
+
#
|
3561
|
+
# @!attribute [rw] message
|
3562
|
+
# The error message if there is any error.
|
3563
|
+
# @return [String]
|
3564
|
+
#
|
3565
|
+
# @!attribute [rw] status_code
|
3566
|
+
# The status code of the segment estimate.
|
3567
|
+
# @return [Integer]
|
3568
|
+
#
|
3569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentEstimateResponse AWS API Documentation
|
3570
|
+
#
|
3571
|
+
class GetSegmentEstimateResponse < Struct.new(
|
3572
|
+
:domain_name,
|
3573
|
+
:estimate_id,
|
3574
|
+
:status,
|
3575
|
+
:estimate,
|
3576
|
+
:message,
|
3577
|
+
:status_code)
|
3578
|
+
SENSITIVE = []
|
3579
|
+
include Aws::Structure
|
3580
|
+
end
|
3581
|
+
|
3582
|
+
# @!attribute [rw] domain_name
|
3583
|
+
# The unique name of the domain.
|
3584
|
+
# @return [String]
|
3585
|
+
#
|
3586
|
+
# @!attribute [rw] segment_definition_name
|
3587
|
+
# The Id of the wanted segment. Needs to be a valid, and existing
|
3588
|
+
# segment Id.
|
3589
|
+
# @return [String]
|
3590
|
+
#
|
3591
|
+
# @!attribute [rw] profile_ids
|
3592
|
+
# The list of profile IDs to query for.
|
3593
|
+
# @return [Array<String>]
|
3594
|
+
#
|
3595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembershipRequest AWS API Documentation
|
3596
|
+
#
|
3597
|
+
class GetSegmentMembershipRequest < Struct.new(
|
3598
|
+
:domain_name,
|
3599
|
+
:segment_definition_name,
|
3600
|
+
:profile_ids)
|
3601
|
+
SENSITIVE = []
|
3602
|
+
include Aws::Structure
|
3603
|
+
end
|
3604
|
+
|
3605
|
+
# @!attribute [rw] segment_definition_name
|
3606
|
+
# The unique name of the segment definition.
|
3607
|
+
# @return [String]
|
3608
|
+
#
|
3609
|
+
# @!attribute [rw] profiles
|
3610
|
+
# An array of maps where each contains a response per profile
|
3611
|
+
# requested.
|
3612
|
+
# @return [Array<Types::ProfileQueryResult>]
|
3613
|
+
#
|
3614
|
+
# @!attribute [rw] failures
|
3615
|
+
# An array of maps where each contains a response per profile failed
|
3616
|
+
# for the request.
|
3617
|
+
# @return [Array<Types::ProfileQueryFailures>]
|
3618
|
+
#
|
3619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembershipResponse AWS API Documentation
|
3620
|
+
#
|
3621
|
+
class GetSegmentMembershipResponse < Struct.new(
|
3622
|
+
:segment_definition_name,
|
3623
|
+
:profiles,
|
3624
|
+
:failures)
|
3625
|
+
SENSITIVE = []
|
3626
|
+
include Aws::Structure
|
3627
|
+
end
|
3628
|
+
|
3629
|
+
# @!attribute [rw] domain_name
|
3630
|
+
# The unique identifier of the domain.
|
3631
|
+
# @return [String]
|
3632
|
+
#
|
3633
|
+
# @!attribute [rw] segment_definition_name
|
3634
|
+
# The unique name of the segment definition.
|
3635
|
+
# @return [String]
|
3636
|
+
#
|
3637
|
+
# @!attribute [rw] snapshot_id
|
3638
|
+
# The unique identifier of the segment snapshot.
|
3639
|
+
# @return [String]
|
3640
|
+
#
|
3641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentSnapshotRequest AWS API Documentation
|
3642
|
+
#
|
3643
|
+
class GetSegmentSnapshotRequest < Struct.new(
|
3644
|
+
:domain_name,
|
3645
|
+
:segment_definition_name,
|
3646
|
+
:snapshot_id)
|
3647
|
+
SENSITIVE = []
|
3648
|
+
include Aws::Structure
|
3649
|
+
end
|
3650
|
+
|
3651
|
+
# @!attribute [rw] snapshot_id
|
3652
|
+
# The unique identifier of the segment snapshot.
|
3653
|
+
# @return [String]
|
3654
|
+
#
|
3655
|
+
# @!attribute [rw] status
|
3656
|
+
# The status of the asynchronous job for exporting the segment
|
3657
|
+
# snapshot.
|
3658
|
+
# @return [String]
|
3659
|
+
#
|
3660
|
+
# @!attribute [rw] status_message
|
3661
|
+
# The status message of the asynchronous job for exporting the segment
|
3662
|
+
# snapshot.
|
3663
|
+
# @return [String]
|
3664
|
+
#
|
3665
|
+
# @!attribute [rw] data_format
|
3666
|
+
# The format in which the segment will be exported.
|
3667
|
+
# @return [String]
|
3668
|
+
#
|
3669
|
+
# @!attribute [rw] encryption_key
|
3670
|
+
# The Amazon Resource Name (ARN) of the KMS key used to encrypt the
|
3671
|
+
# exported segment.
|
3672
|
+
# @return [String]
|
3673
|
+
#
|
3674
|
+
# @!attribute [rw] role_arn
|
3675
|
+
# The Amazon Resource Name (ARN) of the IAM role that allows Customer
|
3676
|
+
# Profiles service principal to assume the role for conducting KMS and
|
3677
|
+
# S3 operations.
|
3678
|
+
# @return [String]
|
3679
|
+
#
|
3680
|
+
# @!attribute [rw] destination_uri
|
3681
|
+
# The destination to which the segment will be exported. This field
|
3682
|
+
# must be provided if the request is not submitted from the Amazon
|
3683
|
+
# Connect Admin Website.
|
3684
|
+
# @return [String]
|
3685
|
+
#
|
3686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentSnapshotResponse AWS API Documentation
|
3687
|
+
#
|
3688
|
+
class GetSegmentSnapshotResponse < Struct.new(
|
3689
|
+
:snapshot_id,
|
3690
|
+
:status,
|
3691
|
+
:status_message,
|
3692
|
+
:data_format,
|
3693
|
+
:encryption_key,
|
3694
|
+
:role_arn,
|
3695
|
+
:destination_uri)
|
3696
|
+
SENSITIVE = []
|
3697
|
+
include Aws::Structure
|
3698
|
+
end
|
3699
|
+
|
2508
3700
|
# @!attribute [rw] next_token
|
2509
3701
|
# The pagination token from the previous `GetSimilarProfiles` API
|
2510
3702
|
# call.
|
@@ -2713,6 +3905,36 @@ module Aws::CustomerProfiles
|
|
2713
3905
|
include Aws::Structure
|
2714
3906
|
end
|
2715
3907
|
|
3908
|
+
# Contains dimensions that determine what to segment on.
|
3909
|
+
#
|
3910
|
+
# @!attribute [rw] dimensions
|
3911
|
+
# Defines the attributes to segment on.
|
3912
|
+
# @return [Array<Types::Dimension>]
|
3913
|
+
#
|
3914
|
+
# @!attribute [rw] source_segments
|
3915
|
+
# Defines the starting source of data.
|
3916
|
+
# @return [Array<Types::SourceSegment>]
|
3917
|
+
#
|
3918
|
+
# @!attribute [rw] source_type
|
3919
|
+
# Defines how to interact with the source data.
|
3920
|
+
# @return [String]
|
3921
|
+
#
|
3922
|
+
# @!attribute [rw] type
|
3923
|
+
# Defines how to interact with the profiles found in the current
|
3924
|
+
# filtering.
|
3925
|
+
# @return [String]
|
3926
|
+
#
|
3927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Group AWS API Documentation
|
3928
|
+
#
|
3929
|
+
class Group < Struct.new(
|
3930
|
+
:dimensions,
|
3931
|
+
:source_segments,
|
3932
|
+
:source_type,
|
3933
|
+
:type)
|
3934
|
+
SENSITIVE = []
|
3935
|
+
include Aws::Structure
|
3936
|
+
end
|
3937
|
+
|
2716
3938
|
# Information about the Identity Resolution Job.
|
2717
3939
|
#
|
2718
3940
|
# @!attribute [rw] domain_name
|
@@ -3182,6 +4404,45 @@ module Aws::CustomerProfiles
|
|
3182
4404
|
include Aws::Structure
|
3183
4405
|
end
|
3184
4406
|
|
4407
|
+
# @!attribute [rw] domain_name
|
4408
|
+
# The unique name of the domain.
|
4409
|
+
# @return [String]
|
4410
|
+
#
|
4411
|
+
# @!attribute [rw] next_token
|
4412
|
+
# The pagination token to use with ListEventTriggers.
|
4413
|
+
# @return [String]
|
4414
|
+
#
|
4415
|
+
# @!attribute [rw] max_results
|
4416
|
+
# The maximum number of results to return per page.
|
4417
|
+
# @return [Integer]
|
4418
|
+
#
|
4419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListEventTriggersRequest AWS API Documentation
|
4420
|
+
#
|
4421
|
+
class ListEventTriggersRequest < Struct.new(
|
4422
|
+
:domain_name,
|
4423
|
+
:next_token,
|
4424
|
+
:max_results)
|
4425
|
+
SENSITIVE = []
|
4426
|
+
include Aws::Structure
|
4427
|
+
end
|
4428
|
+
|
4429
|
+
# @!attribute [rw] items
|
4430
|
+
# The list of Event Triggers.
|
4431
|
+
# @return [Array<Types::EventTriggerSummaryItem>]
|
4432
|
+
#
|
4433
|
+
# @!attribute [rw] next_token
|
4434
|
+
# The pagination token from the previous call to ListEventTriggers.
|
4435
|
+
# @return [String]
|
4436
|
+
#
|
4437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListEventTriggersResponse AWS API Documentation
|
4438
|
+
#
|
4439
|
+
class ListEventTriggersResponse < Struct.new(
|
4440
|
+
:items,
|
4441
|
+
:next_token)
|
4442
|
+
SENSITIVE = [:items]
|
4443
|
+
include Aws::Structure
|
4444
|
+
end
|
4445
|
+
|
3185
4446
|
# @!attribute [rw] domain_name
|
3186
4447
|
# The unique name of the domain.
|
3187
4448
|
# @return [String]
|
@@ -3276,6 +4537,11 @@ module Aws::CustomerProfiles
|
|
3276
4537
|
# this role to make Customer Profiles requests on your behalf.
|
3277
4538
|
# @return [String]
|
3278
4539
|
#
|
4540
|
+
# @!attribute [rw] event_trigger_names
|
4541
|
+
# A list of unique names for active event triggers associated with the
|
4542
|
+
# integration.
|
4543
|
+
# @return [Array<String>]
|
4544
|
+
#
|
3279
4545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationItem AWS API Documentation
|
3280
4546
|
#
|
3281
4547
|
class ListIntegrationItem < Struct.new(
|
@@ -3288,50 +4554,114 @@ module Aws::CustomerProfiles
|
|
3288
4554
|
:object_type_names,
|
3289
4555
|
:workflow_id,
|
3290
4556
|
:is_unstructured,
|
3291
|
-
:role_arn
|
4557
|
+
:role_arn,
|
4558
|
+
:event_trigger_names)
|
4559
|
+
SENSITIVE = []
|
4560
|
+
include Aws::Structure
|
4561
|
+
end
|
4562
|
+
|
4563
|
+
# @!attribute [rw] domain_name
|
4564
|
+
# The unique name of the domain.
|
4565
|
+
# @return [String]
|
4566
|
+
#
|
4567
|
+
# @!attribute [rw] next_token
|
4568
|
+
# The pagination token from the previous ListIntegrations API call.
|
4569
|
+
# @return [String]
|
4570
|
+
#
|
4571
|
+
# @!attribute [rw] max_results
|
4572
|
+
# The maximum number of objects returned per page.
|
4573
|
+
# @return [Integer]
|
4574
|
+
#
|
4575
|
+
# @!attribute [rw] include_hidden
|
4576
|
+
# Boolean to indicate if hidden integration should be returned.
|
4577
|
+
# Defaults to `False`.
|
4578
|
+
# @return [Boolean]
|
4579
|
+
#
|
4580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsRequest AWS API Documentation
|
4581
|
+
#
|
4582
|
+
class ListIntegrationsRequest < Struct.new(
|
4583
|
+
:domain_name,
|
4584
|
+
:next_token,
|
4585
|
+
:max_results,
|
4586
|
+
:include_hidden)
|
4587
|
+
SENSITIVE = []
|
4588
|
+
include Aws::Structure
|
4589
|
+
end
|
4590
|
+
|
4591
|
+
# @!attribute [rw] items
|
4592
|
+
# The list of ListIntegrations instances.
|
4593
|
+
# @return [Array<Types::ListIntegrationItem>]
|
4594
|
+
#
|
4595
|
+
# @!attribute [rw] next_token
|
4596
|
+
# The pagination token from the previous ListIntegrations API call.
|
4597
|
+
# @return [String]
|
4598
|
+
#
|
4599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsResponse AWS API Documentation
|
4600
|
+
#
|
4601
|
+
class ListIntegrationsResponse < Struct.new(
|
4602
|
+
:items,
|
4603
|
+
:next_token)
|
4604
|
+
SENSITIVE = []
|
4605
|
+
include Aws::Structure
|
4606
|
+
end
|
4607
|
+
|
4608
|
+
# Item that contains the attribute and when it was last updated.
|
4609
|
+
#
|
4610
|
+
# @!attribute [rw] attribute_name
|
4611
|
+
# Name of the attribute.
|
4612
|
+
# @return [String]
|
4613
|
+
#
|
4614
|
+
# @!attribute [rw] last_updated_at
|
4615
|
+
# When the attribute was last updated.
|
4616
|
+
# @return [Time]
|
4617
|
+
#
|
4618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributeItem AWS API Documentation
|
4619
|
+
#
|
4620
|
+
class ListObjectTypeAttributeItem < Struct.new(
|
4621
|
+
:attribute_name,
|
4622
|
+
:last_updated_at)
|
3292
4623
|
SENSITIVE = []
|
3293
4624
|
include Aws::Structure
|
3294
4625
|
end
|
3295
4626
|
|
3296
|
-
# @!attribute [rw] domain_name
|
3297
|
-
# The unique name of the domain.
|
3298
|
-
# @return [String]
|
3299
|
-
#
|
3300
4627
|
# @!attribute [rw] next_token
|
3301
|
-
# The pagination token from the previous
|
4628
|
+
# The pagination token from the previous call.
|
3302
4629
|
# @return [String]
|
3303
4630
|
#
|
3304
4631
|
# @!attribute [rw] max_results
|
3305
4632
|
# The maximum number of objects returned per page.
|
3306
4633
|
# @return [Integer]
|
3307
4634
|
#
|
3308
|
-
# @!attribute [rw]
|
3309
|
-
#
|
3310
|
-
#
|
3311
|
-
# @return [Boolean]
|
4635
|
+
# @!attribute [rw] domain_name
|
4636
|
+
# The unique identifier of the domain.
|
4637
|
+
# @return [String]
|
3312
4638
|
#
|
3313
|
-
#
|
4639
|
+
# @!attribute [rw] object_type_name
|
4640
|
+
# The name of the profile object type.
|
4641
|
+
# @return [String]
|
3314
4642
|
#
|
3315
|
-
|
3316
|
-
|
4643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributesRequest AWS API Documentation
|
4644
|
+
#
|
4645
|
+
class ListObjectTypeAttributesRequest < Struct.new(
|
3317
4646
|
:next_token,
|
3318
4647
|
:max_results,
|
3319
|
-
:
|
4648
|
+
:domain_name,
|
4649
|
+
:object_type_name)
|
3320
4650
|
SENSITIVE = []
|
3321
4651
|
include Aws::Structure
|
3322
4652
|
end
|
3323
4653
|
|
3324
4654
|
# @!attribute [rw] items
|
3325
|
-
# The
|
3326
|
-
# @return [Array<Types::
|
4655
|
+
# The items returned as part of the response.
|
4656
|
+
# @return [Array<Types::ListObjectTypeAttributeItem>]
|
3327
4657
|
#
|
3328
4658
|
# @!attribute [rw] next_token
|
3329
|
-
# The pagination token from the previous
|
4659
|
+
# The pagination token from the previous call.
|
3330
4660
|
# @return [String]
|
3331
4661
|
#
|
3332
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/
|
4662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributesResponse AWS API Documentation
|
3333
4663
|
#
|
3334
|
-
class
|
4664
|
+
class ListObjectTypeAttributesResponse < Struct.new(
|
3335
4665
|
:items,
|
3336
4666
|
:next_token)
|
3337
4667
|
SENSITIVE = []
|
@@ -3603,6 +4933,45 @@ module Aws::CustomerProfiles
|
|
3603
4933
|
include Aws::Structure
|
3604
4934
|
end
|
3605
4935
|
|
4936
|
+
# @!attribute [rw] domain_name
|
4937
|
+
# The unique identifier of the domain.
|
4938
|
+
# @return [String]
|
4939
|
+
#
|
4940
|
+
# @!attribute [rw] max_results
|
4941
|
+
# The maximum number of objects returned per page.
|
4942
|
+
# @return [Integer]
|
4943
|
+
#
|
4944
|
+
# @!attribute [rw] next_token
|
4945
|
+
# The pagination token from the previous call.
|
4946
|
+
# @return [String]
|
4947
|
+
#
|
4948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListSegmentDefinitionsRequest AWS API Documentation
|
4949
|
+
#
|
4950
|
+
class ListSegmentDefinitionsRequest < Struct.new(
|
4951
|
+
:domain_name,
|
4952
|
+
:max_results,
|
4953
|
+
:next_token)
|
4954
|
+
SENSITIVE = []
|
4955
|
+
include Aws::Structure
|
4956
|
+
end
|
4957
|
+
|
4958
|
+
# @!attribute [rw] next_token
|
4959
|
+
# The pagination token from the previous call.
|
4960
|
+
# @return [String]
|
4961
|
+
#
|
4962
|
+
# @!attribute [rw] items
|
4963
|
+
# List of segment definitions.
|
4964
|
+
# @return [Array<Types::SegmentDefinitionItem>]
|
4965
|
+
#
|
4966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListSegmentDefinitionsResponse AWS API Documentation
|
4967
|
+
#
|
4968
|
+
class ListSegmentDefinitionsResponse < Struct.new(
|
4969
|
+
:next_token,
|
4970
|
+
:items)
|
4971
|
+
SENSITIVE = []
|
4972
|
+
include Aws::Structure
|
4973
|
+
end
|
4974
|
+
|
3606
4975
|
# @!attribute [rw] resource_arn
|
3607
4976
|
# The ARN of the resource for which you want to view tags.
|
3608
4977
|
# @return [String]
|
@@ -3933,6 +5302,36 @@ module Aws::CustomerProfiles
|
|
3933
5302
|
include Aws::Structure
|
3934
5303
|
end
|
3935
5304
|
|
5305
|
+
# The criteria that a specific object attribute must meet to trigger the
|
5306
|
+
# destination.
|
5307
|
+
#
|
5308
|
+
# @!attribute [rw] source
|
5309
|
+
# An attribute contained within a source object.
|
5310
|
+
# @return [String]
|
5311
|
+
#
|
5312
|
+
# @!attribute [rw] field_name
|
5313
|
+
# A field defined within an object type.
|
5314
|
+
# @return [String]
|
5315
|
+
#
|
5316
|
+
# @!attribute [rw] comparison_operator
|
5317
|
+
# The operator used to compare an attribute against a list of values.
|
5318
|
+
# @return [String]
|
5319
|
+
#
|
5320
|
+
# @!attribute [rw] values
|
5321
|
+
# A list of attribute values used for comparison.
|
5322
|
+
# @return [Array<String>]
|
5323
|
+
#
|
5324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ObjectAttribute AWS API Documentation
|
5325
|
+
#
|
5326
|
+
class ObjectAttribute < Struct.new(
|
5327
|
+
:source,
|
5328
|
+
:field_name,
|
5329
|
+
:comparison_operator,
|
5330
|
+
:values)
|
5331
|
+
SENSITIVE = []
|
5332
|
+
include Aws::Structure
|
5333
|
+
end
|
5334
|
+
|
3936
5335
|
# The filter applied to `ListProfileObjects` response to include profile
|
3937
5336
|
# objects with the specified index values.
|
3938
5337
|
#
|
@@ -4015,6 +5414,36 @@ module Aws::CustomerProfiles
|
|
4015
5414
|
include Aws::Structure
|
4016
5415
|
end
|
4017
5416
|
|
5417
|
+
# Defines a limit and the time period during which it is enforced.
|
5418
|
+
#
|
5419
|
+
# @!attribute [rw] unit
|
5420
|
+
# The unit of time.
|
5421
|
+
# @return [String]
|
5422
|
+
#
|
5423
|
+
# @!attribute [rw] value
|
5424
|
+
# The amount of time of the specified unit.
|
5425
|
+
# @return [Integer]
|
5426
|
+
#
|
5427
|
+
# @!attribute [rw] max_invocations_per_profile
|
5428
|
+
# The maximum allowed number of destination invocations per profile.
|
5429
|
+
# @return [Integer]
|
5430
|
+
#
|
5431
|
+
# @!attribute [rw] unlimited
|
5432
|
+
# If set to true, there is no limit on the number of destination
|
5433
|
+
# invocations per profile. The default is false.
|
5434
|
+
# @return [Boolean]
|
5435
|
+
#
|
5436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Period AWS API Documentation
|
5437
|
+
#
|
5438
|
+
class Period < Struct.new(
|
5439
|
+
:unit,
|
5440
|
+
:value,
|
5441
|
+
:max_invocations_per_profile,
|
5442
|
+
:unlimited)
|
5443
|
+
SENSITIVE = []
|
5444
|
+
include Aws::Structure
|
5445
|
+
end
|
5446
|
+
|
4018
5447
|
# The standard profile of a customer.
|
4019
5448
|
#
|
4020
5449
|
# @!attribute [rw] profile_id
|
@@ -4062,105 +5491,270 @@ module Aws::CustomerProfiles
|
|
4062
5491
|
# mobile, home, or business number.
|
4063
5492
|
# @return [String]
|
4064
5493
|
#
|
4065
|
-
# @!attribute [rw] mobile_phone_number
|
4066
|
-
# The customer’s mobile phone number.
|
4067
|
-
# @return [String]
|
5494
|
+
# @!attribute [rw] mobile_phone_number
|
5495
|
+
# The customer’s mobile phone number.
|
5496
|
+
# @return [String]
|
5497
|
+
#
|
5498
|
+
# @!attribute [rw] home_phone_number
|
5499
|
+
# The customer’s home phone number.
|
5500
|
+
# @return [String]
|
5501
|
+
#
|
5502
|
+
# @!attribute [rw] business_phone_number
|
5503
|
+
# The customer’s home phone number.
|
5504
|
+
# @return [String]
|
5505
|
+
#
|
5506
|
+
# @!attribute [rw] email_address
|
5507
|
+
# The customer’s email address, which has not been specified as a
|
5508
|
+
# personal or business address.
|
5509
|
+
# @return [String]
|
5510
|
+
#
|
5511
|
+
# @!attribute [rw] personal_email_address
|
5512
|
+
# The customer’s personal email address.
|
5513
|
+
# @return [String]
|
5514
|
+
#
|
5515
|
+
# @!attribute [rw] business_email_address
|
5516
|
+
# The customer’s business email address.
|
5517
|
+
# @return [String]
|
5518
|
+
#
|
5519
|
+
# @!attribute [rw] address
|
5520
|
+
# A generic address associated with the customer that is not mailing,
|
5521
|
+
# shipping, or billing.
|
5522
|
+
# @return [Types::Address]
|
5523
|
+
#
|
5524
|
+
# @!attribute [rw] shipping_address
|
5525
|
+
# The customer’s shipping address.
|
5526
|
+
# @return [Types::Address]
|
5527
|
+
#
|
5528
|
+
# @!attribute [rw] mailing_address
|
5529
|
+
# The customer’s mailing address.
|
5530
|
+
# @return [Types::Address]
|
5531
|
+
#
|
5532
|
+
# @!attribute [rw] billing_address
|
5533
|
+
# The customer’s billing address.
|
5534
|
+
# @return [Types::Address]
|
5535
|
+
#
|
5536
|
+
# @!attribute [rw] attributes
|
5537
|
+
# A key value pair of attributes of a customer profile.
|
5538
|
+
# @return [Hash<String,String>]
|
5539
|
+
#
|
5540
|
+
# @!attribute [rw] found_by_items
|
5541
|
+
# A list of items used to find a profile returned in a
|
5542
|
+
# [SearchProfiles][1] response. An item is a key-value(s) pair that
|
5543
|
+
# matches an attribute in the profile.
|
5544
|
+
#
|
5545
|
+
# If the optional `AdditionalSearchKeys` parameter was included in the
|
5546
|
+
# [SearchProfiles][1] request, the `FoundByItems` list should be
|
5547
|
+
# interpreted based on the `LogicalOperator` used in the request:
|
5548
|
+
#
|
5549
|
+
# * `AND` - The profile included in the response matched all of the
|
5550
|
+
# search keys specified in the request. The `FoundByItems` will
|
5551
|
+
# include all of the key-value(s) pairs that were specified in the
|
5552
|
+
# request (as this is a requirement of `AND` search logic).
|
5553
|
+
#
|
5554
|
+
# * `OR` - The profile included in the response matched at least one
|
5555
|
+
# of the search keys specified in the request. The `FoundByItems`
|
5556
|
+
# will include each of the key-value(s) pairs that the profile was
|
5557
|
+
# found by.
|
5558
|
+
#
|
5559
|
+
# The `OR` relationship is the default behavior if the
|
5560
|
+
# `LogicalOperator` parameter is not included in the
|
5561
|
+
# [SearchProfiles][1] request.
|
5562
|
+
#
|
5563
|
+
#
|
5564
|
+
#
|
5565
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
|
5566
|
+
# @return [Array<Types::FoundByKeyValue>]
|
5567
|
+
#
|
5568
|
+
# @!attribute [rw] party_type_string
|
5569
|
+
# An alternative to PartyType which accepts any string as input.
|
5570
|
+
# @return [String]
|
5571
|
+
#
|
5572
|
+
# @!attribute [rw] gender_string
|
5573
|
+
# An alternative to Gender which accepts any string as input.
|
5574
|
+
# @return [String]
|
5575
|
+
#
|
5576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Profile AWS API Documentation
|
5577
|
+
#
|
5578
|
+
class Profile < Struct.new(
|
5579
|
+
:profile_id,
|
5580
|
+
:account_number,
|
5581
|
+
:additional_information,
|
5582
|
+
:party_type,
|
5583
|
+
:business_name,
|
5584
|
+
:first_name,
|
5585
|
+
:middle_name,
|
5586
|
+
:last_name,
|
5587
|
+
:birth_date,
|
5588
|
+
:gender,
|
5589
|
+
:phone_number,
|
5590
|
+
:mobile_phone_number,
|
5591
|
+
:home_phone_number,
|
5592
|
+
:business_phone_number,
|
5593
|
+
:email_address,
|
5594
|
+
:personal_email_address,
|
5595
|
+
:business_email_address,
|
5596
|
+
:address,
|
5597
|
+
:shipping_address,
|
5598
|
+
:mailing_address,
|
5599
|
+
:billing_address,
|
5600
|
+
:attributes,
|
5601
|
+
:found_by_items,
|
5602
|
+
:party_type_string,
|
5603
|
+
:gender_string)
|
5604
|
+
SENSITIVE = [:account_number, :additional_information, :party_type, :business_name, :first_name, :middle_name, :last_name, :birth_date, :gender, :phone_number, :mobile_phone_number, :home_phone_number, :business_phone_number, :email_address, :personal_email_address, :business_email_address, :address, :shipping_address, :mailing_address, :billing_address, :attributes, :party_type_string, :gender_string]
|
5605
|
+
include Aws::Structure
|
5606
|
+
end
|
5607
|
+
|
5608
|
+
# @!attribute [rw] domain_name
|
5609
|
+
# The unique identifier of the domain.
|
5610
|
+
# @return [String]
|
5611
|
+
#
|
5612
|
+
# @!attribute [rw] attribute_name
|
5613
|
+
# The attribute name.
|
5614
|
+
# @return [String]
|
5615
|
+
#
|
5616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileAttributeValuesRequest AWS API Documentation
|
5617
|
+
#
|
5618
|
+
class ProfileAttributeValuesRequest < Struct.new(
|
5619
|
+
:domain_name,
|
5620
|
+
:attribute_name)
|
5621
|
+
SENSITIVE = []
|
5622
|
+
include Aws::Structure
|
5623
|
+
end
|
5624
|
+
|
5625
|
+
# @!attribute [rw] domain_name
|
5626
|
+
# The name of the domain.
|
5627
|
+
# @return [String]
|
5628
|
+
#
|
5629
|
+
# @!attribute [rw] attribute_name
|
5630
|
+
# The attribute name.
|
5631
|
+
# @return [String]
|
5632
|
+
#
|
5633
|
+
# @!attribute [rw] items
|
5634
|
+
# The items returned as part of the response.
|
5635
|
+
# @return [Array<Types::AttributeValueItem>]
|
5636
|
+
#
|
5637
|
+
# @!attribute [rw] status_code
|
5638
|
+
# The status code for the response.
|
5639
|
+
# @return [Integer]
|
5640
|
+
#
|
5641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileAttributeValuesResponse AWS API Documentation
|
5642
|
+
#
|
5643
|
+
class ProfileAttributeValuesResponse < Struct.new(
|
5644
|
+
:domain_name,
|
5645
|
+
:attribute_name,
|
5646
|
+
:items,
|
5647
|
+
:status_code)
|
5648
|
+
SENSITIVE = []
|
5649
|
+
include Aws::Structure
|
5650
|
+
end
|
5651
|
+
|
5652
|
+
# The object used to segment on attributes within the customer profile.
|
5653
|
+
#
|
5654
|
+
# @!attribute [rw] account_number
|
5655
|
+
# A field to describe values to segment on within account number.
|
5656
|
+
# @return [Types::ProfileDimension]
|
5657
|
+
#
|
5658
|
+
# @!attribute [rw] additional_information
|
5659
|
+
# A field to describe values to segment on within additional
|
5660
|
+
# information.
|
5661
|
+
# @return [Types::ExtraLengthValueProfileDimension]
|
5662
|
+
#
|
5663
|
+
# @!attribute [rw] first_name
|
5664
|
+
# A field to describe values to segment on within first name.
|
5665
|
+
# @return [Types::ProfileDimension]
|
5666
|
+
#
|
5667
|
+
# @!attribute [rw] last_name
|
5668
|
+
# A field to describe values to segment on within last name.
|
5669
|
+
# @return [Types::ProfileDimension]
|
5670
|
+
#
|
5671
|
+
# @!attribute [rw] middle_name
|
5672
|
+
# A field to describe values to segment on within middle name.
|
5673
|
+
# @return [Types::ProfileDimension]
|
5674
|
+
#
|
5675
|
+
# @!attribute [rw] gender_string
|
5676
|
+
# A field to describe values to segment on within genderString.
|
5677
|
+
# @return [Types::ProfileDimension]
|
5678
|
+
#
|
5679
|
+
# @!attribute [rw] party_type_string
|
5680
|
+
# A field to describe values to segment on within partyTypeString.
|
5681
|
+
# @return [Types::ProfileDimension]
|
5682
|
+
#
|
5683
|
+
# @!attribute [rw] birth_date
|
5684
|
+
# A field to describe values to segment on within birthDate.
|
5685
|
+
# @return [Types::DateDimension]
|
5686
|
+
#
|
5687
|
+
# @!attribute [rw] phone_number
|
5688
|
+
# A field to describe values to segment on within phone number.
|
5689
|
+
# @return [Types::ProfileDimension]
|
5690
|
+
#
|
5691
|
+
# @!attribute [rw] business_name
|
5692
|
+
# A field to describe values to segment on within business name.
|
5693
|
+
# @return [Types::ProfileDimension]
|
5694
|
+
#
|
5695
|
+
# @!attribute [rw] business_phone_number
|
5696
|
+
# A field to describe values to segment on within business phone
|
5697
|
+
# number.
|
5698
|
+
# @return [Types::ProfileDimension]
|
4068
5699
|
#
|
4069
5700
|
# @!attribute [rw] home_phone_number
|
4070
|
-
#
|
4071
|
-
# @return [
|
5701
|
+
# A field to describe values to segment on within home phone number.
|
5702
|
+
# @return [Types::ProfileDimension]
|
4072
5703
|
#
|
4073
|
-
# @!attribute [rw]
|
4074
|
-
#
|
4075
|
-
# @return [
|
5704
|
+
# @!attribute [rw] mobile_phone_number
|
5705
|
+
# A field to describe values to segment on within mobile phone number.
|
5706
|
+
# @return [Types::ProfileDimension]
|
4076
5707
|
#
|
4077
5708
|
# @!attribute [rw] email_address
|
4078
|
-
#
|
4079
|
-
#
|
4080
|
-
# @return [String]
|
5709
|
+
# A field to describe values to segment on within email address.
|
5710
|
+
# @return [Types::ProfileDimension]
|
4081
5711
|
#
|
4082
5712
|
# @!attribute [rw] personal_email_address
|
4083
|
-
#
|
4084
|
-
#
|
5713
|
+
# A field to describe values to segment on within personal email
|
5714
|
+
# address.
|
5715
|
+
# @return [Types::ProfileDimension]
|
4085
5716
|
#
|
4086
5717
|
# @!attribute [rw] business_email_address
|
4087
|
-
#
|
4088
|
-
#
|
5718
|
+
# A field to describe values to segment on within business email
|
5719
|
+
# address.
|
5720
|
+
# @return [Types::ProfileDimension]
|
4089
5721
|
#
|
4090
5722
|
# @!attribute [rw] address
|
4091
|
-
# A
|
4092
|
-
#
|
4093
|
-
# @return [Types::Address]
|
5723
|
+
# A field to describe values to segment on within address.
|
5724
|
+
# @return [Types::AddressDimension]
|
4094
5725
|
#
|
4095
5726
|
# @!attribute [rw] shipping_address
|
4096
|
-
#
|
4097
|
-
# @return [Types::
|
5727
|
+
# A field to describe values to segment on within shipping address.
|
5728
|
+
# @return [Types::AddressDimension]
|
4098
5729
|
#
|
4099
5730
|
# @!attribute [rw] mailing_address
|
4100
|
-
#
|
4101
|
-
# @return [Types::
|
5731
|
+
# A field to describe values to segment on within mailing address.
|
5732
|
+
# @return [Types::AddressDimension]
|
4102
5733
|
#
|
4103
5734
|
# @!attribute [rw] billing_address
|
4104
|
-
#
|
4105
|
-
# @return [Types::
|
5735
|
+
# A field to describe values to segment on within billing address.
|
5736
|
+
# @return [Types::AddressDimension]
|
4106
5737
|
#
|
4107
5738
|
# @!attribute [rw] attributes
|
4108
|
-
# A
|
4109
|
-
# @return [Hash<String,
|
4110
|
-
#
|
4111
|
-
# @!attribute [rw] found_by_items
|
4112
|
-
# A list of items used to find a profile returned in a
|
4113
|
-
# [SearchProfiles][1] response. An item is a key-value(s) pair that
|
4114
|
-
# matches an attribute in the profile.
|
4115
|
-
#
|
4116
|
-
# If the optional `AdditionalSearchKeys` parameter was included in the
|
4117
|
-
# [SearchProfiles][1] request, the `FoundByItems` list should be
|
4118
|
-
# interpreted based on the `LogicalOperator` used in the request:
|
4119
|
-
#
|
4120
|
-
# * `AND` - The profile included in the response matched all of the
|
4121
|
-
# search keys specified in the request. The `FoundByItems` will
|
4122
|
-
# include all of the key-value(s) pairs that were specified in the
|
4123
|
-
# request (as this is a requirement of `AND` search logic).
|
4124
|
-
#
|
4125
|
-
# * `OR` - The profile included in the response matched at least one
|
4126
|
-
# of the search keys specified in the request. The `FoundByItems`
|
4127
|
-
# will include each of the key-value(s) pairs that the profile was
|
4128
|
-
# found by.
|
4129
|
-
#
|
4130
|
-
# The `OR` relationship is the default behavior if the
|
4131
|
-
# `LogicalOperator` parameter is not included in the
|
4132
|
-
# [SearchProfiles][1] request.
|
4133
|
-
#
|
4134
|
-
#
|
4135
|
-
#
|
4136
|
-
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
|
4137
|
-
# @return [Array<Types::FoundByKeyValue>]
|
4138
|
-
#
|
4139
|
-
# @!attribute [rw] party_type_string
|
4140
|
-
# An alternative to PartyType which accepts any string as input.
|
4141
|
-
# @return [String]
|
4142
|
-
#
|
4143
|
-
# @!attribute [rw] gender_string
|
4144
|
-
# An alternative to Gender which accepts any string as input.
|
4145
|
-
# @return [String]
|
5739
|
+
# A field to describe values to segment on within attributes.
|
5740
|
+
# @return [Hash<String,Types::AttributeDimension>]
|
4146
5741
|
#
|
4147
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/
|
5742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileAttributes AWS API Documentation
|
4148
5743
|
#
|
4149
|
-
class
|
4150
|
-
:profile_id,
|
5744
|
+
class ProfileAttributes < Struct.new(
|
4151
5745
|
:account_number,
|
4152
5746
|
:additional_information,
|
4153
|
-
:party_type,
|
4154
|
-
:business_name,
|
4155
5747
|
:first_name,
|
4156
|
-
:middle_name,
|
4157
5748
|
:last_name,
|
5749
|
+
:middle_name,
|
5750
|
+
:gender_string,
|
5751
|
+
:party_type_string,
|
4158
5752
|
:birth_date,
|
4159
|
-
:gender,
|
4160
5753
|
:phone_number,
|
4161
|
-
:
|
4162
|
-
:home_phone_number,
|
5754
|
+
:business_name,
|
4163
5755
|
:business_phone_number,
|
5756
|
+
:home_phone_number,
|
5757
|
+
:mobile_phone_number,
|
4164
5758
|
:email_address,
|
4165
5759
|
:personal_email_address,
|
4166
5760
|
:business_email_address,
|
@@ -4168,11 +5762,75 @@ module Aws::CustomerProfiles
|
|
4168
5762
|
:shipping_address,
|
4169
5763
|
:mailing_address,
|
4170
5764
|
:billing_address,
|
4171
|
-
:attributes
|
4172
|
-
|
4173
|
-
|
4174
|
-
|
4175
|
-
|
5765
|
+
:attributes)
|
5766
|
+
SENSITIVE = []
|
5767
|
+
include Aws::Structure
|
5768
|
+
end
|
5769
|
+
|
5770
|
+
# Object to hold the dimensions of a profile's fields to segment on.
|
5771
|
+
#
|
5772
|
+
# @!attribute [rw] dimension_type
|
5773
|
+
# The action to segment on.
|
5774
|
+
# @return [String]
|
5775
|
+
#
|
5776
|
+
# @!attribute [rw] values
|
5777
|
+
# The values to apply the DimensionType on.
|
5778
|
+
# @return [Array<String>]
|
5779
|
+
#
|
5780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileDimension AWS API Documentation
|
5781
|
+
#
|
5782
|
+
class ProfileDimension < Struct.new(
|
5783
|
+
:dimension_type,
|
5784
|
+
:values)
|
5785
|
+
SENSITIVE = []
|
5786
|
+
include Aws::Structure
|
5787
|
+
end
|
5788
|
+
|
5789
|
+
# Object that holds failures for membership.
|
5790
|
+
#
|
5791
|
+
# @!attribute [rw] profile_id
|
5792
|
+
# The profile id the failure belongs to.
|
5793
|
+
# @return [String]
|
5794
|
+
#
|
5795
|
+
# @!attribute [rw] message
|
5796
|
+
# A message describing the failure.
|
5797
|
+
# @return [String]
|
5798
|
+
#
|
5799
|
+
# @!attribute [rw] status
|
5800
|
+
# The status describing the failure.
|
5801
|
+
# @return [Integer]
|
5802
|
+
#
|
5803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileQueryFailures AWS API Documentation
|
5804
|
+
#
|
5805
|
+
class ProfileQueryFailures < Struct.new(
|
5806
|
+
:profile_id,
|
5807
|
+
:message,
|
5808
|
+
:status)
|
5809
|
+
SENSITIVE = []
|
5810
|
+
include Aws::Structure
|
5811
|
+
end
|
5812
|
+
|
5813
|
+
# Object that holds the results for membership.
|
5814
|
+
#
|
5815
|
+
# @!attribute [rw] profile_id
|
5816
|
+
# The profile id the result belongs to.
|
5817
|
+
# @return [String]
|
5818
|
+
#
|
5819
|
+
# @!attribute [rw] query_result
|
5820
|
+
# Describes whether the profile was absent or present in the segment.
|
5821
|
+
# @return [String]
|
5822
|
+
#
|
5823
|
+
# @!attribute [rw] profile
|
5824
|
+
# The standard profile of a customer.
|
5825
|
+
# @return [Types::Profile]
|
5826
|
+
#
|
5827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileQueryResult AWS API Documentation
|
5828
|
+
#
|
5829
|
+
class ProfileQueryResult < Struct.new(
|
5830
|
+
:profile_id,
|
5831
|
+
:query_result,
|
5832
|
+
:profile)
|
5833
|
+
SENSITIVE = []
|
4176
5834
|
include Aws::Structure
|
4177
5835
|
end
|
4178
5836
|
|
@@ -4213,6 +5871,11 @@ module Aws::CustomerProfiles
|
|
4213
5871
|
# this role to make Customer Profiles requests on your behalf.
|
4214
5872
|
# @return [String]
|
4215
5873
|
#
|
5874
|
+
# @!attribute [rw] event_trigger_names
|
5875
|
+
# A list of unique names for active event triggers associated with the
|
5876
|
+
# integration.
|
5877
|
+
# @return [Array<String>]
|
5878
|
+
#
|
4216
5879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationRequest AWS API Documentation
|
4217
5880
|
#
|
4218
5881
|
class PutIntegrationRequest < Struct.new(
|
@@ -4222,7 +5885,8 @@ module Aws::CustomerProfiles
|
|
4222
5885
|
:tags,
|
4223
5886
|
:flow_definition,
|
4224
5887
|
:object_type_names,
|
4225
|
-
:role_arn
|
5888
|
+
:role_arn,
|
5889
|
+
:event_trigger_names)
|
4226
5890
|
SENSITIVE = [:flow_definition]
|
4227
5891
|
include Aws::Structure
|
4228
5892
|
end
|
@@ -4277,6 +5941,12 @@ module Aws::CustomerProfiles
|
|
4277
5941
|
# this role to make Customer Profiles requests on your behalf.
|
4278
5942
|
# @return [String]
|
4279
5943
|
#
|
5944
|
+
# @!attribute [rw] event_trigger_names
|
5945
|
+
# A list of unique names for active event triggers associated with the
|
5946
|
+
# integration. This list would be empty if no Event Trigger is
|
5947
|
+
# associated with the integration.
|
5948
|
+
# @return [Array<String>]
|
5949
|
+
#
|
4280
5950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationResponse AWS API Documentation
|
4281
5951
|
#
|
4282
5952
|
class PutIntegrationResponse < Struct.new(
|
@@ -4289,7 +5959,8 @@ module Aws::CustomerProfiles
|
|
4289
5959
|
:object_type_names,
|
4290
5960
|
:workflow_id,
|
4291
5961
|
:is_unstructured,
|
4292
|
-
:role_arn
|
5962
|
+
:role_arn,
|
5963
|
+
:event_trigger_names)
|
4293
5964
|
SENSITIVE = []
|
4294
5965
|
include Aws::Structure
|
4295
5966
|
end
|
@@ -4522,6 +6193,30 @@ module Aws::CustomerProfiles
|
|
4522
6193
|
include Aws::Structure
|
4523
6194
|
end
|
4524
6195
|
|
6196
|
+
# Overrides the original range on a calculated attribute definition.
|
6197
|
+
#
|
6198
|
+
# @!attribute [rw] start
|
6199
|
+
# The start time of when to include objects.
|
6200
|
+
# @return [Integer]
|
6201
|
+
#
|
6202
|
+
# @!attribute [rw] end
|
6203
|
+
# The end time of when to include objects.
|
6204
|
+
# @return [Integer]
|
6205
|
+
#
|
6206
|
+
# @!attribute [rw] unit
|
6207
|
+
# The unit for start and end.
|
6208
|
+
# @return [String]
|
6209
|
+
#
|
6210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RangeOverride AWS API Documentation
|
6211
|
+
#
|
6212
|
+
class RangeOverride < Struct.new(
|
6213
|
+
:start,
|
6214
|
+
:end,
|
6215
|
+
:unit)
|
6216
|
+
SENSITIVE = []
|
6217
|
+
include Aws::Structure
|
6218
|
+
end
|
6219
|
+
|
4525
6220
|
# The requested resource does not exist, or access was denied.
|
4526
6221
|
#
|
4527
6222
|
# @!attribute [rw] message
|
@@ -4922,6 +6617,85 @@ module Aws::CustomerProfiles
|
|
4922
6617
|
include Aws::Structure
|
4923
6618
|
end
|
4924
6619
|
|
6620
|
+
# Object holding the segment definition fields.
|
6621
|
+
#
|
6622
|
+
# @!attribute [rw] segment_definition_name
|
6623
|
+
# Name of the segment definition.
|
6624
|
+
# @return [String]
|
6625
|
+
#
|
6626
|
+
# @!attribute [rw] display_name
|
6627
|
+
# Display name of the segment definition.
|
6628
|
+
# @return [String]
|
6629
|
+
#
|
6630
|
+
# @!attribute [rw] description
|
6631
|
+
# The description of the segment definition.
|
6632
|
+
# @return [String]
|
6633
|
+
#
|
6634
|
+
# @!attribute [rw] segment_definition_arn
|
6635
|
+
# The arn of the segment definition.
|
6636
|
+
# @return [String]
|
6637
|
+
#
|
6638
|
+
# @!attribute [rw] created_at
|
6639
|
+
# When the segment definition was created.
|
6640
|
+
# @return [Time]
|
6641
|
+
#
|
6642
|
+
# @!attribute [rw] tags
|
6643
|
+
# The tags belonging to the segment definition.
|
6644
|
+
# @return [Hash<String,String>]
|
6645
|
+
#
|
6646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentDefinitionItem AWS API Documentation
|
6647
|
+
#
|
6648
|
+
class SegmentDefinitionItem < Struct.new(
|
6649
|
+
:segment_definition_name,
|
6650
|
+
:display_name,
|
6651
|
+
:description,
|
6652
|
+
:segment_definition_arn,
|
6653
|
+
:created_at,
|
6654
|
+
:tags)
|
6655
|
+
SENSITIVE = [:description]
|
6656
|
+
include Aws::Structure
|
6657
|
+
end
|
6658
|
+
|
6659
|
+
# Contains all groups of the segment definition.
|
6660
|
+
#
|
6661
|
+
# @!attribute [rw] groups
|
6662
|
+
# Holds the list of groups within the segment definition.
|
6663
|
+
# @return [Array<Types::Group>]
|
6664
|
+
#
|
6665
|
+
# @!attribute [rw] include
|
6666
|
+
# Defines whether to include or exclude the profiles that fit the
|
6667
|
+
# segment criteria.
|
6668
|
+
# @return [String]
|
6669
|
+
#
|
6670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentGroup AWS API Documentation
|
6671
|
+
#
|
6672
|
+
class SegmentGroup < Struct.new(
|
6673
|
+
:groups,
|
6674
|
+
:include)
|
6675
|
+
SENSITIVE = []
|
6676
|
+
include Aws::Structure
|
6677
|
+
end
|
6678
|
+
|
6679
|
+
# Contains all groups of the segment definition.
|
6680
|
+
#
|
6681
|
+
# @!attribute [rw] groups
|
6682
|
+
# Holds the list of groups within the segment definition.
|
6683
|
+
# @return [Array<Types::Group>]
|
6684
|
+
#
|
6685
|
+
# @!attribute [rw] include
|
6686
|
+
# Define whether to include or exclude the profiles that fit the
|
6687
|
+
# segment criteria.
|
6688
|
+
# @return [String]
|
6689
|
+
#
|
6690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentGroupStructure AWS API Documentation
|
6691
|
+
#
|
6692
|
+
class SegmentGroupStructure < Struct.new(
|
6693
|
+
:groups,
|
6694
|
+
:include)
|
6695
|
+
SENSITIVE = []
|
6696
|
+
include Aws::Structure
|
6697
|
+
end
|
6698
|
+
|
4925
6699
|
# The properties that are applied when ServiceNow is being used as a
|
4926
6700
|
# source.
|
4927
6701
|
#
|
@@ -5011,6 +6785,20 @@ module Aws::CustomerProfiles
|
|
5011
6785
|
include Aws::Structure
|
5012
6786
|
end
|
5013
6787
|
|
6788
|
+
# The source segments to build off of.
|
6789
|
+
#
|
6790
|
+
# @!attribute [rw] segment_definition_name
|
6791
|
+
# The unique name of the segment definition.
|
6792
|
+
# @return [String]
|
6793
|
+
#
|
6794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SourceSegment AWS API Documentation
|
6795
|
+
#
|
6796
|
+
class SourceSegment < Struct.new(
|
6797
|
+
:segment_definition_name)
|
6798
|
+
SENSITIVE = []
|
6799
|
+
include Aws::Structure
|
6800
|
+
end
|
6801
|
+
|
5014
6802
|
# @!attribute [rw] resource_arn
|
5015
6803
|
# The ARN of the resource that you're adding tags to.
|
5016
6804
|
# @return [String]
|
@@ -5462,6 +7250,108 @@ module Aws::CustomerProfiles
|
|
5462
7250
|
include Aws::Structure
|
5463
7251
|
end
|
5464
7252
|
|
7253
|
+
# @!attribute [rw] domain_name
|
7254
|
+
# The unique name of the domain.
|
7255
|
+
# @return [String]
|
7256
|
+
#
|
7257
|
+
# @!attribute [rw] event_trigger_name
|
7258
|
+
# The unique name of the event trigger.
|
7259
|
+
# @return [String]
|
7260
|
+
#
|
7261
|
+
# @!attribute [rw] object_type_name
|
7262
|
+
# The unique name of the object type.
|
7263
|
+
# @return [String]
|
7264
|
+
#
|
7265
|
+
# @!attribute [rw] description
|
7266
|
+
# The description of the event trigger.
|
7267
|
+
# @return [String]
|
7268
|
+
#
|
7269
|
+
# @!attribute [rw] event_trigger_conditions
|
7270
|
+
# A list of conditions that determine when an event should trigger the
|
7271
|
+
# destination.
|
7272
|
+
# @return [Array<Types::EventTriggerCondition>]
|
7273
|
+
#
|
7274
|
+
# @!attribute [rw] segment_filter
|
7275
|
+
# The destination is triggered only for profiles that meet the
|
7276
|
+
# criteria of a segment definition.
|
7277
|
+
# @return [String]
|
7278
|
+
#
|
7279
|
+
# @!attribute [rw] event_trigger_limits
|
7280
|
+
# Defines limits controlling whether an event triggers the
|
7281
|
+
# destination, based on ingestion latency and the number of
|
7282
|
+
# invocations per profile over specific time periods.
|
7283
|
+
# @return [Types::EventTriggerLimits]
|
7284
|
+
#
|
7285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateEventTriggerRequest AWS API Documentation
|
7286
|
+
#
|
7287
|
+
class UpdateEventTriggerRequest < Struct.new(
|
7288
|
+
:domain_name,
|
7289
|
+
:event_trigger_name,
|
7290
|
+
:object_type_name,
|
7291
|
+
:description,
|
7292
|
+
:event_trigger_conditions,
|
7293
|
+
:segment_filter,
|
7294
|
+
:event_trigger_limits)
|
7295
|
+
SENSITIVE = [:description, :event_trigger_conditions]
|
7296
|
+
include Aws::Structure
|
7297
|
+
end
|
7298
|
+
|
7299
|
+
# @!attribute [rw] event_trigger_name
|
7300
|
+
# The unique name of the event trigger.
|
7301
|
+
# @return [String]
|
7302
|
+
#
|
7303
|
+
# @!attribute [rw] object_type_name
|
7304
|
+
# The unique name of the object type.
|
7305
|
+
# @return [String]
|
7306
|
+
#
|
7307
|
+
# @!attribute [rw] description
|
7308
|
+
# The description of the event trigger.
|
7309
|
+
# @return [String]
|
7310
|
+
#
|
7311
|
+
# @!attribute [rw] event_trigger_conditions
|
7312
|
+
# A list of conditions that determine when an event should trigger the
|
7313
|
+
# destination.
|
7314
|
+
# @return [Array<Types::EventTriggerCondition>]
|
7315
|
+
#
|
7316
|
+
# @!attribute [rw] segment_filter
|
7317
|
+
# The destination is triggered only for profiles that meet the
|
7318
|
+
# criteria of a segment definition.
|
7319
|
+
# @return [String]
|
7320
|
+
#
|
7321
|
+
# @!attribute [rw] event_trigger_limits
|
7322
|
+
# Defines limits controlling whether an event triggers the
|
7323
|
+
# destination, based on ingestion latency and the number of
|
7324
|
+
# invocations per profile over specific time periods.
|
7325
|
+
# @return [Types::EventTriggerLimits]
|
7326
|
+
#
|
7327
|
+
# @!attribute [rw] created_at
|
7328
|
+
# The timestamp of when the event trigger was created.
|
7329
|
+
# @return [Time]
|
7330
|
+
#
|
7331
|
+
# @!attribute [rw] last_updated_at
|
7332
|
+
# The timestamp of when the event trigger was most recently updated.
|
7333
|
+
# @return [Time]
|
7334
|
+
#
|
7335
|
+
# @!attribute [rw] tags
|
7336
|
+
# An array of key-value pairs to apply to this resource.
|
7337
|
+
# @return [Hash<String,String>]
|
7338
|
+
#
|
7339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateEventTriggerResponse AWS API Documentation
|
7340
|
+
#
|
7341
|
+
class UpdateEventTriggerResponse < Struct.new(
|
7342
|
+
:event_trigger_name,
|
7343
|
+
:object_type_name,
|
7344
|
+
:description,
|
7345
|
+
:event_trigger_conditions,
|
7346
|
+
:segment_filter,
|
7347
|
+
:event_trigger_limits,
|
7348
|
+
:created_at,
|
7349
|
+
:last_updated_at,
|
7350
|
+
:tags)
|
7351
|
+
SENSITIVE = [:description, :event_trigger_conditions]
|
7352
|
+
include Aws::Structure
|
7353
|
+
end
|
7354
|
+
|
5465
7355
|
# @!attribute [rw] domain_name
|
5466
7356
|
# The unique name of the domain.
|
5467
7357
|
# @return [String]
|