aws-sdk-pinpoint 1.37.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +92 -5
- data/lib/aws-sdk-pinpoint/client_api.rb +18 -0
- data/lib/aws-sdk-pinpoint/types.rb +316 -123
- metadata +3 -3
@@ -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
|
@@ -5587,9 +5692,12 @@ module Aws::Pinpoint
|
|
5587
5692
|
# }
|
5588
5693
|
#
|
5589
5694
|
# @!attribute [rw] configuration_set
|
5590
|
-
# The configuration set that you want to apply to
|
5591
|
-
#
|
5592
|
-
#
|
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
|
5593
5701
|
# @return [String]
|
5594
5702
|
#
|
5595
5703
|
# @!attribute [rw] enabled
|
@@ -5633,9 +5741,12 @@ module Aws::Pinpoint
|
|
5633
5741
|
# @return [String]
|
5634
5742
|
#
|
5635
5743
|
# @!attribute [rw] configuration_set
|
5636
|
-
# The configuration set that's applied to
|
5637
|
-
#
|
5638
|
-
#
|
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
|
5639
5750
|
# @return [String]
|
5640
5751
|
#
|
5641
5752
|
# @!attribute [rw] creation_date
|
@@ -5648,7 +5759,7 @@ module Aws::Pinpoint
|
|
5648
5759
|
# @return [Boolean]
|
5649
5760
|
#
|
5650
5761
|
# @!attribute [rw] from_address
|
5651
|
-
# The verified email address that
|
5762
|
+
# The verified email address that email is sent from when you send
|
5652
5763
|
# email through the channel.
|
5653
5764
|
# @return [String]
|
5654
5765
|
#
|
@@ -5664,7 +5775,7 @@ module Aws::Pinpoint
|
|
5664
5775
|
#
|
5665
5776
|
# @!attribute [rw] identity
|
5666
5777
|
# The Amazon Resource Name (ARN) of the identity, verified with Amazon
|
5667
|
-
# Simple Email Service (Amazon SES), that
|
5778
|
+
# Simple Email Service (Amazon SES), that's used when you send email
|
5668
5779
|
# through the channel.
|
5669
5780
|
# @return [String]
|
5670
5781
|
#
|
@@ -5682,7 +5793,7 @@ module Aws::Pinpoint
|
|
5682
5793
|
# @return [String]
|
5683
5794
|
#
|
5684
5795
|
# @!attribute [rw] messages_per_second
|
5685
|
-
# The maximum number of emails that
|
5796
|
+
# The maximum number of emails that can be sent through the channel
|
5686
5797
|
# each second.
|
5687
5798
|
# @return [Integer]
|
5688
5799
|
#
|
@@ -6151,7 +6262,7 @@ module Aws::Pinpoint
|
|
6151
6262
|
# @return [String]
|
6152
6263
|
#
|
6153
6264
|
# @!attribute [rw] user
|
6154
|
-
# One or more custom
|
6265
|
+
# One or more custom attributes that describe the user who's
|
6155
6266
|
# associated with the endpoint.
|
6156
6267
|
# @return [Types::EndpointUser]
|
6157
6268
|
#
|
@@ -6566,7 +6677,7 @@ module Aws::Pinpoint
|
|
6566
6677
|
# @return [String]
|
6567
6678
|
#
|
6568
6679
|
# @!attribute [rw] user
|
6569
|
-
# One or more custom
|
6680
|
+
# One or more custom attributes that describe the user who's
|
6570
6681
|
# associated with the endpoint.
|
6571
6682
|
# @return [Types::EndpointUser]
|
6572
6683
|
#
|
@@ -9835,7 +9946,7 @@ module Aws::Pinpoint
|
|
9835
9946
|
#
|
9836
9947
|
#
|
9837
9948
|
#
|
9838
|
-
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/
|
9949
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
|
9839
9950
|
# @return [String]
|
9840
9951
|
#
|
9841
9952
|
# @!attribute [rw] kpi_result
|
@@ -10635,6 +10746,9 @@ module Aws::Pinpoint
|
|
10635
10746
|
# title: "__string",
|
10636
10747
|
# url: "__string",
|
10637
10748
|
# },
|
10749
|
+
# custom_message: {
|
10750
|
+
# data: "__string",
|
10751
|
+
# },
|
10638
10752
|
# default_message: {
|
10639
10753
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
10640
10754
|
# body: "__string",
|
@@ -10678,38 +10792,50 @@ module Aws::Pinpoint
|
|
10678
10792
|
#
|
10679
10793
|
# @!attribute [rw] adm_message
|
10680
10794
|
# The message that the campaign sends through the ADM (Amazon Device
|
10681
|
-
# Messaging) channel.
|
10795
|
+
# Messaging) channel. If specified, this message overrides the default
|
10796
|
+
# message.
|
10682
10797
|
# @return [Types::Message]
|
10683
10798
|
#
|
10684
10799
|
# @!attribute [rw] apns_message
|
10685
10800
|
# The message that the campaign sends through the APNs (Apple Push
|
10686
|
-
# Notification service) channel.
|
10687
|
-
# message.
|
10801
|
+
# Notification service) channel. If specified, this message overrides
|
10802
|
+
# the default message.
|
10688
10803
|
# @return [Types::Message]
|
10689
10804
|
#
|
10690
10805
|
# @!attribute [rw] baidu_message
|
10691
10806
|
# The message that the campaign sends through the Baidu (Baidu Cloud
|
10692
|
-
# Push) channel.
|
10807
|
+
# Push) channel. If specified, this message overrides the default
|
10808
|
+
# message.
|
10693
10809
|
# @return [Types::Message]
|
10694
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
|
+
#
|
10695
10818
|
# @!attribute [rw] default_message
|
10696
10819
|
# The default message that the campaign sends through all the channels
|
10697
10820
|
# that are configured for the campaign.
|
10698
10821
|
# @return [Types::Message]
|
10699
10822
|
#
|
10700
10823
|
# @!attribute [rw] email_message
|
10701
|
-
# 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.
|
10702
10826
|
# @return [Types::CampaignEmailMessage]
|
10703
10827
|
#
|
10704
10828
|
# @!attribute [rw] gcm_message
|
10705
10829
|
# The message that the campaign sends through the GCM channel, which
|
10706
10830
|
# enables Amazon Pinpoint to send push notifications through the
|
10707
10831
|
# Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
|
10708
|
-
# (GCM), service.
|
10832
|
+
# (GCM), service. If specified, this message overrides the default
|
10833
|
+
# message.
|
10709
10834
|
# @return [Types::Message]
|
10710
10835
|
#
|
10711
10836
|
# @!attribute [rw] sms_message
|
10712
|
-
# 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.
|
10713
10839
|
# @return [Types::CampaignSmsMessage]
|
10714
10840
|
#
|
10715
10841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageConfiguration AWS API Documentation
|
@@ -10718,6 +10844,7 @@ module Aws::Pinpoint
|
|
10718
10844
|
:adm_message,
|
10719
10845
|
:apns_message,
|
10720
10846
|
:baidu_message,
|
10847
|
+
:custom_message,
|
10721
10848
|
:default_message,
|
10722
10849
|
:email_message,
|
10723
10850
|
:gcm_message,
|
@@ -12243,15 +12370,15 @@ module Aws::Pinpoint
|
|
12243
12370
|
#
|
12244
12371
|
# @!attribute [rw] attributes
|
12245
12372
|
# A map that defines 1-10 custom endpoint or user attributes,
|
12246
|
-
# depending on the value for the
|
12247
|
-
# of these attributes temporarily stores a recommended
|
12248
|
-
# retrieved from the recommender model and sent to an AWS
|
12249
|
-
# function for additional processing. Each attribute can be
|
12250
|
-
# 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.
|
12251
12378
|
#
|
12252
12379
|
# This value is null if the configuration doesn't invoke an AWS
|
12253
|
-
# Lambda function (
|
12254
|
-
# of recommendation data.
|
12380
|
+
# Lambda function (RecommendationTransformerUri) to perform additional
|
12381
|
+
# processing of recommendation data.
|
12255
12382
|
# @return [Hash<String,String>]
|
12256
12383
|
#
|
12257
12384
|
# @!attribute [rw] creation_date
|
@@ -12316,22 +12443,22 @@ module Aws::Pinpoint
|
|
12316
12443
|
#
|
12317
12444
|
# @!attribute [rw] recommendations_display_name
|
12318
12445
|
# The custom display name for the standard endpoint or user attribute
|
12319
|
-
# (RecommendationItems) that temporarily stores
|
12446
|
+
# (RecommendationItems) that temporarily stores recommended items for
|
12320
12447
|
# each endpoint or user, depending on the value for the
|
12321
|
-
#
|
12322
|
-
# finder**
|
12448
|
+
# RecommendationProviderIdType property. This name appears in the
|
12449
|
+
# **Attribute finder** of the template editor on the Amazon Pinpoint
|
12450
|
+
# console.
|
12323
12451
|
#
|
12324
12452
|
# This value is null if the configuration doesn't invoke an AWS
|
12325
|
-
# Lambda function (
|
12326
|
-
# of recommendation data.
|
12453
|
+
# Lambda function (RecommendationTransformerUri) to perform additional
|
12454
|
+
# processing of recommendation data.
|
12327
12455
|
# @return [String]
|
12328
12456
|
#
|
12329
12457
|
# @!attribute [rw] recommendations_per_message
|
12330
12458
|
# The number of recommended items that are retrieved from the model
|
12331
12459
|
# for each endpoint or user, depending on the value for the
|
12332
|
-
#
|
12333
|
-
# recommended
|
12334
|
-
# message templates.
|
12460
|
+
# RecommendationProviderIdType property. This number determines how
|
12461
|
+
# many recommended items are available for use in message variables.
|
12335
12462
|
# @return [Integer]
|
12336
12463
|
#
|
12337
12464
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RecommenderConfigurationResponse AWS API Documentation
|
@@ -14979,9 +15106,16 @@ module Aws::Pinpoint
|
|
14979
15106
|
include Aws::Structure
|
14980
15107
|
end
|
14981
15108
|
|
14982
|
-
# Specifies the settings for a campaign treatment. A treatment is a
|
15109
|
+
# Specifies the settings for a campaign treatment. A *treatment* is a
|
14983
15110
|
# variation of a campaign that's used for A/B testing of a campaign.
|
14984
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
|
+
#
|
14985
15119
|
# @!attribute [rw] id
|
14986
15120
|
# The unique identifier for the treatment.
|
14987
15121
|
# @return [String]
|
@@ -15012,13 +15146,13 @@ module Aws::Pinpoint
|
|
15012
15146
|
# @return [String]
|
15013
15147
|
#
|
15014
15148
|
# @!attribute [rw] treatment_name
|
15015
|
-
# The custom name of the treatment.
|
15016
|
-
# campaign that's used for A/B testing of a campaign.
|
15149
|
+
# The custom name of the treatment.
|
15017
15150
|
# @return [String]
|
15018
15151
|
#
|
15019
15152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TreatmentResource AWS API Documentation
|
15020
15153
|
#
|
15021
15154
|
class TreatmentResource < Struct.new(
|
15155
|
+
:custom_delivery_configuration,
|
15022
15156
|
:id,
|
15023
15157
|
:message_configuration,
|
15024
15158
|
:schedule,
|
@@ -15400,6 +15534,10 @@ module Aws::Pinpoint
|
|
15400
15534
|
# write_campaign_request: { # required
|
15401
15535
|
# additional_treatments: [
|
15402
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
|
+
# },
|
15403
15541
|
# message_configuration: {
|
15404
15542
|
# adm_message: {
|
15405
15543
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -15443,6 +15581,9 @@ module Aws::Pinpoint
|
|
15443
15581
|
# title: "__string",
|
15444
15582
|
# url: "__string",
|
15445
15583
|
# },
|
15584
|
+
# custom_message: {
|
15585
|
+
# data: "__string",
|
15586
|
+
# },
|
15446
15587
|
# default_message: {
|
15447
15588
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
15448
15589
|
# body: "__string",
|
@@ -15538,6 +15679,10 @@ module Aws::Pinpoint
|
|
15538
15679
|
# treatment_name: "__string",
|
15539
15680
|
# },
|
15540
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
|
+
# },
|
15541
15686
|
# description: "__string",
|
15542
15687
|
# holdout_percent: 1,
|
15543
15688
|
# hook: {
|
@@ -15595,6 +15740,9 @@ module Aws::Pinpoint
|
|
15595
15740
|
# title: "__string",
|
15596
15741
|
# url: "__string",
|
15597
15742
|
# },
|
15743
|
+
# custom_message: {
|
15744
|
+
# data: "__string",
|
15745
|
+
# },
|
15598
15746
|
# default_message: {
|
15599
15747
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
15600
15748
|
# body: "__string",
|
@@ -16493,17 +16641,18 @@ module Aws::Pinpoint
|
|
16493
16641
|
#
|
16494
16642
|
# @!attribute [rw] attributes
|
16495
16643
|
# A map of key-value pairs that defines 1-10 custom endpoint or user
|
16496
|
-
# attributes, depending on the value for the
|
16497
|
-
# property. Each of these attributes
|
16498
|
-
# item that's retrieved from the
|
16499
|
-
#
|
16500
|
-
# 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.
|
16501
16650
|
#
|
16502
16651
|
# In the map, the key is the name of a custom attribute and the value
|
16503
16652
|
# is a custom display name for that attribute. The display name
|
16504
|
-
# appears in the **Attribute finder**
|
16505
|
-
#
|
16506
|
-
#
|
16653
|
+
# appears in the **Attribute finder** of the template editor on the
|
16654
|
+
# Amazon Pinpoint console. The following restrictions apply to these
|
16655
|
+
# names:
|
16507
16656
|
#
|
16508
16657
|
# * An attribute name must start with a letter or number and it can
|
16509
16658
|
# contain up to 50 characters. The characters can be letters,
|
@@ -16515,13 +16664,14 @@ module Aws::Pinpoint
|
|
16515
16664
|
# numbers, spaces, underscores (\_), or hyphens (-).
|
16516
16665
|
#
|
16517
16666
|
# This object is required if the configuration invokes an AWS Lambda
|
16518
|
-
# function (
|
16519
|
-
# 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.
|
16520
16669
|
# @return [Hash<String,String>]
|
16521
16670
|
#
|
16522
16671
|
# @!attribute [rw] description
|
16523
16672
|
# A custom description of the configuration for the recommender model.
|
16524
|
-
# 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: \_ ; () , ‐.
|
16525
16675
|
# @return [String]
|
16526
16676
|
#
|
16527
16677
|
# @!attribute [rw] name
|
@@ -16546,7 +16696,7 @@ module Aws::Pinpoint
|
|
16546
16696
|
# particular user and endpoint in Amazon Pinpoint. The data is
|
16547
16697
|
# correlated based on user IDs in Amazon Pinpoint. If you specify
|
16548
16698
|
# this value, an endpoint definition in Amazon Pinpoint has to
|
16549
|
-
# specify
|
16699
|
+
# specify both a user ID (UserId) and an endpoint ID. Otherwise,
|
16550
16700
|
# messages won’t be sent to the user's endpoint.
|
16551
16701
|
# @return [String]
|
16552
16702
|
#
|
@@ -16570,15 +16720,15 @@ module Aws::Pinpoint
|
|
16570
16720
|
#
|
16571
16721
|
# @!attribute [rw] recommendations_display_name
|
16572
16722
|
# A custom display name for the standard endpoint or user attribute
|
16573
|
-
# (RecommendationItems) that temporarily stores
|
16723
|
+
# (RecommendationItems) that temporarily stores recommended items for
|
16574
16724
|
# each endpoint or user, depending on the value for the
|
16575
|
-
#
|
16725
|
+
# RecommendationProviderIdType property. This value is required if the
|
16576
16726
|
# configuration doesn't invoke an AWS Lambda function
|
16577
|
-
# (
|
16727
|
+
# (RecommendationTransformerUri) to perform additional processing of
|
16578
16728
|
# recommendation data.
|
16579
16729
|
#
|
16580
|
-
# This name appears in the **Attribute finder**
|
16581
|
-
#
|
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
|
16582
16732
|
# characters. The characters can be letters, numbers, spaces,
|
16583
16733
|
# underscores (\_), or hyphens (-). These restrictions don't apply to
|
16584
16734
|
# attribute values.
|
@@ -16587,14 +16737,14 @@ module Aws::Pinpoint
|
|
16587
16737
|
# @!attribute [rw] recommendations_per_message
|
16588
16738
|
# The number of recommended items to retrieve from the model for each
|
16589
16739
|
# endpoint or user, depending on the value for the
|
16590
|
-
#
|
16591
|
-
# recommended
|
16592
|
-
#
|
16593
|
-
#
|
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.
|
16594
16744
|
#
|
16595
16745
|
# To use multiple recommended items and custom attributes with message
|
16596
16746
|
# variables, you have to use an AWS Lambda function
|
16597
|
-
# (
|
16747
|
+
# (RecommendationTransformerUri) to perform additional processing of
|
16598
16748
|
# recommendation data.
|
16599
16749
|
# @return [Integer]
|
16600
16750
|
#
|
@@ -17490,13 +17640,15 @@ module Aws::Pinpoint
|
|
17490
17640
|
# }
|
17491
17641
|
#
|
17492
17642
|
# @!attribute [rw] campaign_hook
|
17493
|
-
# The settings for the AWS Lambda function to
|
17494
|
-
# hook for campaigns in the application.
|
17495
|
-
#
|
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
|
17496
17649
|
# linkend="apps-application-id-campaigns-campaign-id" />
|
17497
17650
|
#
|
17498
|
-
# Campaign</link> resource
|
17499
|
-
# for the campaign.
|
17651
|
+
# Campaign</link> resource.
|
17500
17652
|
# @return [Types::CampaignHook]
|
17501
17653
|
#
|
17502
17654
|
# @!attribute [rw] cloud_watch_metrics_enabled
|
@@ -17505,11 +17657,15 @@ module Aws::Pinpoint
|
|
17505
17657
|
# @return [Boolean]
|
17506
17658
|
#
|
17507
17659
|
# @!attribute [rw] limits
|
17508
|
-
# The default sending limits for campaigns in the
|
17509
|
-
# 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
|
17510
17663
|
# linkend="apps-application-id-campaigns-campaign-id" />
|
17511
17664
|
#
|
17512
|
-
# Campaign</link> resource
|
17665
|
+
# Campaign</link> resource or the <link
|
17666
|
+
# linkend="apps-application-id-journeys-journey-id" />
|
17667
|
+
#
|
17668
|
+
# Journey</link> resource, respectively.
|
17513
17669
|
# @return [Types::CampaignLimits]
|
17514
17670
|
#
|
17515
17671
|
# @!attribute [rw] quiet_time
|
@@ -17563,6 +17719,10 @@ module Aws::Pinpoint
|
|
17563
17719
|
# {
|
17564
17720
|
# additional_treatments: [
|
17565
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
|
+
# },
|
17566
17726
|
# message_configuration: {
|
17567
17727
|
# adm_message: {
|
17568
17728
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -17606,6 +17766,9 @@ module Aws::Pinpoint
|
|
17606
17766
|
# title: "__string",
|
17607
17767
|
# url: "__string",
|
17608
17768
|
# },
|
17769
|
+
# custom_message: {
|
17770
|
+
# data: "__string",
|
17771
|
+
# },
|
17609
17772
|
# default_message: {
|
17610
17773
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
17611
17774
|
# body: "__string",
|
@@ -17701,6 +17864,10 @@ module Aws::Pinpoint
|
|
17701
17864
|
# treatment_name: "__string",
|
17702
17865
|
# },
|
17703
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
|
+
# },
|
17704
17871
|
# description: "__string",
|
17705
17872
|
# holdout_percent: 1,
|
17706
17873
|
# hook: {
|
@@ -17758,6 +17925,9 @@ module Aws::Pinpoint
|
|
17758
17925
|
# title: "__string",
|
17759
17926
|
# url: "__string",
|
17760
17927
|
# },
|
17928
|
+
# custom_message: {
|
17929
|
+
# data: "__string",
|
17930
|
+
# },
|
17761
17931
|
# default_message: {
|
17762
17932
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
17763
17933
|
# body: "__string",
|
@@ -17863,6 +18033,13 @@ module Aws::Pinpoint
|
|
17863
18033
|
# campaign, in addition to the default treatment for the campaign.
|
17864
18034
|
# @return [Array<Types::WriteTreatmentResource>]
|
17865
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
|
+
#
|
17866
18043
|
# @!attribute [rw] description
|
17867
18044
|
# A custom description of the campaign.
|
17868
18045
|
# @return [String]
|
@@ -17873,13 +18050,14 @@ module Aws::Pinpoint
|
|
17873
18050
|
# @return [Integer]
|
17874
18051
|
#
|
17875
18052
|
# @!attribute [rw] hook
|
17876
|
-
# The settings for the AWS Lambda function to
|
17877
|
-
# 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.
|
17878
18056
|
# @return [Types::CampaignHook]
|
17879
18057
|
#
|
17880
18058
|
# @!attribute [rw] is_paused
|
17881
18059
|
# Specifies whether to pause the campaign. A paused campaign doesn't
|
17882
|
-
# run unless you resume it by
|
18060
|
+
# run unless you resume it by changing this value to false.
|
17883
18061
|
# @return [Boolean]
|
17884
18062
|
#
|
17885
18063
|
# @!attribute [rw] limits
|
@@ -17918,19 +18096,20 @@ module Aws::Pinpoint
|
|
17918
18096
|
# @return [Types::TemplateConfiguration]
|
17919
18097
|
#
|
17920
18098
|
# @!attribute [rw] treatment_description
|
17921
|
-
# A custom description of
|
17922
|
-
# testing.
|
18099
|
+
# A custom description of the default treatment for the campaign.
|
17923
18100
|
# @return [String]
|
17924
18101
|
#
|
17925
18102
|
# @!attribute [rw] treatment_name
|
17926
|
-
# A custom name
|
17927
|
-
#
|
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.
|
17928
18106
|
# @return [String]
|
17929
18107
|
#
|
17930
18108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteCampaignRequest AWS API Documentation
|
17931
18109
|
#
|
17932
18110
|
class WriteCampaignRequest < Struct.new(
|
17933
18111
|
:additional_treatments,
|
18112
|
+
:custom_delivery_configuration,
|
17934
18113
|
:description,
|
17935
18114
|
:holdout_percent,
|
17936
18115
|
:hook,
|
@@ -18561,13 +18740,17 @@ module Aws::Pinpoint
|
|
18561
18740
|
include Aws::Structure
|
18562
18741
|
end
|
18563
18742
|
|
18564
|
-
# Specifies the settings for a campaign treatment. A treatment is a
|
18743
|
+
# Specifies the settings for a campaign treatment. A *treatment* is a
|
18565
18744
|
# variation of a campaign that's used for A/B testing of a campaign.
|
18566
18745
|
#
|
18567
18746
|
# @note When making an API call, you may pass WriteTreatmentResource
|
18568
18747
|
# data as a hash:
|
18569
18748
|
#
|
18570
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
|
+
# },
|
18571
18754
|
# message_configuration: {
|
18572
18755
|
# adm_message: {
|
18573
18756
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -18611,6 +18794,9 @@ module Aws::Pinpoint
|
|
18611
18794
|
# title: "__string",
|
18612
18795
|
# url: "__string",
|
18613
18796
|
# },
|
18797
|
+
# custom_message: {
|
18798
|
+
# data: "__string",
|
18799
|
+
# },
|
18614
18800
|
# default_message: {
|
18615
18801
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
18616
18802
|
# body: "__string",
|
@@ -18706,6 +18892,13 @@ module Aws::Pinpoint
|
|
18706
18892
|
# treatment_name: "__string",
|
18707
18893
|
# }
|
18708
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
|
+
#
|
18709
18902
|
# @!attribute [rw] message_configuration
|
18710
18903
|
# The message configuration settings for the treatment.
|
18711
18904
|
# @return [Types::MessageConfiguration]
|
@@ -18728,13 +18921,13 @@ module Aws::Pinpoint
|
|
18728
18921
|
# @return [String]
|
18729
18922
|
#
|
18730
18923
|
# @!attribute [rw] treatment_name
|
18731
|
-
# A custom name for the treatment.
|
18732
|
-
# campaign that's used for A/B testing of a campaign.
|
18924
|
+
# A custom name for the treatment.
|
18733
18925
|
# @return [String]
|
18734
18926
|
#
|
18735
18927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteTreatmentResource AWS API Documentation
|
18736
18928
|
#
|
18737
18929
|
class WriteTreatmentResource < Struct.new(
|
18930
|
+
:custom_delivery_configuration,
|
18738
18931
|
:message_configuration,
|
18739
18932
|
:schedule,
|
18740
18933
|
:size_percent,
|