aws-sdk-pinpoint 1.37.0 → 1.42.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -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,8 @@ 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')
87
+ CustomMessageActivity = Shapes::StructureShape.new(name: 'CustomMessageActivity')
85
88
  DefaultMessage = Shapes::StructureShape.new(name: 'DefaultMessage')
86
89
  DefaultPushNotificationMessage = Shapes::StructureShape.new(name: 'DefaultPushNotificationMessage')
87
90
  DefaultPushNotificationTemplate = Shapes::StructureShape.new(name: 'DefaultPushNotificationTemplate')
@@ -268,12 +271,15 @@ module Aws::Pinpoint
268
271
  InternalServerErrorException = Shapes::StructureShape.new(name: 'InternalServerErrorException')
269
272
  ItemResponse = Shapes::StructureShape.new(name: 'ItemResponse')
270
273
  JobStatus = Shapes::StringShape.new(name: 'JobStatus')
274
+ JourneyCustomMessage = Shapes::StructureShape.new(name: 'JourneyCustomMessage')
271
275
  JourneyDateRangeKpiResponse = Shapes::StructureShape.new(name: 'JourneyDateRangeKpiResponse')
272
276
  JourneyEmailMessage = Shapes::StructureShape.new(name: 'JourneyEmailMessage')
273
277
  JourneyExecutionActivityMetricsResponse = Shapes::StructureShape.new(name: 'JourneyExecutionActivityMetricsResponse')
274
278
  JourneyExecutionMetricsResponse = Shapes::StructureShape.new(name: 'JourneyExecutionMetricsResponse')
275
279
  JourneyLimits = Shapes::StructureShape.new(name: 'JourneyLimits')
280
+ JourneyPushMessage = Shapes::StructureShape.new(name: 'JourneyPushMessage')
276
281
  JourneyResponse = Shapes::StructureShape.new(name: 'JourneyResponse')
282
+ JourneySMSMessage = Shapes::StructureShape.new(name: 'JourneySMSMessage')
277
283
  JourneySchedule = Shapes::StructureShape.new(name: 'JourneySchedule')
278
284
  JourneyStateRequest = Shapes::StructureShape.new(name: 'JourneyStateRequest')
279
285
  JourneysResponse = Shapes::StructureShape.new(name: 'JourneysResponse')
@@ -301,6 +307,7 @@ module Aws::Pinpoint
301
307
  ListOfTemplateVersionResponse = Shapes::ListShape.new(name: 'ListOfTemplateVersionResponse')
302
308
  ListOfTreatmentResource = Shapes::ListShape.new(name: 'ListOfTreatmentResource')
303
309
  ListOfWriteTreatmentResource = Shapes::ListShape.new(name: 'ListOfWriteTreatmentResource')
310
+ ListOf__EndpointTypesElement = Shapes::ListShape.new(name: 'ListOf__EndpointTypesElement')
304
311
  ListOf__string = Shapes::ListShape.new(name: 'ListOf__string')
305
312
  ListRecommenderConfigurationsResponse = Shapes::StructureShape.new(name: 'ListRecommenderConfigurationsResponse')
306
313
  ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
@@ -346,6 +353,7 @@ module Aws::Pinpoint
346
353
  PhoneNumberValidateRequest = Shapes::StructureShape.new(name: 'PhoneNumberValidateRequest')
347
354
  PhoneNumberValidateResponse = Shapes::StructureShape.new(name: 'PhoneNumberValidateResponse')
348
355
  PublicEndpoint = Shapes::StructureShape.new(name: 'PublicEndpoint')
356
+ PushMessageActivity = Shapes::StructureShape.new(name: 'PushMessageActivity')
349
357
  PushNotificationTemplateRequest = Shapes::StructureShape.new(name: 'PushNotificationTemplateRequest')
350
358
  PushNotificationTemplateResponse = Shapes::StructureShape.new(name: 'PushNotificationTemplateResponse')
351
359
  PutEventStreamRequest = Shapes::StructureShape.new(name: 'PutEventStreamRequest')
@@ -366,6 +374,7 @@ module Aws::Pinpoint
366
374
  SMSChannelRequest = Shapes::StructureShape.new(name: 'SMSChannelRequest')
367
375
  SMSChannelResponse = Shapes::StructureShape.new(name: 'SMSChannelResponse')
368
376
  SMSMessage = Shapes::StructureShape.new(name: 'SMSMessage')
377
+ SMSMessageActivity = Shapes::StructureShape.new(name: 'SMSMessageActivity')
369
378
  SMSTemplateRequest = Shapes::StructureShape.new(name: 'SMSTemplateRequest')
370
379
  SMSTemplateResponse = Shapes::StructureShape.new(name: 'SMSTemplateResponse')
371
380
  Schedule = Shapes::StructureShape.new(name: 'Schedule')
@@ -470,6 +479,7 @@ module Aws::Pinpoint
470
479
  WriteJourneyRequest = Shapes::StructureShape.new(name: 'WriteJourneyRequest')
471
480
  WriteSegmentRequest = Shapes::StructureShape.new(name: 'WriteSegmentRequest')
472
481
  WriteTreatmentResource = Shapes::StructureShape.new(name: 'WriteTreatmentResource')
482
+ __EndpointTypesElement = Shapes::StringShape.new(name: '__EndpointTypesElement')
473
483
  __blob = Shapes::BlobShape.new(name: '__blob')
474
484
  __boolean = Shapes::BooleanShape.new(name: '__boolean')
475
485
  __double = Shapes::FloatShape.new(name: '__double')
@@ -643,12 +653,15 @@ module Aws::Pinpoint
643
653
  ActivitiesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "NextToken"))
644
654
  ActivitiesResponse.struct_class = Types::ActivitiesResponse
645
655
 
656
+ Activity.add_member(:custom, Shapes::ShapeRef.new(shape: CustomMessageActivity, location_name: "CUSTOM"))
646
657
  Activity.add_member(:conditional_split, Shapes::ShapeRef.new(shape: ConditionalSplitActivity, location_name: "ConditionalSplit"))
647
658
  Activity.add_member(:description, Shapes::ShapeRef.new(shape: __string, location_name: "Description"))
648
659
  Activity.add_member(:email, Shapes::ShapeRef.new(shape: EmailMessageActivity, location_name: "EMAIL"))
649
660
  Activity.add_member(:holdout, Shapes::ShapeRef.new(shape: HoldoutActivity, location_name: "Holdout"))
650
661
  Activity.add_member(:multi_condition, Shapes::ShapeRef.new(shape: MultiConditionalSplitActivity, location_name: "MultiCondition"))
662
+ Activity.add_member(:push, Shapes::ShapeRef.new(shape: PushMessageActivity, location_name: "PUSH"))
651
663
  Activity.add_member(:random_split, Shapes::ShapeRef.new(shape: RandomSplitActivity, location_name: "RandomSplit"))
664
+ Activity.add_member(:sms, Shapes::ShapeRef.new(shape: SMSMessageActivity, location_name: "SMS"))
652
665
  Activity.add_member(:wait, Shapes::ShapeRef.new(shape: WaitActivity, location_name: "Wait"))
653
666
  Activity.struct_class = Types::Activity
654
667
 
@@ -761,6 +774,9 @@ module Aws::Pinpoint
761
774
  BaseKpiResult.add_member(:rows, Shapes::ShapeRef.new(shape: ListOfResultRow, required: true, location_name: "Rows"))
762
775
  BaseKpiResult.struct_class = Types::BaseKpiResult
763
776
 
777
+ CampaignCustomMessage.add_member(:data, Shapes::ShapeRef.new(shape: __string, location_name: "Data"))
778
+ CampaignCustomMessage.struct_class = Types::CampaignCustomMessage
779
+
764
780
  CampaignDateRangeKpiResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
765
781
  CampaignDateRangeKpiResponse.add_member(:campaign_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "CampaignId"))
766
782
  CampaignDateRangeKpiResponse.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampIso8601, required: true, location_name: "EndTime"))
@@ -795,6 +811,7 @@ module Aws::Pinpoint
795
811
  CampaignResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
796
812
  CampaignResponse.add_member(:arn, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Arn"))
797
813
  CampaignResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "CreationDate"))
814
+ CampaignResponse.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
798
815
  CampaignResponse.add_member(:default_state, Shapes::ShapeRef.new(shape: CampaignState, location_name: "DefaultState"))
799
816
  CampaignResponse.add_member(:description, Shapes::ShapeRef.new(shape: __string, location_name: "Description"))
800
817
  CampaignResponse.add_member(:holdout_percent, Shapes::ShapeRef.new(shape: __integer, location_name: "HoldoutPercent"))
@@ -991,6 +1008,18 @@ module Aws::Pinpoint
991
1008
  CreateVoiceTemplateResponse[:payload] = :create_template_message_body
992
1009
  CreateVoiceTemplateResponse[:payload_member] = CreateVoiceTemplateResponse.member(:create_template_message_body)
993
1010
 
1011
+ CustomDeliveryConfiguration.add_member(:delivery_uri, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "DeliveryUri"))
1012
+ CustomDeliveryConfiguration.add_member(:endpoint_types, Shapes::ShapeRef.new(shape: ListOf__EndpointTypesElement, location_name: "EndpointTypes"))
1013
+ CustomDeliveryConfiguration.struct_class = Types::CustomDeliveryConfiguration
1014
+
1015
+ CustomMessageActivity.add_member(:delivery_uri, Shapes::ShapeRef.new(shape: __string, location_name: "DeliveryUri"))
1016
+ CustomMessageActivity.add_member(:endpoint_types, Shapes::ShapeRef.new(shape: ListOf__EndpointTypesElement, location_name: "EndpointTypes"))
1017
+ CustomMessageActivity.add_member(:message_config, Shapes::ShapeRef.new(shape: JourneyCustomMessage, location_name: "MessageConfig"))
1018
+ CustomMessageActivity.add_member(:next_activity, Shapes::ShapeRef.new(shape: __string, location_name: "NextActivity"))
1019
+ CustomMessageActivity.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateName"))
1020
+ CustomMessageActivity.add_member(:template_version, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateVersion"))
1021
+ CustomMessageActivity.struct_class = Types::CustomMessageActivity
1022
+
994
1023
  DefaultMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
995
1024
  DefaultMessage.add_member(:substitutions, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Substitutions"))
996
1025
  DefaultMessage.struct_class = Types::DefaultMessage
@@ -1950,6 +1979,9 @@ module Aws::Pinpoint
1950
1979
  ItemResponse.add_member(:events_item_response, Shapes::ShapeRef.new(shape: MapOfEventItemResponse, location_name: "EventsItemResponse"))
1951
1980
  ItemResponse.struct_class = Types::ItemResponse
1952
1981
 
1982
+ JourneyCustomMessage.add_member(:data, Shapes::ShapeRef.new(shape: __string, location_name: "Data"))
1983
+ JourneyCustomMessage.struct_class = Types::JourneyCustomMessage
1984
+
1953
1985
  JourneyDateRangeKpiResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
1954
1986
  JourneyDateRangeKpiResponse.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampIso8601, required: true, location_name: "EndTime"))
1955
1987
  JourneyDateRangeKpiResponse.add_member(:journey_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "JourneyId"))
@@ -1981,6 +2013,9 @@ module Aws::Pinpoint
1981
2013
  JourneyLimits.add_member(:messages_per_second, Shapes::ShapeRef.new(shape: __integer, location_name: "MessagesPerSecond"))
1982
2014
  JourneyLimits.struct_class = Types::JourneyLimits
1983
2015
 
2016
+ JourneyPushMessage.add_member(:time_to_live, Shapes::ShapeRef.new(shape: __string, location_name: "TimeToLive"))
2017
+ JourneyPushMessage.struct_class = Types::JourneyPushMessage
2018
+
1984
2019
  JourneyResponse.add_member(:activities, Shapes::ShapeRef.new(shape: MapOfActivity, location_name: "Activities"))
1985
2020
  JourneyResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
1986
2021
  JourneyResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: __string, location_name: "CreationDate"))
@@ -1998,6 +2033,10 @@ module Aws::Pinpoint
1998
2033
  JourneyResponse.add_member(:tags, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "tags"))
1999
2034
  JourneyResponse.struct_class = Types::JourneyResponse
2000
2035
 
2036
+ JourneySMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
2037
+ JourneySMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
2038
+ JourneySMSMessage.struct_class = Types::JourneySMSMessage
2039
+
2001
2040
  JourneySchedule.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampIso8601, location_name: "EndTime"))
2002
2041
  JourneySchedule.add_member(:start_time, Shapes::ShapeRef.new(shape: __timestampIso8601, location_name: "StartTime"))
2003
2042
  JourneySchedule.add_member(:timezone, Shapes::ShapeRef.new(shape: __string, location_name: "Timezone"))
@@ -2064,6 +2103,8 @@ module Aws::Pinpoint
2064
2103
 
2065
2104
  ListOfWriteTreatmentResource.member = Shapes::ShapeRef.new(shape: WriteTreatmentResource)
2066
2105
 
2106
+ ListOf__EndpointTypesElement.member = Shapes::ShapeRef.new(shape: __EndpointTypesElement)
2107
+
2067
2108
  ListOf__string.member = Shapes::ShapeRef.new(shape: __string)
2068
2109
 
2069
2110
  ListRecommenderConfigurationsResponse.add_member(:item, Shapes::ShapeRef.new(shape: ListOfRecommenderConfigurationResponse, required: true, location_name: "Item"))
@@ -2172,6 +2213,7 @@ module Aws::Pinpoint
2172
2213
  MessageConfiguration.add_member(:adm_message, Shapes::ShapeRef.new(shape: Message, location_name: "ADMMessage"))
2173
2214
  MessageConfiguration.add_member(:apns_message, Shapes::ShapeRef.new(shape: Message, location_name: "APNSMessage"))
2174
2215
  MessageConfiguration.add_member(:baidu_message, Shapes::ShapeRef.new(shape: Message, location_name: "BaiduMessage"))
2216
+ MessageConfiguration.add_member(:custom_message, Shapes::ShapeRef.new(shape: CampaignCustomMessage, location_name: "CustomMessage"))
2175
2217
  MessageConfiguration.add_member(:default_message, Shapes::ShapeRef.new(shape: Message, location_name: "DefaultMessage"))
2176
2218
  MessageConfiguration.add_member(:email_message, Shapes::ShapeRef.new(shape: CampaignEmailMessage, location_name: "EmailMessage"))
2177
2219
  MessageConfiguration.add_member(:gcm_message, Shapes::ShapeRef.new(shape: Message, location_name: "GCMMessage"))
@@ -2267,6 +2309,12 @@ module Aws::Pinpoint
2267
2309
  PublicEndpoint.add_member(:user, Shapes::ShapeRef.new(shape: EndpointUser, location_name: "User"))
2268
2310
  PublicEndpoint.struct_class = Types::PublicEndpoint
2269
2311
 
2312
+ PushMessageActivity.add_member(:message_config, Shapes::ShapeRef.new(shape: JourneyPushMessage, location_name: "MessageConfig"))
2313
+ PushMessageActivity.add_member(:next_activity, Shapes::ShapeRef.new(shape: __string, location_name: "NextActivity"))
2314
+ PushMessageActivity.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateName"))
2315
+ PushMessageActivity.add_member(:template_version, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateVersion"))
2316
+ PushMessageActivity.struct_class = Types::PushMessageActivity
2317
+
2270
2318
  PushNotificationTemplateRequest.add_member(:adm, Shapes::ShapeRef.new(shape: AndroidPushNotificationTemplate, location_name: "ADM"))
2271
2319
  PushNotificationTemplateRequest.add_member(:apns, Shapes::ShapeRef.new(shape: APNSPushNotificationTemplate, location_name: "APNS"))
2272
2320
  PushNotificationTemplateRequest.add_member(:baidu, Shapes::ShapeRef.new(shape: AndroidPushNotificationTemplate, location_name: "Baidu"))
@@ -2400,6 +2448,12 @@ module Aws::Pinpoint
2400
2448
  SMSMessage.add_member(:substitutions, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Substitutions"))
2401
2449
  SMSMessage.struct_class = Types::SMSMessage
2402
2450
 
2451
+ SMSMessageActivity.add_member(:message_config, Shapes::ShapeRef.new(shape: JourneySMSMessage, location_name: "MessageConfig"))
2452
+ SMSMessageActivity.add_member(:next_activity, Shapes::ShapeRef.new(shape: __string, location_name: "NextActivity"))
2453
+ SMSMessageActivity.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateName"))
2454
+ SMSMessageActivity.add_member(:template_version, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateVersion"))
2455
+ SMSMessageActivity.struct_class = Types::SMSMessageActivity
2456
+
2403
2457
  SMSTemplateRequest.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
2404
2458
  SMSTemplateRequest.add_member(:default_substitutions, Shapes::ShapeRef.new(shape: __string, location_name: "DefaultSubstitutions"))
2405
2459
  SMSTemplateRequest.add_member(:recommender_id, Shapes::ShapeRef.new(shape: __string, location_name: "RecommenderId"))
@@ -2613,6 +2667,7 @@ module Aws::Pinpoint
2613
2667
  TooManyRequestsException.add_member(:request_id, Shapes::ShapeRef.new(shape: __string, location_name: "RequestID"))
2614
2668
  TooManyRequestsException.struct_class = Types::TooManyRequestsException
2615
2669
 
2670
+ TreatmentResource.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
2616
2671
  TreatmentResource.add_member(:id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Id"))
2617
2672
  TreatmentResource.add_member(:message_configuration, Shapes::ShapeRef.new(shape: MessageConfiguration, location_name: "MessageConfiguration"))
2618
2673
  TreatmentResource.add_member(:schedule, Shapes::ShapeRef.new(shape: Schedule, location_name: "Schedule"))
@@ -2967,6 +3022,7 @@ module Aws::Pinpoint
2967
3022
  WriteApplicationSettingsRequest.struct_class = Types::WriteApplicationSettingsRequest
2968
3023
 
2969
3024
  WriteCampaignRequest.add_member(:additional_treatments, Shapes::ShapeRef.new(shape: ListOfWriteTreatmentResource, location_name: "AdditionalTreatments"))
3025
+ WriteCampaignRequest.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
2970
3026
  WriteCampaignRequest.add_member(:description, Shapes::ShapeRef.new(shape: __string, location_name: "Description"))
2971
3027
  WriteCampaignRequest.add_member(:holdout_percent, Shapes::ShapeRef.new(shape: __integer, location_name: "HoldoutPercent"))
2972
3028
  WriteCampaignRequest.add_member(:hook, Shapes::ShapeRef.new(shape: CampaignHook, location_name: "Hook"))
@@ -3007,6 +3063,7 @@ module Aws::Pinpoint
3007
3063
  WriteSegmentRequest.add_member(:tags, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "tags"))
3008
3064
  WriteSegmentRequest.struct_class = Types::WriteSegmentRequest
3009
3065
 
3066
+ WriteTreatmentResource.add_member(:custom_delivery_configuration, Shapes::ShapeRef.new(shape: CustomDeliveryConfiguration, location_name: "CustomDeliveryConfiguration"))
3010
3067
  WriteTreatmentResource.add_member(:message_configuration, Shapes::ShapeRef.new(shape: MessageConfiguration, location_name: "MessageConfiguration"))
3011
3068
  WriteTreatmentResource.add_member(:schedule, Shapes::ShapeRef.new(shape: Schedule, location_name: "Schedule"))
3012
3069
  WriteTreatmentResource.add_member(:size_percent, Shapes::ShapeRef.new(shape: __integer, required: true, location_name: "SizePercent"))
@@ -1234,6 +1234,16 @@ module Aws::Pinpoint
1234
1234
  # data as a hash:
1235
1235
  #
1236
1236
  # {
1237
+ # custom: {
1238
+ # delivery_uri: "__string",
1239
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
1240
+ # message_config: {
1241
+ # data: "__string",
1242
+ # },
1243
+ # next_activity: "__string",
1244
+ # template_name: "__string",
1245
+ # template_version: "__string",
1246
+ # },
1237
1247
  # conditional_split: {
1238
1248
  # condition: {
1239
1249
  # conditions: [
@@ -1454,6 +1464,14 @@ module Aws::Pinpoint
1454
1464
  # wait_until: "__string",
1455
1465
  # },
1456
1466
  # },
1467
+ # push: {
1468
+ # message_config: {
1469
+ # time_to_live: "__string",
1470
+ # },
1471
+ # next_activity: "__string",
1472
+ # template_name: "__string",
1473
+ # template_version: "__string",
1474
+ # },
1457
1475
  # random_split: {
1458
1476
  # branches: [
1459
1477
  # {
@@ -1462,6 +1480,15 @@ module Aws::Pinpoint
1462
1480
  # },
1463
1481
  # ],
1464
1482
  # },
1483
+ # sms: {
1484
+ # message_config: {
1485
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
1486
+ # sender_id: "__string",
1487
+ # },
1488
+ # next_activity: "__string",
1489
+ # template_name: "__string",
1490
+ # template_version: "__string",
1491
+ # },
1465
1492
  # wait: {
1466
1493
  # next_activity: "__string",
1467
1494
  # wait_time: {
@@ -1471,6 +1498,12 @@ module Aws::Pinpoint
1471
1498
  # },
1472
1499
  # }
1473
1500
  #
1501
+ # @!attribute [rw] custom
1502
+ # The settings for a custom message activity. This type of activity
1503
+ # calls an AWS Lambda function or web hook that sends messages to
1504
+ # participants.
1505
+ # @return [Types::CustomMessageActivity]
1506
+ #
1474
1507
  # @!attribute [rw] conditional_split
1475
1508
  # The settings for a yes/no split activity. This type of activity
1476
1509
  # sends participants down one of two paths in a journey, based on
@@ -1498,6 +1531,11 @@ module Aws::Pinpoint
1498
1531
  # that you specify.
1499
1532
  # @return [Types::MultiConditionalSplitActivity]
1500
1533
  #
1534
+ # @!attribute [rw] push
1535
+ # The settings for a push notification activity. This type of activity
1536
+ # sends a push notification to participants.
1537
+ # @return [Types::PushMessageActivity]
1538
+ #
1501
1539
  # @!attribute [rw] random_split
1502
1540
  # The settings for a random split activity. This type of activity
1503
1541
  # randomly sends specified percentages of participants down one of as
@@ -1505,6 +1543,11 @@ module Aws::Pinpoint
1505
1543
  # specify.
1506
1544
  # @return [Types::RandomSplitActivity]
1507
1545
  #
1546
+ # @!attribute [rw] sms
1547
+ # The settings for an SMS activity. This type of activity sends a text
1548
+ # message to participants.
1549
+ # @return [Types::SMSMessageActivity]
1550
+ #
1508
1551
  # @!attribute [rw] wait
1509
1552
  # The settings for a wait activity. This type of activity waits for a
1510
1553
  # certain amount of time or until a specific date and time before
@@ -1514,12 +1557,15 @@ module Aws::Pinpoint
1514
1557
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Activity AWS API Documentation
1515
1558
  #
1516
1559
  class Activity < Struct.new(
1560
+ :custom,
1517
1561
  :conditional_split,
1518
1562
  :description,
1519
1563
  :email,
1520
1564
  :holdout,
1521
1565
  :multi_condition,
1566
+ :push,
1522
1567
  :random_split,
1568
+ :sms,
1523
1569
  :wait)
1524
1570
  include Aws::Structure
1525
1571
  end
@@ -1615,7 +1661,7 @@ module Aws::Pinpoint
1615
1661
  #
1616
1662
  # {
1617
1663
  # body_override: "__string",
1618
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
1664
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
1619
1665
  # context: {
1620
1666
  # "__string" => "__string",
1621
1667
  # },
@@ -1795,7 +1841,7 @@ module Aws::Pinpoint
1795
1841
  #
1796
1842
  #
1797
1843
  #
1798
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
1844
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
1799
1845
  # @return [String]
1800
1846
  #
1801
1847
  # @!attribute [rw] kpi_result
@@ -1870,8 +1916,9 @@ module Aws::Pinpoint
1870
1916
  # @return [String]
1871
1917
  #
1872
1918
  # @!attribute [rw] campaign_hook
1873
- # The settings for the AWS Lambda function to use by default as a code
1874
- # hook for campaigns in the application.
1919
+ # The settings for the AWS Lambda function to invoke by default as a
1920
+ # code hook for campaigns in the application. You can use this hook to
1921
+ # customize segments that are used by campaigns in the application.
1875
1922
  # @return [Types::CampaignHook]
1876
1923
  #
1877
1924
  # @!attribute [rw] last_modified_date
@@ -1880,7 +1927,8 @@ module Aws::Pinpoint
1880
1927
  # @return [String]
1881
1928
  #
1882
1929
  # @!attribute [rw] limits
1883
- # The default sending limits for campaigns in the application.
1930
+ # The default sending limits for campaigns and journeys in the
1931
+ # application.
1884
1932
  # @return [Types::CampaignLimits]
1885
1933
  #
1886
1934
  # @!attribute [rw] quiet_time
@@ -2276,6 +2324,28 @@ module Aws::Pinpoint
2276
2324
  include Aws::Structure
2277
2325
  end
2278
2326
 
2327
+ # Specifies the contents of a message that's sent through a custom
2328
+ # channel to recipients of a campaign.
2329
+ #
2330
+ # @note When making an API call, you may pass CampaignCustomMessage
2331
+ # data as a hash:
2332
+ #
2333
+ # {
2334
+ # data: "__string",
2335
+ # }
2336
+ #
2337
+ # @!attribute [rw] data
2338
+ # The raw, JSON-formatted string to use as the payload for the
2339
+ # message. The maximum size is 5 KB.
2340
+ # @return [String]
2341
+ #
2342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignCustomMessage AWS API Documentation
2343
+ #
2344
+ class CampaignCustomMessage < Struct.new(
2345
+ :data)
2346
+ include Aws::Structure
2347
+ end
2348
+
2279
2349
  # Provides the results of a query that retrieved the data for a standard
2280
2350
  # metric that applies to a campaign, and provides information about that
2281
2351
  # query.
@@ -2305,7 +2375,7 @@ module Aws::Pinpoint
2305
2375
  #
2306
2376
  #
2307
2377
  #
2308
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
2378
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
2309
2379
  # @return [String]
2310
2380
  #
2311
2381
  # @!attribute [rw] kpi_result
@@ -2431,8 +2501,8 @@ module Aws::Pinpoint
2431
2501
  include Aws::Structure
2432
2502
  end
2433
2503
 
2434
- # Specifies the AWS Lambda function to use as a code hook for a
2435
- # campaign.
2504
+ # Specifies settings for invoking an AWS Lambda function that customizes
2505
+ # a segment for a campaign.
2436
2506
  #
2437
2507
  # @note When making an API call, you may pass CampaignHook
2438
2508
  # data as a hash:
@@ -2445,12 +2515,21 @@ module Aws::Pinpoint
2445
2515
  #
2446
2516
  # @!attribute [rw] lambda_function_name
2447
2517
  # The name or Amazon Resource Name (ARN) of the AWS Lambda function
2448
- # that Amazon Pinpoint invokes to send messages for a campaign.
2518
+ # that Amazon Pinpoint invokes to customize a segment for a campaign.
2449
2519
  # @return [String]
2450
2520
  #
2451
2521
  # @!attribute [rw] mode
2452
- # Specifies which Lambda mode to use when invoking the AWS Lambda
2453
- # function.
2522
+ # The mode that Amazon Pinpoint uses to invoke the AWS Lambda
2523
+ # function. Possible values are:
2524
+ #
2525
+ # * FILTER - Invoke the function to customize the segment that's used
2526
+ # by a campaign.
2527
+ #
2528
+ # * DELIVERY - (Deprecated) Previously, invoked the function to send a
2529
+ # campaign through a custom channel. This functionality is not
2530
+ # supported anymore. To send a campaign through a custom channel,
2531
+ # use the CustomDeliveryConfiguration and CampaignCustomMessage
2532
+ # objects of the campaign.
2454
2533
  # @return [String]
2455
2534
  #
2456
2535
  # @!attribute [rw] web_url
@@ -2467,7 +2546,9 @@ module Aws::Pinpoint
2467
2546
  include Aws::Structure
2468
2547
  end
2469
2548
 
2470
- # Specifies limits on the messages that a campaign can send.
2549
+ # For a campaign, specifies limits on the messages that the campaign can
2550
+ # send. For an application, specifies the default limits for messages
2551
+ # that campaigns and journeys in the application can send.
2471
2552
  #
2472
2553
  # @note When making an API call, you may pass CampaignLimits
2473
2554
  # data as a hash:
@@ -2481,7 +2562,10 @@ module Aws::Pinpoint
2481
2562
  #
2482
2563
  # @!attribute [rw] daily
2483
2564
  # The maximum number of messages that a campaign can send to a single
2484
- # endpoint during a 24-hour period. The maximum value is 100.
2565
+ # endpoint during a 24-hour period. For an application, this value
2566
+ # specifies the default limit for the number of messages that
2567
+ # campaigns and journeys can send to a single endpoint during a
2568
+ # 24-hour period. The maximum value is 100.
2485
2569
  # @return [Integer]
2486
2570
  #
2487
2571
  # @!attribute [rw] maximum_duration
@@ -2492,13 +2576,16 @@ module Aws::Pinpoint
2492
2576
  #
2493
2577
  # @!attribute [rw] messages_per_second
2494
2578
  # The maximum number of messages that a campaign can send each second.
2579
+ # For an application, this value specifies the default limit for the
2580
+ # number of messages that campaigns and journeys can send each second.
2495
2581
  # The minimum value is 50. The maximum value is 20,000.
2496
2582
  # @return [Integer]
2497
2583
  #
2498
2584
  # @!attribute [rw] total
2499
2585
  # The maximum number of messages that a campaign can send to a single
2500
- # endpoint during the course of the campaign. The maximum value is
2501
- # 100.
2586
+ # endpoint during the course of the campaign. If a campaign recurs,
2587
+ # this setting applies to all runs of the campaign. The maximum value
2588
+ # is 100.
2502
2589
  # @return [Integer]
2503
2590
  #
2504
2591
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignLimits AWS API Documentation
@@ -2532,10 +2619,14 @@ module Aws::Pinpoint
2532
2619
  # The date, in ISO 8601 format, when the campaign was created.
2533
2620
  # @return [String]
2534
2621
  #
2622
+ # @!attribute [rw] custom_delivery_configuration
2623
+ # The delivery configuration settings for sending the campaign through
2624
+ # a custom channel.
2625
+ # @return [Types::CustomDeliveryConfiguration]
2626
+ #
2535
2627
  # @!attribute [rw] default_state
2536
2628
  # The current status of the campaign's default treatment. This value
2537
- # exists only for campaigns that have more than one treatment, to
2538
- # support A/B testing.
2629
+ # exists only for campaigns that have more than one treatment.
2539
2630
  # @return [Types::CampaignState]
2540
2631
  #
2541
2632
  # @!attribute [rw] description
@@ -2549,7 +2640,8 @@ module Aws::Pinpoint
2549
2640
  #
2550
2641
  # @!attribute [rw] hook
2551
2642
  # The settings for the AWS Lambda function to use as a code hook for
2552
- # the campaign.
2643
+ # the campaign. You can use this hook to customize the segment that's
2644
+ # used by the campaign.
2553
2645
  # @return [Types::CampaignHook]
2554
2646
  #
2555
2647
  # @!attribute [rw] id
@@ -2606,13 +2698,13 @@ module Aws::Pinpoint
2606
2698
  # @return [Types::TemplateConfiguration]
2607
2699
  #
2608
2700
  # @!attribute [rw] treatment_description
2609
- # The custom description of a variation of the campaign that's used
2610
- # for A/B testing.
2701
+ # The custom description of the default treatment for the campaign.
2611
2702
  # @return [String]
2612
2703
  #
2613
2704
  # @!attribute [rw] treatment_name
2614
- # The custom name of a variation of the campaign that's used for A/B
2615
- # testing.
2705
+ # The custom name of the default treatment for the campaign, if the
2706
+ # campaign has multiple treatments. A *treatment* is a variation of a
2707
+ # campaign that's used for A/B testing.
2616
2708
  # @return [String]
2617
2709
  #
2618
2710
  # @!attribute [rw] version
@@ -2626,6 +2718,7 @@ module Aws::Pinpoint
2626
2718
  :application_id,
2627
2719
  :arn,
2628
2720
  :creation_date,
2721
+ :custom_delivery_configuration,
2629
2722
  :default_state,
2630
2723
  :description,
2631
2724
  :holdout_percent,
@@ -2665,10 +2758,10 @@ module Aws::Pinpoint
2665
2758
  # @return [String]
2666
2759
  #
2667
2760
  # @!attribute [rw] message_type
2668
- # The type of SMS message. Valid values are: TRANSACTIONAL, the
2669
- # message is critical or time-sensitive, such as a one-time password
2670
- # that supports a customer transaction; and, PROMOTIONAL, the message
2671
- # isn't critical or time-sensitive, such as a marketing message.
2761
+ # The SMS message type. Valid values are TRANSACTIONAL (for messages
2762
+ # that are critical or time-sensitive, such as a one-time passwords)
2763
+ # and PROMOTIONAL (for messsages that aren't critical or
2764
+ # time-sensitive, such as marketing messages).
2672
2765
  # @return [String]
2673
2766
  #
2674
2767
  # @!attribute [rw] sender_id
@@ -2689,9 +2782,12 @@ module Aws::Pinpoint
2689
2782
  #
2690
2783
  # @!attribute [rw] campaign_status
2691
2784
  # The current status of the campaign, or the current status of a
2692
- # treatment that belongs to an A/B test campaign. If a campaign uses
2693
- # A/B testing, the campaign has a status of COMPLETED only if all
2694
- # campaign treatments have a status of COMPLETED.
2785
+ # treatment that belongs to an A/B test campaign.
2786
+ #
2787
+ # If a campaign uses A/B testing, the campaign has a status of
2788
+ # COMPLETED only if all campaign treatments have a status of
2789
+ # COMPLETED. If you delete the segment that's associated with a
2790
+ # campaign, the campaign fails and has a status of DELETED.
2695
2791
  # @return [String]
2696
2792
  #
2697
2793
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignState AWS API Documentation
@@ -3137,6 +3233,10 @@ module Aws::Pinpoint
3137
3233
  # write_campaign_request: { # required
3138
3234
  # additional_treatments: [
3139
3235
  # {
3236
+ # custom_delivery_configuration: {
3237
+ # delivery_uri: "__string", # required
3238
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
3239
+ # },
3140
3240
  # message_configuration: {
3141
3241
  # adm_message: {
3142
3242
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
@@ -3180,6 +3280,9 @@ module Aws::Pinpoint
3180
3280
  # title: "__string",
3181
3281
  # url: "__string",
3182
3282
  # },
3283
+ # custom_message: {
3284
+ # data: "__string",
3285
+ # },
3183
3286
  # default_message: {
3184
3287
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
3185
3288
  # body: "__string",
@@ -3275,6 +3378,10 @@ module Aws::Pinpoint
3275
3378
  # treatment_name: "__string",
3276
3379
  # },
3277
3380
  # ],
3381
+ # custom_delivery_configuration: {
3382
+ # delivery_uri: "__string", # required
3383
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
3384
+ # },
3278
3385
  # description: "__string",
3279
3386
  # holdout_percent: 1,
3280
3387
  # hook: {
@@ -3332,6 +3439,9 @@ module Aws::Pinpoint
3332
3439
  # title: "__string",
3333
3440
  # url: "__string",
3334
3441
  # },
3442
+ # custom_message: {
3443
+ # data: "__string",
3444
+ # },
3335
3445
  # default_message: {
3336
3446
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
3337
3447
  # body: "__string",
@@ -3605,6 +3715,16 @@ module Aws::Pinpoint
3605
3715
  # write_journey_request: { # required
3606
3716
  # activities: {
3607
3717
  # "__string" => {
3718
+ # custom: {
3719
+ # delivery_uri: "__string",
3720
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
3721
+ # message_config: {
3722
+ # data: "__string",
3723
+ # },
3724
+ # next_activity: "__string",
3725
+ # template_name: "__string",
3726
+ # template_version: "__string",
3727
+ # },
3608
3728
  # conditional_split: {
3609
3729
  # condition: {
3610
3730
  # conditions: [
@@ -3825,6 +3945,14 @@ module Aws::Pinpoint
3825
3945
  # wait_until: "__string",
3826
3946
  # },
3827
3947
  # },
3948
+ # push: {
3949
+ # message_config: {
3950
+ # time_to_live: "__string",
3951
+ # },
3952
+ # next_activity: "__string",
3953
+ # template_name: "__string",
3954
+ # template_version: "__string",
3955
+ # },
3828
3956
  # random_split: {
3829
3957
  # branches: [
3830
3958
  # {
@@ -3833,6 +3961,15 @@ module Aws::Pinpoint
3833
3961
  # },
3834
3962
  # ],
3835
3963
  # },
3964
+ # sms: {
3965
+ # message_config: {
3966
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
3967
+ # sender_id: "__string",
3968
+ # },
3969
+ # next_activity: "__string",
3970
+ # template_name: "__string",
3971
+ # template_version: "__string",
3972
+ # },
3836
3973
  # wait: {
3837
3974
  # next_activity: "__string",
3838
3975
  # wait_time: {
@@ -4013,17 +4150,18 @@ module Aws::Pinpoint
4013
4150
  #
4014
4151
  # @!attribute [rw] attributes
4015
4152
  # A map of key-value pairs that defines 1-10 custom endpoint or user
4016
- # attributes, depending on the value for the RecommenderUserIdType
4017
- # property. Each of these attributes temporarily stores a recommended
4018
- # item that's retrieved from the recommender model and sent to an AWS
4019
- # Lambda function for additional processing. Each attribute can be
4020
- # used as a message variable in a message template.
4153
+ # attributes, depending on the value for the
4154
+ # RecommendationProviderIdType property. Each of these attributes
4155
+ # temporarily stores a recommended item that's retrieved from the
4156
+ # recommender model and sent to an AWS Lambda function for additional
4157
+ # processing. Each attribute can be used as a message variable in a
4158
+ # message template.
4021
4159
  #
4022
4160
  # In the map, the key is the name of a custom attribute and the value
4023
4161
  # is a custom display name for that attribute. The display name
4024
- # appears in the **Attribute finder** pane of the template editor on
4025
- # the Amazon Pinpoint console. The following restrictions apply to
4026
- # these names:
4162
+ # appears in the **Attribute finder** of the template editor on the
4163
+ # Amazon Pinpoint console. The following restrictions apply to these
4164
+ # names:
4027
4165
  #
4028
4166
  # * An attribute name must start with a letter or number and it can
4029
4167
  # contain up to 50 characters. The characters can be letters,
@@ -4035,13 +4173,14 @@ module Aws::Pinpoint
4035
4173
  # numbers, spaces, underscores (\_), or hyphens (-).
4036
4174
  #
4037
4175
  # This object is required if the configuration invokes an AWS Lambda
4038
- # function (LambdaFunctionArn) to process recommendation data.
4039
- # Otherwise, don't include this object in your request.
4176
+ # function (RecommendationTransformerUri) to process recommendation
4177
+ # data. Otherwise, don't include this object in your request.
4040
4178
  # @return [Hash<String,String>]
4041
4179
  #
4042
4180
  # @!attribute [rw] description
4043
4181
  # A custom description of the configuration for the recommender model.
4044
- # The description can contain up to 128 characters.
4182
+ # The description can contain up to 128 characters. The characters can
4183
+ # be letters, numbers, spaces, or the following symbols: \_ ; () , ‐.
4045
4184
  # @return [String]
4046
4185
  #
4047
4186
  # @!attribute [rw] name
@@ -4066,7 +4205,7 @@ module Aws::Pinpoint
4066
4205
  # particular user and endpoint in Amazon Pinpoint. The data is
4067
4206
  # correlated based on user IDs in Amazon Pinpoint. If you specify
4068
4207
  # this value, an endpoint definition in Amazon Pinpoint has to
4069
- # specify a both a user ID (UserId) and an endpoint ID. Otherwise,
4208
+ # specify both a user ID (UserId) and an endpoint ID. Otherwise,
4070
4209
  # messages won’t be sent to the user's endpoint.
4071
4210
  # @return [String]
4072
4211
  #
@@ -4090,15 +4229,15 @@ module Aws::Pinpoint
4090
4229
  #
4091
4230
  # @!attribute [rw] recommendations_display_name
4092
4231
  # A custom display name for the standard endpoint or user attribute
4093
- # (RecommendationItems) that temporarily stores a recommended item for
4232
+ # (RecommendationItems) that temporarily stores recommended items for
4094
4233
  # each endpoint or user, depending on the value for the
4095
- # RecommenderUserIdType property. This value is required if the
4234
+ # RecommendationProviderIdType property. This value is required if the
4096
4235
  # configuration doesn't invoke an AWS Lambda function
4097
- # (LambdaFunctionArn) to perform additional processing of
4236
+ # (RecommendationTransformerUri) to perform additional processing of
4098
4237
  # recommendation data.
4099
4238
  #
4100
- # This name appears in the **Attribute finder** pane of the template
4101
- # editor on the Amazon Pinpoint console. The name can contain up to 25
4239
+ # This name appears in the **Attribute finder** of the template editor
4240
+ # on the Amazon Pinpoint console. The name can contain up to 25
4102
4241
  # characters. The characters can be letters, numbers, spaces,
4103
4242
  # underscores (\_), or hyphens (-). These restrictions don't apply to
4104
4243
  # attribute values.
@@ -4107,14 +4246,14 @@ module Aws::Pinpoint
4107
4246
  # @!attribute [rw] recommendations_per_message
4108
4247
  # The number of recommended items to retrieve from the model for each
4109
4248
  # endpoint or user, depending on the value for the
4110
- # RecommenderUserIdType property. This number determines how many
4111
- # recommended attributes are available for use as message variables in
4112
- # message templates. The minimum value is 1. The maximum value is 5.
4113
- # The default value is 5.
4249
+ # RecommendationProviderIdType property. This number determines how
4250
+ # many recommended items are available for use in message variables.
4251
+ # The minimum value is 1. The maximum value is 5. The default value is
4252
+ # 5.
4114
4253
  #
4115
4254
  # To use multiple recommended items and custom attributes with message
4116
4255
  # variables, you have to use an AWS Lambda function
4117
- # (LambdaFunctionArn) to perform additional processing of
4256
+ # (RecommendationTransformerUri) to perform additional processing of
4118
4257
  # recommendation data.
4119
4258
  # @return [Integer]
4120
4259
  #
@@ -4478,6 +4617,125 @@ module Aws::Pinpoint
4478
4617
  include Aws::Structure
4479
4618
  end
4480
4619
 
4620
+ # Specifies the delivery configuration settings for sending a campaign
4621
+ # or campaign treatment through a custom channel. This object is
4622
+ # required if you use the CampaignCustomMessage object to define the
4623
+ # message to send for the campaign or campaign treatment.
4624
+ #
4625
+ # @note When making an API call, you may pass CustomDeliveryConfiguration
4626
+ # data as a hash:
4627
+ #
4628
+ # {
4629
+ # delivery_uri: "__string", # required
4630
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
4631
+ # }
4632
+ #
4633
+ # @!attribute [rw] delivery_uri
4634
+ # The destination to send the campaign or treatment to. This value can
4635
+ # be one of the following:
4636
+ #
4637
+ # * The name or Amazon Resource Name (ARN) of an AWS Lambda function
4638
+ # to invoke to handle delivery of the campaign or treatment.
4639
+ #
4640
+ # * The URL for a web application or service that supports HTTPS and
4641
+ # can receive the message. The URL has to be a full URL, including
4642
+ # the HTTPS protocol.
4643
+ # @return [String]
4644
+ #
4645
+ # @!attribute [rw] endpoint_types
4646
+ # The types of endpoints to send the campaign or treatment to. Each
4647
+ # valid value maps to a type of channel that you can associate with an
4648
+ # endpoint by using the ChannelType property of an endpoint.
4649
+ # @return [Array<String>]
4650
+ #
4651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CustomDeliveryConfiguration AWS API Documentation
4652
+ #
4653
+ class CustomDeliveryConfiguration < Struct.new(
4654
+ :delivery_uri,
4655
+ :endpoint_types)
4656
+ include Aws::Structure
4657
+ end
4658
+
4659
+ # The settings for a custom message activity. This type of activity
4660
+ # calls an AWS Lambda function or web hook that sends messages to
4661
+ # participants.
4662
+ #
4663
+ # @note When making an API call, you may pass CustomMessageActivity
4664
+ # data as a hash:
4665
+ #
4666
+ # {
4667
+ # delivery_uri: "__string",
4668
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
4669
+ # message_config: {
4670
+ # data: "__string",
4671
+ # },
4672
+ # next_activity: "__string",
4673
+ # template_name: "__string",
4674
+ # template_version: "__string",
4675
+ # }
4676
+ #
4677
+ # @!attribute [rw] delivery_uri
4678
+ # The destination to send the custom message to. This value can be one
4679
+ # of the following:
4680
+ #
4681
+ # * The name or Amazon Resource Name (ARN) of an AWS Lambda function
4682
+ # to invoke to handle delivery of the custom message.
4683
+ #
4684
+ # * The URL for a web application or service that supports HTTPS and
4685
+ # can receive the message. The URL has to be a full URL, including
4686
+ # the HTTPS protocol.
4687
+ # @return [String]
4688
+ #
4689
+ # @!attribute [rw] endpoint_types
4690
+ # The types of endpoints to send the custom message to. Each valid
4691
+ # value maps to a type of channel that you can associate with an
4692
+ # endpoint by using the ChannelType property of an endpoint.
4693
+ # @return [Array<String>]
4694
+ #
4695
+ # @!attribute [rw] message_config
4696
+ # Specifies the message data included in a custom channel message
4697
+ # that's sent to participants in a journey.
4698
+ # @return [Types::JourneyCustomMessage]
4699
+ #
4700
+ # @!attribute [rw] next_activity
4701
+ # The unique identifier for the next activity to perform, after Amazon
4702
+ # Pinpoint calls the AWS Lambda function or web hook.
4703
+ # @return [String]
4704
+ #
4705
+ # @!attribute [rw] template_name
4706
+ # The name of the custom message template to use for the message. If
4707
+ # specified, this value must match the name of an existing message
4708
+ # template.
4709
+ # @return [String]
4710
+ #
4711
+ # @!attribute [rw] template_version
4712
+ # The unique identifier for the version of the message template to use
4713
+ # for the message. If specified, this value must match the identifier
4714
+ # for an existing template version. To retrieve a list of versions and
4715
+ # version identifiers for a template, use the <link
4716
+ # linkend="templates-template-name-template-type-versions" />
4717
+ #
4718
+ # Template Versions</link> resource.
4719
+ #
4720
+ # If you don't specify a value for this property, Amazon Pinpoint
4721
+ # uses the *active version* of the template. The *active version* is
4722
+ # typically the version of a template that's been most recently
4723
+ # reviewed and approved for use, depending on your workflow. It isn't
4724
+ # necessarily the latest version of a template.
4725
+ # @return [String]
4726
+ #
4727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CustomMessageActivity AWS API Documentation
4728
+ #
4729
+ class CustomMessageActivity < Struct.new(
4730
+ :delivery_uri,
4731
+ :endpoint_types,
4732
+ :message_config,
4733
+ :next_activity,
4734
+ :template_name,
4735
+ :template_version)
4736
+ include Aws::Structure
4737
+ end
4738
+
4481
4739
  # Specifies the default message for all channels.
4482
4740
  #
4483
4741
  # @note When making an API call, you may pass DefaultMessage
@@ -5587,9 +5845,12 @@ module Aws::Pinpoint
5587
5845
  # }
5588
5846
  #
5589
5847
  # @!attribute [rw] configuration_set
5590
- # The configuration set that you want to apply to email that you send
5591
- # through the channel by using the [Amazon Pinpoint Email
5592
- # API](emailAPIreference.html).
5848
+ # The [Amazon SES configuration set][1] that you want to apply to
5849
+ # messages that you send through the channel.
5850
+ #
5851
+ #
5852
+ #
5853
+ # [1]: https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html
5593
5854
  # @return [String]
5594
5855
  #
5595
5856
  # @!attribute [rw] enabled
@@ -5633,9 +5894,12 @@ module Aws::Pinpoint
5633
5894
  # @return [String]
5634
5895
  #
5635
5896
  # @!attribute [rw] configuration_set
5636
- # The configuration set that's applied to email that's sent through
5637
- # the channel by using the [Amazon Pinpoint Email
5638
- # API](emailAPIreference.html).
5897
+ # The [Amazon SES configuration set][1] that's applied to messages
5898
+ # that are sent through the channel.
5899
+ #
5900
+ #
5901
+ #
5902
+ # [1]: https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html
5639
5903
  # @return [String]
5640
5904
  #
5641
5905
  # @!attribute [rw] creation_date
@@ -5648,7 +5912,7 @@ module Aws::Pinpoint
5648
5912
  # @return [Boolean]
5649
5913
  #
5650
5914
  # @!attribute [rw] from_address
5651
- # The verified email address that you send email from when you send
5915
+ # The verified email address that email is sent from when you send
5652
5916
  # email through the channel.
5653
5917
  # @return [String]
5654
5918
  #
@@ -5664,7 +5928,7 @@ module Aws::Pinpoint
5664
5928
  #
5665
5929
  # @!attribute [rw] identity
5666
5930
  # The Amazon Resource Name (ARN) of the identity, verified with Amazon
5667
- # Simple Email Service (Amazon SES), that you use when you send email
5931
+ # Simple Email Service (Amazon SES), that's used when you send email
5668
5932
  # through the channel.
5669
5933
  # @return [String]
5670
5934
  #
@@ -5682,7 +5946,7 @@ module Aws::Pinpoint
5682
5946
  # @return [String]
5683
5947
  #
5684
5948
  # @!attribute [rw] messages_per_second
5685
- # The maximum number of emails that you can send through the channel
5949
+ # The maximum number of emails that can be sent through the channel
5686
5950
  # each second.
5687
5951
  # @return [Integer]
5688
5952
  #
@@ -5817,7 +6081,8 @@ module Aws::Pinpoint
5817
6081
  # }
5818
6082
  #
5819
6083
  # @!attribute [rw] message_config
5820
- # The "From" address to use for the message.
6084
+ # Specifies the sender address for an email message that's sent to
6085
+ # participants in the journey.
5821
6086
  # @return [Types::JourneyEmailMessage]
5822
6087
  #
5823
6088
  # @!attribute [rw] next_activity
@@ -5826,7 +6091,9 @@ module Aws::Pinpoint
5826
6091
  # @return [String]
5827
6092
  #
5828
6093
  # @!attribute [rw] template_name
5829
- # The name of the email template to use for the message.
6094
+ # The name of the email message template to use for the message. If
6095
+ # specified, this value must match the name of an existing message
6096
+ # template.
5830
6097
  # @return [String]
5831
6098
  #
5832
6099
  # @!attribute [rw] template_version
@@ -6034,7 +6301,7 @@ module Aws::Pinpoint
6034
6301
  # attributes: {
6035
6302
  # "__string" => ["__string"],
6036
6303
  # },
6037
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
6304
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
6038
6305
  # demographic: {
6039
6306
  # app_version: "__string",
6040
6307
  # locale: "__string",
@@ -6151,7 +6418,7 @@ module Aws::Pinpoint
6151
6418
  # @return [String]
6152
6419
  #
6153
6420
  # @!attribute [rw] user
6154
- # One or more custom user attributes that describe the user who's
6421
+ # One or more custom attributes that describe the user who's
6155
6422
  # associated with the endpoint.
6156
6423
  # @return [Types::EndpointUser]
6157
6424
  #
@@ -6186,7 +6453,7 @@ module Aws::Pinpoint
6186
6453
  # attributes: {
6187
6454
  # "__string" => ["__string"],
6188
6455
  # },
6189
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
6456
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
6190
6457
  # demographic: {
6191
6458
  # app_version: "__string",
6192
6459
  # locale: "__string",
@@ -6455,7 +6722,7 @@ module Aws::Pinpoint
6455
6722
  # attributes: {
6456
6723
  # "__string" => ["__string"],
6457
6724
  # },
6458
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
6725
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
6459
6726
  # demographic: {
6460
6727
  # app_version: "__string",
6461
6728
  # locale: "__string",
@@ -6566,7 +6833,7 @@ module Aws::Pinpoint
6566
6833
  # @return [String]
6567
6834
  #
6568
6835
  # @!attribute [rw] user
6569
- # One or more custom user attributes that describe the user who's
6836
+ # One or more custom attributes that describe the user who's
6570
6837
  # associated with the endpoint.
6571
6838
  # @return [Types::EndpointUser]
6572
6839
  #
@@ -7102,7 +7369,7 @@ module Aws::Pinpoint
7102
7369
  # attributes: {
7103
7370
  # "__string" => ["__string"],
7104
7371
  # },
7105
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
7372
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
7106
7373
  # demographic: {
7107
7374
  # app_version: "__string",
7108
7375
  # locale: "__string",
@@ -7190,7 +7457,7 @@ module Aws::Pinpoint
7190
7457
  # attributes: {
7191
7458
  # "__string" => ["__string"],
7192
7459
  # },
7193
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
7460
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
7194
7461
  # demographic: {
7195
7462
  # app_version: "__string",
7196
7463
  # locale: "__string",
@@ -9806,6 +10073,28 @@ module Aws::Pinpoint
9806
10073
  include Aws::Structure
9807
10074
  end
9808
10075
 
10076
+ # Specifies the message content for a custom channel message that's
10077
+ # sent to participants in a journey.
10078
+ #
10079
+ # @note When making an API call, you may pass JourneyCustomMessage
10080
+ # data as a hash:
10081
+ #
10082
+ # {
10083
+ # data: "__string",
10084
+ # }
10085
+ #
10086
+ # @!attribute [rw] data
10087
+ # The message content that's passed to an AWS Lambda function or to a
10088
+ # web hook.
10089
+ # @return [String]
10090
+ #
10091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyCustomMessage AWS API Documentation
10092
+ #
10093
+ class JourneyCustomMessage < Struct.new(
10094
+ :data)
10095
+ include Aws::Structure
10096
+ end
10097
+
9809
10098
  # Provides the results of a query that retrieved the data for a standard
9810
10099
  # engagement metric that applies to a journey, and provides information
9811
10100
  # about that query.
@@ -9835,7 +10124,7 @@ module Aws::Pinpoint
9835
10124
  #
9836
10125
  #
9837
10126
  #
9838
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
10127
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
9839
10128
  # @return [String]
9840
10129
  #
9841
10130
  # @!attribute [rw] kpi_result
@@ -9951,7 +10240,7 @@ module Aws::Pinpoint
9951
10240
  #
9952
10241
  #
9953
10242
  #
9954
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
10243
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
9955
10244
  # @return [Hash<String,String>]
9956
10245
  #
9957
10246
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionActivityMetricsResponse AWS API Documentation
@@ -9991,7 +10280,7 @@ module Aws::Pinpoint
9991
10280
  #
9992
10281
  #
9993
10282
  #
9994
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
10283
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html
9995
10284
  # @return [Hash<String,String>]
9996
10285
  #
9997
10286
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionMetricsResponse AWS API Documentation
@@ -10041,6 +10330,35 @@ module Aws::Pinpoint
10041
10330
  include Aws::Structure
10042
10331
  end
10043
10332
 
10333
+ # Specifies the message configuration for a push notification that's
10334
+ # sent to participants in a journey.
10335
+ #
10336
+ # @note When making an API call, you may pass JourneyPushMessage
10337
+ # data as a hash:
10338
+ #
10339
+ # {
10340
+ # time_to_live: "__string",
10341
+ # }
10342
+ #
10343
+ # @!attribute [rw] time_to_live
10344
+ # The number of seconds that the push notification service should keep
10345
+ # the message, if the service is unable to deliver the notification
10346
+ # the first time. This value is converted to an expiration value when
10347
+ # it's sent to a push-notification service. If this value is 0, the
10348
+ # service treats the notification as if it expires immediately and the
10349
+ # service doesn't store or try to deliver the notification again.
10350
+ #
10351
+ # This value doesn't apply to messages that are sent through the
10352
+ # Amazon Device Messaging (ADM) service.
10353
+ # @return [String]
10354
+ #
10355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyPushMessage AWS API Documentation
10356
+ #
10357
+ class JourneyPushMessage < Struct.new(
10358
+ :time_to_live)
10359
+ include Aws::Structure
10360
+ end
10361
+
10044
10362
  # Provides information about the status, configuration, and other
10045
10363
  # settings for a journey.
10046
10364
  #
@@ -10176,6 +10494,43 @@ module Aws::Pinpoint
10176
10494
  include Aws::Structure
10177
10495
  end
10178
10496
 
10497
+ # Specifies the sender ID and message type for an SMS message that's
10498
+ # sent to participants in a journey.
10499
+ #
10500
+ # @note When making an API call, you may pass JourneySMSMessage
10501
+ # data as a hash:
10502
+ #
10503
+ # {
10504
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
10505
+ # sender_id: "__string",
10506
+ # }
10507
+ #
10508
+ # @!attribute [rw] message_type
10509
+ # The SMS message type. Valid values are TRANSACTIONAL (for messages
10510
+ # that are critical or time-sensitive, such as a one-time passwords)
10511
+ # and PROMOTIONAL (for messsages that aren't critical or
10512
+ # time-sensitive, such as marketing messages).
10513
+ # @return [String]
10514
+ #
10515
+ # @!attribute [rw] sender_id
10516
+ # The sender ID to display as the sender of the message on a
10517
+ # recipient's device. Support for sender IDs varies by country or
10518
+ # region. For more information, see [Supported Countries and
10519
+ # Regions][1] in the Amazon Pinpoint User Guide.
10520
+ #
10521
+ #
10522
+ #
10523
+ # [1]: https://docs.aws.amazon.com.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html
10524
+ # @return [String]
10525
+ #
10526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneySMSMessage AWS API Documentation
10527
+ #
10528
+ class JourneySMSMessage < Struct.new(
10529
+ :message_type,
10530
+ :sender_id)
10531
+ include Aws::Structure
10532
+ end
10533
+
10179
10534
  # Specifies the schedule settings for a journey.
10180
10535
  #
10181
10536
  # @note When making an API call, you may pass JourneySchedule
@@ -10635,6 +10990,9 @@ module Aws::Pinpoint
10635
10990
  # title: "__string",
10636
10991
  # url: "__string",
10637
10992
  # },
10993
+ # custom_message: {
10994
+ # data: "__string",
10995
+ # },
10638
10996
  # default_message: {
10639
10997
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
10640
10998
  # body: "__string",
@@ -10678,38 +11036,50 @@ module Aws::Pinpoint
10678
11036
  #
10679
11037
  # @!attribute [rw] adm_message
10680
11038
  # The message that the campaign sends through the ADM (Amazon Device
10681
- # Messaging) channel. This message overrides the default message.
11039
+ # Messaging) channel. If specified, this message overrides the default
11040
+ # message.
10682
11041
  # @return [Types::Message]
10683
11042
  #
10684
11043
  # @!attribute [rw] apns_message
10685
11044
  # The message that the campaign sends through the APNs (Apple Push
10686
- # Notification service) channel. This message overrides the default
10687
- # message.
11045
+ # Notification service) channel. If specified, this message overrides
11046
+ # the default message.
10688
11047
  # @return [Types::Message]
10689
11048
  #
10690
11049
  # @!attribute [rw] baidu_message
10691
11050
  # The message that the campaign sends through the Baidu (Baidu Cloud
10692
- # Push) channel. This message overrides the default message.
11051
+ # Push) channel. If specified, this message overrides the default
11052
+ # message.
10693
11053
  # @return [Types::Message]
10694
11054
  #
11055
+ # @!attribute [rw] custom_message
11056
+ # The message that the campaign sends through a custom channel, as
11057
+ # specified by the delivery configuration
11058
+ # (CustomDeliveryConfiguration) settings for the campaign. If
11059
+ # specified, this message overrides the default message.
11060
+ # @return [Types::CampaignCustomMessage]
11061
+ #
10695
11062
  # @!attribute [rw] default_message
10696
11063
  # The default message that the campaign sends through all the channels
10697
11064
  # that are configured for the campaign.
10698
11065
  # @return [Types::Message]
10699
11066
  #
10700
11067
  # @!attribute [rw] email_message
10701
- # The message that the campaign sends through the email channel.
11068
+ # The message that the campaign sends through the email channel. If
11069
+ # specified, this message overrides the default message.
10702
11070
  # @return [Types::CampaignEmailMessage]
10703
11071
  #
10704
11072
  # @!attribute [rw] gcm_message
10705
11073
  # The message that the campaign sends through the GCM channel, which
10706
11074
  # enables Amazon Pinpoint to send push notifications through the
10707
11075
  # Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
10708
- # (GCM), service. This message overrides the default message.
11076
+ # (GCM), service. If specified, this message overrides the default
11077
+ # message.
10709
11078
  # @return [Types::Message]
10710
11079
  #
10711
11080
  # @!attribute [rw] sms_message
10712
- # The message that the campaign sends through the SMS channel.
11081
+ # The message that the campaign sends through the SMS channel. If
11082
+ # specified, this message overrides the default message.
10713
11083
  # @return [Types::CampaignSmsMessage]
10714
11084
  #
10715
11085
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageConfiguration AWS API Documentation
@@ -10718,6 +11088,7 @@ module Aws::Pinpoint
10718
11088
  :adm_message,
10719
11089
  :apns_message,
10720
11090
  :baidu_message,
11091
+ :custom_message,
10721
11092
  :default_message,
10722
11093
  :email_message,
10723
11094
  :gcm_message,
@@ -10734,7 +11105,7 @@ module Aws::Pinpoint
10734
11105
  # addresses: {
10735
11106
  # "__string" => {
10736
11107
  # body_override: "__string",
10737
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
11108
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
10738
11109
  # context: {
10739
11110
  # "__string" => "__string",
10740
11111
  # },
@@ -11583,7 +11954,7 @@ module Aws::Pinpoint
11583
11954
  # attributes: {
11584
11955
  # "__string" => ["__string"],
11585
11956
  # },
11586
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
11957
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
11587
11958
  # demographic: {
11588
11959
  # app_version: "__string",
11589
11960
  # locale: "__string",
@@ -11700,6 +12071,63 @@ module Aws::Pinpoint
11700
12071
  include Aws::Structure
11701
12072
  end
11702
12073
 
12074
+ # Specifies the settings for a push notification activity in a journey.
12075
+ # This type of activity sends a push notification to participants.
12076
+ #
12077
+ # @note When making an API call, you may pass PushMessageActivity
12078
+ # data as a hash:
12079
+ #
12080
+ # {
12081
+ # message_config: {
12082
+ # time_to_live: "__string",
12083
+ # },
12084
+ # next_activity: "__string",
12085
+ # template_name: "__string",
12086
+ # template_version: "__string",
12087
+ # }
12088
+ #
12089
+ # @!attribute [rw] message_config
12090
+ # Specifies the time to live (TTL) value for push notifications that
12091
+ # are sent to participants in a journey.
12092
+ # @return [Types::JourneyPushMessage]
12093
+ #
12094
+ # @!attribute [rw] next_activity
12095
+ # The unique identifier for the next activity to perform, after the
12096
+ # message is sent.
12097
+ # @return [String]
12098
+ #
12099
+ # @!attribute [rw] template_name
12100
+ # The name of the push notification template to use for the message.
12101
+ # If specified, this value must match the name of an existing message
12102
+ # template.
12103
+ # @return [String]
12104
+ #
12105
+ # @!attribute [rw] template_version
12106
+ # The unique identifier for the version of the push notification
12107
+ # template to use for the message. If specified, this value must match
12108
+ # the identifier for an existing template version. To retrieve a list
12109
+ # of versions and version identifiers for a template, use the <link
12110
+ # linkend="templates-template-name-template-type-versions" />
12111
+ #
12112
+ # Template Versions</link> resource.
12113
+ #
12114
+ # If you don't specify a value for this property, Amazon Pinpoint
12115
+ # uses the *active version* of the template. The *active version* is
12116
+ # typically the version of a template that's been most recently
12117
+ # reviewed and approved for use, depending on your workflow. It isn't
12118
+ # necessarily the latest version of a template.
12119
+ # @return [String]
12120
+ #
12121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PushMessageActivity AWS API Documentation
12122
+ #
12123
+ class PushMessageActivity < Struct.new(
12124
+ :message_config,
12125
+ :next_activity,
12126
+ :template_name,
12127
+ :template_version)
12128
+ include Aws::Structure
12129
+ end
12130
+
11703
12131
  # Specifies the content and settings for a message template that can be
11704
12132
  # used in messages that are sent through a push notification channel.
11705
12133
  #
@@ -12000,7 +12428,7 @@ module Aws::Pinpoint
12000
12428
  # attributes: {
12001
12429
  # "__string" => ["__string"],
12002
12430
  # },
12003
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
12431
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
12004
12432
  # demographic: {
12005
12433
  # app_version: "__string",
12006
12434
  # locale: "__string",
@@ -12243,15 +12671,15 @@ module Aws::Pinpoint
12243
12671
  #
12244
12672
  # @!attribute [rw] attributes
12245
12673
  # A map that defines 1-10 custom endpoint or user attributes,
12246
- # depending on the value for the RecommenderUserIdType property. Each
12247
- # of these attributes temporarily stores a recommended item that's
12248
- # retrieved from the recommender model and sent to an AWS Lambda
12249
- # function for additional processing. Each attribute can be used as a
12250
- # message variable in a message template.
12674
+ # depending on the value for the RecommendationProviderIdType
12675
+ # property. Each of these attributes temporarily stores a recommended
12676
+ # item that's retrieved from the recommender model and sent to an AWS
12677
+ # Lambda function for additional processing. Each attribute can be
12678
+ # used as a message variable in a message template.
12251
12679
  #
12252
12680
  # This value is null if the configuration doesn't invoke an AWS
12253
- # Lambda function (LambdaFunctionArn) to perform additional processing
12254
- # of recommendation data.
12681
+ # Lambda function (RecommendationTransformerUri) to perform additional
12682
+ # processing of recommendation data.
12255
12683
  # @return [Hash<String,String>]
12256
12684
  #
12257
12685
  # @!attribute [rw] creation_date
@@ -12316,22 +12744,22 @@ module Aws::Pinpoint
12316
12744
  #
12317
12745
  # @!attribute [rw] recommendations_display_name
12318
12746
  # The custom display name for the standard endpoint or user attribute
12319
- # (RecommendationItems) that temporarily stores a recommended item for
12747
+ # (RecommendationItems) that temporarily stores recommended items for
12320
12748
  # each endpoint or user, depending on the value for the
12321
- # RecommenderUserIdType property. This name appears in the **Attribute
12322
- # finder** pane of the template editor on the Amazon Pinpoint console.
12749
+ # RecommendationProviderIdType property. This name appears in the
12750
+ # **Attribute finder** of the template editor on the Amazon Pinpoint
12751
+ # console.
12323
12752
  #
12324
12753
  # This value is null if the configuration doesn't invoke an AWS
12325
- # Lambda function (LambdaFunctionArn) to perform additional processing
12326
- # of recommendation data.
12754
+ # Lambda function (RecommendationTransformerUri) to perform additional
12755
+ # processing of recommendation data.
12327
12756
  # @return [String]
12328
12757
  #
12329
12758
  # @!attribute [rw] recommendations_per_message
12330
12759
  # The number of recommended items that are retrieved from the model
12331
12760
  # for each endpoint or user, depending on the value for the
12332
- # RecommenderUserIdType property. This number determines how many
12333
- # recommended attributes are available for use as message variables in
12334
- # message templates.
12761
+ # RecommendationProviderIdType property. This number determines how
12762
+ # many recommended items are available for use in message variables.
12335
12763
  # @return [Integer]
12336
12764
  #
12337
12765
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RecommenderConfigurationResponse AWS API Documentation
@@ -12605,10 +13033,10 @@ module Aws::Pinpoint
12605
13033
  # @return [String]
12606
13034
  #
12607
13035
  # @!attribute [rw] message_type
12608
- # The SMS message type. Valid values are: TRANSACTIONAL, the message
12609
- # is critical or time-sensitive, such as a one-time password that
12610
- # supports a customer transaction; and, PROMOTIONAL, the message is
12611
- # not critical or time-sensitive, such as a marketing message.
13036
+ # The SMS message type. Valid values are TRANSACTIONAL (for messages
13037
+ # that are critical or time-sensitive, such as a one-time passwords)
13038
+ # and PROMOTIONAL (for messsages that aren't critical or
13039
+ # time-sensitive, such as marketing messages).
12612
13040
  # @return [String]
12613
13041
  #
12614
13042
  # @!attribute [rw] origination_number
@@ -12643,6 +13071,64 @@ module Aws::Pinpoint
12643
13071
  include Aws::Structure
12644
13072
  end
12645
13073
 
13074
+ # Specifies the settings for an SMS activity in a journey. This type of
13075
+ # activity sends a text message to participants.
13076
+ #
13077
+ # @note When making an API call, you may pass SMSMessageActivity
13078
+ # data as a hash:
13079
+ #
13080
+ # {
13081
+ # message_config: {
13082
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
13083
+ # sender_id: "__string",
13084
+ # },
13085
+ # next_activity: "__string",
13086
+ # template_name: "__string",
13087
+ # template_version: "__string",
13088
+ # }
13089
+ #
13090
+ # @!attribute [rw] message_config
13091
+ # Specifies the sender ID and message type for an SMS message that's
13092
+ # sent to participants in a journey.
13093
+ # @return [Types::JourneySMSMessage]
13094
+ #
13095
+ # @!attribute [rw] next_activity
13096
+ # The unique identifier for the next activity to perform, after the
13097
+ # message is sent.
13098
+ # @return [String]
13099
+ #
13100
+ # @!attribute [rw] template_name
13101
+ # The name of the SMS message template to use for the message. If
13102
+ # specified, this value must match the name of an existing message
13103
+ # template.
13104
+ # @return [String]
13105
+ #
13106
+ # @!attribute [rw] template_version
13107
+ # The unique identifier for the version of the SMS template to use for
13108
+ # the message. If specified, this value must match the identifier for
13109
+ # an existing template version. To retrieve a list of versions and
13110
+ # version identifiers for a template, use the <link
13111
+ # linkend="templates-template-name-template-type-versions" />
13112
+ #
13113
+ # Template Versions</link> resource.
13114
+ #
13115
+ # If you don't specify a value for this property, Amazon Pinpoint
13116
+ # uses the *active version* of the template. The *active version* is
13117
+ # typically the version of a template that's been most recently
13118
+ # reviewed and approved for use, depending on your workflow. It isn't
13119
+ # necessarily the latest version of a template.
13120
+ # @return [String]
13121
+ #
13122
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSMessageActivity AWS API Documentation
13123
+ #
13124
+ class SMSMessageActivity < Struct.new(
13125
+ :message_config,
13126
+ :next_activity,
13127
+ :template_name,
13128
+ :template_version)
13129
+ include Aws::Structure
13130
+ end
13131
+
12646
13132
  # Specifies the content and settings for a message template that can be
12647
13133
  # used in text messages that are sent through the SMS channel.
12648
13134
  #
@@ -13578,7 +14064,7 @@ module Aws::Pinpoint
13578
14064
  # addresses: {
13579
14065
  # "__string" => {
13580
14066
  # body_override: "__string",
13581
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
14067
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
13582
14068
  # context: {
13583
14069
  # "__string" => "__string",
13584
14070
  # },
@@ -14979,9 +15465,16 @@ module Aws::Pinpoint
14979
15465
  include Aws::Structure
14980
15466
  end
14981
15467
 
14982
- # Specifies the settings for a campaign treatment. A treatment is a
15468
+ # Specifies the settings for a campaign treatment. A *treatment* is a
14983
15469
  # variation of a campaign that's used for A/B testing of a campaign.
14984
15470
  #
15471
+ # @!attribute [rw] custom_delivery_configuration
15472
+ # The delivery configuration settings for sending the treatment
15473
+ # through a custom channel. This object is required if the
15474
+ # MessageConfiguration object for the treatment specifies a
15475
+ # CustomMessage object.
15476
+ # @return [Types::CustomDeliveryConfiguration]
15477
+ #
14985
15478
  # @!attribute [rw] id
14986
15479
  # The unique identifier for the treatment.
14987
15480
  # @return [String]
@@ -15012,13 +15505,13 @@ module Aws::Pinpoint
15012
15505
  # @return [String]
15013
15506
  #
15014
15507
  # @!attribute [rw] treatment_name
15015
- # The custom name of the treatment. A treatment is a variation of a
15016
- # campaign that's used for A/B testing of a campaign.
15508
+ # The custom name of the treatment.
15017
15509
  # @return [String]
15018
15510
  #
15019
15511
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TreatmentResource AWS API Documentation
15020
15512
  #
15021
15513
  class TreatmentResource < Struct.new(
15514
+ :custom_delivery_configuration,
15022
15515
  :id,
15023
15516
  :message_configuration,
15024
15517
  :schedule,
@@ -15400,6 +15893,10 @@ module Aws::Pinpoint
15400
15893
  # write_campaign_request: { # required
15401
15894
  # additional_treatments: [
15402
15895
  # {
15896
+ # custom_delivery_configuration: {
15897
+ # delivery_uri: "__string", # required
15898
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
15899
+ # },
15403
15900
  # message_configuration: {
15404
15901
  # adm_message: {
15405
15902
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
@@ -15443,6 +15940,9 @@ module Aws::Pinpoint
15443
15940
  # title: "__string",
15444
15941
  # url: "__string",
15445
15942
  # },
15943
+ # custom_message: {
15944
+ # data: "__string",
15945
+ # },
15446
15946
  # default_message: {
15447
15947
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
15448
15948
  # body: "__string",
@@ -15538,6 +16038,10 @@ module Aws::Pinpoint
15538
16038
  # treatment_name: "__string",
15539
16039
  # },
15540
16040
  # ],
16041
+ # custom_delivery_configuration: {
16042
+ # delivery_uri: "__string", # required
16043
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
16044
+ # },
15541
16045
  # description: "__string",
15542
16046
  # holdout_percent: 1,
15543
16047
  # hook: {
@@ -15595,6 +16099,9 @@ module Aws::Pinpoint
15595
16099
  # title: "__string",
15596
16100
  # url: "__string",
15597
16101
  # },
16102
+ # custom_message: {
16103
+ # data: "__string",
16104
+ # },
15598
16105
  # default_message: {
15599
16106
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
15600
16107
  # body: "__string",
@@ -15835,7 +16342,7 @@ module Aws::Pinpoint
15835
16342
  # attributes: {
15836
16343
  # "__string" => ["__string"],
15837
16344
  # },
15838
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
16345
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
15839
16346
  # demographic: {
15840
16347
  # app_version: "__string",
15841
16348
  # locale: "__string",
@@ -15912,7 +16419,7 @@ module Aws::Pinpoint
15912
16419
  # attributes: {
15913
16420
  # "__string" => ["__string"],
15914
16421
  # },
15915
- # channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
16422
+ # channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
15916
16423
  # demographic: {
15917
16424
  # app_version: "__string",
15918
16425
  # locale: "__string",
@@ -16029,6 +16536,16 @@ module Aws::Pinpoint
16029
16536
  # write_journey_request: { # required
16030
16537
  # activities: {
16031
16538
  # "__string" => {
16539
+ # custom: {
16540
+ # delivery_uri: "__string",
16541
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
16542
+ # message_config: {
16543
+ # data: "__string",
16544
+ # },
16545
+ # next_activity: "__string",
16546
+ # template_name: "__string",
16547
+ # template_version: "__string",
16548
+ # },
16032
16549
  # conditional_split: {
16033
16550
  # condition: {
16034
16551
  # conditions: [
@@ -16249,6 +16766,14 @@ module Aws::Pinpoint
16249
16766
  # wait_until: "__string",
16250
16767
  # },
16251
16768
  # },
16769
+ # push: {
16770
+ # message_config: {
16771
+ # time_to_live: "__string",
16772
+ # },
16773
+ # next_activity: "__string",
16774
+ # template_name: "__string",
16775
+ # template_version: "__string",
16776
+ # },
16252
16777
  # random_split: {
16253
16778
  # branches: [
16254
16779
  # {
@@ -16257,6 +16782,15 @@ module Aws::Pinpoint
16257
16782
  # },
16258
16783
  # ],
16259
16784
  # },
16785
+ # sms: {
16786
+ # message_config: {
16787
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
16788
+ # sender_id: "__string",
16789
+ # },
16790
+ # next_activity: "__string",
16791
+ # template_name: "__string",
16792
+ # template_version: "__string",
16793
+ # },
16260
16794
  # wait: {
16261
16795
  # next_activity: "__string",
16262
16796
  # wait_time: {
@@ -16493,17 +17027,18 @@ module Aws::Pinpoint
16493
17027
  #
16494
17028
  # @!attribute [rw] attributes
16495
17029
  # A map of key-value pairs that defines 1-10 custom endpoint or user
16496
- # attributes, depending on the value for the RecommenderUserIdType
16497
- # property. Each of these attributes temporarily stores a recommended
16498
- # item that's retrieved from the recommender model and sent to an AWS
16499
- # Lambda function for additional processing. Each attribute can be
16500
- # used as a message variable in a message template.
17030
+ # attributes, depending on the value for the
17031
+ # RecommendationProviderIdType property. Each of these attributes
17032
+ # temporarily stores a recommended item that's retrieved from the
17033
+ # recommender model and sent to an AWS Lambda function for additional
17034
+ # processing. Each attribute can be used as a message variable in a
17035
+ # message template.
16501
17036
  #
16502
17037
  # In the map, the key is the name of a custom attribute and the value
16503
17038
  # is a custom display name for that attribute. The display name
16504
- # appears in the **Attribute finder** pane of the template editor on
16505
- # the Amazon Pinpoint console. The following restrictions apply to
16506
- # these names:
17039
+ # appears in the **Attribute finder** of the template editor on the
17040
+ # Amazon Pinpoint console. The following restrictions apply to these
17041
+ # names:
16507
17042
  #
16508
17043
  # * An attribute name must start with a letter or number and it can
16509
17044
  # contain up to 50 characters. The characters can be letters,
@@ -16515,13 +17050,14 @@ module Aws::Pinpoint
16515
17050
  # numbers, spaces, underscores (\_), or hyphens (-).
16516
17051
  #
16517
17052
  # This object is required if the configuration invokes an AWS Lambda
16518
- # function (LambdaFunctionArn) to process recommendation data.
16519
- # Otherwise, don't include this object in your request.
17053
+ # function (RecommendationTransformerUri) to process recommendation
17054
+ # data. Otherwise, don't include this object in your request.
16520
17055
  # @return [Hash<String,String>]
16521
17056
  #
16522
17057
  # @!attribute [rw] description
16523
17058
  # A custom description of the configuration for the recommender model.
16524
- # The description can contain up to 128 characters.
17059
+ # The description can contain up to 128 characters. The characters can
17060
+ # be letters, numbers, spaces, or the following symbols: \_ ; () , ‐.
16525
17061
  # @return [String]
16526
17062
  #
16527
17063
  # @!attribute [rw] name
@@ -16546,7 +17082,7 @@ module Aws::Pinpoint
16546
17082
  # particular user and endpoint in Amazon Pinpoint. The data is
16547
17083
  # correlated based on user IDs in Amazon Pinpoint. If you specify
16548
17084
  # this value, an endpoint definition in Amazon Pinpoint has to
16549
- # specify a both a user ID (UserId) and an endpoint ID. Otherwise,
17085
+ # specify both a user ID (UserId) and an endpoint ID. Otherwise,
16550
17086
  # messages won’t be sent to the user's endpoint.
16551
17087
  # @return [String]
16552
17088
  #
@@ -16570,15 +17106,15 @@ module Aws::Pinpoint
16570
17106
  #
16571
17107
  # @!attribute [rw] recommendations_display_name
16572
17108
  # A custom display name for the standard endpoint or user attribute
16573
- # (RecommendationItems) that temporarily stores a recommended item for
17109
+ # (RecommendationItems) that temporarily stores recommended items for
16574
17110
  # each endpoint or user, depending on the value for the
16575
- # RecommenderUserIdType property. This value is required if the
17111
+ # RecommendationProviderIdType property. This value is required if the
16576
17112
  # configuration doesn't invoke an AWS Lambda function
16577
- # (LambdaFunctionArn) to perform additional processing of
17113
+ # (RecommendationTransformerUri) to perform additional processing of
16578
17114
  # recommendation data.
16579
17115
  #
16580
- # This name appears in the **Attribute finder** pane of the template
16581
- # editor on the Amazon Pinpoint console. The name can contain up to 25
17116
+ # This name appears in the **Attribute finder** of the template editor
17117
+ # on the Amazon Pinpoint console. The name can contain up to 25
16582
17118
  # characters. The characters can be letters, numbers, spaces,
16583
17119
  # underscores (\_), or hyphens (-). These restrictions don't apply to
16584
17120
  # attribute values.
@@ -16587,14 +17123,14 @@ module Aws::Pinpoint
16587
17123
  # @!attribute [rw] recommendations_per_message
16588
17124
  # The number of recommended items to retrieve from the model for each
16589
17125
  # endpoint or user, depending on the value for the
16590
- # RecommenderUserIdType property. This number determines how many
16591
- # recommended attributes are available for use as message variables in
16592
- # message templates. The minimum value is 1. The maximum value is 5.
16593
- # The default value is 5.
17126
+ # RecommendationProviderIdType property. This number determines how
17127
+ # many recommended items are available for use in message variables.
17128
+ # The minimum value is 1. The maximum value is 5. The default value is
17129
+ # 5.
16594
17130
  #
16595
17131
  # To use multiple recommended items and custom attributes with message
16596
17132
  # variables, you have to use an AWS Lambda function
16597
- # (LambdaFunctionArn) to perform additional processing of
17133
+ # (RecommendationTransformerUri) to perform additional processing of
16598
17134
  # recommendation data.
16599
17135
  # @return [Integer]
16600
17136
  #
@@ -17490,13 +18026,15 @@ module Aws::Pinpoint
17490
18026
  # }
17491
18027
  #
17492
18028
  # @!attribute [rw] campaign_hook
17493
- # The settings for the AWS Lambda function to use by default as a code
17494
- # hook for campaigns in the application. To override these settings
17495
- # for a specific campaign, use the <link
18029
+ # The settings for the AWS Lambda function to invoke by default as a
18030
+ # code hook for campaigns in the application. You can use this hook to
18031
+ # customize segments that are used by campaigns in the application.
18032
+ #
18033
+ # To override these settings and define custom settings for a specific
18034
+ # campaign, use the CampaignHook object of the <link
17496
18035
  # linkend="apps-application-id-campaigns-campaign-id" />
17497
18036
  #
17498
- # Campaign</link> resource to define custom Lambda function settings
17499
- # for the campaign.
18037
+ # Campaign</link> resource.
17500
18038
  # @return [Types::CampaignHook]
17501
18039
  #
17502
18040
  # @!attribute [rw] cloud_watch_metrics_enabled
@@ -17505,11 +18043,15 @@ module Aws::Pinpoint
17505
18043
  # @return [Boolean]
17506
18044
  #
17507
18045
  # @!attribute [rw] limits
17508
- # The default sending limits for campaigns in the application. To
17509
- # override these limits for a specific campaign, use the <link
18046
+ # The default sending limits for campaigns and journeys in the
18047
+ # application. To override these limits and define custom limits for a
18048
+ # specific campaign or journey, use the <link
17510
18049
  # linkend="apps-application-id-campaigns-campaign-id" />
17511
18050
  #
17512
- # Campaign</link> resource to define custom limits for the campaign.
18051
+ # Campaign</link> resource or the <link
18052
+ # linkend="apps-application-id-journeys-journey-id" />
18053
+ #
18054
+ # Journey</link> resource, respectively.
17513
18055
  # @return [Types::CampaignLimits]
17514
18056
  #
17515
18057
  # @!attribute [rw] quiet_time
@@ -17563,6 +18105,10 @@ module Aws::Pinpoint
17563
18105
  # {
17564
18106
  # additional_treatments: [
17565
18107
  # {
18108
+ # custom_delivery_configuration: {
18109
+ # delivery_uri: "__string", # required
18110
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
18111
+ # },
17566
18112
  # message_configuration: {
17567
18113
  # adm_message: {
17568
18114
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
@@ -17606,6 +18152,9 @@ module Aws::Pinpoint
17606
18152
  # title: "__string",
17607
18153
  # url: "__string",
17608
18154
  # },
18155
+ # custom_message: {
18156
+ # data: "__string",
18157
+ # },
17609
18158
  # default_message: {
17610
18159
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
17611
18160
  # body: "__string",
@@ -17701,6 +18250,10 @@ module Aws::Pinpoint
17701
18250
  # treatment_name: "__string",
17702
18251
  # },
17703
18252
  # ],
18253
+ # custom_delivery_configuration: {
18254
+ # delivery_uri: "__string", # required
18255
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
18256
+ # },
17704
18257
  # description: "__string",
17705
18258
  # holdout_percent: 1,
17706
18259
  # hook: {
@@ -17758,6 +18311,9 @@ module Aws::Pinpoint
17758
18311
  # title: "__string",
17759
18312
  # url: "__string",
17760
18313
  # },
18314
+ # custom_message: {
18315
+ # data: "__string",
18316
+ # },
17761
18317
  # default_message: {
17762
18318
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
17763
18319
  # body: "__string",
@@ -17863,6 +18419,13 @@ module Aws::Pinpoint
17863
18419
  # campaign, in addition to the default treatment for the campaign.
17864
18420
  # @return [Array<Types::WriteTreatmentResource>]
17865
18421
  #
18422
+ # @!attribute [rw] custom_delivery_configuration
18423
+ # The delivery configuration settings for sending the campaign through
18424
+ # a custom channel. This object is required if the
18425
+ # MessageConfiguration object for the campaign specifies a
18426
+ # CustomMessage object.
18427
+ # @return [Types::CustomDeliveryConfiguration]
18428
+ #
17866
18429
  # @!attribute [rw] description
17867
18430
  # A custom description of the campaign.
17868
18431
  # @return [String]
@@ -17873,13 +18436,14 @@ module Aws::Pinpoint
17873
18436
  # @return [Integer]
17874
18437
  #
17875
18438
  # @!attribute [rw] hook
17876
- # The settings for the AWS Lambda function to use as a code hook for
17877
- # the campaign.
18439
+ # The settings for the AWS Lambda function to invoke as a code hook
18440
+ # for the campaign. You can use this hook to customize the segment
18441
+ # that's used by the campaign.
17878
18442
  # @return [Types::CampaignHook]
17879
18443
  #
17880
18444
  # @!attribute [rw] is_paused
17881
18445
  # Specifies whether to pause the campaign. A paused campaign doesn't
17882
- # run unless you resume it by setting this value to false.
18446
+ # run unless you resume it by changing this value to false.
17883
18447
  # @return [Boolean]
17884
18448
  #
17885
18449
  # @!attribute [rw] limits
@@ -17918,19 +18482,20 @@ module Aws::Pinpoint
17918
18482
  # @return [Types::TemplateConfiguration]
17919
18483
  #
17920
18484
  # @!attribute [rw] treatment_description
17921
- # A custom description of a variation of the campaign to use for A/B
17922
- # testing.
18485
+ # A custom description of the default treatment for the campaign.
17923
18486
  # @return [String]
17924
18487
  #
17925
18488
  # @!attribute [rw] treatment_name
17926
- # A custom name for a variation of the campaign to use for A/B
17927
- # testing.
18489
+ # A custom name of the default treatment for the campaign, if the
18490
+ # campaign has multiple treatments. A *treatment* is a variation of a
18491
+ # campaign that's used for A/B testing.
17928
18492
  # @return [String]
17929
18493
  #
17930
18494
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteCampaignRequest AWS API Documentation
17931
18495
  #
17932
18496
  class WriteCampaignRequest < Struct.new(
17933
18497
  :additional_treatments,
18498
+ :custom_delivery_configuration,
17934
18499
  :description,
17935
18500
  :holdout_percent,
17936
18501
  :hook,
@@ -17994,6 +18559,16 @@ module Aws::Pinpoint
17994
18559
  # {
17995
18560
  # activities: {
17996
18561
  # "__string" => {
18562
+ # custom: {
18563
+ # delivery_uri: "__string",
18564
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
18565
+ # message_config: {
18566
+ # data: "__string",
18567
+ # },
18568
+ # next_activity: "__string",
18569
+ # template_name: "__string",
18570
+ # template_version: "__string",
18571
+ # },
17997
18572
  # conditional_split: {
17998
18573
  # condition: {
17999
18574
  # conditions: [
@@ -18214,6 +18789,14 @@ module Aws::Pinpoint
18214
18789
  # wait_until: "__string",
18215
18790
  # },
18216
18791
  # },
18792
+ # push: {
18793
+ # message_config: {
18794
+ # time_to_live: "__string",
18795
+ # },
18796
+ # next_activity: "__string",
18797
+ # template_name: "__string",
18798
+ # template_version: "__string",
18799
+ # },
18217
18800
  # random_split: {
18218
18801
  # branches: [
18219
18802
  # {
@@ -18222,6 +18805,15 @@ module Aws::Pinpoint
18222
18805
  # },
18223
18806
  # ],
18224
18807
  # },
18808
+ # sms: {
18809
+ # message_config: {
18810
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
18811
+ # sender_id: "__string",
18812
+ # },
18813
+ # next_activity: "__string",
18814
+ # template_name: "__string",
18815
+ # template_version: "__string",
18816
+ # },
18225
18817
  # wait: {
18226
18818
  # next_activity: "__string",
18227
18819
  # wait_time: {
@@ -18561,13 +19153,17 @@ module Aws::Pinpoint
18561
19153
  include Aws::Structure
18562
19154
  end
18563
19155
 
18564
- # Specifies the settings for a campaign treatment. A treatment is a
19156
+ # Specifies the settings for a campaign treatment. A *treatment* is a
18565
19157
  # variation of a campaign that's used for A/B testing of a campaign.
18566
19158
  #
18567
19159
  # @note When making an API call, you may pass WriteTreatmentResource
18568
19160
  # data as a hash:
18569
19161
  #
18570
19162
  # {
19163
+ # custom_delivery_configuration: {
19164
+ # delivery_uri: "__string", # required
19165
+ # endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
19166
+ # },
18571
19167
  # message_configuration: {
18572
19168
  # adm_message: {
18573
19169
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
@@ -18611,6 +19207,9 @@ module Aws::Pinpoint
18611
19207
  # title: "__string",
18612
19208
  # url: "__string",
18613
19209
  # },
19210
+ # custom_message: {
19211
+ # data: "__string",
19212
+ # },
18614
19213
  # default_message: {
18615
19214
  # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
18616
19215
  # body: "__string",
@@ -18706,6 +19305,13 @@ module Aws::Pinpoint
18706
19305
  # treatment_name: "__string",
18707
19306
  # }
18708
19307
  #
19308
+ # @!attribute [rw] custom_delivery_configuration
19309
+ # The delivery configuration settings for sending the treatment
19310
+ # through a custom channel. This object is required if the
19311
+ # MessageConfiguration object for the treatment specifies a
19312
+ # CustomMessage object.
19313
+ # @return [Types::CustomDeliveryConfiguration]
19314
+ #
18709
19315
  # @!attribute [rw] message_configuration
18710
19316
  # The message configuration settings for the treatment.
18711
19317
  # @return [Types::MessageConfiguration]
@@ -18728,13 +19334,13 @@ module Aws::Pinpoint
18728
19334
  # @return [String]
18729
19335
  #
18730
19336
  # @!attribute [rw] treatment_name
18731
- # A custom name for the treatment. A treatment is a variation of a
18732
- # campaign that's used for A/B testing of a campaign.
19337
+ # A custom name for the treatment.
18733
19338
  # @return [String]
18734
19339
  #
18735
19340
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteTreatmentResource AWS API Documentation
18736
19341
  #
18737
19342
  class WriteTreatmentResource < Struct.new(
19343
+ :custom_delivery_configuration,
18738
19344
  :message_configuration,
18739
19345
  :schedule,
18740
19346
  :size_percent,