aws-sdk-pinpoint 1.35.0 → 1.40.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 +5 -5
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +151 -18
- data/lib/aws-sdk-pinpoint/client_api.rb +19 -0
- data/lib/aws-sdk-pinpoint/errors.rb +4 -15
- data/lib/aws-sdk-pinpoint/resource.rb +1 -7
- data/lib/aws-sdk-pinpoint/types.rb +339 -169
- metadata +3 -3
@@ -42,6 +42,7 @@ module Aws::Pinpoint
|
|
42
42
|
BaiduChannelResponse = Shapes::StructureShape.new(name: 'BaiduChannelResponse')
|
43
43
|
BaiduMessage = Shapes::StructureShape.new(name: 'BaiduMessage')
|
44
44
|
BaseKpiResult = Shapes::StructureShape.new(name: 'BaseKpiResult')
|
45
|
+
CampaignCustomMessage = Shapes::StructureShape.new(name: 'CampaignCustomMessage')
|
45
46
|
CampaignDateRangeKpiResponse = Shapes::StructureShape.new(name: 'CampaignDateRangeKpiResponse')
|
46
47
|
CampaignEmailMessage = Shapes::StructureShape.new(name: 'CampaignEmailMessage')
|
47
48
|
CampaignEventFilter = Shapes::StructureShape.new(name: 'CampaignEventFilter')
|
@@ -82,6 +83,7 @@ module Aws::Pinpoint
|
|
82
83
|
CreateTemplateMessageBody = Shapes::StructureShape.new(name: 'CreateTemplateMessageBody')
|
83
84
|
CreateVoiceTemplateRequest = Shapes::StructureShape.new(name: 'CreateVoiceTemplateRequest')
|
84
85
|
CreateVoiceTemplateResponse = Shapes::StructureShape.new(name: 'CreateVoiceTemplateResponse')
|
86
|
+
CustomDeliveryConfiguration = Shapes::StructureShape.new(name: 'CustomDeliveryConfiguration')
|
85
87
|
DefaultMessage = Shapes::StructureShape.new(name: 'DefaultMessage')
|
86
88
|
DefaultPushNotificationMessage = Shapes::StructureShape.new(name: 'DefaultPushNotificationMessage')
|
87
89
|
DefaultPushNotificationTemplate = Shapes::StructureShape.new(name: 'DefaultPushNotificationTemplate')
|
@@ -301,6 +303,7 @@ module Aws::Pinpoint
|
|
301
303
|
ListOfTemplateVersionResponse = Shapes::ListShape.new(name: 'ListOfTemplateVersionResponse')
|
302
304
|
ListOfTreatmentResource = Shapes::ListShape.new(name: 'ListOfTreatmentResource')
|
303
305
|
ListOfWriteTreatmentResource = Shapes::ListShape.new(name: 'ListOfWriteTreatmentResource')
|
306
|
+
ListOf__EndpointTypesElement = Shapes::ListShape.new(name: 'ListOf__EndpointTypesElement')
|
304
307
|
ListOf__string = Shapes::ListShape.new(name: 'ListOf__string')
|
305
308
|
ListRecommenderConfigurationsResponse = Shapes::StructureShape.new(name: 'ListRecommenderConfigurationsResponse')
|
306
309
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -470,6 +473,7 @@ module Aws::Pinpoint
|
|
470
473
|
WriteJourneyRequest = Shapes::StructureShape.new(name: 'WriteJourneyRequest')
|
471
474
|
WriteSegmentRequest = Shapes::StructureShape.new(name: 'WriteSegmentRequest')
|
472
475
|
WriteTreatmentResource = Shapes::StructureShape.new(name: 'WriteTreatmentResource')
|
476
|
+
__EndpointTypesElement = Shapes::StringShape.new(name: '__EndpointTypesElement')
|
473
477
|
__blob = Shapes::BlobShape.new(name: '__blob')
|
474
478
|
__boolean = Shapes::BooleanShape.new(name: '__boolean')
|
475
479
|
__double = Shapes::FloatShape.new(name: '__double')
|
@@ -761,6 +765,9 @@ module Aws::Pinpoint
|
|
761
765
|
BaseKpiResult.add_member(:rows, Shapes::ShapeRef.new(shape: ListOfResultRow, required: true, location_name: "Rows"))
|
762
766
|
BaseKpiResult.struct_class = Types::BaseKpiResult
|
763
767
|
|
768
|
+
CampaignCustomMessage.add_member(:data, Shapes::ShapeRef.new(shape: __string, location_name: "Data"))
|
769
|
+
CampaignCustomMessage.struct_class = Types::CampaignCustomMessage
|
770
|
+
|
764
771
|
CampaignDateRangeKpiResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
|
765
772
|
CampaignDateRangeKpiResponse.add_member(:campaign_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "CampaignId"))
|
766
773
|
CampaignDateRangeKpiResponse.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampIso8601, required: true, location_name: "EndTime"))
|
@@ -795,6 +802,7 @@ module Aws::Pinpoint
|
|
795
802
|
CampaignResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
|
796
803
|
CampaignResponse.add_member(:arn, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Arn"))
|
797
804
|
CampaignResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "CreationDate"))
|
805
|
+
CampaignResponse.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
|
798
806
|
CampaignResponse.add_member(:default_state, Shapes::ShapeRef.new(shape: CampaignState, location_name: "DefaultState"))
|
799
807
|
CampaignResponse.add_member(:description, Shapes::ShapeRef.new(shape: __string, location_name: "Description"))
|
800
808
|
CampaignResponse.add_member(:holdout_percent, Shapes::ShapeRef.new(shape: __integer, location_name: "HoldoutPercent"))
|
@@ -991,6 +999,10 @@ module Aws::Pinpoint
|
|
991
999
|
CreateVoiceTemplateResponse[:payload] = :create_template_message_body
|
992
1000
|
CreateVoiceTemplateResponse[:payload_member] = CreateVoiceTemplateResponse.member(:create_template_message_body)
|
993
1001
|
|
1002
|
+
CustomDeliveryConfiguration.add_member(:delivery_uri, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DeliveryUri"))
|
1003
|
+
CustomDeliveryConfiguration.add_member(:endpoint_types, Shapes::ShapeRef.new(shape: ListOf__EndpointTypesElement, location_name: "EndpointTypes"))
|
1004
|
+
CustomDeliveryConfiguration.struct_class = Types::CustomDeliveryConfiguration
|
1005
|
+
|
994
1006
|
DefaultMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
|
995
1007
|
DefaultMessage.add_member(:substitutions, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Substitutions"))
|
996
1008
|
DefaultMessage.struct_class = Types::DefaultMessage
|
@@ -2064,6 +2076,8 @@ module Aws::Pinpoint
|
|
2064
2076
|
|
2065
2077
|
ListOfWriteTreatmentResource.member = Shapes::ShapeRef.new(shape: WriteTreatmentResource)
|
2066
2078
|
|
2079
|
+
ListOf__EndpointTypesElement.member = Shapes::ShapeRef.new(shape: __EndpointTypesElement)
|
2080
|
+
|
2067
2081
|
ListOf__string.member = Shapes::ShapeRef.new(shape: __string)
|
2068
2082
|
|
2069
2083
|
ListRecommenderConfigurationsResponse.add_member(:item, Shapes::ShapeRef.new(shape: ListOfRecommenderConfigurationResponse, required: true, location_name: "Item"))
|
@@ -2172,6 +2186,7 @@ module Aws::Pinpoint
|
|
2172
2186
|
MessageConfiguration.add_member(:adm_message, Shapes::ShapeRef.new(shape: Message, location_name: "ADMMessage"))
|
2173
2187
|
MessageConfiguration.add_member(:apns_message, Shapes::ShapeRef.new(shape: Message, location_name: "APNSMessage"))
|
2174
2188
|
MessageConfiguration.add_member(:baidu_message, Shapes::ShapeRef.new(shape: Message, location_name: "BaiduMessage"))
|
2189
|
+
MessageConfiguration.add_member(:custom_message, Shapes::ShapeRef.new(shape: CampaignCustomMessage, location_name: "CustomMessage"))
|
2175
2190
|
MessageConfiguration.add_member(:default_message, Shapes::ShapeRef.new(shape: Message, location_name: "DefaultMessage"))
|
2176
2191
|
MessageConfiguration.add_member(:email_message, Shapes::ShapeRef.new(shape: CampaignEmailMessage, location_name: "EmailMessage"))
|
2177
2192
|
MessageConfiguration.add_member(:gcm_message, Shapes::ShapeRef.new(shape: Message, location_name: "GCMMessage"))
|
@@ -2393,6 +2408,7 @@ module Aws::Pinpoint
|
|
2393
2408
|
|
2394
2409
|
SMSMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
|
2395
2410
|
SMSMessage.add_member(:keyword, Shapes::ShapeRef.new(shape: __string, location_name: "Keyword"))
|
2411
|
+
SMSMessage.add_member(:media_url, Shapes::ShapeRef.new(shape: __string, location_name: "MediaUrl"))
|
2396
2412
|
SMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
2397
2413
|
SMSMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
2398
2414
|
SMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
@@ -2612,6 +2628,7 @@ module Aws::Pinpoint
|
|
2612
2628
|
TooManyRequestsException.add_member(:request_id, Shapes::ShapeRef.new(shape: __string, location_name: "RequestID"))
|
2613
2629
|
TooManyRequestsException.struct_class = Types::TooManyRequestsException
|
2614
2630
|
|
2631
|
+
TreatmentResource.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
|
2615
2632
|
TreatmentResource.add_member(:id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Id"))
|
2616
2633
|
TreatmentResource.add_member(:message_configuration, Shapes::ShapeRef.new(shape: MessageConfiguration, location_name: "MessageConfiguration"))
|
2617
2634
|
TreatmentResource.add_member(:schedule, Shapes::ShapeRef.new(shape: Schedule, location_name: "Schedule"))
|
@@ -2966,6 +2983,7 @@ module Aws::Pinpoint
|
|
2966
2983
|
WriteApplicationSettingsRequest.struct_class = Types::WriteApplicationSettingsRequest
|
2967
2984
|
|
2968
2985
|
WriteCampaignRequest.add_member(:additional_treatments, Shapes::ShapeRef.new(shape: ListOfWriteTreatmentResource, location_name: "AdditionalTreatments"))
|
2986
|
+
WriteCampaignRequest.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
|
2969
2987
|
WriteCampaignRequest.add_member(:description, Shapes::ShapeRef.new(shape: __string, location_name: "Description"))
|
2970
2988
|
WriteCampaignRequest.add_member(:holdout_percent, Shapes::ShapeRef.new(shape: __integer, location_name: "HoldoutPercent"))
|
2971
2989
|
WriteCampaignRequest.add_member(:hook, Shapes::ShapeRef.new(shape: CampaignHook, location_name: "Hook"))
|
@@ -3006,6 +3024,7 @@ module Aws::Pinpoint
|
|
3006
3024
|
WriteSegmentRequest.add_member(:tags, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "tags"))
|
3007
3025
|
WriteSegmentRequest.struct_class = Types::WriteSegmentRequest
|
3008
3026
|
|
3027
|
+
WriteTreatmentResource.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
|
3009
3028
|
WriteTreatmentResource.add_member(:message_configuration, Shapes::ShapeRef.new(shape: MessageConfiguration, location_name: "MessageConfiguration"))
|
3010
3029
|
WriteTreatmentResource.add_member(:schedule, Shapes::ShapeRef.new(shape: Schedule, location_name: "Schedule"))
|
3011
3030
|
WriteTreatmentResource.add_member(:size_percent, Shapes::ShapeRef.new(shape: __integer, required: true, location_name: "SizePercent"))
|
@@ -11,22 +11,17 @@ module Aws::Pinpoint
|
|
11
11
|
# These errors all extend Aws::Pinpoint::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
12
|
#
|
13
13
|
# You can rescue all Pinpoint errors using ServiceError:
|
14
|
+
#
|
14
15
|
# begin
|
15
16
|
# # do stuff
|
16
17
|
# rescue Aws::Pinpoint::Errors::ServiceError
|
17
18
|
# # rescues all Pinpoint API errors
|
18
19
|
# end
|
19
20
|
#
|
21
|
+
#
|
20
22
|
# ## Request Context
|
21
23
|
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
22
|
-
# information about the request that generated the error
|
23
|
-
# *
|
24
|
-
# * #params - The request params
|
25
|
-
# * #operation_name - Name of the API operation invoked
|
26
|
-
# * #http_request
|
27
|
-
# * #http_response
|
28
|
-
# * etc ...
|
29
|
-
#
|
24
|
+
# information about the request that generated the error.
|
30
25
|
# See {Seahorse::Client::RequestContext} for more information.
|
31
26
|
#
|
32
27
|
# ## Error Classes
|
@@ -37,6 +32,7 @@ module Aws::Pinpoint
|
|
37
32
|
# * {NotFoundException}
|
38
33
|
# * {PayloadTooLargeException}
|
39
34
|
# * {TooManyRequestsException}
|
35
|
+
#
|
40
36
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
41
37
|
# if they are not defined above.
|
42
38
|
module Errors
|
@@ -61,7 +57,6 @@ module Aws::Pinpoint
|
|
61
57
|
def request_id
|
62
58
|
@data[:request_id]
|
63
59
|
end
|
64
|
-
|
65
60
|
end
|
66
61
|
|
67
62
|
class ForbiddenException < ServiceError
|
@@ -82,7 +77,6 @@ module Aws::Pinpoint
|
|
82
77
|
def request_id
|
83
78
|
@data[:request_id]
|
84
79
|
end
|
85
|
-
|
86
80
|
end
|
87
81
|
|
88
82
|
class InternalServerErrorException < ServiceError
|
@@ -103,7 +97,6 @@ module Aws::Pinpoint
|
|
103
97
|
def request_id
|
104
98
|
@data[:request_id]
|
105
99
|
end
|
106
|
-
|
107
100
|
end
|
108
101
|
|
109
102
|
class MethodNotAllowedException < ServiceError
|
@@ -124,7 +117,6 @@ module Aws::Pinpoint
|
|
124
117
|
def request_id
|
125
118
|
@data[:request_id]
|
126
119
|
end
|
127
|
-
|
128
120
|
end
|
129
121
|
|
130
122
|
class NotFoundException < ServiceError
|
@@ -145,7 +137,6 @@ module Aws::Pinpoint
|
|
145
137
|
def request_id
|
146
138
|
@data[:request_id]
|
147
139
|
end
|
148
|
-
|
149
140
|
end
|
150
141
|
|
151
142
|
class PayloadTooLargeException < ServiceError
|
@@ -166,7 +157,6 @@ module Aws::Pinpoint
|
|
166
157
|
def request_id
|
167
158
|
@data[:request_id]
|
168
159
|
end
|
169
|
-
|
170
160
|
end
|
171
161
|
|
172
162
|
class TooManyRequestsException < ServiceError
|
@@ -187,7 +177,6 @@ module Aws::Pinpoint
|
|
187
177
|
def request_id
|
188
178
|
@data[:request_id]
|
189
179
|
end
|
190
|
-
|
191
180
|
end
|
192
181
|
|
193
182
|
end
|
@@ -6,13 +6,7 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::Pinpoint
|
9
|
-
|
10
|
-
# To create a resource object:
|
11
|
-
# resource = Aws::Pinpoint::Resource.new(region: 'us-west-2')
|
12
|
-
# You can supply a client object with custom configuration that will be used for all resource operations.
|
13
|
-
# If you do not pass +:client+, a default client will be constructed.
|
14
|
-
# client = Aws::Pinpoint::Client.new(region: 'us-west-2')
|
15
|
-
# resource = Aws::Pinpoint::Resource.new(client: client)
|
9
|
+
|
16
10
|
class Resource
|
17
11
|
|
18
12
|
# @param options ({})
|
@@ -1795,7 +1795,7 @@ module Aws::Pinpoint
|
|
1795
1795
|
#
|
1796
1796
|
#
|
1797
1797
|
#
|
1798
|
-
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/
|
1798
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
|
1799
1799
|
# @return [String]
|
1800
1800
|
#
|
1801
1801
|
# @!attribute [rw] kpi_result
|
@@ -1870,8 +1870,9 @@ module Aws::Pinpoint
|
|
1870
1870
|
# @return [String]
|
1871
1871
|
#
|
1872
1872
|
# @!attribute [rw] campaign_hook
|
1873
|
-
# The settings for the AWS Lambda function to
|
1874
|
-
# hook for campaigns in the application.
|
1873
|
+
# The settings for the AWS Lambda function to invoke by default as a
|
1874
|
+
# code hook for campaigns in the application. You can use this hook to
|
1875
|
+
# customize segments that are used by campaigns in the application.
|
1875
1876
|
# @return [Types::CampaignHook]
|
1876
1877
|
#
|
1877
1878
|
# @!attribute [rw] last_modified_date
|
@@ -1880,7 +1881,8 @@ module Aws::Pinpoint
|
|
1880
1881
|
# @return [String]
|
1881
1882
|
#
|
1882
1883
|
# @!attribute [rw] limits
|
1883
|
-
# The default sending limits for campaigns in the
|
1884
|
+
# The default sending limits for campaigns and journeys in the
|
1885
|
+
# application.
|
1884
1886
|
# @return [Types::CampaignLimits]
|
1885
1887
|
#
|
1886
1888
|
# @!attribute [rw] quiet_time
|
@@ -2276,6 +2278,28 @@ module Aws::Pinpoint
|
|
2276
2278
|
include Aws::Structure
|
2277
2279
|
end
|
2278
2280
|
|
2281
|
+
# Specifies the contents of a message that's sent through a custom
|
2282
|
+
# channel to recipients of a campaign.
|
2283
|
+
#
|
2284
|
+
# @note When making an API call, you may pass CampaignCustomMessage
|
2285
|
+
# data as a hash:
|
2286
|
+
#
|
2287
|
+
# {
|
2288
|
+
# data: "__string",
|
2289
|
+
# }
|
2290
|
+
#
|
2291
|
+
# @!attribute [rw] data
|
2292
|
+
# The raw, JSON-formatted string to use as the payload for the
|
2293
|
+
# message. The maximum size is 5 KB.
|
2294
|
+
# @return [String]
|
2295
|
+
#
|
2296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignCustomMessage AWS API Documentation
|
2297
|
+
#
|
2298
|
+
class CampaignCustomMessage < Struct.new(
|
2299
|
+
:data)
|
2300
|
+
include Aws::Structure
|
2301
|
+
end
|
2302
|
+
|
2279
2303
|
# Provides the results of a query that retrieved the data for a standard
|
2280
2304
|
# metric that applies to a campaign, and provides information about that
|
2281
2305
|
# query.
|
@@ -2305,7 +2329,7 @@ module Aws::Pinpoint
|
|
2305
2329
|
#
|
2306
2330
|
#
|
2307
2331
|
#
|
2308
|
-
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/
|
2332
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
|
2309
2333
|
# @return [String]
|
2310
2334
|
#
|
2311
2335
|
# @!attribute [rw] kpi_result
|
@@ -2431,8 +2455,8 @@ module Aws::Pinpoint
|
|
2431
2455
|
include Aws::Structure
|
2432
2456
|
end
|
2433
2457
|
|
2434
|
-
# Specifies
|
2435
|
-
# campaign.
|
2458
|
+
# Specifies settings for invoking an AWS Lambda function that customizes
|
2459
|
+
# a segment for a campaign.
|
2436
2460
|
#
|
2437
2461
|
# @note When making an API call, you may pass CampaignHook
|
2438
2462
|
# data as a hash:
|
@@ -2445,12 +2469,21 @@ module Aws::Pinpoint
|
|
2445
2469
|
#
|
2446
2470
|
# @!attribute [rw] lambda_function_name
|
2447
2471
|
# The name or Amazon Resource Name (ARN) of the AWS Lambda function
|
2448
|
-
# that Amazon Pinpoint invokes to
|
2472
|
+
# that Amazon Pinpoint invokes to customize a segment for a campaign.
|
2449
2473
|
# @return [String]
|
2450
2474
|
#
|
2451
2475
|
# @!attribute [rw] mode
|
2452
|
-
#
|
2453
|
-
# function.
|
2476
|
+
# The mode that Amazon Pinpoint uses to invoke the AWS Lambda
|
2477
|
+
# function. Possible values are:
|
2478
|
+
#
|
2479
|
+
# * FILTER - Invoke the function to customize the segment that's used
|
2480
|
+
# by a campaign.
|
2481
|
+
#
|
2482
|
+
# * DELIVERY - (Deprecated) Previously, invoked the function to send a
|
2483
|
+
# campaign through a custom channel. This functionality is not
|
2484
|
+
# supported anymore. To send a campaign through a custom channel,
|
2485
|
+
# use the CustomDeliveryConfiguration and CampaignCustomMessage
|
2486
|
+
# objects of the campaign.
|
2454
2487
|
# @return [String]
|
2455
2488
|
#
|
2456
2489
|
# @!attribute [rw] web_url
|
@@ -2467,7 +2500,9 @@ module Aws::Pinpoint
|
|
2467
2500
|
include Aws::Structure
|
2468
2501
|
end
|
2469
2502
|
|
2470
|
-
#
|
2503
|
+
# For a campaign, specifies limits on the messages that the campaign can
|
2504
|
+
# send. For an application, specifies the default limits for messages
|
2505
|
+
# that campaigns and journeys in the application can send.
|
2471
2506
|
#
|
2472
2507
|
# @note When making an API call, you may pass CampaignLimits
|
2473
2508
|
# data as a hash:
|
@@ -2481,7 +2516,10 @@ module Aws::Pinpoint
|
|
2481
2516
|
#
|
2482
2517
|
# @!attribute [rw] daily
|
2483
2518
|
# The maximum number of messages that a campaign can send to a single
|
2484
|
-
# endpoint during a 24-hour period.
|
2519
|
+
# endpoint during a 24-hour period. For an application, this value
|
2520
|
+
# specifies the default limit for the number of messages that
|
2521
|
+
# campaigns and journeys can send to a single endpoint during a
|
2522
|
+
# 24-hour period. The maximum value is 100.
|
2485
2523
|
# @return [Integer]
|
2486
2524
|
#
|
2487
2525
|
# @!attribute [rw] maximum_duration
|
@@ -2492,13 +2530,16 @@ module Aws::Pinpoint
|
|
2492
2530
|
#
|
2493
2531
|
# @!attribute [rw] messages_per_second
|
2494
2532
|
# The maximum number of messages that a campaign can send each second.
|
2533
|
+
# For an application, this value specifies the default limit for the
|
2534
|
+
# number of messages that campaigns and journeys can send each second.
|
2495
2535
|
# The minimum value is 50. The maximum value is 20,000.
|
2496
2536
|
# @return [Integer]
|
2497
2537
|
#
|
2498
2538
|
# @!attribute [rw] total
|
2499
2539
|
# The maximum number of messages that a campaign can send to a single
|
2500
|
-
# endpoint during the course of the campaign.
|
2501
|
-
#
|
2540
|
+
# endpoint during the course of the campaign. If a campaign recurs,
|
2541
|
+
# this setting applies to all runs of the campaign. The maximum value
|
2542
|
+
# is 100.
|
2502
2543
|
# @return [Integer]
|
2503
2544
|
#
|
2504
2545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignLimits AWS API Documentation
|
@@ -2532,10 +2573,14 @@ module Aws::Pinpoint
|
|
2532
2573
|
# The date, in ISO 8601 format, when the campaign was created.
|
2533
2574
|
# @return [String]
|
2534
2575
|
#
|
2576
|
+
# @!attribute [rw] custom_delivery_configuration
|
2577
|
+
# The delivery configuration settings for sending the campaign through
|
2578
|
+
# a custom channel.
|
2579
|
+
# @return [Types::CustomDeliveryConfiguration]
|
2580
|
+
#
|
2535
2581
|
# @!attribute [rw] default_state
|
2536
2582
|
# The current status of the campaign's default treatment. This value
|
2537
|
-
# exists only for campaigns that have more than one treatment
|
2538
|
-
# support A/B testing.
|
2583
|
+
# exists only for campaigns that have more than one treatment.
|
2539
2584
|
# @return [Types::CampaignState]
|
2540
2585
|
#
|
2541
2586
|
# @!attribute [rw] description
|
@@ -2549,7 +2594,8 @@ module Aws::Pinpoint
|
|
2549
2594
|
#
|
2550
2595
|
# @!attribute [rw] hook
|
2551
2596
|
# The settings for the AWS Lambda function to use as a code hook for
|
2552
|
-
# the campaign.
|
2597
|
+
# the campaign. You can use this hook to customize the segment that's
|
2598
|
+
# used by the campaign.
|
2553
2599
|
# @return [Types::CampaignHook]
|
2554
2600
|
#
|
2555
2601
|
# @!attribute [rw] id
|
@@ -2606,13 +2652,13 @@ module Aws::Pinpoint
|
|
2606
2652
|
# @return [Types::TemplateConfiguration]
|
2607
2653
|
#
|
2608
2654
|
# @!attribute [rw] treatment_description
|
2609
|
-
# The custom description of
|
2610
|
-
# for A/B testing.
|
2655
|
+
# The custom description of the default treatment for the campaign.
|
2611
2656
|
# @return [String]
|
2612
2657
|
#
|
2613
2658
|
# @!attribute [rw] treatment_name
|
2614
|
-
# The custom name of
|
2615
|
-
#
|
2659
|
+
# The custom name of the default treatment for the campaign, if the
|
2660
|
+
# campaign has multiple treatments. A *treatment* is a variation of a
|
2661
|
+
# campaign that's used for A/B testing.
|
2616
2662
|
# @return [String]
|
2617
2663
|
#
|
2618
2664
|
# @!attribute [rw] version
|
@@ -2626,6 +2672,7 @@ module Aws::Pinpoint
|
|
2626
2672
|
:application_id,
|
2627
2673
|
:arn,
|
2628
2674
|
:creation_date,
|
2675
|
+
:custom_delivery_configuration,
|
2629
2676
|
:default_state,
|
2630
2677
|
:description,
|
2631
2678
|
:holdout_percent,
|
@@ -2689,9 +2736,12 @@ module Aws::Pinpoint
|
|
2689
2736
|
#
|
2690
2737
|
# @!attribute [rw] campaign_status
|
2691
2738
|
# The current status of the campaign, or the current status of a
|
2692
|
-
# treatment that belongs to an A/B test campaign.
|
2693
|
-
#
|
2694
|
-
# campaign
|
2739
|
+
# treatment that belongs to an A/B test campaign.
|
2740
|
+
#
|
2741
|
+
# If a campaign uses A/B testing, the campaign has a status of
|
2742
|
+
# COMPLETED only if all campaign treatments have a status of
|
2743
|
+
# COMPLETED. If you delete the segment that's associated with a
|
2744
|
+
# campaign, the campaign fails and has a status of DELETED.
|
2695
2745
|
# @return [String]
|
2696
2746
|
#
|
2697
2747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignState AWS API Documentation
|
@@ -3137,6 +3187,10 @@ module Aws::Pinpoint
|
|
3137
3187
|
# write_campaign_request: { # required
|
3138
3188
|
# additional_treatments: [
|
3139
3189
|
# {
|
3190
|
+
# custom_delivery_configuration: {
|
3191
|
+
# delivery_uri: "__string", # required
|
3192
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
3193
|
+
# },
|
3140
3194
|
# message_configuration: {
|
3141
3195
|
# adm_message: {
|
3142
3196
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -3180,6 +3234,9 @@ module Aws::Pinpoint
|
|
3180
3234
|
# title: "__string",
|
3181
3235
|
# url: "__string",
|
3182
3236
|
# },
|
3237
|
+
# custom_message: {
|
3238
|
+
# data: "__string",
|
3239
|
+
# },
|
3183
3240
|
# default_message: {
|
3184
3241
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3185
3242
|
# body: "__string",
|
@@ -3275,6 +3332,10 @@ module Aws::Pinpoint
|
|
3275
3332
|
# treatment_name: "__string",
|
3276
3333
|
# },
|
3277
3334
|
# ],
|
3335
|
+
# custom_delivery_configuration: {
|
3336
|
+
# delivery_uri: "__string", # required
|
3337
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
3338
|
+
# },
|
3278
3339
|
# description: "__string",
|
3279
3340
|
# holdout_percent: 1,
|
3280
3341
|
# hook: {
|
@@ -3332,6 +3393,9 @@ module Aws::Pinpoint
|
|
3332
3393
|
# title: "__string",
|
3333
3394
|
# url: "__string",
|
3334
3395
|
# },
|
3396
|
+
# custom_message: {
|
3397
|
+
# data: "__string",
|
3398
|
+
# },
|
3335
3399
|
# default_message: {
|
3336
3400
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3337
3401
|
# body: "__string",
|
@@ -4013,17 +4077,18 @@ module Aws::Pinpoint
|
|
4013
4077
|
#
|
4014
4078
|
# @!attribute [rw] attributes
|
4015
4079
|
# A map of key-value pairs that defines 1-10 custom endpoint or user
|
4016
|
-
# attributes, depending on the value for the
|
4017
|
-
# property. Each of these attributes
|
4018
|
-
# item that's retrieved from the
|
4019
|
-
#
|
4020
|
-
# used as a message variable in a
|
4080
|
+
# attributes, depending on the value for the
|
4081
|
+
# RecommendationProviderIdType property. Each of these attributes
|
4082
|
+
# temporarily stores a recommended item that's retrieved from the
|
4083
|
+
# recommender model and sent to an AWS Lambda function for additional
|
4084
|
+
# processing. Each attribute can be used as a message variable in a
|
4085
|
+
# message template.
|
4021
4086
|
#
|
4022
4087
|
# In the map, the key is the name of a custom attribute and the value
|
4023
4088
|
# is a custom display name for that attribute. The display name
|
4024
|
-
# appears in the **Attribute finder**
|
4025
|
-
#
|
4026
|
-
#
|
4089
|
+
# appears in the **Attribute finder** of the template editor on the
|
4090
|
+
# Amazon Pinpoint console. The following restrictions apply to these
|
4091
|
+
# names:
|
4027
4092
|
#
|
4028
4093
|
# * An attribute name must start with a letter or number and it can
|
4029
4094
|
# contain up to 50 characters. The characters can be letters,
|
@@ -4035,13 +4100,14 @@ module Aws::Pinpoint
|
|
4035
4100
|
# numbers, spaces, underscores (\_), or hyphens (-).
|
4036
4101
|
#
|
4037
4102
|
# This object is required if the configuration invokes an AWS Lambda
|
4038
|
-
# function (
|
4039
|
-
# Otherwise, don't include this object in your request.
|
4103
|
+
# function (RecommendationTransformerUri) to process recommendation
|
4104
|
+
# data. Otherwise, don't include this object in your request.
|
4040
4105
|
# @return [Hash<String,String>]
|
4041
4106
|
#
|
4042
4107
|
# @!attribute [rw] description
|
4043
4108
|
# A custom description of the configuration for the recommender model.
|
4044
|
-
# The description can contain up to 128 characters.
|
4109
|
+
# The description can contain up to 128 characters. The characters can
|
4110
|
+
# be letters, numbers, spaces, or the following symbols: \_ ; () , ‐.
|
4045
4111
|
# @return [String]
|
4046
4112
|
#
|
4047
4113
|
# @!attribute [rw] name
|
@@ -4066,7 +4132,7 @@ module Aws::Pinpoint
|
|
4066
4132
|
# particular user and endpoint in Amazon Pinpoint. The data is
|
4067
4133
|
# correlated based on user IDs in Amazon Pinpoint. If you specify
|
4068
4134
|
# this value, an endpoint definition in Amazon Pinpoint has to
|
4069
|
-
# specify
|
4135
|
+
# specify both a user ID (UserId) and an endpoint ID. Otherwise,
|
4070
4136
|
# messages won’t be sent to the user's endpoint.
|
4071
4137
|
# @return [String]
|
4072
4138
|
#
|
@@ -4090,15 +4156,15 @@ module Aws::Pinpoint
|
|
4090
4156
|
#
|
4091
4157
|
# @!attribute [rw] recommendations_display_name
|
4092
4158
|
# A custom display name for the standard endpoint or user attribute
|
4093
|
-
# (RecommendationItems) that temporarily stores
|
4159
|
+
# (RecommendationItems) that temporarily stores recommended items for
|
4094
4160
|
# each endpoint or user, depending on the value for the
|
4095
|
-
#
|
4161
|
+
# RecommendationProviderIdType property. This value is required if the
|
4096
4162
|
# configuration doesn't invoke an AWS Lambda function
|
4097
|
-
# (
|
4163
|
+
# (RecommendationTransformerUri) to perform additional processing of
|
4098
4164
|
# recommendation data.
|
4099
4165
|
#
|
4100
|
-
# This name appears in the **Attribute finder**
|
4101
|
-
#
|
4166
|
+
# This name appears in the **Attribute finder** of the template editor
|
4167
|
+
# on the Amazon Pinpoint console. The name can contain up to 25
|
4102
4168
|
# characters. The characters can be letters, numbers, spaces,
|
4103
4169
|
# underscores (\_), or hyphens (-). These restrictions don't apply to
|
4104
4170
|
# attribute values.
|
@@ -4107,14 +4173,14 @@ module Aws::Pinpoint
|
|
4107
4173
|
# @!attribute [rw] recommendations_per_message
|
4108
4174
|
# The number of recommended items to retrieve from the model for each
|
4109
4175
|
# endpoint or user, depending on the value for the
|
4110
|
-
#
|
4111
|
-
# recommended
|
4112
|
-
#
|
4113
|
-
#
|
4176
|
+
# RecommendationProviderIdType property. This number determines how
|
4177
|
+
# many recommended items are available for use in message variables.
|
4178
|
+
# The minimum value is 1. The maximum value is 5. The default value is
|
4179
|
+
# 5.
|
4114
4180
|
#
|
4115
4181
|
# To use multiple recommended items and custom attributes with message
|
4116
4182
|
# variables, you have to use an AWS Lambda function
|
4117
|
-
# (
|
4183
|
+
# (RecommendationTransformerUri) to perform additional processing of
|
4118
4184
|
# recommendation data.
|
4119
4185
|
# @return [Integer]
|
4120
4186
|
#
|
@@ -4478,6 +4544,45 @@ module Aws::Pinpoint
|
|
4478
4544
|
include Aws::Structure
|
4479
4545
|
end
|
4480
4546
|
|
4547
|
+
# Specifies the delivery configuration settings for sending a campaign
|
4548
|
+
# or campaign treatment through a custom channel. This object is
|
4549
|
+
# required if you use the CampaignCustomMessage object to define the
|
4550
|
+
# message to send for the campaign or campaign treatment.
|
4551
|
+
#
|
4552
|
+
# @note When making an API call, you may pass CustomDeliveryConfiguration
|
4553
|
+
# data as a hash:
|
4554
|
+
#
|
4555
|
+
# {
|
4556
|
+
# delivery_uri: "__string", # required
|
4557
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
4558
|
+
# }
|
4559
|
+
#
|
4560
|
+
# @!attribute [rw] delivery_uri
|
4561
|
+
# The destination to send the campaign or treatment to. This value can
|
4562
|
+
# be one of the following:
|
4563
|
+
#
|
4564
|
+
# * The name or Amazon Resource Name (ARN) of an AWS Lambda function
|
4565
|
+
# to invoke to handle delivery of the campaign or treatment.
|
4566
|
+
#
|
4567
|
+
# * The URL for a web application or service that supports HTTPS and
|
4568
|
+
# can receive the message. The URL has to be a full URL, including
|
4569
|
+
# the HTTPS protocol.
|
4570
|
+
# @return [String]
|
4571
|
+
#
|
4572
|
+
# @!attribute [rw] endpoint_types
|
4573
|
+
# The types of endpoints to send the campaign or treatment to. Each
|
4574
|
+
# valid value maps to a type of channel that you can associate with an
|
4575
|
+
# endpoint by using the ChannelType property of an endpoint.
|
4576
|
+
# @return [Array<String>]
|
4577
|
+
#
|
4578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CustomDeliveryConfiguration AWS API Documentation
|
4579
|
+
#
|
4580
|
+
class CustomDeliveryConfiguration < Struct.new(
|
4581
|
+
:delivery_uri,
|
4582
|
+
:endpoint_types)
|
4583
|
+
include Aws::Structure
|
4584
|
+
end
|
4585
|
+
|
4481
4586
|
# Specifies the default message for all channels.
|
4482
4587
|
#
|
4483
4588
|
# @note When making an API call, you may pass DefaultMessage
|
@@ -5488,6 +5593,7 @@ module Aws::Pinpoint
|
|
5488
5593
|
# sms_message: {
|
5489
5594
|
# body: "__string",
|
5490
5595
|
# keyword: "__string",
|
5596
|
+
# media_url: "__string",
|
5491
5597
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
5492
5598
|
# origination_number: "__string",
|
5493
5599
|
# sender_id: "__string",
|
@@ -5586,9 +5692,12 @@ module Aws::Pinpoint
|
|
5586
5692
|
# }
|
5587
5693
|
#
|
5588
5694
|
# @!attribute [rw] configuration_set
|
5589
|
-
# The configuration set that you want to apply to
|
5590
|
-
#
|
5591
|
-
#
|
5695
|
+
# The [Amazon SES configuration set][1] that you want to apply to
|
5696
|
+
# messages that you send through the channel.
|
5697
|
+
#
|
5698
|
+
#
|
5699
|
+
#
|
5700
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html
|
5592
5701
|
# @return [String]
|
5593
5702
|
#
|
5594
5703
|
# @!attribute [rw] enabled
|
@@ -5632,9 +5741,12 @@ module Aws::Pinpoint
|
|
5632
5741
|
# @return [String]
|
5633
5742
|
#
|
5634
5743
|
# @!attribute [rw] configuration_set
|
5635
|
-
# The configuration set that's applied to
|
5636
|
-
#
|
5637
|
-
#
|
5744
|
+
# The [Amazon SES configuration set][1] that's applied to messages
|
5745
|
+
# that are sent through the channel.
|
5746
|
+
#
|
5747
|
+
#
|
5748
|
+
#
|
5749
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html
|
5638
5750
|
# @return [String]
|
5639
5751
|
#
|
5640
5752
|
# @!attribute [rw] creation_date
|
@@ -5647,7 +5759,7 @@ module Aws::Pinpoint
|
|
5647
5759
|
# @return [Boolean]
|
5648
5760
|
#
|
5649
5761
|
# @!attribute [rw] from_address
|
5650
|
-
# The verified email address that
|
5762
|
+
# The verified email address that email is sent from when you send
|
5651
5763
|
# email through the channel.
|
5652
5764
|
# @return [String]
|
5653
5765
|
#
|
@@ -5663,7 +5775,7 @@ module Aws::Pinpoint
|
|
5663
5775
|
#
|
5664
5776
|
# @!attribute [rw] identity
|
5665
5777
|
# The Amazon Resource Name (ARN) of the identity, verified with Amazon
|
5666
|
-
# Simple Email Service (Amazon SES), that
|
5778
|
+
# Simple Email Service (Amazon SES), that's used when you send email
|
5667
5779
|
# through the channel.
|
5668
5780
|
# @return [String]
|
5669
5781
|
#
|
@@ -5681,7 +5793,7 @@ module Aws::Pinpoint
|
|
5681
5793
|
# @return [String]
|
5682
5794
|
#
|
5683
5795
|
# @!attribute [rw] messages_per_second
|
5684
|
-
# The maximum number of emails that
|
5796
|
+
# The maximum number of emails that can be sent through the channel
|
5685
5797
|
# each second.
|
5686
5798
|
# @return [Integer]
|
5687
5799
|
#
|
@@ -6150,7 +6262,7 @@ module Aws::Pinpoint
|
|
6150
6262
|
# @return [String]
|
6151
6263
|
#
|
6152
6264
|
# @!attribute [rw] user
|
6153
|
-
# One or more custom
|
6265
|
+
# One or more custom attributes that describe the user who's
|
6154
6266
|
# associated with the endpoint.
|
6155
6267
|
# @return [Types::EndpointUser]
|
6156
6268
|
#
|
@@ -6565,7 +6677,7 @@ module Aws::Pinpoint
|
|
6565
6677
|
# @return [String]
|
6566
6678
|
#
|
6567
6679
|
# @!attribute [rw] user
|
6568
|
-
# One or more custom
|
6680
|
+
# One or more custom attributes that describe the user who's
|
6569
6681
|
# associated with the endpoint.
|
6570
6682
|
# @return [Types::EndpointUser]
|
6571
6683
|
#
|
@@ -7049,18 +7161,10 @@ module Aws::Pinpoint
|
|
7049
7161
|
# to.
|
7050
7162
|
#
|
7051
7163
|
# For a Kinesis data stream, the ARN format is:
|
7052
|
-
# arn:aws:kinesis
|
7053
|
-
#
|
7054
|
-
# \:<replaceable>account-id</replaceable>
|
7055
|
-
#
|
7056
|
-
# \:stream/<replaceable>stream_name</replaceable>
|
7164
|
+
# arn:aws:kinesis:*region*\:*account-id*\:stream/*stream\_name*
|
7057
7165
|
#
|
7058
7166
|
# For a Kinesis Data Firehose delivery stream, the ARN format is:
|
7059
|
-
# arn:aws:firehose
|
7060
|
-
#
|
7061
|
-
# \:<replaceable>account-id</replaceable>
|
7062
|
-
#
|
7063
|
-
# \:deliverystream/<replaceable>stream_name</replaceable>
|
7167
|
+
# arn:aws:firehose:*region*\:*account-id*\:deliverystream/*stream\_name*
|
7064
7168
|
# @return [String]
|
7065
7169
|
#
|
7066
7170
|
# @!attribute [rw] external_id
|
@@ -7313,11 +7417,7 @@ module Aws::Pinpoint
|
|
7313
7417
|
# S3) bucket where you want to export endpoint definitions to. This
|
7314
7418
|
# location is typically a folder that contains multiple files. The URL
|
7315
7419
|
# should be in the following format:
|
7316
|
-
# s3
|
7317
|
-
#
|
7318
|
-
# /<replaceable>folder-name</replaceable>
|
7319
|
-
#
|
7320
|
-
# /.
|
7420
|
+
# s3://*bucket-name*/*folder-name*/.
|
7321
7421
|
# @return [String]
|
7322
7422
|
#
|
7323
7423
|
# @!attribute [rw] segment_id
|
@@ -7359,11 +7459,7 @@ module Aws::Pinpoint
|
|
7359
7459
|
# S3) bucket where the endpoint definitions were exported to. This
|
7360
7460
|
# location is typically a folder that contains multiple files. The URL
|
7361
7461
|
# should be in the following format:
|
7362
|
-
# s3
|
7363
|
-
#
|
7364
|
-
# /<replaceable>folder-name</replaceable>
|
7365
|
-
#
|
7366
|
-
# /.
|
7462
|
+
# s3://*bucket-name*/*folder-name*/.
|
7367
7463
|
# @return [String]
|
7368
7464
|
#
|
7369
7465
|
# @!attribute [rw] segment_id
|
@@ -9565,14 +9661,9 @@ module Aws::Pinpoint
|
|
9565
9661
|
# location, including any subfolders that the folder contains.
|
9566
9662
|
#
|
9567
9663
|
# The URL should be in the following format:
|
9568
|
-
# s3
|
9569
|
-
#
|
9570
|
-
#
|
9571
|
-
#
|
9572
|
-
# /<replaceable>file-name</replaceable>
|
9573
|
-
#
|
9574
|
-
# . The location can end with the key for an individual object or a
|
9575
|
-
# prefix that qualifies multiple objects.
|
9664
|
+
# s3://*bucket-name*/*folder-name*/*file-name*. The location can end
|
9665
|
+
# with the key for an individual object or a prefix that qualifies
|
9666
|
+
# multiple objects.
|
9576
9667
|
# @return [String]
|
9577
9668
|
#
|
9578
9669
|
# @!attribute [rw] segment_id
|
@@ -9648,14 +9739,9 @@ module Aws::Pinpoint
|
|
9648
9739
|
# location, including any subfolders that the folder contains.
|
9649
9740
|
#
|
9650
9741
|
# The URL should be in the following format:
|
9651
|
-
# s3
|
9652
|
-
#
|
9653
|
-
#
|
9654
|
-
#
|
9655
|
-
# /<replaceable>file-name</replaceable>
|
9656
|
-
#
|
9657
|
-
# . The location can end with the key for an individual object or a
|
9658
|
-
# prefix that qualifies multiple objects.
|
9742
|
+
# s3://*bucket-name*/*folder-name*/*file-name*. The location can end
|
9743
|
+
# with the key for an individual object or a prefix that qualifies
|
9744
|
+
# multiple objects.
|
9659
9745
|
# @return [String]
|
9660
9746
|
#
|
9661
9747
|
# @!attribute [rw] segment_id
|
@@ -9860,7 +9946,7 @@ module Aws::Pinpoint
|
|
9860
9946
|
#
|
9861
9947
|
#
|
9862
9948
|
#
|
9863
|
-
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/
|
9949
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
|
9864
9950
|
# @return [String]
|
9865
9951
|
#
|
9866
9952
|
# @!attribute [rw] kpi_result
|
@@ -10660,6 +10746,9 @@ module Aws::Pinpoint
|
|
10660
10746
|
# title: "__string",
|
10661
10747
|
# url: "__string",
|
10662
10748
|
# },
|
10749
|
+
# custom_message: {
|
10750
|
+
# data: "__string",
|
10751
|
+
# },
|
10663
10752
|
# default_message: {
|
10664
10753
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
10665
10754
|
# body: "__string",
|
@@ -10703,38 +10792,50 @@ module Aws::Pinpoint
|
|
10703
10792
|
#
|
10704
10793
|
# @!attribute [rw] adm_message
|
10705
10794
|
# The message that the campaign sends through the ADM (Amazon Device
|
10706
|
-
# Messaging) channel.
|
10795
|
+
# Messaging) channel. If specified, this message overrides the default
|
10796
|
+
# message.
|
10707
10797
|
# @return [Types::Message]
|
10708
10798
|
#
|
10709
10799
|
# @!attribute [rw] apns_message
|
10710
10800
|
# The message that the campaign sends through the APNs (Apple Push
|
10711
|
-
# Notification service) channel.
|
10712
|
-
# message.
|
10801
|
+
# Notification service) channel. If specified, this message overrides
|
10802
|
+
# the default message.
|
10713
10803
|
# @return [Types::Message]
|
10714
10804
|
#
|
10715
10805
|
# @!attribute [rw] baidu_message
|
10716
10806
|
# The message that the campaign sends through the Baidu (Baidu Cloud
|
10717
|
-
# Push) channel.
|
10807
|
+
# Push) channel. If specified, this message overrides the default
|
10808
|
+
# message.
|
10718
10809
|
# @return [Types::Message]
|
10719
10810
|
#
|
10811
|
+
# @!attribute [rw] custom_message
|
10812
|
+
# The message that the campaign sends through a custom channel, as
|
10813
|
+
# specified by the delivery configuration
|
10814
|
+
# (CustomDeliveryConfiguration) settings for the campaign. If
|
10815
|
+
# specified, this message overrides the default message.
|
10816
|
+
# @return [Types::CampaignCustomMessage]
|
10817
|
+
#
|
10720
10818
|
# @!attribute [rw] default_message
|
10721
10819
|
# The default message that the campaign sends through all the channels
|
10722
10820
|
# that are configured for the campaign.
|
10723
10821
|
# @return [Types::Message]
|
10724
10822
|
#
|
10725
10823
|
# @!attribute [rw] email_message
|
10726
|
-
# The message that the campaign sends through the email channel.
|
10824
|
+
# The message that the campaign sends through the email channel. If
|
10825
|
+
# specified, this message overrides the default message.
|
10727
10826
|
# @return [Types::CampaignEmailMessage]
|
10728
10827
|
#
|
10729
10828
|
# @!attribute [rw] gcm_message
|
10730
10829
|
# The message that the campaign sends through the GCM channel, which
|
10731
10830
|
# enables Amazon Pinpoint to send push notifications through the
|
10732
10831
|
# Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
|
10733
|
-
# (GCM), service.
|
10832
|
+
# (GCM), service. If specified, this message overrides the default
|
10833
|
+
# message.
|
10734
10834
|
# @return [Types::Message]
|
10735
10835
|
#
|
10736
10836
|
# @!attribute [rw] sms_message
|
10737
|
-
# The message that the campaign sends through the SMS channel.
|
10837
|
+
# The message that the campaign sends through the SMS channel. If
|
10838
|
+
# specified, this message overrides the default message.
|
10738
10839
|
# @return [Types::CampaignSmsMessage]
|
10739
10840
|
#
|
10740
10841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageConfiguration AWS API Documentation
|
@@ -10743,6 +10844,7 @@ module Aws::Pinpoint
|
|
10743
10844
|
:adm_message,
|
10744
10845
|
:apns_message,
|
10745
10846
|
:baidu_message,
|
10847
|
+
:custom_message,
|
10746
10848
|
:default_message,
|
10747
10849
|
:email_message,
|
10748
10850
|
:gcm_message,
|
@@ -10924,6 +11026,7 @@ module Aws::Pinpoint
|
|
10924
11026
|
# sms_message: {
|
10925
11027
|
# body: "__string",
|
10926
11028
|
# keyword: "__string",
|
11029
|
+
# media_url: "__string",
|
10927
11030
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
10928
11031
|
# origination_number: "__string",
|
10929
11032
|
# sender_id: "__string",
|
@@ -12267,15 +12370,15 @@ module Aws::Pinpoint
|
|
12267
12370
|
#
|
12268
12371
|
# @!attribute [rw] attributes
|
12269
12372
|
# A map that defines 1-10 custom endpoint or user attributes,
|
12270
|
-
# depending on the value for the
|
12271
|
-
# of these attributes temporarily stores a recommended
|
12272
|
-
# retrieved from the recommender model and sent to an AWS
|
12273
|
-
# function for additional processing. Each attribute can be
|
12274
|
-
# message variable in a message template.
|
12373
|
+
# depending on the value for the RecommendationProviderIdType
|
12374
|
+
# property. Each of these attributes temporarily stores a recommended
|
12375
|
+
# item that's retrieved from the recommender model and sent to an AWS
|
12376
|
+
# Lambda function for additional processing. Each attribute can be
|
12377
|
+
# used as a message variable in a message template.
|
12275
12378
|
#
|
12276
12379
|
# This value is null if the configuration doesn't invoke an AWS
|
12277
|
-
# Lambda function (
|
12278
|
-
# of recommendation data.
|
12380
|
+
# Lambda function (RecommendationTransformerUri) to perform additional
|
12381
|
+
# processing of recommendation data.
|
12279
12382
|
# @return [Hash<String,String>]
|
12280
12383
|
#
|
12281
12384
|
# @!attribute [rw] creation_date
|
@@ -12340,22 +12443,22 @@ module Aws::Pinpoint
|
|
12340
12443
|
#
|
12341
12444
|
# @!attribute [rw] recommendations_display_name
|
12342
12445
|
# The custom display name for the standard endpoint or user attribute
|
12343
|
-
# (RecommendationItems) that temporarily stores
|
12446
|
+
# (RecommendationItems) that temporarily stores recommended items for
|
12344
12447
|
# each endpoint or user, depending on the value for the
|
12345
|
-
#
|
12346
|
-
# finder**
|
12448
|
+
# RecommendationProviderIdType property. This name appears in the
|
12449
|
+
# **Attribute finder** of the template editor on the Amazon Pinpoint
|
12450
|
+
# console.
|
12347
12451
|
#
|
12348
12452
|
# This value is null if the configuration doesn't invoke an AWS
|
12349
|
-
# Lambda function (
|
12350
|
-
# of recommendation data.
|
12453
|
+
# Lambda function (RecommendationTransformerUri) to perform additional
|
12454
|
+
# processing of recommendation data.
|
12351
12455
|
# @return [String]
|
12352
12456
|
#
|
12353
12457
|
# @!attribute [rw] recommendations_per_message
|
12354
12458
|
# The number of recommended items that are retrieved from the model
|
12355
12459
|
# for each endpoint or user, depending on the value for the
|
12356
|
-
#
|
12357
|
-
# recommended
|
12358
|
-
# message templates.
|
12460
|
+
# RecommendationProviderIdType property. This number determines how
|
12461
|
+
# many recommended items are available for use in message variables.
|
12359
12462
|
# @return [Integer]
|
12360
12463
|
#
|
12361
12464
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RecommenderConfigurationResponse AWS API Documentation
|
@@ -12606,6 +12709,7 @@ module Aws::Pinpoint
|
|
12606
12709
|
# {
|
12607
12710
|
# body: "__string",
|
12608
12711
|
# keyword: "__string",
|
12712
|
+
# media_url: "__string",
|
12609
12713
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
12610
12714
|
# origination_number: "__string",
|
12611
12715
|
# sender_id: "__string",
|
@@ -12623,6 +12727,10 @@ module Aws::Pinpoint
|
|
12623
12727
|
# requested your dedicated number.
|
12624
12728
|
# @return [String]
|
12625
12729
|
#
|
12730
|
+
# @!attribute [rw] media_url
|
12731
|
+
# The URL of an image or video to display in the SMS message.
|
12732
|
+
# @return [String]
|
12733
|
+
#
|
12626
12734
|
# @!attribute [rw] message_type
|
12627
12735
|
# The SMS message type. Valid values are: TRANSACTIONAL, the message
|
12628
12736
|
# is critical or time-sensitive, such as a one-time password that
|
@@ -12654,6 +12762,7 @@ module Aws::Pinpoint
|
|
12654
12762
|
class SMSMessage < Struct.new(
|
12655
12763
|
:body,
|
12656
12764
|
:keyword,
|
12765
|
+
:media_url,
|
12657
12766
|
:message_type,
|
12658
12767
|
:origination_number,
|
12659
12768
|
:sender_id,
|
@@ -13761,6 +13870,7 @@ module Aws::Pinpoint
|
|
13761
13870
|
# sms_message: {
|
13762
13871
|
# body: "__string",
|
13763
13872
|
# keyword: "__string",
|
13873
|
+
# media_url: "__string",
|
13764
13874
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
13765
13875
|
# origination_number: "__string",
|
13766
13876
|
# sender_id: "__string",
|
@@ -13975,6 +14085,7 @@ module Aws::Pinpoint
|
|
13975
14085
|
# sms_message: {
|
13976
14086
|
# body: "__string",
|
13977
14087
|
# keyword: "__string",
|
14088
|
+
# media_url: "__string",
|
13978
14089
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
13979
14090
|
# origination_number: "__string",
|
13980
14091
|
# sender_id: "__string",
|
@@ -14241,6 +14352,7 @@ module Aws::Pinpoint
|
|
14241
14352
|
# sms_message: {
|
14242
14353
|
# body: "__string",
|
14243
14354
|
# keyword: "__string",
|
14355
|
+
# media_url: "__string",
|
14244
14356
|
# message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
|
14245
14357
|
# origination_number: "__string",
|
14246
14358
|
# sender_id: "__string",
|
@@ -14994,9 +15106,16 @@ module Aws::Pinpoint
|
|
14994
15106
|
include Aws::Structure
|
14995
15107
|
end
|
14996
15108
|
|
14997
|
-
# Specifies the settings for a campaign treatment. A treatment is a
|
15109
|
+
# Specifies the settings for a campaign treatment. A *treatment* is a
|
14998
15110
|
# variation of a campaign that's used for A/B testing of a campaign.
|
14999
15111
|
#
|
15112
|
+
# @!attribute [rw] custom_delivery_configuration
|
15113
|
+
# The delivery configuration settings for sending the treatment
|
15114
|
+
# through a custom channel. This object is required if the
|
15115
|
+
# MessageConfiguration object for the treatment specifies a
|
15116
|
+
# CustomMessage object.
|
15117
|
+
# @return [Types::CustomDeliveryConfiguration]
|
15118
|
+
#
|
15000
15119
|
# @!attribute [rw] id
|
15001
15120
|
# The unique identifier for the treatment.
|
15002
15121
|
# @return [String]
|
@@ -15027,13 +15146,13 @@ module Aws::Pinpoint
|
|
15027
15146
|
# @return [String]
|
15028
15147
|
#
|
15029
15148
|
# @!attribute [rw] treatment_name
|
15030
|
-
# The custom name of the treatment.
|
15031
|
-
# campaign that's used for A/B testing of a campaign.
|
15149
|
+
# The custom name of the treatment.
|
15032
15150
|
# @return [String]
|
15033
15151
|
#
|
15034
15152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TreatmentResource AWS API Documentation
|
15035
15153
|
#
|
15036
15154
|
class TreatmentResource < Struct.new(
|
15155
|
+
:custom_delivery_configuration,
|
15037
15156
|
:id,
|
15038
15157
|
:message_configuration,
|
15039
15158
|
:schedule,
|
@@ -15415,6 +15534,10 @@ module Aws::Pinpoint
|
|
15415
15534
|
# write_campaign_request: { # required
|
15416
15535
|
# additional_treatments: [
|
15417
15536
|
# {
|
15537
|
+
# custom_delivery_configuration: {
|
15538
|
+
# delivery_uri: "__string", # required
|
15539
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
15540
|
+
# },
|
15418
15541
|
# message_configuration: {
|
15419
15542
|
# adm_message: {
|
15420
15543
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -15458,6 +15581,9 @@ module Aws::Pinpoint
|
|
15458
15581
|
# title: "__string",
|
15459
15582
|
# url: "__string",
|
15460
15583
|
# },
|
15584
|
+
# custom_message: {
|
15585
|
+
# data: "__string",
|
15586
|
+
# },
|
15461
15587
|
# default_message: {
|
15462
15588
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
15463
15589
|
# body: "__string",
|
@@ -15553,6 +15679,10 @@ module Aws::Pinpoint
|
|
15553
15679
|
# treatment_name: "__string",
|
15554
15680
|
# },
|
15555
15681
|
# ],
|
15682
|
+
# custom_delivery_configuration: {
|
15683
|
+
# delivery_uri: "__string", # required
|
15684
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
15685
|
+
# },
|
15556
15686
|
# description: "__string",
|
15557
15687
|
# holdout_percent: 1,
|
15558
15688
|
# hook: {
|
@@ -15610,6 +15740,9 @@ module Aws::Pinpoint
|
|
15610
15740
|
# title: "__string",
|
15611
15741
|
# url: "__string",
|
15612
15742
|
# },
|
15743
|
+
# custom_message: {
|
15744
|
+
# data: "__string",
|
15745
|
+
# },
|
15613
15746
|
# default_message: {
|
15614
15747
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
15615
15748
|
# body: "__string",
|
@@ -16508,17 +16641,18 @@ module Aws::Pinpoint
|
|
16508
16641
|
#
|
16509
16642
|
# @!attribute [rw] attributes
|
16510
16643
|
# A map of key-value pairs that defines 1-10 custom endpoint or user
|
16511
|
-
# attributes, depending on the value for the
|
16512
|
-
# property. Each of these attributes
|
16513
|
-
# item that's retrieved from the
|
16514
|
-
#
|
16515
|
-
# used as a message variable in a
|
16644
|
+
# attributes, depending on the value for the
|
16645
|
+
# RecommendationProviderIdType property. Each of these attributes
|
16646
|
+
# temporarily stores a recommended item that's retrieved from the
|
16647
|
+
# recommender model and sent to an AWS Lambda function for additional
|
16648
|
+
# processing. Each attribute can be used as a message variable in a
|
16649
|
+
# message template.
|
16516
16650
|
#
|
16517
16651
|
# In the map, the key is the name of a custom attribute and the value
|
16518
16652
|
# is a custom display name for that attribute. The display name
|
16519
|
-
# appears in the **Attribute finder**
|
16520
|
-
#
|
16521
|
-
#
|
16653
|
+
# appears in the **Attribute finder** of the template editor on the
|
16654
|
+
# Amazon Pinpoint console. The following restrictions apply to these
|
16655
|
+
# names:
|
16522
16656
|
#
|
16523
16657
|
# * An attribute name must start with a letter or number and it can
|
16524
16658
|
# contain up to 50 characters. The characters can be letters,
|
@@ -16530,13 +16664,14 @@ module Aws::Pinpoint
|
|
16530
16664
|
# numbers, spaces, underscores (\_), or hyphens (-).
|
16531
16665
|
#
|
16532
16666
|
# This object is required if the configuration invokes an AWS Lambda
|
16533
|
-
# function (
|
16534
|
-
# Otherwise, don't include this object in your request.
|
16667
|
+
# function (RecommendationTransformerUri) to process recommendation
|
16668
|
+
# data. Otherwise, don't include this object in your request.
|
16535
16669
|
# @return [Hash<String,String>]
|
16536
16670
|
#
|
16537
16671
|
# @!attribute [rw] description
|
16538
16672
|
# A custom description of the configuration for the recommender model.
|
16539
|
-
# The description can contain up to 128 characters.
|
16673
|
+
# The description can contain up to 128 characters. The characters can
|
16674
|
+
# be letters, numbers, spaces, or the following symbols: \_ ; () , ‐.
|
16540
16675
|
# @return [String]
|
16541
16676
|
#
|
16542
16677
|
# @!attribute [rw] name
|
@@ -16561,7 +16696,7 @@ module Aws::Pinpoint
|
|
16561
16696
|
# particular user and endpoint in Amazon Pinpoint. The data is
|
16562
16697
|
# correlated based on user IDs in Amazon Pinpoint. If you specify
|
16563
16698
|
# this value, an endpoint definition in Amazon Pinpoint has to
|
16564
|
-
# specify
|
16699
|
+
# specify both a user ID (UserId) and an endpoint ID. Otherwise,
|
16565
16700
|
# messages won’t be sent to the user's endpoint.
|
16566
16701
|
# @return [String]
|
16567
16702
|
#
|
@@ -16585,15 +16720,15 @@ module Aws::Pinpoint
|
|
16585
16720
|
#
|
16586
16721
|
# @!attribute [rw] recommendations_display_name
|
16587
16722
|
# A custom display name for the standard endpoint or user attribute
|
16588
|
-
# (RecommendationItems) that temporarily stores
|
16723
|
+
# (RecommendationItems) that temporarily stores recommended items for
|
16589
16724
|
# each endpoint or user, depending on the value for the
|
16590
|
-
#
|
16725
|
+
# RecommendationProviderIdType property. This value is required if the
|
16591
16726
|
# configuration doesn't invoke an AWS Lambda function
|
16592
|
-
# (
|
16727
|
+
# (RecommendationTransformerUri) to perform additional processing of
|
16593
16728
|
# recommendation data.
|
16594
16729
|
#
|
16595
|
-
# This name appears in the **Attribute finder**
|
16596
|
-
#
|
16730
|
+
# This name appears in the **Attribute finder** of the template editor
|
16731
|
+
# on the Amazon Pinpoint console. The name can contain up to 25
|
16597
16732
|
# characters. The characters can be letters, numbers, spaces,
|
16598
16733
|
# underscores (\_), or hyphens (-). These restrictions don't apply to
|
16599
16734
|
# attribute values.
|
@@ -16602,14 +16737,14 @@ module Aws::Pinpoint
|
|
16602
16737
|
# @!attribute [rw] recommendations_per_message
|
16603
16738
|
# The number of recommended items to retrieve from the model for each
|
16604
16739
|
# endpoint or user, depending on the value for the
|
16605
|
-
#
|
16606
|
-
# recommended
|
16607
|
-
#
|
16608
|
-
#
|
16740
|
+
# RecommendationProviderIdType property. This number determines how
|
16741
|
+
# many recommended items are available for use in message variables.
|
16742
|
+
# The minimum value is 1. The maximum value is 5. The default value is
|
16743
|
+
# 5.
|
16609
16744
|
#
|
16610
16745
|
# To use multiple recommended items and custom attributes with message
|
16611
16746
|
# variables, you have to use an AWS Lambda function
|
16612
|
-
# (
|
16747
|
+
# (RecommendationTransformerUri) to perform additional processing of
|
16613
16748
|
# recommendation data.
|
16614
16749
|
# @return [Integer]
|
16615
16750
|
#
|
@@ -17505,13 +17640,15 @@ module Aws::Pinpoint
|
|
17505
17640
|
# }
|
17506
17641
|
#
|
17507
17642
|
# @!attribute [rw] campaign_hook
|
17508
|
-
# The settings for the AWS Lambda function to
|
17509
|
-
# hook for campaigns in the application.
|
17510
|
-
#
|
17643
|
+
# The settings for the AWS Lambda function to invoke by default as a
|
17644
|
+
# code hook for campaigns in the application. You can use this hook to
|
17645
|
+
# customize segments that are used by campaigns in the application.
|
17646
|
+
#
|
17647
|
+
# To override these settings and define custom settings for a specific
|
17648
|
+
# campaign, use the CampaignHook object of the <link
|
17511
17649
|
# linkend="apps-application-id-campaigns-campaign-id" />
|
17512
17650
|
#
|
17513
|
-
# Campaign</link> resource
|
17514
|
-
# for the campaign.
|
17651
|
+
# Campaign</link> resource.
|
17515
17652
|
# @return [Types::CampaignHook]
|
17516
17653
|
#
|
17517
17654
|
# @!attribute [rw] cloud_watch_metrics_enabled
|
@@ -17520,11 +17657,15 @@ module Aws::Pinpoint
|
|
17520
17657
|
# @return [Boolean]
|
17521
17658
|
#
|
17522
17659
|
# @!attribute [rw] limits
|
17523
|
-
# The default sending limits for campaigns in the
|
17524
|
-
# override these limits
|
17660
|
+
# The default sending limits for campaigns and journeys in the
|
17661
|
+
# application. To override these limits and define custom limits for a
|
17662
|
+
# specific campaign or journey, use the <link
|
17525
17663
|
# linkend="apps-application-id-campaigns-campaign-id" />
|
17526
17664
|
#
|
17527
|
-
# Campaign</link> resource
|
17665
|
+
# Campaign</link> resource or the <link
|
17666
|
+
# linkend="apps-application-id-journeys-journey-id" />
|
17667
|
+
#
|
17668
|
+
# Journey</link> resource, respectively.
|
17528
17669
|
# @return [Types::CampaignLimits]
|
17529
17670
|
#
|
17530
17671
|
# @!attribute [rw] quiet_time
|
@@ -17578,6 +17719,10 @@ module Aws::Pinpoint
|
|
17578
17719
|
# {
|
17579
17720
|
# additional_treatments: [
|
17580
17721
|
# {
|
17722
|
+
# custom_delivery_configuration: {
|
17723
|
+
# delivery_uri: "__string", # required
|
17724
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
17725
|
+
# },
|
17581
17726
|
# message_configuration: {
|
17582
17727
|
# adm_message: {
|
17583
17728
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -17621,6 +17766,9 @@ module Aws::Pinpoint
|
|
17621
17766
|
# title: "__string",
|
17622
17767
|
# url: "__string",
|
17623
17768
|
# },
|
17769
|
+
# custom_message: {
|
17770
|
+
# data: "__string",
|
17771
|
+
# },
|
17624
17772
|
# default_message: {
|
17625
17773
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
17626
17774
|
# body: "__string",
|
@@ -17716,6 +17864,10 @@ module Aws::Pinpoint
|
|
17716
17864
|
# treatment_name: "__string",
|
17717
17865
|
# },
|
17718
17866
|
# ],
|
17867
|
+
# custom_delivery_configuration: {
|
17868
|
+
# delivery_uri: "__string", # required
|
17869
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
17870
|
+
# },
|
17719
17871
|
# description: "__string",
|
17720
17872
|
# holdout_percent: 1,
|
17721
17873
|
# hook: {
|
@@ -17773,6 +17925,9 @@ module Aws::Pinpoint
|
|
17773
17925
|
# title: "__string",
|
17774
17926
|
# url: "__string",
|
17775
17927
|
# },
|
17928
|
+
# custom_message: {
|
17929
|
+
# data: "__string",
|
17930
|
+
# },
|
17776
17931
|
# default_message: {
|
17777
17932
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
17778
17933
|
# body: "__string",
|
@@ -17878,6 +18033,13 @@ module Aws::Pinpoint
|
|
17878
18033
|
# campaign, in addition to the default treatment for the campaign.
|
17879
18034
|
# @return [Array<Types::WriteTreatmentResource>]
|
17880
18035
|
#
|
18036
|
+
# @!attribute [rw] custom_delivery_configuration
|
18037
|
+
# The delivery configuration settings for sending the campaign through
|
18038
|
+
# a custom channel. This object is required if the
|
18039
|
+
# MessageConfiguration object for the campaign specifies a
|
18040
|
+
# CustomMessage object.
|
18041
|
+
# @return [Types::CustomDeliveryConfiguration]
|
18042
|
+
#
|
17881
18043
|
# @!attribute [rw] description
|
17882
18044
|
# A custom description of the campaign.
|
17883
18045
|
# @return [String]
|
@@ -17888,13 +18050,14 @@ module Aws::Pinpoint
|
|
17888
18050
|
# @return [Integer]
|
17889
18051
|
#
|
17890
18052
|
# @!attribute [rw] hook
|
17891
|
-
# The settings for the AWS Lambda function to
|
17892
|
-
# the campaign.
|
18053
|
+
# The settings for the AWS Lambda function to invoke as a code hook
|
18054
|
+
# for the campaign. You can use this hook to customize the segment
|
18055
|
+
# that's used by the campaign.
|
17893
18056
|
# @return [Types::CampaignHook]
|
17894
18057
|
#
|
17895
18058
|
# @!attribute [rw] is_paused
|
17896
18059
|
# Specifies whether to pause the campaign. A paused campaign doesn't
|
17897
|
-
# run unless you resume it by
|
18060
|
+
# run unless you resume it by changing this value to false.
|
17898
18061
|
# @return [Boolean]
|
17899
18062
|
#
|
17900
18063
|
# @!attribute [rw] limits
|
@@ -17933,19 +18096,20 @@ module Aws::Pinpoint
|
|
17933
18096
|
# @return [Types::TemplateConfiguration]
|
17934
18097
|
#
|
17935
18098
|
# @!attribute [rw] treatment_description
|
17936
|
-
# A custom description of
|
17937
|
-
# testing.
|
18099
|
+
# A custom description of the default treatment for the campaign.
|
17938
18100
|
# @return [String]
|
17939
18101
|
#
|
17940
18102
|
# @!attribute [rw] treatment_name
|
17941
|
-
# A custom name
|
17942
|
-
#
|
18103
|
+
# A custom name of the default treatment for the campaign, if the
|
18104
|
+
# campaign has multiple treatments. A *treatment* is a variation of a
|
18105
|
+
# campaign that's used for A/B testing.
|
17943
18106
|
# @return [String]
|
17944
18107
|
#
|
17945
18108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteCampaignRequest AWS API Documentation
|
17946
18109
|
#
|
17947
18110
|
class WriteCampaignRequest < Struct.new(
|
17948
18111
|
:additional_treatments,
|
18112
|
+
:custom_delivery_configuration,
|
17949
18113
|
:description,
|
17950
18114
|
:holdout_percent,
|
17951
18115
|
:hook,
|
@@ -17981,18 +18145,10 @@ module Aws::Pinpoint
|
|
17981
18145
|
# publish event data to.
|
17982
18146
|
#
|
17983
18147
|
# For a Kinesis data stream, the ARN format is:
|
17984
|
-
# arn:aws:kinesis
|
17985
|
-
#
|
17986
|
-
# \:<replaceable>account-id</replaceable>
|
17987
|
-
#
|
17988
|
-
# \:stream/<replaceable>stream_name</replaceable>
|
18148
|
+
# arn:aws:kinesis:*region*\:*account-id*\:stream/*stream\_name*
|
17989
18149
|
#
|
17990
18150
|
# For a Kinesis Data Firehose delivery stream, the ARN format is:
|
17991
|
-
# arn:aws:firehose
|
17992
|
-
#
|
17993
|
-
# \:<replaceable>account-id</replaceable>
|
17994
|
-
#
|
17995
|
-
# \:deliverystream/<replaceable>stream_name</replaceable>
|
18151
|
+
# arn:aws:firehose:*region*\:*account-id*\:deliverystream/*stream\_name*
|
17996
18152
|
# @return [String]
|
17997
18153
|
#
|
17998
18154
|
# @!attribute [rw] role_arn
|
@@ -18584,13 +18740,17 @@ module Aws::Pinpoint
|
|
18584
18740
|
include Aws::Structure
|
18585
18741
|
end
|
18586
18742
|
|
18587
|
-
# Specifies the settings for a campaign treatment. A treatment is a
|
18743
|
+
# Specifies the settings for a campaign treatment. A *treatment* is a
|
18588
18744
|
# variation of a campaign that's used for A/B testing of a campaign.
|
18589
18745
|
#
|
18590
18746
|
# @note When making an API call, you may pass WriteTreatmentResource
|
18591
18747
|
# data as a hash:
|
18592
18748
|
#
|
18593
18749
|
# {
|
18750
|
+
# custom_delivery_configuration: {
|
18751
|
+
# delivery_uri: "__string", # required
|
18752
|
+
# endpoint_types: ["GCM"], # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
|
18753
|
+
# },
|
18594
18754
|
# message_configuration: {
|
18595
18755
|
# adm_message: {
|
18596
18756
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -18634,6 +18794,9 @@ module Aws::Pinpoint
|
|
18634
18794
|
# title: "__string",
|
18635
18795
|
# url: "__string",
|
18636
18796
|
# },
|
18797
|
+
# custom_message: {
|
18798
|
+
# data: "__string",
|
18799
|
+
# },
|
18637
18800
|
# default_message: {
|
18638
18801
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
18639
18802
|
# body: "__string",
|
@@ -18729,6 +18892,13 @@ module Aws::Pinpoint
|
|
18729
18892
|
# treatment_name: "__string",
|
18730
18893
|
# }
|
18731
18894
|
#
|
18895
|
+
# @!attribute [rw] custom_delivery_configuration
|
18896
|
+
# The delivery configuration settings for sending the treatment
|
18897
|
+
# through a custom channel. This object is required if the
|
18898
|
+
# MessageConfiguration object for the treatment specifies a
|
18899
|
+
# CustomMessage object.
|
18900
|
+
# @return [Types::CustomDeliveryConfiguration]
|
18901
|
+
#
|
18732
18902
|
# @!attribute [rw] message_configuration
|
18733
18903
|
# The message configuration settings for the treatment.
|
18734
18904
|
# @return [Types::MessageConfiguration]
|
@@ -18751,13 +18921,13 @@ module Aws::Pinpoint
|
|
18751
18921
|
# @return [String]
|
18752
18922
|
#
|
18753
18923
|
# @!attribute [rw] treatment_name
|
18754
|
-
# A custom name for the treatment.
|
18755
|
-
# campaign that's used for A/B testing of a campaign.
|
18924
|
+
# A custom name for the treatment.
|
18756
18925
|
# @return [String]
|
18757
18926
|
#
|
18758
18927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteTreatmentResource AWS API Documentation
|
18759
18928
|
#
|
18760
18929
|
class WriteTreatmentResource < Struct.new(
|
18930
|
+
:custom_delivery_configuration,
|
18761
18931
|
:message_configuration,
|
18762
18932
|
:schedule,
|
18763
18933
|
:size_percent,
|