aws-sdk-pinpoint 1.45.0 → 1.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +2 -1
- data/lib/aws-sdk-pinpoint/client.rb +274 -128
- data/lib/aws-sdk-pinpoint/client_api.rb +20 -1
- data/lib/aws-sdk-pinpoint/errors.rb +21 -0
- data/lib/aws-sdk-pinpoint/types.rb +417 -118
- metadata +4 -4
@@ -60,6 +60,7 @@ module Aws::Pinpoint
|
|
60
60
|
ChannelsResponse = Shapes::StructureShape.new(name: 'ChannelsResponse')
|
61
61
|
Condition = Shapes::StructureShape.new(name: 'Condition')
|
62
62
|
ConditionalSplitActivity = Shapes::StructureShape.new(name: 'ConditionalSplitActivity')
|
63
|
+
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
63
64
|
CreateAppRequest = Shapes::StructureShape.new(name: 'CreateAppRequest')
|
64
65
|
CreateAppResponse = Shapes::StructureShape.new(name: 'CreateAppResponse')
|
65
66
|
CreateApplicationRequest = Shapes::StructureShape.new(name: 'CreateApplicationRequest')
|
@@ -158,7 +159,9 @@ module Aws::Pinpoint
|
|
158
159
|
Event = Shapes::StructureShape.new(name: 'Event')
|
159
160
|
EventCondition = Shapes::StructureShape.new(name: 'EventCondition')
|
160
161
|
EventDimensions = Shapes::StructureShape.new(name: 'EventDimensions')
|
162
|
+
EventFilter = Shapes::StructureShape.new(name: 'EventFilter')
|
161
163
|
EventItemResponse = Shapes::StructureShape.new(name: 'EventItemResponse')
|
164
|
+
EventStartCondition = Shapes::StructureShape.new(name: 'EventStartCondition')
|
162
165
|
EventStream = Shapes::StructureShape.new(name: 'EventStream')
|
163
166
|
EventsBatch = Shapes::StructureShape.new(name: 'EventsBatch')
|
164
167
|
EventsRequest = Shapes::StructureShape.new(name: 'EventsRequest')
|
@@ -837,6 +840,7 @@ module Aws::Pinpoint
|
|
837
840
|
|
838
841
|
CampaignSmsMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
|
839
842
|
CampaignSmsMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
843
|
+
CampaignSmsMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
840
844
|
CampaignSmsMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
841
845
|
CampaignSmsMessage.struct_class = Types::CampaignSmsMessage
|
842
846
|
|
@@ -871,6 +875,10 @@ module Aws::Pinpoint
|
|
871
875
|
ConditionalSplitActivity.add_member(:true_activity, Shapes::ShapeRef.new(shape: __string, location_name: "TrueActivity"))
|
872
876
|
ConditionalSplitActivity.struct_class = Types::ConditionalSplitActivity
|
873
877
|
|
878
|
+
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: __string, location_name: "Message"))
|
879
|
+
ConflictException.add_member(:request_id, Shapes::ShapeRef.new(shape: __string, location_name: "RequestID"))
|
880
|
+
ConflictException.struct_class = Types::ConflictException
|
881
|
+
|
874
882
|
CreateAppRequest.add_member(:create_application_request, Shapes::ShapeRef.new(shape: CreateApplicationRequest, required: true, location_name: "CreateApplicationRequest"))
|
875
883
|
CreateAppRequest.struct_class = Types::CreateAppRequest
|
876
884
|
CreateAppRequest[:payload] = :create_application_request
|
@@ -1404,7 +1412,7 @@ module Aws::Pinpoint
|
|
1404
1412
|
Event.add_member(:timestamp, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Timestamp"))
|
1405
1413
|
Event.struct_class = Types::Event
|
1406
1414
|
|
1407
|
-
EventCondition.add_member(:dimensions, Shapes::ShapeRef.new(shape: EventDimensions,
|
1415
|
+
EventCondition.add_member(:dimensions, Shapes::ShapeRef.new(shape: EventDimensions, location_name: "Dimensions"))
|
1408
1416
|
EventCondition.add_member(:message_activity, Shapes::ShapeRef.new(shape: __string, location_name: "MessageActivity"))
|
1409
1417
|
EventCondition.struct_class = Types::EventCondition
|
1410
1418
|
|
@@ -1413,10 +1421,18 @@ module Aws::Pinpoint
|
|
1413
1421
|
EventDimensions.add_member(:metrics, Shapes::ShapeRef.new(shape: MapOfMetricDimension, location_name: "Metrics"))
|
1414
1422
|
EventDimensions.struct_class = Types::EventDimensions
|
1415
1423
|
|
1424
|
+
EventFilter.add_member(:dimensions, Shapes::ShapeRef.new(shape: EventDimensions, required: true, location_name: "Dimensions"))
|
1425
|
+
EventFilter.add_member(:filter_type, Shapes::ShapeRef.new(shape: FilterType, required: true, location_name: "FilterType"))
|
1426
|
+
EventFilter.struct_class = Types::EventFilter
|
1427
|
+
|
1416
1428
|
EventItemResponse.add_member(:message, Shapes::ShapeRef.new(shape: __string, location_name: "Message"))
|
1417
1429
|
EventItemResponse.add_member(:status_code, Shapes::ShapeRef.new(shape: __integer, location_name: "StatusCode"))
|
1418
1430
|
EventItemResponse.struct_class = Types::EventItemResponse
|
1419
1431
|
|
1432
|
+
EventStartCondition.add_member(:event_filter, Shapes::ShapeRef.new(shape: EventFilter, location_name: "EventFilter"))
|
1433
|
+
EventStartCondition.add_member(:segment_id, Shapes::ShapeRef.new(shape: __string, location_name: "SegmentId"))
|
1434
|
+
EventStartCondition.struct_class = Types::EventStartCondition
|
1435
|
+
|
1420
1436
|
EventStream.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
|
1421
1437
|
EventStream.add_member(:destination_stream_arn, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DestinationStreamArn"))
|
1422
1438
|
EventStream.add_member(:external_id, Shapes::ShapeRef.new(shape: __string, location_name: "ExternalId"))
|
@@ -2036,6 +2052,7 @@ module Aws::Pinpoint
|
|
2036
2052
|
JourneyResponse.struct_class = Types::JourneyResponse
|
2037
2053
|
|
2038
2054
|
JourneySMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
2055
|
+
JourneySMSMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
2039
2056
|
JourneySMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
2040
2057
|
JourneySMSMessage.struct_class = Types::JourneySMSMessage
|
2041
2058
|
|
@@ -2610,6 +2627,7 @@ module Aws::Pinpoint
|
|
2610
2627
|
SimpleEmailPart.struct_class = Types::SimpleEmailPart
|
2611
2628
|
|
2612
2629
|
StartCondition.add_member(:description, Shapes::ShapeRef.new(shape: __string, location_name: "Description"))
|
2630
|
+
StartCondition.add_member(:event_start_condition, Shapes::ShapeRef.new(shape: EventStartCondition, location_name: "EventStartCondition"))
|
2613
2631
|
StartCondition.add_member(:segment_start_condition, Shapes::ShapeRef.new(shape: SegmentCondition, location_name: "SegmentStartCondition"))
|
2614
2632
|
StartCondition.struct_class = Types::StartCondition
|
2615
2633
|
|
@@ -4604,6 +4622,7 @@ module Aws::Pinpoint
|
|
4604
4622
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
4605
4623
|
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
4606
4624
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
4625
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
4607
4626
|
end)
|
4608
4627
|
|
4609
4628
|
api.add_operation(:update_journey_state, Seahorse::Model::Operation.new.tap do |o|
|
@@ -28,6 +28,7 @@ module Aws::Pinpoint
|
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
30
|
# * {BadRequestException}
|
31
|
+
# * {ConflictException}
|
31
32
|
# * {ForbiddenException}
|
32
33
|
# * {InternalServerErrorException}
|
33
34
|
# * {MethodNotAllowedException}
|
@@ -61,6 +62,26 @@ module Aws::Pinpoint
|
|
61
62
|
end
|
62
63
|
end
|
63
64
|
|
65
|
+
class ConflictException < ServiceError
|
66
|
+
|
67
|
+
# @param [Seahorse::Client::RequestContext] context
|
68
|
+
# @param [String] message
|
69
|
+
# @param [Aws::Pinpoint::Types::ConflictException] data
|
70
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
71
|
+
super(context, message, data)
|
72
|
+
end
|
73
|
+
|
74
|
+
# @return [String]
|
75
|
+
def message
|
76
|
+
@message || @data[:message]
|
77
|
+
end
|
78
|
+
|
79
|
+
# @return [String]
|
80
|
+
def request_id
|
81
|
+
@data[:request_id]
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
64
85
|
class ForbiddenException < ServiceError
|
65
86
|
|
66
87
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -1265,10 +1265,10 @@ module Aws::Pinpoint
|
|
1265
1265
|
# conditions: [
|
1266
1266
|
# {
|
1267
1267
|
# event_condition: {
|
1268
|
-
# dimensions: {
|
1268
|
+
# dimensions: {
|
1269
1269
|
# attributes: {
|
1270
1270
|
# "__string" => {
|
1271
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1271
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
1272
1272
|
# values: ["__string"], # required
|
1273
1273
|
# },
|
1274
1274
|
# },
|
@@ -1291,7 +1291,7 @@ module Aws::Pinpoint
|
|
1291
1291
|
# segment_dimensions: {
|
1292
1292
|
# attributes: {
|
1293
1293
|
# "__string" => {
|
1294
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1294
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
1295
1295
|
# values: ["__string"], # required
|
1296
1296
|
# },
|
1297
1297
|
# },
|
@@ -1348,7 +1348,7 @@ module Aws::Pinpoint
|
|
1348
1348
|
# },
|
1349
1349
|
# user_attributes: {
|
1350
1350
|
# "__string" => {
|
1351
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1351
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
1352
1352
|
# values: ["__string"], # required
|
1353
1353
|
# },
|
1354
1354
|
# },
|
@@ -1382,10 +1382,10 @@ module Aws::Pinpoint
|
|
1382
1382
|
# {
|
1383
1383
|
# condition: {
|
1384
1384
|
# event_condition: {
|
1385
|
-
# dimensions: {
|
1385
|
+
# dimensions: {
|
1386
1386
|
# attributes: {
|
1387
1387
|
# "__string" => {
|
1388
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1388
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
1389
1389
|
# values: ["__string"], # required
|
1390
1390
|
# },
|
1391
1391
|
# },
|
@@ -1408,7 +1408,7 @@ module Aws::Pinpoint
|
|
1408
1408
|
# segment_dimensions: {
|
1409
1409
|
# attributes: {
|
1410
1410
|
# "__string" => {
|
1411
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1411
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
1412
1412
|
# values: ["__string"], # required
|
1413
1413
|
# },
|
1414
1414
|
# },
|
@@ -1465,7 +1465,7 @@ module Aws::Pinpoint
|
|
1465
1465
|
# },
|
1466
1466
|
# user_attributes: {
|
1467
1467
|
# "__string" => {
|
1468
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1468
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
1469
1469
|
# values: ["__string"], # required
|
1470
1470
|
# },
|
1471
1471
|
# },
|
@@ -1499,6 +1499,7 @@ module Aws::Pinpoint
|
|
1499
1499
|
# sms: {
|
1500
1500
|
# message_config: {
|
1501
1501
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
1502
|
+
# origination_number: "__string",
|
1502
1503
|
# sender_id: "__string",
|
1503
1504
|
# },
|
1504
1505
|
# next_activity: "__string",
|
@@ -1949,14 +1950,13 @@ module Aws::Pinpoint
|
|
1949
1950
|
# @return [String]
|
1950
1951
|
#
|
1951
1952
|
# @!attribute [rw] limits
|
1952
|
-
# The default sending limits for campaigns
|
1953
|
-
# application.
|
1953
|
+
# The default sending limits for campaigns in the application.
|
1954
1954
|
# @return [Types::CampaignLimits]
|
1955
1955
|
#
|
1956
1956
|
# @!attribute [rw] quiet_time
|
1957
|
-
# The default quiet time for campaigns
|
1958
|
-
#
|
1959
|
-
#
|
1957
|
+
# The default quiet time for campaigns in the application. Quiet time
|
1958
|
+
# is a specific time range when messages aren't sent to endpoints, if
|
1959
|
+
# all the following conditions are met:
|
1960
1960
|
#
|
1961
1961
|
# * The EndpointDemographic.Timezone property of the endpoint is set
|
1962
1962
|
# to a valid value.
|
@@ -2016,15 +2016,26 @@ module Aws::Pinpoint
|
|
2016
2016
|
# data as a hash:
|
2017
2017
|
#
|
2018
2018
|
# {
|
2019
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2019
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
2020
2020
|
# values: ["__string"], # required
|
2021
2021
|
# }
|
2022
2022
|
#
|
2023
2023
|
# @!attribute [rw] attribute_type
|
2024
|
-
#
|
2025
|
-
#
|
2026
|
-
# EXCLUSIVE
|
2027
|
-
#
|
2024
|
+
# * INCLUSIVE - endpoints that have attributes matching the values are
|
2025
|
+
# included in the segment.
|
2026
|
+
# * EXCLUSIVE - endpoints that have attributes matching the values are
|
2027
|
+
# excluded in the segment.
|
2028
|
+
# * CONTAINS - endpoints that have attributes' substrings match the
|
2029
|
+
# values are included in the segment.
|
2030
|
+
# * BEFORE - endpoints with attributes read as ISO\_INSTANT datetimes
|
2031
|
+
# before the value are included in the segment.
|
2032
|
+
# * AFTER - endpoints with attributes read as ISO\_INSTANT datetimes
|
2033
|
+
# after the value are included in the segment.
|
2034
|
+
# * ON - endpoints with attributes read as ISO\_INSTANT dates on the
|
2035
|
+
# value are included in the segment. Time is ignored in this
|
2036
|
+
# comparison.
|
2037
|
+
# * BETWEEN - endpoints with attributes read as ISO\_INSTANT datetimes
|
2038
|
+
# between the values are included in the segment.
|
2028
2039
|
# @return [String]
|
2029
2040
|
#
|
2030
2041
|
# @!attribute [rw] values
|
@@ -2496,7 +2507,7 @@ module Aws::Pinpoint
|
|
2496
2507
|
# dimensions: { # required
|
2497
2508
|
# attributes: {
|
2498
2509
|
# "__string" => {
|
2499
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2510
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
2500
2511
|
# values: ["__string"], # required
|
2501
2512
|
# },
|
2502
2513
|
# },
|
@@ -2584,7 +2595,7 @@ module Aws::Pinpoint
|
|
2584
2595
|
|
2585
2596
|
# For a campaign, specifies limits on the messages that the campaign can
|
2586
2597
|
# send. For an application, specifies the default limits for messages
|
2587
|
-
# that campaigns
|
2598
|
+
# that campaigns in the application can send.
|
2588
2599
|
#
|
2589
2600
|
# @note When making an API call, you may pass CampaignLimits
|
2590
2601
|
# data as a hash:
|
@@ -2613,8 +2624,8 @@ module Aws::Pinpoint
|
|
2613
2624
|
# @!attribute [rw] messages_per_second
|
2614
2625
|
# The maximum number of messages that a campaign can send each second.
|
2615
2626
|
# For an application, this value specifies the default limit for the
|
2616
|
-
# number of messages that campaigns
|
2617
|
-
#
|
2627
|
+
# number of messages that campaigns can send each second. The minimum
|
2628
|
+
# value is 50. The maximum value is 20,000.
|
2618
2629
|
# @return [Integer]
|
2619
2630
|
#
|
2620
2631
|
# @!attribute [rw] total
|
@@ -2788,6 +2799,7 @@ module Aws::Pinpoint
|
|
2788
2799
|
# {
|
2789
2800
|
# body: "__string",
|
2790
2801
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
2802
|
+
# origination_number: "__string",
|
2791
2803
|
# sender_id: "__string",
|
2792
2804
|
# }
|
2793
2805
|
#
|
@@ -2802,6 +2814,14 @@ module Aws::Pinpoint
|
|
2802
2814
|
# time-sensitive, such as marketing messages).
|
2803
2815
|
# @return [String]
|
2804
2816
|
#
|
2817
|
+
# @!attribute [rw] origination_number
|
2818
|
+
# The long code to send the SMS message from. This value should be one
|
2819
|
+
# of the dedicated long codes that's assigned to your AWS account.
|
2820
|
+
# Although it isn't required, we recommend that you specify the long
|
2821
|
+
# code using an E.164 format to ensure prompt and accurate delivery of
|
2822
|
+
# the message. For example, +12065550100.
|
2823
|
+
# @return [String]
|
2824
|
+
#
|
2805
2825
|
# @!attribute [rw] sender_id
|
2806
2826
|
# The sender ID to display on recipients' devices when they receive
|
2807
2827
|
# the SMS message.
|
@@ -2812,6 +2832,7 @@ module Aws::Pinpoint
|
|
2812
2832
|
class CampaignSmsMessage < Struct.new(
|
2813
2833
|
:body,
|
2814
2834
|
:message_type,
|
2835
|
+
:origination_number,
|
2815
2836
|
:sender_id)
|
2816
2837
|
SENSITIVE = []
|
2817
2838
|
include Aws::Structure
|
@@ -2946,10 +2967,10 @@ module Aws::Pinpoint
|
|
2946
2967
|
# conditions: [
|
2947
2968
|
# {
|
2948
2969
|
# event_condition: {
|
2949
|
-
# dimensions: {
|
2970
|
+
# dimensions: {
|
2950
2971
|
# attributes: {
|
2951
2972
|
# "__string" => {
|
2952
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2973
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
2953
2974
|
# values: ["__string"], # required
|
2954
2975
|
# },
|
2955
2976
|
# },
|
@@ -2972,7 +2993,7 @@ module Aws::Pinpoint
|
|
2972
2993
|
# segment_dimensions: {
|
2973
2994
|
# attributes: {
|
2974
2995
|
# "__string" => {
|
2975
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2996
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
2976
2997
|
# values: ["__string"], # required
|
2977
2998
|
# },
|
2978
2999
|
# },
|
@@ -3029,7 +3050,7 @@ module Aws::Pinpoint
|
|
3029
3050
|
# },
|
3030
3051
|
# user_attributes: {
|
3031
3052
|
# "__string" => {
|
3032
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3053
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3033
3054
|
# values: ["__string"], # required
|
3034
3055
|
# },
|
3035
3056
|
# },
|
@@ -3063,6 +3084,19 @@ module Aws::Pinpoint
|
|
3063
3084
|
# type of activity sends participants down one of two paths in a
|
3064
3085
|
# journey, based on conditions that you specify.
|
3065
3086
|
#
|
3087
|
+
# <note markdown="1">To create yes/no split activities that send participants down
|
3088
|
+
# different paths based on push notification events (such as Open or
|
3089
|
+
# Received events), your mobile app has to specify the User ID and
|
3090
|
+
# Endpoint ID values. For more information, see [Integrating Amazon
|
3091
|
+
# Pinpoint with your application][1] in the *Amazon Pinpoint Developer
|
3092
|
+
# Guide*.
|
3093
|
+
#
|
3094
|
+
# </note>
|
3095
|
+
#
|
3096
|
+
#
|
3097
|
+
#
|
3098
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html
|
3099
|
+
#
|
3066
3100
|
# @note When making an API call, you may pass ConditionalSplitActivity
|
3067
3101
|
# data as a hash:
|
3068
3102
|
#
|
@@ -3071,10 +3105,10 @@ module Aws::Pinpoint
|
|
3071
3105
|
# conditions: [
|
3072
3106
|
# {
|
3073
3107
|
# event_condition: {
|
3074
|
-
# dimensions: {
|
3108
|
+
# dimensions: {
|
3075
3109
|
# attributes: {
|
3076
3110
|
# "__string" => {
|
3077
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3111
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3078
3112
|
# values: ["__string"], # required
|
3079
3113
|
# },
|
3080
3114
|
# },
|
@@ -3097,7 +3131,7 @@ module Aws::Pinpoint
|
|
3097
3131
|
# segment_dimensions: {
|
3098
3132
|
# attributes: {
|
3099
3133
|
# "__string" => {
|
3100
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3134
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3101
3135
|
# values: ["__string"], # required
|
3102
3136
|
# },
|
3103
3137
|
# },
|
@@ -3154,7 +3188,7 @@ module Aws::Pinpoint
|
|
3154
3188
|
# },
|
3155
3189
|
# user_attributes: {
|
3156
3190
|
# "__string" => {
|
3157
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3191
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3158
3192
|
# values: ["__string"], # required
|
3159
3193
|
# },
|
3160
3194
|
# },
|
@@ -3203,6 +3237,23 @@ module Aws::Pinpoint
|
|
3203
3237
|
include Aws::Structure
|
3204
3238
|
end
|
3205
3239
|
|
3240
|
+
# Provides information about an API request or response.
|
3241
|
+
#
|
3242
|
+
# @!attribute [rw] message
|
3243
|
+
# @return [String]
|
3244
|
+
#
|
3245
|
+
# @!attribute [rw] request_id
|
3246
|
+
# @return [String]
|
3247
|
+
#
|
3248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ConflictException AWS API Documentation
|
3249
|
+
#
|
3250
|
+
class ConflictException < Struct.new(
|
3251
|
+
:message,
|
3252
|
+
:request_id)
|
3253
|
+
SENSITIVE = []
|
3254
|
+
include Aws::Structure
|
3255
|
+
end
|
3256
|
+
|
3206
3257
|
# @note When making an API call, you may pass CreateAppRequest
|
3207
3258
|
# data as a hash:
|
3208
3259
|
#
|
@@ -3368,6 +3419,7 @@ module Aws::Pinpoint
|
|
3368
3419
|
# sms_message: {
|
3369
3420
|
# body: "__string",
|
3370
3421
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3422
|
+
# origination_number: "__string",
|
3371
3423
|
# sender_id: "__string",
|
3372
3424
|
# },
|
3373
3425
|
# },
|
@@ -3377,7 +3429,7 @@ module Aws::Pinpoint
|
|
3377
3429
|
# dimensions: { # required
|
3378
3430
|
# attributes: {
|
3379
3431
|
# "__string" => {
|
3380
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3432
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3381
3433
|
# values: ["__string"], # required
|
3382
3434
|
# },
|
3383
3435
|
# },
|
@@ -3527,6 +3579,7 @@ module Aws::Pinpoint
|
|
3527
3579
|
# sms_message: {
|
3528
3580
|
# body: "__string",
|
3529
3581
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
3582
|
+
# origination_number: "__string",
|
3530
3583
|
# sender_id: "__string",
|
3531
3584
|
# },
|
3532
3585
|
# },
|
@@ -3537,7 +3590,7 @@ module Aws::Pinpoint
|
|
3537
3590
|
# dimensions: { # required
|
3538
3591
|
# attributes: {
|
3539
3592
|
# "__string" => {
|
3540
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3593
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3541
3594
|
# values: ["__string"], # required
|
3542
3595
|
# },
|
3543
3596
|
# },
|
@@ -3786,10 +3839,10 @@ module Aws::Pinpoint
|
|
3786
3839
|
# conditions: [
|
3787
3840
|
# {
|
3788
3841
|
# event_condition: {
|
3789
|
-
# dimensions: {
|
3842
|
+
# dimensions: {
|
3790
3843
|
# attributes: {
|
3791
3844
|
# "__string" => {
|
3792
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3845
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3793
3846
|
# values: ["__string"], # required
|
3794
3847
|
# },
|
3795
3848
|
# },
|
@@ -3812,7 +3865,7 @@ module Aws::Pinpoint
|
|
3812
3865
|
# segment_dimensions: {
|
3813
3866
|
# attributes: {
|
3814
3867
|
# "__string" => {
|
3815
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3868
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3816
3869
|
# values: ["__string"], # required
|
3817
3870
|
# },
|
3818
3871
|
# },
|
@@ -3869,7 +3922,7 @@ module Aws::Pinpoint
|
|
3869
3922
|
# },
|
3870
3923
|
# user_attributes: {
|
3871
3924
|
# "__string" => {
|
3872
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3925
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3873
3926
|
# values: ["__string"], # required
|
3874
3927
|
# },
|
3875
3928
|
# },
|
@@ -3903,10 +3956,10 @@ module Aws::Pinpoint
|
|
3903
3956
|
# {
|
3904
3957
|
# condition: {
|
3905
3958
|
# event_condition: {
|
3906
|
-
# dimensions: {
|
3959
|
+
# dimensions: {
|
3907
3960
|
# attributes: {
|
3908
3961
|
# "__string" => {
|
3909
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3962
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3910
3963
|
# values: ["__string"], # required
|
3911
3964
|
# },
|
3912
3965
|
# },
|
@@ -3929,7 +3982,7 @@ module Aws::Pinpoint
|
|
3929
3982
|
# segment_dimensions: {
|
3930
3983
|
# attributes: {
|
3931
3984
|
# "__string" => {
|
3932
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3985
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3933
3986
|
# values: ["__string"], # required
|
3934
3987
|
# },
|
3935
3988
|
# },
|
@@ -3986,7 +4039,7 @@ module Aws::Pinpoint
|
|
3986
4039
|
# },
|
3987
4040
|
# user_attributes: {
|
3988
4041
|
# "__string" => {
|
3989
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4042
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
3990
4043
|
# values: ["__string"], # required
|
3991
4044
|
# },
|
3992
4045
|
# },
|
@@ -4020,6 +4073,7 @@ module Aws::Pinpoint
|
|
4020
4073
|
# sms: {
|
4021
4074
|
# message_config: {
|
4022
4075
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
4076
|
+
# origination_number: "__string",
|
4023
4077
|
# sender_id: "__string",
|
4024
4078
|
# },
|
4025
4079
|
# next_activity: "__string",
|
@@ -4057,6 +4111,30 @@ module Aws::Pinpoint
|
|
4057
4111
|
# start_activity: "__string",
|
4058
4112
|
# start_condition: {
|
4059
4113
|
# description: "__string",
|
4114
|
+
# event_start_condition: {
|
4115
|
+
# event_filter: {
|
4116
|
+
# dimensions: { # required
|
4117
|
+
# attributes: {
|
4118
|
+
# "__string" => {
|
4119
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
4120
|
+
# values: ["__string"], # required
|
4121
|
+
# },
|
4122
|
+
# },
|
4123
|
+
# event_type: {
|
4124
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4125
|
+
# values: ["__string"], # required
|
4126
|
+
# },
|
4127
|
+
# metrics: {
|
4128
|
+
# "__string" => {
|
4129
|
+
# comparison_operator: "__string", # required
|
4130
|
+
# value: 1.0, # required
|
4131
|
+
# },
|
4132
|
+
# },
|
4133
|
+
# },
|
4134
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
4135
|
+
# },
|
4136
|
+
# segment_id: "__string",
|
4137
|
+
# },
|
4060
4138
|
# segment_start_condition: {
|
4061
4139
|
# segment_id: "__string", # required
|
4062
4140
|
# },
|
@@ -4387,7 +4465,7 @@ module Aws::Pinpoint
|
|
4387
4465
|
# dimensions: {
|
4388
4466
|
# attributes: {
|
4389
4467
|
# "__string" => {
|
4390
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4468
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
4391
4469
|
# values: ["__string"], # required
|
4392
4470
|
# },
|
4393
4471
|
# },
|
@@ -4444,7 +4522,7 @@ module Aws::Pinpoint
|
|
4444
4522
|
# },
|
4445
4523
|
# user_attributes: {
|
4446
4524
|
# "__string" => {
|
4447
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4525
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
4448
4526
|
# values: ["__string"], # required
|
4449
4527
|
# },
|
4450
4528
|
# },
|
@@ -4457,7 +4535,7 @@ module Aws::Pinpoint
|
|
4457
4535
|
# {
|
4458
4536
|
# attributes: {
|
4459
4537
|
# "__string" => {
|
4460
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4538
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
4461
4539
|
# values: ["__string"], # required
|
4462
4540
|
# },
|
4463
4541
|
# },
|
@@ -4514,7 +4592,7 @@ module Aws::Pinpoint
|
|
4514
4592
|
# },
|
4515
4593
|
# user_attributes: {
|
4516
4594
|
# "__string" => {
|
4517
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
4595
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
4518
4596
|
# values: ["__string"], # required
|
4519
4597
|
# },
|
4520
4598
|
# },
|
@@ -4746,11 +4824,11 @@ module Aws::Pinpoint
|
|
4746
4824
|
# }
|
4747
4825
|
#
|
4748
4826
|
# @!attribute [rw] delivery_uri
|
4749
|
-
# The destination to send the
|
4750
|
-
# of the following:
|
4827
|
+
# The destination to send the campaign or treatment to. This value can
|
4828
|
+
# be one of the following:
|
4751
4829
|
#
|
4752
4830
|
# * The name or Amazon Resource Name (ARN) of an AWS Lambda function
|
4753
|
-
# to invoke to handle delivery of the
|
4831
|
+
# to invoke to handle delivery of the campaign or treatment.
|
4754
4832
|
#
|
4755
4833
|
# * The URL for a web application or service that supports HTTPS and
|
4756
4834
|
# can receive the message. The URL has to be a full URL, including
|
@@ -7323,10 +7401,10 @@ module Aws::Pinpoint
|
|
7323
7401
|
# data as a hash:
|
7324
7402
|
#
|
7325
7403
|
# {
|
7326
|
-
# dimensions: {
|
7404
|
+
# dimensions: {
|
7327
7405
|
# attributes: {
|
7328
7406
|
# "__string" => {
|
7329
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
7407
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
7330
7408
|
# values: ["__string"], # required
|
7331
7409
|
# },
|
7332
7410
|
# },
|
@@ -7371,7 +7449,7 @@ module Aws::Pinpoint
|
|
7371
7449
|
# {
|
7372
7450
|
# attributes: {
|
7373
7451
|
# "__string" => {
|
7374
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
7452
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
7375
7453
|
# values: ["__string"], # required
|
7376
7454
|
# },
|
7377
7455
|
# },
|
@@ -7422,6 +7500,58 @@ module Aws::Pinpoint
|
|
7422
7500
|
include Aws::Structure
|
7423
7501
|
end
|
7424
7502
|
|
7503
|
+
# Specifies the settings for an event that causes a campaign to be sent
|
7504
|
+
# or a journey activity to be performed.
|
7505
|
+
#
|
7506
|
+
# @note When making an API call, you may pass EventFilter
|
7507
|
+
# data as a hash:
|
7508
|
+
#
|
7509
|
+
# {
|
7510
|
+
# dimensions: { # required
|
7511
|
+
# attributes: {
|
7512
|
+
# "__string" => {
|
7513
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
7514
|
+
# values: ["__string"], # required
|
7515
|
+
# },
|
7516
|
+
# },
|
7517
|
+
# event_type: {
|
7518
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
7519
|
+
# values: ["__string"], # required
|
7520
|
+
# },
|
7521
|
+
# metrics: {
|
7522
|
+
# "__string" => {
|
7523
|
+
# comparison_operator: "__string", # required
|
7524
|
+
# value: 1.0, # required
|
7525
|
+
# },
|
7526
|
+
# },
|
7527
|
+
# },
|
7528
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
7529
|
+
# }
|
7530
|
+
#
|
7531
|
+
# @!attribute [rw] dimensions
|
7532
|
+
# The dimensions for the event filter to use for the campaign or the
|
7533
|
+
# journey activity.
|
7534
|
+
# @return [Types::EventDimensions]
|
7535
|
+
#
|
7536
|
+
# @!attribute [rw] filter_type
|
7537
|
+
# The type of event that causes the campaign to be sent or the journey
|
7538
|
+
# activity to be performed. Valid values are: SYSTEM, sends the
|
7539
|
+
# campaign or performs the activity when a system event occurs; and,
|
7540
|
+
# ENDPOINT, sends the campaign or performs the activity when an
|
7541
|
+
# endpoint event (<link linkend="apps-application-id-events" />
|
7542
|
+
#
|
7543
|
+
# Events resource</link>) occurs.
|
7544
|
+
# @return [String]
|
7545
|
+
#
|
7546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventFilter AWS API Documentation
|
7547
|
+
#
|
7548
|
+
class EventFilter < Struct.new(
|
7549
|
+
:dimensions,
|
7550
|
+
:filter_type)
|
7551
|
+
SENSITIVE = []
|
7552
|
+
include Aws::Structure
|
7553
|
+
end
|
7554
|
+
|
7425
7555
|
# Provides the status code and message that result from processing an
|
7426
7556
|
# event.
|
7427
7557
|
#
|
@@ -7445,6 +7575,54 @@ module Aws::Pinpoint
|
|
7445
7575
|
include Aws::Structure
|
7446
7576
|
end
|
7447
7577
|
|
7578
|
+
# Specifies the settings for an event that causes a journey activity to
|
7579
|
+
# start.
|
7580
|
+
#
|
7581
|
+
# @note When making an API call, you may pass EventStartCondition
|
7582
|
+
# data as a hash:
|
7583
|
+
#
|
7584
|
+
# {
|
7585
|
+
# event_filter: {
|
7586
|
+
# dimensions: { # required
|
7587
|
+
# attributes: {
|
7588
|
+
# "__string" => {
|
7589
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
7590
|
+
# values: ["__string"], # required
|
7591
|
+
# },
|
7592
|
+
# },
|
7593
|
+
# event_type: {
|
7594
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
7595
|
+
# values: ["__string"], # required
|
7596
|
+
# },
|
7597
|
+
# metrics: {
|
7598
|
+
# "__string" => {
|
7599
|
+
# comparison_operator: "__string", # required
|
7600
|
+
# value: 1.0, # required
|
7601
|
+
# },
|
7602
|
+
# },
|
7603
|
+
# },
|
7604
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
7605
|
+
# },
|
7606
|
+
# segment_id: "__string",
|
7607
|
+
# }
|
7608
|
+
#
|
7609
|
+
# @!attribute [rw] event_filter
|
7610
|
+
# Specifies the settings for an event that causes a campaign to be
|
7611
|
+
# sent or a journey activity to be performed.
|
7612
|
+
# @return [Types::EventFilter]
|
7613
|
+
#
|
7614
|
+
# @!attribute [rw] segment_id
|
7615
|
+
# @return [String]
|
7616
|
+
#
|
7617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventStartCondition AWS API Documentation
|
7618
|
+
#
|
7619
|
+
class EventStartCondition < Struct.new(
|
7620
|
+
:event_filter,
|
7621
|
+
:segment_id)
|
7622
|
+
SENSITIVE = []
|
7623
|
+
include Aws::Structure
|
7624
|
+
end
|
7625
|
+
|
7448
7626
|
# Specifies settings for publishing event data to an Amazon Kinesis data
|
7449
7627
|
# stream or an Amazon Kinesis Data Firehose delivery stream.
|
7450
7628
|
#
|
@@ -10534,7 +10712,7 @@ module Aws::Pinpoint
|
|
10534
10712
|
#
|
10535
10713
|
#
|
10536
10714
|
#
|
10537
|
-
# [1]: https://docs.aws.amazon.com
|
10715
|
+
# [1]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html
|
10538
10716
|
# @return [Hash<String,String>]
|
10539
10717
|
#
|
10540
10718
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionMetricsResponse AWS API Documentation
|
@@ -10760,6 +10938,7 @@ module Aws::Pinpoint
|
|
10760
10938
|
#
|
10761
10939
|
# {
|
10762
10940
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
10941
|
+
# origination_number: "__string",
|
10763
10942
|
# sender_id: "__string",
|
10764
10943
|
# }
|
10765
10944
|
#
|
@@ -10770,6 +10949,14 @@ module Aws::Pinpoint
|
|
10770
10949
|
# time-sensitive, such as marketing messages).
|
10771
10950
|
# @return [String]
|
10772
10951
|
#
|
10952
|
+
# @!attribute [rw] origination_number
|
10953
|
+
# The long code to send the SMS message from. This value should be one
|
10954
|
+
# of the dedicated long codes that's assigned to your AWS account.
|
10955
|
+
# Although it isn't required, we recommend that you specify the long
|
10956
|
+
# code using an E.164 format to ensure prompt and accurate delivery of
|
10957
|
+
# the message. For example, +12065550100.
|
10958
|
+
# @return [String]
|
10959
|
+
#
|
10773
10960
|
# @!attribute [rw] sender_id
|
10774
10961
|
# The sender ID to display as the sender of the message on a
|
10775
10962
|
# recipient's device. Support for sender IDs varies by country or
|
@@ -10778,13 +10965,14 @@ module Aws::Pinpoint
|
|
10778
10965
|
#
|
10779
10966
|
#
|
10780
10967
|
#
|
10781
|
-
# [1]: https://docs.aws.amazon.com
|
10968
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html
|
10782
10969
|
# @return [String]
|
10783
10970
|
#
|
10784
10971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneySMSMessage AWS API Documentation
|
10785
10972
|
#
|
10786
10973
|
class JourneySMSMessage < Struct.new(
|
10787
10974
|
:message_type,
|
10975
|
+
:origination_number,
|
10788
10976
|
:sender_id)
|
10789
10977
|
SENSITIVE = []
|
10790
10978
|
include Aws::Structure
|
@@ -11303,6 +11491,7 @@ module Aws::Pinpoint
|
|
11303
11491
|
# sms_message: {
|
11304
11492
|
# body: "__string",
|
11305
11493
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
11494
|
+
# origination_number: "__string",
|
11306
11495
|
# sender_id: "__string",
|
11307
11496
|
# },
|
11308
11497
|
# }
|
@@ -11585,11 +11774,15 @@ module Aws::Pinpoint
|
|
11585
11774
|
#
|
11586
11775
|
# @!attribute [rw] addresses
|
11587
11776
|
# A map of key-value pairs, where each key is an address and each
|
11588
|
-
# value is an AddressConfiguration object. An address can be a
|
11589
|
-
# notification token, a phone number, or an email address. You
|
11590
|
-
# an AddressConfiguration object to tailor the message
|
11591
|
-
# by specifying settings such as content overrides and
|
11592
|
-
# variables.
|
11777
|
+
# value is an [AddressConfiguration][1] object. An address can be a
|
11778
|
+
# push notification token, a phone number, or an email address. You
|
11779
|
+
# can use an [AddressConfiguration][1] object to tailor the message
|
11780
|
+
# for an address by specifying settings such as content overrides and
|
11781
|
+
# message variables.
|
11782
|
+
#
|
11783
|
+
#
|
11784
|
+
#
|
11785
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration
|
11593
11786
|
# @return [Hash<String,Types::AddressConfiguration>]
|
11594
11787
|
#
|
11595
11788
|
# @!attribute [rw] context
|
@@ -11601,10 +11794,14 @@ module Aws::Pinpoint
|
|
11601
11794
|
#
|
11602
11795
|
# @!attribute [rw] endpoints
|
11603
11796
|
# A map of key-value pairs, where each key is an endpoint ID and each
|
11604
|
-
# value is an EndpointSendConfiguration object. You can use an
|
11605
|
-
# EndpointSendConfiguration object to tailor the message for an
|
11797
|
+
# value is an [EndpointSendConfiguration][1] object. You can use an
|
11798
|
+
# [EndpointSendConfiguration][1] object to tailor the message for an
|
11606
11799
|
# endpoint by specifying settings such as content overrides and
|
11607
11800
|
# message variables.
|
11801
|
+
#
|
11802
|
+
#
|
11803
|
+
#
|
11804
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration
|
11608
11805
|
# @return [Hash<String,Types::EndpointSendConfiguration>]
|
11609
11806
|
#
|
11610
11807
|
# @!attribute [rw] message_configuration
|
@@ -11789,10 +11986,10 @@ module Aws::Pinpoint
|
|
11789
11986
|
# {
|
11790
11987
|
# condition: {
|
11791
11988
|
# event_condition: {
|
11792
|
-
# dimensions: {
|
11989
|
+
# dimensions: {
|
11793
11990
|
# attributes: {
|
11794
11991
|
# "__string" => {
|
11795
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
11992
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
11796
11993
|
# values: ["__string"], # required
|
11797
11994
|
# },
|
11798
11995
|
# },
|
@@ -11815,7 +12012,7 @@ module Aws::Pinpoint
|
|
11815
12012
|
# segment_dimensions: {
|
11816
12013
|
# attributes: {
|
11817
12014
|
# "__string" => {
|
11818
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
12015
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
11819
12016
|
# values: ["__string"], # required
|
11820
12017
|
# },
|
11821
12018
|
# },
|
@@ -11872,7 +12069,7 @@ module Aws::Pinpoint
|
|
11872
12069
|
# },
|
11873
12070
|
# user_attributes: {
|
11874
12071
|
# "__string" => {
|
11875
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
12072
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
11876
12073
|
# values: ["__string"], # required
|
11877
12074
|
# },
|
11878
12075
|
# },
|
@@ -11904,6 +12101,19 @@ module Aws::Pinpoint
|
|
11904
12101
|
# paths (including a default *Else* path) in a journey, based on
|
11905
12102
|
# conditions that you specify.
|
11906
12103
|
#
|
12104
|
+
# <note markdown="1">To create multivariate split activities that send participants down
|
12105
|
+
# different paths based on push notification events (such as Open or
|
12106
|
+
# Received events), your mobile app has to specify the User ID and
|
12107
|
+
# Endpoint ID values. For more information, see [Integrating Amazon
|
12108
|
+
# Pinpoint with your application][1] in the *Amazon Pinpoint Developer
|
12109
|
+
# Guide*.
|
12110
|
+
#
|
12111
|
+
# </note>
|
12112
|
+
#
|
12113
|
+
#
|
12114
|
+
#
|
12115
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html
|
12116
|
+
#
|
11907
12117
|
# @note When making an API call, you may pass MultiConditionalSplitActivity
|
11908
12118
|
# data as a hash:
|
11909
12119
|
#
|
@@ -11912,10 +12122,10 @@ module Aws::Pinpoint
|
|
11912
12122
|
# {
|
11913
12123
|
# condition: {
|
11914
12124
|
# event_condition: {
|
11915
|
-
# dimensions: {
|
12125
|
+
# dimensions: {
|
11916
12126
|
# attributes: {
|
11917
12127
|
# "__string" => {
|
11918
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
12128
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
11919
12129
|
# values: ["__string"], # required
|
11920
12130
|
# },
|
11921
12131
|
# },
|
@@ -11938,7 +12148,7 @@ module Aws::Pinpoint
|
|
11938
12148
|
# segment_dimensions: {
|
11939
12149
|
# attributes: {
|
11940
12150
|
# "__string" => {
|
11941
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
12151
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
11942
12152
|
# values: ["__string"], # required
|
11943
12153
|
# },
|
11944
12154
|
# },
|
@@ -11995,7 +12205,7 @@ module Aws::Pinpoint
|
|
11995
12205
|
# },
|
11996
12206
|
# user_attributes: {
|
11997
12207
|
# "__string" => {
|
11998
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
12208
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
11999
12209
|
# values: ["__string"], # required
|
12000
12210
|
# },
|
12001
12211
|
# },
|
@@ -13336,8 +13546,7 @@ module Aws::Pinpoint
|
|
13336
13546
|
# @return [String]
|
13337
13547
|
#
|
13338
13548
|
# @!attribute [rw] media_url
|
13339
|
-
#
|
13340
|
-
# field is reserved for future use.
|
13549
|
+
# This field is reserved for future use.
|
13341
13550
|
# @return [String]
|
13342
13551
|
#
|
13343
13552
|
# @!attribute [rw] message_type
|
@@ -13389,6 +13598,7 @@ module Aws::Pinpoint
|
|
13389
13598
|
# {
|
13390
13599
|
# message_config: {
|
13391
13600
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
13601
|
+
# origination_number: "__string",
|
13392
13602
|
# sender_id: "__string",
|
13393
13603
|
# },
|
13394
13604
|
# next_activity: "__string",
|
@@ -13589,7 +13799,7 @@ module Aws::Pinpoint
|
|
13589
13799
|
# dimensions: { # required
|
13590
13800
|
# attributes: {
|
13591
13801
|
# "__string" => {
|
13592
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13802
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
13593
13803
|
# values: ["__string"], # required
|
13594
13804
|
# },
|
13595
13805
|
# },
|
@@ -13814,7 +14024,7 @@ module Aws::Pinpoint
|
|
13814
14024
|
# {
|
13815
14025
|
# attributes: {
|
13816
14026
|
# "__string" => {
|
13817
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14027
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
13818
14028
|
# values: ["__string"], # required
|
13819
14029
|
# },
|
13820
14030
|
# },
|
@@ -13871,7 +14081,7 @@ module Aws::Pinpoint
|
|
13871
14081
|
# },
|
13872
14082
|
# user_attributes: {
|
13873
14083
|
# "__string" => {
|
13874
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14084
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
13875
14085
|
# values: ["__string"], # required
|
13876
14086
|
# },
|
13877
14087
|
# },
|
@@ -13929,7 +14139,7 @@ module Aws::Pinpoint
|
|
13929
14139
|
# {
|
13930
14140
|
# attributes: {
|
13931
14141
|
# "__string" => {
|
13932
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14142
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
13933
14143
|
# values: ["__string"], # required
|
13934
14144
|
# },
|
13935
14145
|
# },
|
@@ -13986,7 +14196,7 @@ module Aws::Pinpoint
|
|
13986
14196
|
# },
|
13987
14197
|
# user_attributes: {
|
13988
14198
|
# "__string" => {
|
13989
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14199
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
13990
14200
|
# values: ["__string"], # required
|
13991
14201
|
# },
|
13992
14202
|
# },
|
@@ -14057,7 +14267,7 @@ module Aws::Pinpoint
|
|
14057
14267
|
# {
|
14058
14268
|
# attributes: {
|
14059
14269
|
# "__string" => {
|
14060
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14270
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
14061
14271
|
# values: ["__string"], # required
|
14062
14272
|
# },
|
14063
14273
|
# },
|
@@ -14114,7 +14324,7 @@ module Aws::Pinpoint
|
|
14114
14324
|
# },
|
14115
14325
|
# user_attributes: {
|
14116
14326
|
# "__string" => {
|
14117
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14327
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
14118
14328
|
# values: ["__string"], # required
|
14119
14329
|
# },
|
14120
14330
|
# },
|
@@ -14845,10 +15055,14 @@ module Aws::Pinpoint
|
|
14845
15055
|
# @return [String]
|
14846
15056
|
#
|
14847
15057
|
# @!attribute [rw] users
|
14848
|
-
# A map that associates user IDs with EndpointSendConfiguration
|
14849
|
-
# objects. You can use an EndpointSendConfiguration object to
|
14850
|
-
# the message for a user by specifying settings such as content
|
15058
|
+
# A map that associates user IDs with [EndpointSendConfiguration][1]
|
15059
|
+
# objects. You can use an [EndpointSendConfiguration][1] object to
|
15060
|
+
# tailor the message for a user by specifying settings such as content
|
14851
15061
|
# overrides and message variables.
|
15062
|
+
#
|
15063
|
+
#
|
15064
|
+
#
|
15065
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration
|
14852
15066
|
# @return [Hash<String,Types::EndpointSendConfiguration>]
|
14853
15067
|
#
|
14854
15068
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessageRequest AWS API Documentation
|
@@ -15200,10 +15414,10 @@ module Aws::Pinpoint
|
|
15200
15414
|
#
|
15201
15415
|
# {
|
15202
15416
|
# event_condition: {
|
15203
|
-
# dimensions: {
|
15417
|
+
# dimensions: {
|
15204
15418
|
# attributes: {
|
15205
15419
|
# "__string" => {
|
15206
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15420
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
15207
15421
|
# values: ["__string"], # required
|
15208
15422
|
# },
|
15209
15423
|
# },
|
@@ -15226,7 +15440,7 @@ module Aws::Pinpoint
|
|
15226
15440
|
# segment_dimensions: {
|
15227
15441
|
# attributes: {
|
15228
15442
|
# "__string" => {
|
15229
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15443
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
15230
15444
|
# values: ["__string"], # required
|
15231
15445
|
# },
|
15232
15446
|
# },
|
@@ -15283,7 +15497,7 @@ module Aws::Pinpoint
|
|
15283
15497
|
# },
|
15284
15498
|
# user_attributes: {
|
15285
15499
|
# "__string" => {
|
15286
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15500
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
15287
15501
|
# values: ["__string"], # required
|
15288
15502
|
# },
|
15289
15503
|
# },
|
@@ -15399,6 +15613,30 @@ module Aws::Pinpoint
|
|
15399
15613
|
#
|
15400
15614
|
# {
|
15401
15615
|
# description: "__string",
|
15616
|
+
# event_start_condition: {
|
15617
|
+
# event_filter: {
|
15618
|
+
# dimensions: { # required
|
15619
|
+
# attributes: {
|
15620
|
+
# "__string" => {
|
15621
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
15622
|
+
# values: ["__string"], # required
|
15623
|
+
# },
|
15624
|
+
# },
|
15625
|
+
# event_type: {
|
15626
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15627
|
+
# values: ["__string"], # required
|
15628
|
+
# },
|
15629
|
+
# metrics: {
|
15630
|
+
# "__string" => {
|
15631
|
+
# comparison_operator: "__string", # required
|
15632
|
+
# value: 1.0, # required
|
15633
|
+
# },
|
15634
|
+
# },
|
15635
|
+
# },
|
15636
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
15637
|
+
# },
|
15638
|
+
# segment_id: "__string",
|
15639
|
+
# },
|
15402
15640
|
# segment_start_condition: {
|
15403
15641
|
# segment_id: "__string", # required
|
15404
15642
|
# },
|
@@ -15408,6 +15646,11 @@ module Aws::Pinpoint
|
|
15408
15646
|
# The custom description of the condition.
|
15409
15647
|
# @return [String]
|
15410
15648
|
#
|
15649
|
+
# @!attribute [rw] event_start_condition
|
15650
|
+
# Specifies the settings for an event that causes a journey activity
|
15651
|
+
# to start.
|
15652
|
+
# @return [Types::EventStartCondition]
|
15653
|
+
#
|
15411
15654
|
# @!attribute [rw] segment_start_condition
|
15412
15655
|
# The segment that's associated with the first activity in the
|
15413
15656
|
# journey. This segment determines which users are participants in the
|
@@ -15418,6 +15661,7 @@ module Aws::Pinpoint
|
|
15418
15661
|
#
|
15419
15662
|
class StartCondition < Struct.new(
|
15420
15663
|
:description,
|
15664
|
+
:event_start_condition,
|
15421
15665
|
:segment_start_condition)
|
15422
15666
|
SENSITIVE = []
|
15423
15667
|
include Aws::Structure
|
@@ -16343,6 +16587,7 @@ module Aws::Pinpoint
|
|
16343
16587
|
# sms_message: {
|
16344
16588
|
# body: "__string",
|
16345
16589
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
16590
|
+
# origination_number: "__string",
|
16346
16591
|
# sender_id: "__string",
|
16347
16592
|
# },
|
16348
16593
|
# },
|
@@ -16352,7 +16597,7 @@ module Aws::Pinpoint
|
|
16352
16597
|
# dimensions: { # required
|
16353
16598
|
# attributes: {
|
16354
16599
|
# "__string" => {
|
16355
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16600
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
16356
16601
|
# values: ["__string"], # required
|
16357
16602
|
# },
|
16358
16603
|
# },
|
@@ -16502,6 +16747,7 @@ module Aws::Pinpoint
|
|
16502
16747
|
# sms_message: {
|
16503
16748
|
# body: "__string",
|
16504
16749
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
16750
|
+
# origination_number: "__string",
|
16505
16751
|
# sender_id: "__string",
|
16506
16752
|
# },
|
16507
16753
|
# },
|
@@ -16512,7 +16758,7 @@ module Aws::Pinpoint
|
|
16512
16758
|
# dimensions: { # required
|
16513
16759
|
# attributes: {
|
16514
16760
|
# "__string" => {
|
16515
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16761
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
16516
16762
|
# values: ["__string"], # required
|
16517
16763
|
# },
|
16518
16764
|
# },
|
@@ -16926,10 +17172,10 @@ module Aws::Pinpoint
|
|
16926
17172
|
# conditions: [
|
16927
17173
|
# {
|
16928
17174
|
# event_condition: {
|
16929
|
-
# dimensions: {
|
17175
|
+
# dimensions: {
|
16930
17176
|
# attributes: {
|
16931
17177
|
# "__string" => {
|
16932
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17178
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
16933
17179
|
# values: ["__string"], # required
|
16934
17180
|
# },
|
16935
17181
|
# },
|
@@ -16952,7 +17198,7 @@ module Aws::Pinpoint
|
|
16952
17198
|
# segment_dimensions: {
|
16953
17199
|
# attributes: {
|
16954
17200
|
# "__string" => {
|
16955
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17201
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
16956
17202
|
# values: ["__string"], # required
|
16957
17203
|
# },
|
16958
17204
|
# },
|
@@ -17009,7 +17255,7 @@ module Aws::Pinpoint
|
|
17009
17255
|
# },
|
17010
17256
|
# user_attributes: {
|
17011
17257
|
# "__string" => {
|
17012
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17258
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17013
17259
|
# values: ["__string"], # required
|
17014
17260
|
# },
|
17015
17261
|
# },
|
@@ -17043,10 +17289,10 @@ module Aws::Pinpoint
|
|
17043
17289
|
# {
|
17044
17290
|
# condition: {
|
17045
17291
|
# event_condition: {
|
17046
|
-
# dimensions: {
|
17292
|
+
# dimensions: {
|
17047
17293
|
# attributes: {
|
17048
17294
|
# "__string" => {
|
17049
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17295
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17050
17296
|
# values: ["__string"], # required
|
17051
17297
|
# },
|
17052
17298
|
# },
|
@@ -17069,7 +17315,7 @@ module Aws::Pinpoint
|
|
17069
17315
|
# segment_dimensions: {
|
17070
17316
|
# attributes: {
|
17071
17317
|
# "__string" => {
|
17072
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17318
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17073
17319
|
# values: ["__string"], # required
|
17074
17320
|
# },
|
17075
17321
|
# },
|
@@ -17126,7 +17372,7 @@ module Aws::Pinpoint
|
|
17126
17372
|
# },
|
17127
17373
|
# user_attributes: {
|
17128
17374
|
# "__string" => {
|
17129
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17375
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17130
17376
|
# values: ["__string"], # required
|
17131
17377
|
# },
|
17132
17378
|
# },
|
@@ -17160,6 +17406,7 @@ module Aws::Pinpoint
|
|
17160
17406
|
# sms: {
|
17161
17407
|
# message_config: {
|
17162
17408
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
17409
|
+
# origination_number: "__string",
|
17163
17410
|
# sender_id: "__string",
|
17164
17411
|
# },
|
17165
17412
|
# next_activity: "__string",
|
@@ -17197,6 +17444,30 @@ module Aws::Pinpoint
|
|
17197
17444
|
# start_activity: "__string",
|
17198
17445
|
# start_condition: {
|
17199
17446
|
# description: "__string",
|
17447
|
+
# event_start_condition: {
|
17448
|
+
# event_filter: {
|
17449
|
+
# dimensions: { # required
|
17450
|
+
# attributes: {
|
17451
|
+
# "__string" => {
|
17452
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17453
|
+
# values: ["__string"], # required
|
17454
|
+
# },
|
17455
|
+
# },
|
17456
|
+
# event_type: {
|
17457
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17458
|
+
# values: ["__string"], # required
|
17459
|
+
# },
|
17460
|
+
# metrics: {
|
17461
|
+
# "__string" => {
|
17462
|
+
# comparison_operator: "__string", # required
|
17463
|
+
# value: 1.0, # required
|
17464
|
+
# },
|
17465
|
+
# },
|
17466
|
+
# },
|
17467
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
17468
|
+
# },
|
17469
|
+
# segment_id: "__string",
|
17470
|
+
# },
|
17200
17471
|
# segment_start_condition: {
|
17201
17472
|
# segment_id: "__string", # required
|
17202
17473
|
# },
|
@@ -17591,7 +17862,7 @@ module Aws::Pinpoint
|
|
17591
17862
|
# dimensions: {
|
17592
17863
|
# attributes: {
|
17593
17864
|
# "__string" => {
|
17594
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17865
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17595
17866
|
# values: ["__string"], # required
|
17596
17867
|
# },
|
17597
17868
|
# },
|
@@ -17648,7 +17919,7 @@ module Aws::Pinpoint
|
|
17648
17919
|
# },
|
17649
17920
|
# user_attributes: {
|
17650
17921
|
# "__string" => {
|
17651
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17922
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17652
17923
|
# values: ["__string"], # required
|
17653
17924
|
# },
|
17654
17925
|
# },
|
@@ -17661,7 +17932,7 @@ module Aws::Pinpoint
|
|
17661
17932
|
# {
|
17662
17933
|
# attributes: {
|
17663
17934
|
# "__string" => {
|
17664
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17935
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17665
17936
|
# values: ["__string"], # required
|
17666
17937
|
# },
|
17667
17938
|
# },
|
@@ -17718,7 +17989,7 @@ module Aws::Pinpoint
|
|
17718
17989
|
# },
|
17719
17990
|
# user_attributes: {
|
17720
17991
|
# "__string" => {
|
17721
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
17992
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
17722
17993
|
# values: ["__string"], # required
|
17723
17994
|
# },
|
17724
17995
|
# },
|
@@ -18446,9 +18717,9 @@ module Aws::Pinpoint
|
|
18446
18717
|
# @return [Boolean]
|
18447
18718
|
#
|
18448
18719
|
# @!attribute [rw] limits
|
18449
|
-
# The default sending limits for campaigns
|
18450
|
-
#
|
18451
|
-
#
|
18720
|
+
# The default sending limits for campaigns in the application. To
|
18721
|
+
# override these limits and define custom limits for a specific
|
18722
|
+
# campaign or journey, use the <link
|
18452
18723
|
# linkend="apps-application-id-campaigns-campaign-id" />
|
18453
18724
|
#
|
18454
18725
|
# Campaign</link> resource or the <link
|
@@ -18458,9 +18729,9 @@ module Aws::Pinpoint
|
|
18458
18729
|
# @return [Types::CampaignLimits]
|
18459
18730
|
#
|
18460
18731
|
# @!attribute [rw] quiet_time
|
18461
|
-
# The default quiet time for campaigns
|
18462
|
-
#
|
18463
|
-
#
|
18732
|
+
# The default quiet time for campaigns in the application. Quiet time
|
18733
|
+
# is a specific time range when messages aren't sent to endpoints, if
|
18734
|
+
# all the following conditions are met:
|
18464
18735
|
#
|
18465
18736
|
# * The EndpointDemographic.Timezone property of the endpoint is set
|
18466
18737
|
# to a valid value.
|
@@ -18596,6 +18867,7 @@ module Aws::Pinpoint
|
|
18596
18867
|
# sms_message: {
|
18597
18868
|
# body: "__string",
|
18598
18869
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
18870
|
+
# origination_number: "__string",
|
18599
18871
|
# sender_id: "__string",
|
18600
18872
|
# },
|
18601
18873
|
# },
|
@@ -18605,7 +18877,7 @@ module Aws::Pinpoint
|
|
18605
18877
|
# dimensions: { # required
|
18606
18878
|
# attributes: {
|
18607
18879
|
# "__string" => {
|
18608
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
18880
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
18609
18881
|
# values: ["__string"], # required
|
18610
18882
|
# },
|
18611
18883
|
# },
|
@@ -18755,6 +19027,7 @@ module Aws::Pinpoint
|
|
18755
19027
|
# sms_message: {
|
18756
19028
|
# body: "__string",
|
18757
19029
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
19030
|
+
# origination_number: "__string",
|
18758
19031
|
# sender_id: "__string",
|
18759
19032
|
# },
|
18760
19033
|
# },
|
@@ -18765,7 +19038,7 @@ module Aws::Pinpoint
|
|
18765
19038
|
# dimensions: { # required
|
18766
19039
|
# attributes: {
|
18767
19040
|
# "__string" => {
|
18768
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19041
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
18769
19042
|
# values: ["__string"], # required
|
18770
19043
|
# },
|
18771
19044
|
# },
|
@@ -18980,10 +19253,10 @@ module Aws::Pinpoint
|
|
18980
19253
|
# conditions: [
|
18981
19254
|
# {
|
18982
19255
|
# event_condition: {
|
18983
|
-
# dimensions: {
|
19256
|
+
# dimensions: {
|
18984
19257
|
# attributes: {
|
18985
19258
|
# "__string" => {
|
18986
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19259
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
18987
19260
|
# values: ["__string"], # required
|
18988
19261
|
# },
|
18989
19262
|
# },
|
@@ -19006,7 +19279,7 @@ module Aws::Pinpoint
|
|
19006
19279
|
# segment_dimensions: {
|
19007
19280
|
# attributes: {
|
19008
19281
|
# "__string" => {
|
19009
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19282
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19010
19283
|
# values: ["__string"], # required
|
19011
19284
|
# },
|
19012
19285
|
# },
|
@@ -19063,7 +19336,7 @@ module Aws::Pinpoint
|
|
19063
19336
|
# },
|
19064
19337
|
# user_attributes: {
|
19065
19338
|
# "__string" => {
|
19066
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19339
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19067
19340
|
# values: ["__string"], # required
|
19068
19341
|
# },
|
19069
19342
|
# },
|
@@ -19097,10 +19370,10 @@ module Aws::Pinpoint
|
|
19097
19370
|
# {
|
19098
19371
|
# condition: {
|
19099
19372
|
# event_condition: {
|
19100
|
-
# dimensions: {
|
19373
|
+
# dimensions: {
|
19101
19374
|
# attributes: {
|
19102
19375
|
# "__string" => {
|
19103
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19376
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19104
19377
|
# values: ["__string"], # required
|
19105
19378
|
# },
|
19106
19379
|
# },
|
@@ -19123,7 +19396,7 @@ module Aws::Pinpoint
|
|
19123
19396
|
# segment_dimensions: {
|
19124
19397
|
# attributes: {
|
19125
19398
|
# "__string" => {
|
19126
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19399
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19127
19400
|
# values: ["__string"], # required
|
19128
19401
|
# },
|
19129
19402
|
# },
|
@@ -19180,7 +19453,7 @@ module Aws::Pinpoint
|
|
19180
19453
|
# },
|
19181
19454
|
# user_attributes: {
|
19182
19455
|
# "__string" => {
|
19183
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19456
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19184
19457
|
# values: ["__string"], # required
|
19185
19458
|
# },
|
19186
19459
|
# },
|
@@ -19214,6 +19487,7 @@ module Aws::Pinpoint
|
|
19214
19487
|
# sms: {
|
19215
19488
|
# message_config: {
|
19216
19489
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
19490
|
+
# origination_number: "__string",
|
19217
19491
|
# sender_id: "__string",
|
19218
19492
|
# },
|
19219
19493
|
# next_activity: "__string",
|
@@ -19251,6 +19525,30 @@ module Aws::Pinpoint
|
|
19251
19525
|
# start_activity: "__string",
|
19252
19526
|
# start_condition: {
|
19253
19527
|
# description: "__string",
|
19528
|
+
# event_start_condition: {
|
19529
|
+
# event_filter: {
|
19530
|
+
# dimensions: { # required
|
19531
|
+
# attributes: {
|
19532
|
+
# "__string" => {
|
19533
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19534
|
+
# values: ["__string"], # required
|
19535
|
+
# },
|
19536
|
+
# },
|
19537
|
+
# event_type: {
|
19538
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19539
|
+
# values: ["__string"], # required
|
19540
|
+
# },
|
19541
|
+
# metrics: {
|
19542
|
+
# "__string" => {
|
19543
|
+
# comparison_operator: "__string", # required
|
19544
|
+
# value: 1.0, # required
|
19545
|
+
# },
|
19546
|
+
# },
|
19547
|
+
# },
|
19548
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
19549
|
+
# },
|
19550
|
+
# segment_id: "__string",
|
19551
|
+
# },
|
19254
19552
|
# segment_start_condition: {
|
19255
19553
|
# segment_id: "__string", # required
|
19256
19554
|
# },
|
@@ -19379,7 +19677,7 @@ module Aws::Pinpoint
|
|
19379
19677
|
# dimensions: {
|
19380
19678
|
# attributes: {
|
19381
19679
|
# "__string" => {
|
19382
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19680
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19383
19681
|
# values: ["__string"], # required
|
19384
19682
|
# },
|
19385
19683
|
# },
|
@@ -19436,7 +19734,7 @@ module Aws::Pinpoint
|
|
19436
19734
|
# },
|
19437
19735
|
# user_attributes: {
|
19438
19736
|
# "__string" => {
|
19439
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19737
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19440
19738
|
# values: ["__string"], # required
|
19441
19739
|
# },
|
19442
19740
|
# },
|
@@ -19449,7 +19747,7 @@ module Aws::Pinpoint
|
|
19449
19747
|
# {
|
19450
19748
|
# attributes: {
|
19451
19749
|
# "__string" => {
|
19452
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19750
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19453
19751
|
# values: ["__string"], # required
|
19454
19752
|
# },
|
19455
19753
|
# },
|
@@ -19506,7 +19804,7 @@ module Aws::Pinpoint
|
|
19506
19804
|
# },
|
19507
19805
|
# user_attributes: {
|
19508
19806
|
# "__string" => {
|
19509
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19807
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19510
19808
|
# values: ["__string"], # required
|
19511
19809
|
# },
|
19512
19810
|
# },
|
@@ -19655,6 +19953,7 @@ module Aws::Pinpoint
|
|
19655
19953
|
# sms_message: {
|
19656
19954
|
# body: "__string",
|
19657
19955
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
19956
|
+
# origination_number: "__string",
|
19658
19957
|
# sender_id: "__string",
|
19659
19958
|
# },
|
19660
19959
|
# },
|
@@ -19664,7 +19963,7 @@ module Aws::Pinpoint
|
|
19664
19963
|
# dimensions: { # required
|
19665
19964
|
# attributes: {
|
19666
19965
|
# "__string" => {
|
19667
|
-
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
19966
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
|
19668
19967
|
# values: ["__string"], # required
|
19669
19968
|
# },
|
19670
19969
|
# },
|