aws-sdk-pinpoint 1.31.0 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +264 -36
- data/lib/aws-sdk-pinpoint/client_api.rb +102 -0
- data/lib/aws-sdk-pinpoint/types.rb +482 -48
- metadata +2 -2
@@ -288,11 +288,14 @@ module Aws::Pinpoint
|
|
288
288
|
ListOfSegmentResponse = Shapes::ListShape.new(name: 'ListOfSegmentResponse')
|
289
289
|
ListOfSimpleCondition = Shapes::ListShape.new(name: 'ListOfSimpleCondition')
|
290
290
|
ListOfTemplateResponse = Shapes::ListShape.new(name: 'ListOfTemplateResponse')
|
291
|
+
ListOfTemplateVersionResponse = Shapes::ListShape.new(name: 'ListOfTemplateVersionResponse')
|
291
292
|
ListOfTreatmentResource = Shapes::ListShape.new(name: 'ListOfTreatmentResource')
|
292
293
|
ListOfWriteTreatmentResource = Shapes::ListShape.new(name: 'ListOfWriteTreatmentResource')
|
293
294
|
ListOf__string = Shapes::ListShape.new(name: 'ListOf__string')
|
294
295
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
295
296
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
297
|
+
ListTemplateVersionsRequest = Shapes::StructureShape.new(name: 'ListTemplateVersionsRequest')
|
298
|
+
ListTemplateVersionsResponse = Shapes::StructureShape.new(name: 'ListTemplateVersionsResponse')
|
296
299
|
ListTemplatesRequest = Shapes::StructureShape.new(name: 'ListTemplatesRequest')
|
297
300
|
ListTemplatesResponse = Shapes::StructureShape.new(name: 'ListTemplatesResponse')
|
298
301
|
MapOfActivity = Shapes::MapShape.new(name: 'MapOfActivity')
|
@@ -382,9 +385,12 @@ module Aws::Pinpoint
|
|
382
385
|
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
383
386
|
TagsModel = Shapes::StructureShape.new(name: 'TagsModel')
|
384
387
|
Template = Shapes::StructureShape.new(name: 'Template')
|
388
|
+
TemplateActiveVersionRequest = Shapes::StructureShape.new(name: 'TemplateActiveVersionRequest')
|
385
389
|
TemplateConfiguration = Shapes::StructureShape.new(name: 'TemplateConfiguration')
|
386
390
|
TemplateResponse = Shapes::StructureShape.new(name: 'TemplateResponse')
|
387
391
|
TemplateType = Shapes::StringShape.new(name: 'TemplateType')
|
392
|
+
TemplateVersionResponse = Shapes::StructureShape.new(name: 'TemplateVersionResponse')
|
393
|
+
TemplateVersionsResponse = Shapes::StructureShape.new(name: 'TemplateVersionsResponse')
|
388
394
|
TemplatesResponse = Shapes::StructureShape.new(name: 'TemplatesResponse')
|
389
395
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
390
396
|
TreatmentResource = Shapes::StructureShape.new(name: 'TreatmentResource')
|
@@ -429,6 +435,8 @@ module Aws::Pinpoint
|
|
429
435
|
UpdateSmsChannelResponse = Shapes::StructureShape.new(name: 'UpdateSmsChannelResponse')
|
430
436
|
UpdateSmsTemplateRequest = Shapes::StructureShape.new(name: 'UpdateSmsTemplateRequest')
|
431
437
|
UpdateSmsTemplateResponse = Shapes::StructureShape.new(name: 'UpdateSmsTemplateResponse')
|
438
|
+
UpdateTemplateActiveVersionRequest = Shapes::StructureShape.new(name: 'UpdateTemplateActiveVersionRequest')
|
439
|
+
UpdateTemplateActiveVersionResponse = Shapes::StructureShape.new(name: 'UpdateTemplateActiveVersionResponse')
|
432
440
|
UpdateVoiceChannelRequest = Shapes::StructureShape.new(name: 'UpdateVoiceChannelRequest')
|
433
441
|
UpdateVoiceChannelResponse = Shapes::StructureShape.new(name: 'UpdateVoiceChannelResponse')
|
434
442
|
UpdateVoiceTemplateRequest = Shapes::StructureShape.new(name: 'UpdateVoiceTemplateRequest')
|
@@ -1040,6 +1048,7 @@ module Aws::Pinpoint
|
|
1040
1048
|
DeleteEmailChannelResponse[:payload_member] = DeleteEmailChannelResponse.member(:email_channel_response)
|
1041
1049
|
|
1042
1050
|
DeleteEmailTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1051
|
+
DeleteEmailTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1043
1052
|
DeleteEmailTemplateRequest.struct_class = Types::DeleteEmailTemplateRequest
|
1044
1053
|
|
1045
1054
|
DeleteEmailTemplateResponse.add_member(:message_body, Shapes::ShapeRef.new(shape: MessageBody, required: true, location_name: "MessageBody"))
|
@@ -1082,6 +1091,7 @@ module Aws::Pinpoint
|
|
1082
1091
|
DeleteJourneyResponse[:payload_member] = DeleteJourneyResponse.member(:journey_response)
|
1083
1092
|
|
1084
1093
|
DeletePushTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1094
|
+
DeletePushTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1085
1095
|
DeletePushTemplateRequest.struct_class = Types::DeletePushTemplateRequest
|
1086
1096
|
|
1087
1097
|
DeletePushTemplateResponse.add_member(:message_body, Shapes::ShapeRef.new(shape: MessageBody, required: true, location_name: "MessageBody"))
|
@@ -1107,6 +1117,7 @@ module Aws::Pinpoint
|
|
1107
1117
|
DeleteSmsChannelResponse[:payload_member] = DeleteSmsChannelResponse.member(:sms_channel_response)
|
1108
1118
|
|
1109
1119
|
DeleteSmsTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1120
|
+
DeleteSmsTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1110
1121
|
DeleteSmsTemplateRequest.struct_class = Types::DeleteSmsTemplateRequest
|
1111
1122
|
|
1112
1123
|
DeleteSmsTemplateResponse.add_member(:message_body, Shapes::ShapeRef.new(shape: MessageBody, required: true, location_name: "MessageBody"))
|
@@ -1132,6 +1143,7 @@ module Aws::Pinpoint
|
|
1132
1143
|
DeleteVoiceChannelResponse[:payload_member] = DeleteVoiceChannelResponse.member(:voice_channel_response)
|
1133
1144
|
|
1134
1145
|
DeleteVoiceTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1146
|
+
DeleteVoiceTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1135
1147
|
DeleteVoiceTemplateRequest.struct_class = Types::DeleteVoiceTemplateRequest
|
1136
1148
|
|
1137
1149
|
DeleteVoiceTemplateResponse.add_member(:message_body, Shapes::ShapeRef.new(shape: MessageBody, required: true, location_name: "MessageBody"))
|
@@ -1186,6 +1198,7 @@ module Aws::Pinpoint
|
|
1186
1198
|
EmailMessageActivity.add_member(:message_config, Shapes::ShapeRef.new(shape: JourneyEmailMessage, location_name: "MessageConfig"))
|
1187
1199
|
EmailMessageActivity.add_member(:next_activity, Shapes::ShapeRef.new(shape: __string, location_name: "NextActivity"))
|
1188
1200
|
EmailMessageActivity.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateName"))
|
1201
|
+
EmailMessageActivity.add_member(:template_version, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateVersion"))
|
1189
1202
|
EmailMessageActivity.struct_class = Types::EmailMessageActivity
|
1190
1203
|
|
1191
1204
|
EmailTemplateRequest.add_member(:default_substitutions, Shapes::ShapeRef.new(shape: __string, location_name: "DefaultSubstitutions"))
|
@@ -1207,6 +1220,7 @@ module Aws::Pinpoint
|
|
1207
1220
|
EmailTemplateResponse.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateName"))
|
1208
1221
|
EmailTemplateResponse.add_member(:template_type, Shapes::ShapeRef.new(shape: TemplateType, required: true, location_name: "TemplateType"))
|
1209
1222
|
EmailTemplateResponse.add_member(:text_part, Shapes::ShapeRef.new(shape: __string, location_name: "TextPart"))
|
1223
|
+
EmailTemplateResponse.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
1210
1224
|
EmailTemplateResponse.struct_class = Types::EmailTemplateResponse
|
1211
1225
|
|
1212
1226
|
EndpointBatchItem.add_member(:address, Shapes::ShapeRef.new(shape: __string, location_name: "Address"))
|
@@ -1590,6 +1604,7 @@ module Aws::Pinpoint
|
|
1590
1604
|
GetEmailChannelResponse[:payload_member] = GetEmailChannelResponse.member(:email_channel_response)
|
1591
1605
|
|
1592
1606
|
GetEmailTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1607
|
+
GetEmailTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1593
1608
|
GetEmailTemplateRequest.struct_class = Types::GetEmailTemplateRequest
|
1594
1609
|
|
1595
1610
|
GetEmailTemplateResponse.add_member(:email_template_response, Shapes::ShapeRef.new(shape: EmailTemplateResponse, required: true, location_name: "EmailTemplateResponse"))
|
@@ -1707,6 +1722,7 @@ module Aws::Pinpoint
|
|
1707
1722
|
GetJourneyResponse[:payload_member] = GetJourneyResponse.member(:journey_response)
|
1708
1723
|
|
1709
1724
|
GetPushTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1725
|
+
GetPushTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1710
1726
|
GetPushTemplateRequest.struct_class = Types::GetPushTemplateRequest
|
1711
1727
|
|
1712
1728
|
GetPushTemplateResponse.add_member(:push_notification_template_response, Shapes::ShapeRef.new(shape: PushNotificationTemplateResponse, required: true, location_name: "PushNotificationTemplateResponse"))
|
@@ -1785,6 +1801,7 @@ module Aws::Pinpoint
|
|
1785
1801
|
GetSmsChannelResponse[:payload_member] = GetSmsChannelResponse.member(:sms_channel_response)
|
1786
1802
|
|
1787
1803
|
GetSmsTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1804
|
+
GetSmsTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1788
1805
|
GetSmsTemplateRequest.struct_class = Types::GetSmsTemplateRequest
|
1789
1806
|
|
1790
1807
|
GetSmsTemplateResponse.add_member(:sms_template_response, Shapes::ShapeRef.new(shape: SMSTemplateResponse, required: true, location_name: "SMSTemplateResponse"))
|
@@ -1810,6 +1827,7 @@ module Aws::Pinpoint
|
|
1810
1827
|
GetVoiceChannelResponse[:payload_member] = GetVoiceChannelResponse.member(:voice_channel_response)
|
1811
1828
|
|
1812
1829
|
GetVoiceTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
1830
|
+
GetVoiceTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
1813
1831
|
GetVoiceTemplateRequest.struct_class = Types::GetVoiceTemplateRequest
|
1814
1832
|
|
1815
1833
|
GetVoiceTemplateResponse.add_member(:voice_template_response, Shapes::ShapeRef.new(shape: VoiceTemplateResponse, required: true, location_name: "VoiceTemplateResponse"))
|
@@ -1974,6 +1992,8 @@ module Aws::Pinpoint
|
|
1974
1992
|
|
1975
1993
|
ListOfTemplateResponse.member = Shapes::ShapeRef.new(shape: TemplateResponse)
|
1976
1994
|
|
1995
|
+
ListOfTemplateVersionResponse.member = Shapes::ShapeRef.new(shape: TemplateVersionResponse)
|
1996
|
+
|
1977
1997
|
ListOfTreatmentResource.member = Shapes::ShapeRef.new(shape: TreatmentResource)
|
1978
1998
|
|
1979
1999
|
ListOfWriteTreatmentResource.member = Shapes::ShapeRef.new(shape: WriteTreatmentResource)
|
@@ -1988,6 +2008,17 @@ module Aws::Pinpoint
|
|
1988
2008
|
ListTagsForResourceResponse[:payload] = :tags_model
|
1989
2009
|
ListTagsForResourceResponse[:payload_member] = ListTagsForResourceResponse.member(:tags_model)
|
1990
2010
|
|
2011
|
+
ListTemplateVersionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "next-token"))
|
2012
|
+
ListTemplateVersionsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "page-size"))
|
2013
|
+
ListTemplateVersionsRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
2014
|
+
ListTemplateVersionsRequest.add_member(:template_type, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-type"))
|
2015
|
+
ListTemplateVersionsRequest.struct_class = Types::ListTemplateVersionsRequest
|
2016
|
+
|
2017
|
+
ListTemplateVersionsResponse.add_member(:template_versions_response, Shapes::ShapeRef.new(shape: TemplateVersionsResponse, required: true, location_name: "TemplateVersionsResponse"))
|
2018
|
+
ListTemplateVersionsResponse.struct_class = Types::ListTemplateVersionsResponse
|
2019
|
+
ListTemplateVersionsResponse[:payload] = :template_versions_response
|
2020
|
+
ListTemplateVersionsResponse[:payload_member] = ListTemplateVersionsResponse.member(:template_versions_response)
|
2021
|
+
|
1991
2022
|
ListTemplatesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "next-token"))
|
1992
2023
|
ListTemplatesRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "page-size"))
|
1993
2024
|
ListTemplatesRequest.add_member(:prefix, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "prefix"))
|
@@ -2185,6 +2216,7 @@ module Aws::Pinpoint
|
|
2185
2216
|
PushNotificationTemplateResponse.add_member(:template_description, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateDescription"))
|
2186
2217
|
PushNotificationTemplateResponse.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateName"))
|
2187
2218
|
PushNotificationTemplateResponse.add_member(:template_type, Shapes::ShapeRef.new(shape: TemplateType, required: true, location_name: "TemplateType"))
|
2219
|
+
PushNotificationTemplateResponse.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2188
2220
|
PushNotificationTemplateResponse.struct_class = Types::PushNotificationTemplateResponse
|
2189
2221
|
|
2190
2222
|
PutEventStreamRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
@@ -2292,6 +2324,7 @@ module Aws::Pinpoint
|
|
2292
2324
|
SMSTemplateResponse.add_member(:template_description, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateDescription"))
|
2293
2325
|
SMSTemplateResponse.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateName"))
|
2294
2326
|
SMSTemplateResponse.add_member(:template_type, Shapes::ShapeRef.new(shape: TemplateType, required: true, location_name: "TemplateType"))
|
2327
|
+
SMSTemplateResponse.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2295
2328
|
SMSTemplateResponse.struct_class = Types::SMSTemplateResponse
|
2296
2329
|
|
2297
2330
|
Schedule.add_member(:end_time, Shapes::ShapeRef.new(shape: __string, location_name: "EndTime"))
|
@@ -2441,8 +2474,12 @@ module Aws::Pinpoint
|
|
2441
2474
|
TagsModel.struct_class = Types::TagsModel
|
2442
2475
|
|
2443
2476
|
Template.add_member(:name, Shapes::ShapeRef.new(shape: __string, location_name: "Name"))
|
2477
|
+
Template.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2444
2478
|
Template.struct_class = Types::Template
|
2445
2479
|
|
2480
|
+
TemplateActiveVersionRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2481
|
+
TemplateActiveVersionRequest.struct_class = Types::TemplateActiveVersionRequest
|
2482
|
+
|
2446
2483
|
TemplateConfiguration.add_member(:email_template, Shapes::ShapeRef.new(shape: Template, location_name: "EmailTemplate"))
|
2447
2484
|
TemplateConfiguration.add_member(:push_template, Shapes::ShapeRef.new(shape: Template, location_name: "PushTemplate"))
|
2448
2485
|
TemplateConfiguration.add_member(:sms_template, Shapes::ShapeRef.new(shape: Template, location_name: "SMSTemplate"))
|
@@ -2457,8 +2494,24 @@ module Aws::Pinpoint
|
|
2457
2494
|
TemplateResponse.add_member(:template_description, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateDescription"))
|
2458
2495
|
TemplateResponse.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateName"))
|
2459
2496
|
TemplateResponse.add_member(:template_type, Shapes::ShapeRef.new(shape: TemplateType, required: true, location_name: "TemplateType"))
|
2497
|
+
TemplateResponse.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2460
2498
|
TemplateResponse.struct_class = Types::TemplateResponse
|
2461
2499
|
|
2500
|
+
TemplateVersionResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "CreationDate"))
|
2501
|
+
TemplateVersionResponse.add_member(:default_substitutions, Shapes::ShapeRef.new(shape: __string, location_name: "DefaultSubstitutions"))
|
2502
|
+
TemplateVersionResponse.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "LastModifiedDate"))
|
2503
|
+
TemplateVersionResponse.add_member(:template_description, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateDescription"))
|
2504
|
+
TemplateVersionResponse.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateName"))
|
2505
|
+
TemplateVersionResponse.add_member(:template_type, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateType"))
|
2506
|
+
TemplateVersionResponse.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2507
|
+
TemplateVersionResponse.struct_class = Types::TemplateVersionResponse
|
2508
|
+
|
2509
|
+
TemplateVersionsResponse.add_member(:item, Shapes::ShapeRef.new(shape: ListOfTemplateVersionResponse, required: true, location_name: "Item"))
|
2510
|
+
TemplateVersionsResponse.add_member(:message, Shapes::ShapeRef.new(shape: __string, location_name: "Message"))
|
2511
|
+
TemplateVersionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "NextToken"))
|
2512
|
+
TemplateVersionsResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: __string, location_name: "RequestID"))
|
2513
|
+
TemplateVersionsResponse.struct_class = Types::TemplateVersionsResponse
|
2514
|
+
|
2462
2515
|
TemplatesResponse.add_member(:item, Shapes::ShapeRef.new(shape: ListOfTemplateResponse, required: true, location_name: "Item"))
|
2463
2516
|
TemplatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "NextToken"))
|
2464
2517
|
TemplatesResponse.struct_class = Types::TemplatesResponse
|
@@ -2584,8 +2637,10 @@ module Aws::Pinpoint
|
|
2584
2637
|
UpdateEmailChannelResponse[:payload] = :email_channel_response
|
2585
2638
|
UpdateEmailChannelResponse[:payload_member] = UpdateEmailChannelResponse.member(:email_channel_response)
|
2586
2639
|
|
2640
|
+
UpdateEmailTemplateRequest.add_member(:create_new_version, Shapes::ShapeRef.new(shape: __boolean, location: "querystring", location_name: "create-new-version"))
|
2587
2641
|
UpdateEmailTemplateRequest.add_member(:email_template_request, Shapes::ShapeRef.new(shape: EmailTemplateRequest, required: true, location_name: "EmailTemplateRequest"))
|
2588
2642
|
UpdateEmailTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
2643
|
+
UpdateEmailTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
2589
2644
|
UpdateEmailTemplateRequest.struct_class = Types::UpdateEmailTemplateRequest
|
2590
2645
|
UpdateEmailTemplateRequest[:payload] = :email_template_request
|
2591
2646
|
UpdateEmailTemplateRequest[:payload_member] = UpdateEmailTemplateRequest.member(:email_template_request)
|
@@ -2653,8 +2708,10 @@ module Aws::Pinpoint
|
|
2653
2708
|
UpdateJourneyStateResponse[:payload] = :journey_response
|
2654
2709
|
UpdateJourneyStateResponse[:payload_member] = UpdateJourneyStateResponse.member(:journey_response)
|
2655
2710
|
|
2711
|
+
UpdatePushTemplateRequest.add_member(:create_new_version, Shapes::ShapeRef.new(shape: __boolean, location: "querystring", location_name: "create-new-version"))
|
2656
2712
|
UpdatePushTemplateRequest.add_member(:push_notification_template_request, Shapes::ShapeRef.new(shape: PushNotificationTemplateRequest, required: true, location_name: "PushNotificationTemplateRequest"))
|
2657
2713
|
UpdatePushTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
2714
|
+
UpdatePushTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
2658
2715
|
UpdatePushTemplateRequest.struct_class = Types::UpdatePushTemplateRequest
|
2659
2716
|
UpdatePushTemplateRequest[:payload] = :push_notification_template_request
|
2660
2717
|
UpdatePushTemplateRequest[:payload_member] = UpdatePushTemplateRequest.member(:push_notification_template_request)
|
@@ -2687,8 +2744,10 @@ module Aws::Pinpoint
|
|
2687
2744
|
UpdateSmsChannelResponse[:payload] = :sms_channel_response
|
2688
2745
|
UpdateSmsChannelResponse[:payload_member] = UpdateSmsChannelResponse.member(:sms_channel_response)
|
2689
2746
|
|
2747
|
+
UpdateSmsTemplateRequest.add_member(:create_new_version, Shapes::ShapeRef.new(shape: __boolean, location: "querystring", location_name: "create-new-version"))
|
2690
2748
|
UpdateSmsTemplateRequest.add_member(:sms_template_request, Shapes::ShapeRef.new(shape: SMSTemplateRequest, required: true, location_name: "SMSTemplateRequest"))
|
2691
2749
|
UpdateSmsTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
2750
|
+
UpdateSmsTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
2692
2751
|
UpdateSmsTemplateRequest.struct_class = Types::UpdateSmsTemplateRequest
|
2693
2752
|
UpdateSmsTemplateRequest[:payload] = :sms_template_request
|
2694
2753
|
UpdateSmsTemplateRequest[:payload_member] = UpdateSmsTemplateRequest.member(:sms_template_request)
|
@@ -2698,6 +2757,18 @@ module Aws::Pinpoint
|
|
2698
2757
|
UpdateSmsTemplateResponse[:payload] = :message_body
|
2699
2758
|
UpdateSmsTemplateResponse[:payload_member] = UpdateSmsTemplateResponse.member(:message_body)
|
2700
2759
|
|
2760
|
+
UpdateTemplateActiveVersionRequest.add_member(:template_active_version_request, Shapes::ShapeRef.new(shape: TemplateActiveVersionRequest, required: true, location_name: "TemplateActiveVersionRequest"))
|
2761
|
+
UpdateTemplateActiveVersionRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
2762
|
+
UpdateTemplateActiveVersionRequest.add_member(:template_type, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-type"))
|
2763
|
+
UpdateTemplateActiveVersionRequest.struct_class = Types::UpdateTemplateActiveVersionRequest
|
2764
|
+
UpdateTemplateActiveVersionRequest[:payload] = :template_active_version_request
|
2765
|
+
UpdateTemplateActiveVersionRequest[:payload_member] = UpdateTemplateActiveVersionRequest.member(:template_active_version_request)
|
2766
|
+
|
2767
|
+
UpdateTemplateActiveVersionResponse.add_member(:message_body, Shapes::ShapeRef.new(shape: MessageBody, required: true, location_name: "MessageBody"))
|
2768
|
+
UpdateTemplateActiveVersionResponse.struct_class = Types::UpdateTemplateActiveVersionResponse
|
2769
|
+
UpdateTemplateActiveVersionResponse[:payload] = :message_body
|
2770
|
+
UpdateTemplateActiveVersionResponse[:payload_member] = UpdateTemplateActiveVersionResponse.member(:message_body)
|
2771
|
+
|
2701
2772
|
UpdateVoiceChannelRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
2702
2773
|
UpdateVoiceChannelRequest.add_member(:voice_channel_request, Shapes::ShapeRef.new(shape: VoiceChannelRequest, required: true, location_name: "VoiceChannelRequest"))
|
2703
2774
|
UpdateVoiceChannelRequest.struct_class = Types::UpdateVoiceChannelRequest
|
@@ -2709,7 +2780,9 @@ module Aws::Pinpoint
|
|
2709
2780
|
UpdateVoiceChannelResponse[:payload] = :voice_channel_response
|
2710
2781
|
UpdateVoiceChannelResponse[:payload_member] = UpdateVoiceChannelResponse.member(:voice_channel_response)
|
2711
2782
|
|
2783
|
+
UpdateVoiceTemplateRequest.add_member(:create_new_version, Shapes::ShapeRef.new(shape: __boolean, location: "querystring", location_name: "create-new-version"))
|
2712
2784
|
UpdateVoiceTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
2785
|
+
UpdateVoiceTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
2713
2786
|
UpdateVoiceTemplateRequest.add_member(:voice_template_request, Shapes::ShapeRef.new(shape: VoiceTemplateRequest, required: true, location_name: "VoiceTemplateRequest"))
|
2714
2787
|
UpdateVoiceTemplateRequest.struct_class = Types::UpdateVoiceTemplateRequest
|
2715
2788
|
UpdateVoiceTemplateRequest[:payload] = :voice_template_request
|
@@ -2760,6 +2833,7 @@ module Aws::Pinpoint
|
|
2760
2833
|
VoiceTemplateResponse.add_member(:template_description, Shapes::ShapeRef.new(shape: __string, location_name: "TemplateDescription"))
|
2761
2834
|
VoiceTemplateResponse.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "TemplateName"))
|
2762
2835
|
VoiceTemplateResponse.add_member(:template_type, Shapes::ShapeRef.new(shape: TemplateType, required: true, location_name: "TemplateType"))
|
2836
|
+
VoiceTemplateResponse.add_member(:version, Shapes::ShapeRef.new(shape: __string, location_name: "Version"))
|
2763
2837
|
VoiceTemplateResponse.add_member(:voice_id, Shapes::ShapeRef.new(shape: __string, location_name: "VoiceId"))
|
2764
2838
|
VoiceTemplateResponse.struct_class = Types::VoiceTemplateResponse
|
2765
2839
|
|
@@ -3884,6 +3958,20 @@ module Aws::Pinpoint
|
|
3884
3958
|
o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceResponse)
|
3885
3959
|
end)
|
3886
3960
|
|
3961
|
+
api.add_operation(:list_template_versions, Seahorse::Model::Operation.new.tap do |o|
|
3962
|
+
o.name = "ListTemplateVersions"
|
3963
|
+
o.http_method = "GET"
|
3964
|
+
o.http_request_uri = "/v1/templates/{template-name}/{template-type}/versions"
|
3965
|
+
o.input = Shapes::ShapeRef.new(shape: ListTemplateVersionsRequest)
|
3966
|
+
o.output = Shapes::ShapeRef.new(shape: ListTemplateVersionsResponse)
|
3967
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
3968
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
3969
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
3970
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
3971
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
3972
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
3973
|
+
end)
|
3974
|
+
|
3887
3975
|
api.add_operation(:list_templates, Seahorse::Model::Operation.new.tap do |o|
|
3888
3976
|
o.name = "ListTemplates"
|
3889
3977
|
o.http_method = "GET"
|
@@ -4263,6 +4351,20 @@ module Aws::Pinpoint
|
|
4263
4351
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
4264
4352
|
end)
|
4265
4353
|
|
4354
|
+
api.add_operation(:update_template_active_version, Seahorse::Model::Operation.new.tap do |o|
|
4355
|
+
o.name = "UpdateTemplateActiveVersion"
|
4356
|
+
o.http_method = "PUT"
|
4357
|
+
o.http_request_uri = "/v1/templates/{template-name}/{template-type}/active-version"
|
4358
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateTemplateActiveVersionRequest)
|
4359
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateTemplateActiveVersionResponse)
|
4360
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
4361
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
4362
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
4363
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
4364
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
4365
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
4366
|
+
end)
|
4367
|
+
|
4266
4368
|
api.add_operation(:update_voice_channel, Seahorse::Model::Operation.new.tap do |o|
|
4267
4369
|
o.name = "UpdateVoiceChannel"
|
4268
4370
|
o.http_method = "PUT"
|
@@ -1345,6 +1345,7 @@ module Aws::Pinpoint
|
|
1345
1345
|
# },
|
1346
1346
|
# next_activity: "__string",
|
1347
1347
|
# template_name: "__string",
|
1348
|
+
# template_version: "__string",
|
1348
1349
|
# },
|
1349
1350
|
# holdout: {
|
1350
1351
|
# next_activity: "__string",
|
@@ -1492,8 +1493,9 @@ module Aws::Pinpoint
|
|
1492
1493
|
#
|
1493
1494
|
# @!attribute [rw] multi_condition
|
1494
1495
|
# The settings for a multivariate split activity. This type of
|
1495
|
-
# activity sends participants down one of as many as five paths
|
1496
|
-
# journey, based on conditions
|
1496
|
+
# activity sends participants down one of as many as five paths
|
1497
|
+
# (including a default *Else* path) in a journey, based on conditions
|
1498
|
+
# that you specify.
|
1497
1499
|
# @return [Types::MultiConditionalSplitActivity]
|
1498
1500
|
#
|
1499
1501
|
# @!attribute [rw] random_split
|
@@ -2526,7 +2528,7 @@ module Aws::Pinpoint
|
|
2526
2528
|
# @return [String]
|
2527
2529
|
#
|
2528
2530
|
# @!attribute [rw] creation_date
|
2529
|
-
# The date, ISO 8601 format, when the campaign was created.
|
2531
|
+
# The date, in ISO 8601 format, when the campaign was created.
|
2530
2532
|
# @return [String]
|
2531
2533
|
#
|
2532
2534
|
# @!attribute [rw] default_state
|
@@ -3040,13 +3042,13 @@ module Aws::Pinpoint
|
|
3040
3042
|
# @return [Types::WaitTime]
|
3041
3043
|
#
|
3042
3044
|
# @!attribute [rw] false_activity
|
3043
|
-
# The unique identifier for the activity to perform if the
|
3044
|
-
#
|
3045
|
+
# The unique identifier for the activity to perform if the conditions
|
3046
|
+
# aren't met.
|
3045
3047
|
# @return [String]
|
3046
3048
|
#
|
3047
3049
|
# @!attribute [rw] true_activity
|
3048
|
-
# The unique identifier for the activity to perform if the
|
3049
|
-
#
|
3050
|
+
# The unique identifier for the activity to perform if the conditions
|
3051
|
+
# are met.
|
3050
3052
|
# @return [String]
|
3051
3053
|
#
|
3052
3054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ConditionalSplitActivity AWS API Documentation
|
@@ -3253,15 +3255,19 @@ module Aws::Pinpoint
|
|
3253
3255
|
# template_configuration: {
|
3254
3256
|
# email_template: {
|
3255
3257
|
# name: "__string",
|
3258
|
+
# version: "__string",
|
3256
3259
|
# },
|
3257
3260
|
# push_template: {
|
3258
3261
|
# name: "__string",
|
3262
|
+
# version: "__string",
|
3259
3263
|
# },
|
3260
3264
|
# sms_template: {
|
3261
3265
|
# name: "__string",
|
3266
|
+
# version: "__string",
|
3262
3267
|
# },
|
3263
3268
|
# voice_template: {
|
3264
3269
|
# name: "__string",
|
3270
|
+
# version: "__string",
|
3265
3271
|
# },
|
3266
3272
|
# },
|
3267
3273
|
# treatment_description: "__string",
|
@@ -3406,15 +3412,19 @@ module Aws::Pinpoint
|
|
3406
3412
|
# template_configuration: {
|
3407
3413
|
# email_template: {
|
3408
3414
|
# name: "__string",
|
3415
|
+
# version: "__string",
|
3409
3416
|
# },
|
3410
3417
|
# push_template: {
|
3411
3418
|
# name: "__string",
|
3419
|
+
# version: "__string",
|
3412
3420
|
# },
|
3413
3421
|
# sms_template: {
|
3414
3422
|
# name: "__string",
|
3423
|
+
# version: "__string",
|
3415
3424
|
# },
|
3416
3425
|
# voice_template: {
|
3417
3426
|
# name: "__string",
|
3427
|
+
# version: "__string",
|
3418
3428
|
# },
|
3419
3429
|
# },
|
3420
3430
|
# treatment_description: "__string",
|
@@ -3704,6 +3714,7 @@ module Aws::Pinpoint
|
|
3704
3714
|
# },
|
3705
3715
|
# next_activity: "__string",
|
3706
3716
|
# template_name: "__string",
|
3717
|
+
# template_version: "__string",
|
3707
3718
|
# },
|
3708
3719
|
# holdout: {
|
3709
3720
|
# next_activity: "__string",
|
@@ -4734,15 +4745,20 @@ module Aws::Pinpoint
|
|
4734
4745
|
#
|
4735
4746
|
# {
|
4736
4747
|
# template_name: "__string", # required
|
4748
|
+
# version: "__string",
|
4737
4749
|
# }
|
4738
4750
|
#
|
4739
4751
|
# @!attribute [rw] template_name
|
4740
4752
|
# @return [String]
|
4741
4753
|
#
|
4754
|
+
# @!attribute [rw] version
|
4755
|
+
# @return [String]
|
4756
|
+
#
|
4742
4757
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailTemplateRequest AWS API Documentation
|
4743
4758
|
#
|
4744
4759
|
class DeleteEmailTemplateRequest < Struct.new(
|
4745
|
-
:template_name
|
4760
|
+
:template_name,
|
4761
|
+
:version)
|
4746
4762
|
include Aws::Structure
|
4747
4763
|
end
|
4748
4764
|
|
@@ -4890,15 +4906,20 @@ module Aws::Pinpoint
|
|
4890
4906
|
#
|
4891
4907
|
# {
|
4892
4908
|
# template_name: "__string", # required
|
4909
|
+
# version: "__string",
|
4893
4910
|
# }
|
4894
4911
|
#
|
4895
4912
|
# @!attribute [rw] template_name
|
4896
4913
|
# @return [String]
|
4897
4914
|
#
|
4915
|
+
# @!attribute [rw] version
|
4916
|
+
# @return [String]
|
4917
|
+
#
|
4898
4918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeletePushTemplateRequest AWS API Documentation
|
4899
4919
|
#
|
4900
4920
|
class DeletePushTemplateRequest < Struct.new(
|
4901
|
-
:template_name
|
4921
|
+
:template_name,
|
4922
|
+
:version)
|
4902
4923
|
include Aws::Structure
|
4903
4924
|
end
|
4904
4925
|
|
@@ -4981,15 +5002,20 @@ module Aws::Pinpoint
|
|
4981
5002
|
#
|
4982
5003
|
# {
|
4983
5004
|
# template_name: "__string", # required
|
5005
|
+
# version: "__string",
|
4984
5006
|
# }
|
4985
5007
|
#
|
4986
5008
|
# @!attribute [rw] template_name
|
4987
5009
|
# @return [String]
|
4988
5010
|
#
|
5011
|
+
# @!attribute [rw] version
|
5012
|
+
# @return [String]
|
5013
|
+
#
|
4989
5014
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsTemplateRequest AWS API Documentation
|
4990
5015
|
#
|
4991
5016
|
class DeleteSmsTemplateRequest < Struct.new(
|
4992
|
-
:template_name
|
5017
|
+
:template_name,
|
5018
|
+
:version)
|
4993
5019
|
include Aws::Structure
|
4994
5020
|
end
|
4995
5021
|
|
@@ -5072,15 +5098,20 @@ module Aws::Pinpoint
|
|
5072
5098
|
#
|
5073
5099
|
# {
|
5074
5100
|
# template_name: "__string", # required
|
5101
|
+
# version: "__string",
|
5075
5102
|
# }
|
5076
5103
|
#
|
5077
5104
|
# @!attribute [rw] template_name
|
5078
5105
|
# @return [String]
|
5079
5106
|
#
|
5107
|
+
# @!attribute [rw] version
|
5108
|
+
# @return [String]
|
5109
|
+
#
|
5080
5110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceTemplateRequest AWS API Documentation
|
5081
5111
|
#
|
5082
5112
|
class DeleteVoiceTemplateRequest < Struct.new(
|
5083
|
-
:template_name
|
5113
|
+
:template_name,
|
5114
|
+
:version)
|
5084
5115
|
include Aws::Structure
|
5085
5116
|
end
|
5086
5117
|
|
@@ -5563,6 +5594,7 @@ module Aws::Pinpoint
|
|
5563
5594
|
# },
|
5564
5595
|
# next_activity: "__string",
|
5565
5596
|
# template_name: "__string",
|
5597
|
+
# template_version: "__string",
|
5566
5598
|
# }
|
5567
5599
|
#
|
5568
5600
|
# @!attribute [rw] message_config
|
@@ -5578,12 +5610,29 @@ module Aws::Pinpoint
|
|
5578
5610
|
# The name of the email template to use for the message.
|
5579
5611
|
# @return [String]
|
5580
5612
|
#
|
5613
|
+
# @!attribute [rw] template_version
|
5614
|
+
# The unique identifier for the version of the email template to use
|
5615
|
+
# for the message. If specified, this value must match the identifier
|
5616
|
+
# for an existing template version. To retrieve a list of versions and
|
5617
|
+
# version identifiers for a template, use the <link
|
5618
|
+
# linkend="templates-template-name-template-type-versions" />
|
5619
|
+
#
|
5620
|
+
# Template Versions</link> resource.
|
5621
|
+
#
|
5622
|
+
# If you don't specify a value for this property, Amazon Pinpoint
|
5623
|
+
# uses the *active* version of the template. The *active* version is
|
5624
|
+
# typically the version of a template that's been most recently
|
5625
|
+
# reviewed and approved for use, depending on your workflow. It isn't
|
5626
|
+
# necessarily the latest version of a template.
|
5627
|
+
# @return [String]
|
5628
|
+
#
|
5581
5629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailMessageActivity AWS API Documentation
|
5582
5630
|
#
|
5583
5631
|
class EmailMessageActivity < Struct.new(
|
5584
5632
|
:message_config,
|
5585
5633
|
:next_activity,
|
5586
|
-
:template_name
|
5634
|
+
:template_name,
|
5635
|
+
:template_version)
|
5587
5636
|
include Aws::Structure
|
5588
5637
|
end
|
5589
5638
|
|
@@ -5665,7 +5714,7 @@ module Aws::Pinpoint
|
|
5665
5714
|
# @return [String]
|
5666
5715
|
#
|
5667
5716
|
# @!attribute [rw] creation_date
|
5668
|
-
# The date when the message template was created.
|
5717
|
+
# The date, in ISO 8601 format, when the message template was created.
|
5669
5718
|
# @return [String]
|
5670
5719
|
#
|
5671
5720
|
# @!attribute [rw] default_substitutions
|
@@ -5682,7 +5731,8 @@ module Aws::Pinpoint
|
|
5682
5731
|
# @return [String]
|
5683
5732
|
#
|
5684
5733
|
# @!attribute [rw] last_modified_date
|
5685
|
-
# The date when the message template was last
|
5734
|
+
# The date, in ISO 8601 format, when the message template was last
|
5735
|
+
# modified.
|
5686
5736
|
# @return [String]
|
5687
5737
|
#
|
5688
5738
|
# @!attribute [rw] subject
|
@@ -5714,6 +5764,12 @@ module Aws::Pinpoint
|
|
5714
5764
|
# messages that are based on the message template.
|
5715
5765
|
# @return [String]
|
5716
5766
|
#
|
5767
|
+
# @!attribute [rw] version
|
5768
|
+
# The unique identifier, as an integer, for the active version of the
|
5769
|
+
# message template, or the version of the template that you specified
|
5770
|
+
# by using the version parameter in your request.
|
5771
|
+
# @return [String]
|
5772
|
+
#
|
5717
5773
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailTemplateResponse AWS API Documentation
|
5718
5774
|
#
|
5719
5775
|
class EmailTemplateResponse < Struct.new(
|
@@ -5727,7 +5783,8 @@ module Aws::Pinpoint
|
|
5727
5783
|
:template_description,
|
5728
5784
|
:template_name,
|
5729
5785
|
:template_type,
|
5730
|
-
:text_part
|
5786
|
+
:text_part,
|
5787
|
+
:version)
|
5731
5788
|
include Aws::Structure
|
5732
5789
|
end
|
5733
5790
|
|
@@ -5969,11 +6026,12 @@ module Aws::Pinpoint
|
|
5969
6026
|
# @return [String]
|
5970
6027
|
#
|
5971
6028
|
# @!attribute [rw] make
|
5972
|
-
# The manufacturer of the endpoint device, such as
|
6029
|
+
# The manufacturer of the endpoint device, such as apple or samsung.
|
5973
6030
|
# @return [String]
|
5974
6031
|
#
|
5975
6032
|
# @!attribute [rw] model
|
5976
|
-
# The model name or number of the endpoint device, such as iPhone
|
6033
|
+
# The model name or number of the endpoint device, such as iPhone or
|
6034
|
+
# SM-G900F.
|
5977
6035
|
# @return [String]
|
5978
6036
|
#
|
5979
6037
|
# @!attribute [rw] model_version
|
@@ -5981,7 +6039,7 @@ module Aws::Pinpoint
|
|
5981
6039
|
# @return [String]
|
5982
6040
|
#
|
5983
6041
|
# @!attribute [rw] platform
|
5984
|
-
# The platform of the endpoint device, such as
|
6042
|
+
# The platform of the endpoint device, such as ios.
|
5985
6043
|
# @return [String]
|
5986
6044
|
#
|
5987
6045
|
# @!attribute [rw] platform_version
|
@@ -8190,15 +8248,20 @@ module Aws::Pinpoint
|
|
8190
8248
|
#
|
8191
8249
|
# {
|
8192
8250
|
# template_name: "__string", # required
|
8251
|
+
# version: "__string",
|
8193
8252
|
# }
|
8194
8253
|
#
|
8195
8254
|
# @!attribute [rw] template_name
|
8196
8255
|
# @return [String]
|
8197
8256
|
#
|
8257
|
+
# @!attribute [rw] version
|
8258
|
+
# @return [String]
|
8259
|
+
#
|
8198
8260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailTemplateRequest AWS API Documentation
|
8199
8261
|
#
|
8200
8262
|
class GetEmailTemplateRequest < Struct.new(
|
8201
|
-
:template_name
|
8263
|
+
:template_name,
|
8264
|
+
:version)
|
8202
8265
|
include Aws::Structure
|
8203
8266
|
end
|
8204
8267
|
|
@@ -8608,7 +8671,8 @@ module Aws::Pinpoint
|
|
8608
8671
|
|
8609
8672
|
# @!attribute [rw] journey_execution_metrics_response
|
8610
8673
|
# Provides the results of a query that retrieved the data for a
|
8611
|
-
# standard execution metric that applies to a journey
|
8674
|
+
# standard execution metric that applies to a journey, and provides
|
8675
|
+
# information about that query.
|
8612
8676
|
# @return [Types::JourneyExecutionMetricsResponse]
|
8613
8677
|
#
|
8614
8678
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetricsResponse AWS API Documentation
|
@@ -8657,15 +8721,20 @@ module Aws::Pinpoint
|
|
8657
8721
|
#
|
8658
8722
|
# {
|
8659
8723
|
# template_name: "__string", # required
|
8724
|
+
# version: "__string",
|
8660
8725
|
# }
|
8661
8726
|
#
|
8662
8727
|
# @!attribute [rw] template_name
|
8663
8728
|
# @return [String]
|
8664
8729
|
#
|
8730
|
+
# @!attribute [rw] version
|
8731
|
+
# @return [String]
|
8732
|
+
#
|
8665
8733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplateRequest AWS API Documentation
|
8666
8734
|
#
|
8667
8735
|
class GetPushTemplateRequest < Struct.new(
|
8668
|
-
:template_name
|
8736
|
+
:template_name,
|
8737
|
+
:version)
|
8669
8738
|
include Aws::Structure
|
8670
8739
|
end
|
8671
8740
|
|
@@ -8963,15 +9032,20 @@ module Aws::Pinpoint
|
|
8963
9032
|
#
|
8964
9033
|
# {
|
8965
9034
|
# template_name: "__string", # required
|
9035
|
+
# version: "__string",
|
8966
9036
|
# }
|
8967
9037
|
#
|
8968
9038
|
# @!attribute [rw] template_name
|
8969
9039
|
# @return [String]
|
8970
9040
|
#
|
9041
|
+
# @!attribute [rw] version
|
9042
|
+
# @return [String]
|
9043
|
+
#
|
8971
9044
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsTemplateRequest AWS API Documentation
|
8972
9045
|
#
|
8973
9046
|
class GetSmsTemplateRequest < Struct.new(
|
8974
|
-
:template_name
|
9047
|
+
:template_name,
|
9048
|
+
:version)
|
8975
9049
|
include Aws::Structure
|
8976
9050
|
end
|
8977
9051
|
|
@@ -9056,15 +9130,20 @@ module Aws::Pinpoint
|
|
9056
9130
|
#
|
9057
9131
|
# {
|
9058
9132
|
# template_name: "__string", # required
|
9133
|
+
# version: "__string",
|
9059
9134
|
# }
|
9060
9135
|
#
|
9061
9136
|
# @!attribute [rw] template_name
|
9062
9137
|
# @return [String]
|
9063
9138
|
#
|
9139
|
+
# @!attribute [rw] version
|
9140
|
+
# @return [String]
|
9141
|
+
#
|
9064
9142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetVoiceTemplateRequest AWS API Documentation
|
9065
9143
|
#
|
9066
9144
|
class GetVoiceTemplateRequest < Struct.new(
|
9067
|
-
:template_name
|
9145
|
+
:template_name,
|
9146
|
+
:version)
|
9068
9147
|
include Aws::Structure
|
9069
9148
|
end
|
9070
9149
|
|
@@ -9100,6 +9179,11 @@ module Aws::Pinpoint
|
|
9100
9179
|
#
|
9101
9180
|
# @!attribute [rw] percentage
|
9102
9181
|
# The percentage of participants who shouldn't continue the journey.
|
9182
|
+
#
|
9183
|
+
# To determine which participants are held out, Amazon Pinpoint
|
9184
|
+
# applies a probability-based algorithm to the percentage that you
|
9185
|
+
# specify. Therefore, the actual percentage of participants who are
|
9186
|
+
# held out may not be equal to the percentage that you specify.
|
9103
9187
|
# @return [Integer]
|
9104
9188
|
#
|
9105
9189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/HoldoutActivity AWS API Documentation
|
@@ -9595,7 +9679,8 @@ module Aws::Pinpoint
|
|
9595
9679
|
end
|
9596
9680
|
|
9597
9681
|
# Provides the results of a query that retrieved the data for a standard
|
9598
|
-
# execution metric that applies to a journey
|
9682
|
+
# execution metric that applies to a journey, and provides information
|
9683
|
+
# about that query.
|
9599
9684
|
#
|
9600
9685
|
# @!attribute [rw] application_id
|
9601
9686
|
# The unique identifier for the application that the metric applies
|
@@ -9672,8 +9757,10 @@ module Aws::Pinpoint
|
|
9672
9757
|
# settings for a journey.
|
9673
9758
|
#
|
9674
9759
|
# @!attribute [rw] activities
|
9675
|
-
#
|
9676
|
-
#
|
9760
|
+
# A map that contains a set of Activity objects, one object for each
|
9761
|
+
# activity in the journey. For each Activity object, the key is the
|
9762
|
+
# unique identifier (string) for an activity and the value is the
|
9763
|
+
# settings for the activity.
|
9677
9764
|
# @return [Hash<String,Types::Activity>]
|
9678
9765
|
#
|
9679
9766
|
# @!attribute [rw] application_id
|
@@ -9772,7 +9859,8 @@ module Aws::Pinpoint
|
|
9772
9859
|
# specified for it. If a journey's status is CLOSED, you can't add
|
9773
9860
|
# participants to it, and no existing participants can enter the
|
9774
9861
|
# journey for the first time. However, any existing participants who
|
9775
|
-
# are currently waiting to start an activity may
|
9862
|
+
# are currently waiting to start an activity may continue the
|
9863
|
+
# journey.
|
9776
9864
|
# @return [String]
|
9777
9865
|
#
|
9778
9866
|
# @!attribute [rw] tags
|
@@ -9967,6 +10055,50 @@ module Aws::Pinpoint
|
|
9967
10055
|
include Aws::Structure
|
9968
10056
|
end
|
9969
10057
|
|
10058
|
+
# @note When making an API call, you may pass ListTemplateVersionsRequest
|
10059
|
+
# data as a hash:
|
10060
|
+
#
|
10061
|
+
# {
|
10062
|
+
# next_token: "__string",
|
10063
|
+
# page_size: "__string",
|
10064
|
+
# template_name: "__string", # required
|
10065
|
+
# template_type: "__string", # required
|
10066
|
+
# }
|
10067
|
+
#
|
10068
|
+
# @!attribute [rw] next_token
|
10069
|
+
# @return [String]
|
10070
|
+
#
|
10071
|
+
# @!attribute [rw] page_size
|
10072
|
+
# @return [String]
|
10073
|
+
#
|
10074
|
+
# @!attribute [rw] template_name
|
10075
|
+
# @return [String]
|
10076
|
+
#
|
10077
|
+
# @!attribute [rw] template_type
|
10078
|
+
# @return [String]
|
10079
|
+
#
|
10080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplateVersionsRequest AWS API Documentation
|
10081
|
+
#
|
10082
|
+
class ListTemplateVersionsRequest < Struct.new(
|
10083
|
+
:next_token,
|
10084
|
+
:page_size,
|
10085
|
+
:template_name,
|
10086
|
+
:template_type)
|
10087
|
+
include Aws::Structure
|
10088
|
+
end
|
10089
|
+
|
10090
|
+
# @!attribute [rw] template_versions_response
|
10091
|
+
# Provides information about all the versions of a specific message
|
10092
|
+
# template.
|
10093
|
+
# @return [Types::TemplateVersionsResponse]
|
10094
|
+
#
|
10095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplateVersionsResponse AWS API Documentation
|
10096
|
+
#
|
10097
|
+
class ListTemplateVersionsResponse < Struct.new(
|
10098
|
+
:template_versions_response)
|
10099
|
+
include Aws::Structure
|
10100
|
+
end
|
10101
|
+
|
9970
10102
|
# @note When making an API call, you may pass ListTemplatesRequest
|
9971
10103
|
# data as a hash:
|
9972
10104
|
#
|
@@ -10479,15 +10611,19 @@ module Aws::Pinpoint
|
|
10479
10611
|
# template_configuration: {
|
10480
10612
|
# email_template: {
|
10481
10613
|
# name: "__string",
|
10614
|
+
# version: "__string",
|
10482
10615
|
# },
|
10483
10616
|
# push_template: {
|
10484
10617
|
# name: "__string",
|
10618
|
+
# version: "__string",
|
10485
10619
|
# },
|
10486
10620
|
# sms_template: {
|
10487
10621
|
# name: "__string",
|
10622
|
+
# version: "__string",
|
10488
10623
|
# },
|
10489
10624
|
# voice_template: {
|
10490
10625
|
# name: "__string",
|
10626
|
+
# version: "__string",
|
10491
10627
|
# },
|
10492
10628
|
# },
|
10493
10629
|
# trace_id: "__string",
|
@@ -10805,7 +10941,8 @@ module Aws::Pinpoint
|
|
10805
10941
|
|
10806
10942
|
# Specifies the settings for a multivariate split activity in a journey.
|
10807
10943
|
# This type of activity sends participants down one of as many as five
|
10808
|
-
# paths in a journey, based on
|
10944
|
+
# paths (including a default *Else* path) in a journey, based on
|
10945
|
+
# conditions that you specify.
|
10809
10946
|
#
|
10810
10947
|
# @note When making an API call, you may pass MultiConditionalSplitActivity
|
10811
10948
|
# data as a hash:
|
@@ -10920,7 +11057,9 @@ module Aws::Pinpoint
|
|
10920
11057
|
# @return [Array<Types::MultiConditionalBranch>]
|
10921
11058
|
#
|
10922
11059
|
# @!attribute [rw] default_activity
|
10923
|
-
# The activity to perform
|
11060
|
+
# The unique identifier for the activity to perform for participants
|
11061
|
+
# who don't meet any of the conditions specified for other paths in
|
11062
|
+
# the activity.
|
10924
11063
|
# @return [String]
|
10925
11064
|
#
|
10926
11065
|
# @!attribute [rw] evaluation_wait_time
|
@@ -11393,7 +11532,7 @@ module Aws::Pinpoint
|
|
11393
11532
|
# @return [Types::AndroidPushNotificationTemplate]
|
11394
11533
|
#
|
11395
11534
|
# @!attribute [rw] creation_date
|
11396
|
-
# The date when the message template was created.
|
11535
|
+
# The date, in ISO 8601 format, when the message template was created.
|
11397
11536
|
# @return [String]
|
11398
11537
|
#
|
11399
11538
|
# @!attribute [rw] default
|
@@ -11418,7 +11557,8 @@ module Aws::Pinpoint
|
|
11418
11557
|
# @return [Types::AndroidPushNotificationTemplate]
|
11419
11558
|
#
|
11420
11559
|
# @!attribute [rw] last_modified_date
|
11421
|
-
# The date when the message template was last
|
11560
|
+
# The date, in ISO 8601 format, when the message template was last
|
11561
|
+
# modified.
|
11422
11562
|
# @return [String]
|
11423
11563
|
#
|
11424
11564
|
# @!attribute [rw] tags
|
@@ -11440,6 +11580,12 @@ module Aws::Pinpoint
|
|
11440
11580
|
# push notification template, this value is PUSH.
|
11441
11581
|
# @return [String]
|
11442
11582
|
#
|
11583
|
+
# @!attribute [rw] version
|
11584
|
+
# The unique identifier, as an integer, for the active version of the
|
11585
|
+
# message template, or the version of the template that you specified
|
11586
|
+
# by using the version parameter in your request.
|
11587
|
+
# @return [String]
|
11588
|
+
#
|
11443
11589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PushNotificationTemplateResponse AWS API Documentation
|
11444
11590
|
#
|
11445
11591
|
class PushNotificationTemplateResponse < Struct.new(
|
@@ -11455,7 +11601,8 @@ module Aws::Pinpoint
|
|
11455
11601
|
:tags,
|
11456
11602
|
:template_description,
|
11457
11603
|
:template_name,
|
11458
|
-
:template_type
|
11604
|
+
:template_type,
|
11605
|
+
:version)
|
11459
11606
|
include Aws::Structure
|
11460
11607
|
end
|
11461
11608
|
|
@@ -11680,6 +11827,12 @@ module Aws::Pinpoint
|
|
11680
11827
|
#
|
11681
11828
|
# @!attribute [rw] percentage
|
11682
11829
|
# The percentage of participants to send down the activity path.
|
11830
|
+
#
|
11831
|
+
# To determine which participants are sent down each path, Amazon
|
11832
|
+
# Pinpoint applies a probability-based algorithm to the percentages
|
11833
|
+
# that you specify for the paths. Therefore, the actual percentage of
|
11834
|
+
# participants who are sent down a path may not be equal to the
|
11835
|
+
# percentage that you specify.
|
11683
11836
|
# @return [Integer]
|
11684
11837
|
#
|
11685
11838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RandomSplitEntry AWS API Documentation
|
@@ -12093,7 +12246,7 @@ module Aws::Pinpoint
|
|
12093
12246
|
# @return [String]
|
12094
12247
|
#
|
12095
12248
|
# @!attribute [rw] creation_date
|
12096
|
-
# The date when the message template was created.
|
12249
|
+
# The date, in ISO 8601 format, when the message template was created.
|
12097
12250
|
# @return [String]
|
12098
12251
|
#
|
12099
12252
|
# @!attribute [rw] default_substitutions
|
@@ -12105,7 +12258,8 @@ module Aws::Pinpoint
|
|
12105
12258
|
# @return [String]
|
12106
12259
|
#
|
12107
12260
|
# @!attribute [rw] last_modified_date
|
12108
|
-
# The date when the message template was last
|
12261
|
+
# The date, in ISO 8601 format, when the message template was last
|
12262
|
+
# modified.
|
12109
12263
|
# @return [String]
|
12110
12264
|
#
|
12111
12265
|
# @!attribute [rw] tags
|
@@ -12127,6 +12281,12 @@ module Aws::Pinpoint
|
|
12127
12281
|
# an SMS template, this value is SMS.
|
12128
12282
|
# @return [String]
|
12129
12283
|
#
|
12284
|
+
# @!attribute [rw] version
|
12285
|
+
# The unique identifier, as an integer, for the active version of the
|
12286
|
+
# message template, or the version of the template that you specified
|
12287
|
+
# by using the version parameter in your request.
|
12288
|
+
# @return [String]
|
12289
|
+
#
|
12130
12290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSTemplateResponse AWS API Documentation
|
12131
12291
|
#
|
12132
12292
|
class SMSTemplateResponse < Struct.new(
|
@@ -12138,7 +12298,8 @@ module Aws::Pinpoint
|
|
12138
12298
|
:tags,
|
12139
12299
|
:template_description,
|
12140
12300
|
:template_name,
|
12141
|
-
:template_type
|
12301
|
+
:template_type,
|
12302
|
+
:version)
|
12142
12303
|
include Aws::Structure
|
12143
12304
|
end
|
12144
12305
|
|
@@ -13124,15 +13285,19 @@ module Aws::Pinpoint
|
|
13124
13285
|
# template_configuration: {
|
13125
13286
|
# email_template: {
|
13126
13287
|
# name: "__string",
|
13288
|
+
# version: "__string",
|
13127
13289
|
# },
|
13128
13290
|
# push_template: {
|
13129
13291
|
# name: "__string",
|
13292
|
+
# version: "__string",
|
13130
13293
|
# },
|
13131
13294
|
# sms_template: {
|
13132
13295
|
# name: "__string",
|
13296
|
+
# version: "__string",
|
13133
13297
|
# },
|
13134
13298
|
# voice_template: {
|
13135
13299
|
# name: "__string",
|
13300
|
+
# version: "__string",
|
13136
13301
|
# },
|
13137
13302
|
# },
|
13138
13303
|
# trace_id: "__string",
|
@@ -13334,15 +13499,19 @@ module Aws::Pinpoint
|
|
13334
13499
|
# template_configuration: {
|
13335
13500
|
# email_template: {
|
13336
13501
|
# name: "__string",
|
13502
|
+
# version: "__string",
|
13337
13503
|
# },
|
13338
13504
|
# push_template: {
|
13339
13505
|
# name: "__string",
|
13506
|
+
# version: "__string",
|
13340
13507
|
# },
|
13341
13508
|
# sms_template: {
|
13342
13509
|
# name: "__string",
|
13510
|
+
# version: "__string",
|
13343
13511
|
# },
|
13344
13512
|
# voice_template: {
|
13345
13513
|
# name: "__string",
|
13514
|
+
# version: "__string",
|
13346
13515
|
# },
|
13347
13516
|
# },
|
13348
13517
|
# trace_id: "__string",
|
@@ -13596,15 +13765,19 @@ module Aws::Pinpoint
|
|
13596
13765
|
# template_configuration: {
|
13597
13766
|
# email_template: {
|
13598
13767
|
# name: "__string",
|
13768
|
+
# version: "__string",
|
13599
13769
|
# },
|
13600
13770
|
# push_template: {
|
13601
13771
|
# name: "__string",
|
13772
|
+
# version: "__string",
|
13602
13773
|
# },
|
13603
13774
|
# sms_template: {
|
13604
13775
|
# name: "__string",
|
13776
|
+
# version: "__string",
|
13605
13777
|
# },
|
13606
13778
|
# voice_template: {
|
13607
13779
|
# name: "__string",
|
13780
|
+
# version: "__string",
|
13608
13781
|
# },
|
13609
13782
|
# },
|
13610
13783
|
# trace_id: "__string",
|
@@ -14004,13 +14177,15 @@ module Aws::Pinpoint
|
|
14004
14177
|
include Aws::Structure
|
14005
14178
|
end
|
14006
14179
|
|
14007
|
-
# Specifies the name of the message template to use for the
|
14180
|
+
# Specifies the name and version of the message template to use for the
|
14181
|
+
# message.
|
14008
14182
|
#
|
14009
14183
|
# @note When making an API call, you may pass Template
|
14010
14184
|
# data as a hash:
|
14011
14185
|
#
|
14012
14186
|
# {
|
14013
14187
|
# name: "__string",
|
14188
|
+
# version: "__string",
|
14014
14189
|
# }
|
14015
14190
|
#
|
14016
14191
|
# @!attribute [rw] name
|
@@ -14019,10 +14194,54 @@ module Aws::Pinpoint
|
|
14019
14194
|
# template.
|
14020
14195
|
# @return [String]
|
14021
14196
|
#
|
14197
|
+
# @!attribute [rw] version
|
14198
|
+
# The unique identifier for the version of the message template to use
|
14199
|
+
# for the message. If specified, this value must match the identifier
|
14200
|
+
# for an existing template version. To retrieve a list of versions and
|
14201
|
+
# version identifiers for a template, use the <link
|
14202
|
+
# linkend="templates-template-name-template-type-versions" />
|
14203
|
+
#
|
14204
|
+
# Template Versions</link> resource.
|
14205
|
+
#
|
14206
|
+
# If you don't specify a value for this property, Amazon Pinpoint
|
14207
|
+
# uses the *active* version of the template. The *active* version is
|
14208
|
+
# typically the version of a template that's been most recently
|
14209
|
+
# reviewed and approved for use, depending on your workflow. It isn't
|
14210
|
+
# necessarily the latest version of a template.
|
14211
|
+
# @return [String]
|
14212
|
+
#
|
14022
14213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Template AWS API Documentation
|
14023
14214
|
#
|
14024
14215
|
class Template < Struct.new(
|
14025
|
-
:name
|
14216
|
+
:name,
|
14217
|
+
:version)
|
14218
|
+
include Aws::Structure
|
14219
|
+
end
|
14220
|
+
|
14221
|
+
# Specifies which version of a message template to use as the active
|
14222
|
+
# version of the template.
|
14223
|
+
#
|
14224
|
+
# @note When making an API call, you may pass TemplateActiveVersionRequest
|
14225
|
+
# data as a hash:
|
14226
|
+
#
|
14227
|
+
# {
|
14228
|
+
# version: "__string",
|
14229
|
+
# }
|
14230
|
+
#
|
14231
|
+
# @!attribute [rw] version
|
14232
|
+
# The unique identifier for the version of the message template to use
|
14233
|
+
# as the active version of the template. If specified, this value must
|
14234
|
+
# match the identifier for an existing template version. To retrieve a
|
14235
|
+
# list of versions and version identifiers for a template, use the
|
14236
|
+
# <link linkend="templates-template-name-template-type-versions" />
|
14237
|
+
#
|
14238
|
+
# Template Versions</link> resource.
|
14239
|
+
# @return [String]
|
14240
|
+
#
|
14241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateActiveVersionRequest AWS API Documentation
|
14242
|
+
#
|
14243
|
+
class TemplateActiveVersionRequest < Struct.new(
|
14244
|
+
:version)
|
14026
14245
|
include Aws::Structure
|
14027
14246
|
end
|
14028
14247
|
|
@@ -14035,15 +14254,19 @@ module Aws::Pinpoint
|
|
14035
14254
|
# {
|
14036
14255
|
# email_template: {
|
14037
14256
|
# name: "__string",
|
14257
|
+
# version: "__string",
|
14038
14258
|
# },
|
14039
14259
|
# push_template: {
|
14040
14260
|
# name: "__string",
|
14261
|
+
# version: "__string",
|
14041
14262
|
# },
|
14042
14263
|
# sms_template: {
|
14043
14264
|
# name: "__string",
|
14265
|
+
# version: "__string",
|
14044
14266
|
# },
|
14045
14267
|
# voice_template: {
|
14046
14268
|
# name: "__string",
|
14269
|
+
# version: "__string",
|
14047
14270
|
# },
|
14048
14271
|
# }
|
14049
14272
|
#
|
@@ -14081,7 +14304,7 @@ module Aws::Pinpoint
|
|
14081
14304
|
# @return [String]
|
14082
14305
|
#
|
14083
14306
|
# @!attribute [rw] creation_date
|
14084
|
-
# The date when the message template was created.
|
14307
|
+
# The date, in ISO 8601 format, when the message template was created.
|
14085
14308
|
# @return [String]
|
14086
14309
|
#
|
14087
14310
|
# @!attribute [rw] default_substitutions
|
@@ -14093,7 +14316,8 @@ module Aws::Pinpoint
|
|
14093
14316
|
# @return [String]
|
14094
14317
|
#
|
14095
14318
|
# @!attribute [rw] last_modified_date
|
14096
|
-
# The date when the message template was last
|
14319
|
+
# The date, in ISO 8601 format, when the message template was last
|
14320
|
+
# modified.
|
14097
14321
|
# @return [String]
|
14098
14322
|
#
|
14099
14323
|
# @!attribute [rw] tags
|
@@ -14112,6 +14336,12 @@ module Aws::Pinpoint
|
|
14112
14336
|
#
|
14113
14337
|
# @!attribute [rw] template_type
|
14114
14338
|
# The type of channel that the message template is designed for.
|
14339
|
+
# Possible values are: EMAIL, PUSH, SMS, and VOICE.
|
14340
|
+
# @return [String]
|
14341
|
+
#
|
14342
|
+
# @!attribute [rw] version
|
14343
|
+
# The unique identifier, as an integer, for the active version of the
|
14344
|
+
# message template.
|
14115
14345
|
# @return [String]
|
14116
14346
|
#
|
14117
14347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateResponse AWS API Documentation
|
@@ -14124,7 +14354,93 @@ module Aws::Pinpoint
|
|
14124
14354
|
:tags,
|
14125
14355
|
:template_description,
|
14126
14356
|
:template_name,
|
14127
|
-
:template_type
|
14357
|
+
:template_type,
|
14358
|
+
:version)
|
14359
|
+
include Aws::Structure
|
14360
|
+
end
|
14361
|
+
|
14362
|
+
# Provides information about a specific version of a message template.
|
14363
|
+
#
|
14364
|
+
# @!attribute [rw] creation_date
|
14365
|
+
# The date, in ISO 8601 format, when the version of the message
|
14366
|
+
# template was created.
|
14367
|
+
# @return [String]
|
14368
|
+
#
|
14369
|
+
# @!attribute [rw] default_substitutions
|
14370
|
+
# A JSON object that specifies the default values that are used for
|
14371
|
+
# message variables in the version of the message template. This
|
14372
|
+
# object is a set of key-value pairs. Each key defines a message
|
14373
|
+
# variable in the template. The corresponding value defines the
|
14374
|
+
# default value for that variable.
|
14375
|
+
# @return [String]
|
14376
|
+
#
|
14377
|
+
# @!attribute [rw] last_modified_date
|
14378
|
+
# The date, in ISO 8601 format, when the version of the message
|
14379
|
+
# template was last modified.
|
14380
|
+
# @return [String]
|
14381
|
+
#
|
14382
|
+
# @!attribute [rw] template_description
|
14383
|
+
# The custom description of the version of the message template.
|
14384
|
+
# @return [String]
|
14385
|
+
#
|
14386
|
+
# @!attribute [rw] template_name
|
14387
|
+
# The name of the message template.
|
14388
|
+
# @return [String]
|
14389
|
+
#
|
14390
|
+
# @!attribute [rw] template_type
|
14391
|
+
# The type of channel that the message template is designed for.
|
14392
|
+
# Possible values are: EMAIL, PUSH, SMS, and VOICE.
|
14393
|
+
# @return [String]
|
14394
|
+
#
|
14395
|
+
# @!attribute [rw] version
|
14396
|
+
# The unique identifier for the version of the message template. This
|
14397
|
+
# value is an integer that Amazon Pinpoint automatically increments
|
14398
|
+
# and assigns to each new version of a template.
|
14399
|
+
# @return [String]
|
14400
|
+
#
|
14401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateVersionResponse AWS API Documentation
|
14402
|
+
#
|
14403
|
+
class TemplateVersionResponse < Struct.new(
|
14404
|
+
:creation_date,
|
14405
|
+
:default_substitutions,
|
14406
|
+
:last_modified_date,
|
14407
|
+
:template_description,
|
14408
|
+
:template_name,
|
14409
|
+
:template_type,
|
14410
|
+
:version)
|
14411
|
+
include Aws::Structure
|
14412
|
+
end
|
14413
|
+
|
14414
|
+
# Provides information about all the versions of a specific message
|
14415
|
+
# template.
|
14416
|
+
#
|
14417
|
+
# @!attribute [rw] item
|
14418
|
+
# An array of responses, one for each version of the message template.
|
14419
|
+
# @return [Array<Types::TemplateVersionResponse>]
|
14420
|
+
#
|
14421
|
+
# @!attribute [rw] message
|
14422
|
+
# The message that's returned from the API for the request to
|
14423
|
+
# retrieve information about all the versions of the message template.
|
14424
|
+
# @return [String]
|
14425
|
+
#
|
14426
|
+
# @!attribute [rw] next_token
|
14427
|
+
# The string to use in a subsequent request to get the next page of
|
14428
|
+
# results in a paginated response. This value is null if there are no
|
14429
|
+
# additional pages.
|
14430
|
+
# @return [String]
|
14431
|
+
#
|
14432
|
+
# @!attribute [rw] request_id
|
14433
|
+
# The unique identifier for the request to retrieve information about
|
14434
|
+
# all the versions of the message template.
|
14435
|
+
# @return [String]
|
14436
|
+
#
|
14437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateVersionsResponse AWS API Documentation
|
14438
|
+
#
|
14439
|
+
class TemplateVersionsResponse < Struct.new(
|
14440
|
+
:item,
|
14441
|
+
:message,
|
14442
|
+
:next_token,
|
14443
|
+
:request_id)
|
14128
14444
|
include Aws::Structure
|
14129
14445
|
end
|
14130
14446
|
|
@@ -14707,15 +15023,19 @@ module Aws::Pinpoint
|
|
14707
15023
|
# template_configuration: {
|
14708
15024
|
# email_template: {
|
14709
15025
|
# name: "__string",
|
15026
|
+
# version: "__string",
|
14710
15027
|
# },
|
14711
15028
|
# push_template: {
|
14712
15029
|
# name: "__string",
|
15030
|
+
# version: "__string",
|
14713
15031
|
# },
|
14714
15032
|
# sms_template: {
|
14715
15033
|
# name: "__string",
|
15034
|
+
# version: "__string",
|
14716
15035
|
# },
|
14717
15036
|
# voice_template: {
|
14718
15037
|
# name: "__string",
|
15038
|
+
# version: "__string",
|
14719
15039
|
# },
|
14720
15040
|
# },
|
14721
15041
|
# treatment_description: "__string",
|
@@ -14860,15 +15180,19 @@ module Aws::Pinpoint
|
|
14860
15180
|
# template_configuration: {
|
14861
15181
|
# email_template: {
|
14862
15182
|
# name: "__string",
|
15183
|
+
# version: "__string",
|
14863
15184
|
# },
|
14864
15185
|
# push_template: {
|
14865
15186
|
# name: "__string",
|
15187
|
+
# version: "__string",
|
14866
15188
|
# },
|
14867
15189
|
# sms_template: {
|
14868
15190
|
# name: "__string",
|
15191
|
+
# version: "__string",
|
14869
15192
|
# },
|
14870
15193
|
# voice_template: {
|
14871
15194
|
# name: "__string",
|
15195
|
+
# version: "__string",
|
14872
15196
|
# },
|
14873
15197
|
# },
|
14874
15198
|
# treatment_description: "__string",
|
@@ -14953,6 +15277,7 @@ module Aws::Pinpoint
|
|
14953
15277
|
# data as a hash:
|
14954
15278
|
#
|
14955
15279
|
# {
|
15280
|
+
# create_new_version: false,
|
14956
15281
|
# email_template_request: { # required
|
14957
15282
|
# default_substitutions: "__string",
|
14958
15283
|
# html_part: "__string",
|
@@ -14964,8 +15289,12 @@ module Aws::Pinpoint
|
|
14964
15289
|
# text_part: "__string",
|
14965
15290
|
# },
|
14966
15291
|
# template_name: "__string", # required
|
15292
|
+
# version: "__string",
|
14967
15293
|
# }
|
14968
15294
|
#
|
15295
|
+
# @!attribute [rw] create_new_version
|
15296
|
+
# @return [Boolean]
|
15297
|
+
#
|
14969
15298
|
# @!attribute [rw] email_template_request
|
14970
15299
|
# Specifies the content and settings for a message template that can
|
14971
15300
|
# be used in messages that are sent through the email channel.
|
@@ -14974,11 +15303,16 @@ module Aws::Pinpoint
|
|
14974
15303
|
# @!attribute [rw] template_name
|
14975
15304
|
# @return [String]
|
14976
15305
|
#
|
15306
|
+
# @!attribute [rw] version
|
15307
|
+
# @return [String]
|
15308
|
+
#
|
14977
15309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailTemplateRequest AWS API Documentation
|
14978
15310
|
#
|
14979
15311
|
class UpdateEmailTemplateRequest < Struct.new(
|
15312
|
+
:create_new_version,
|
14980
15313
|
:email_template_request,
|
14981
|
-
:template_name
|
15314
|
+
:template_name,
|
15315
|
+
:version)
|
14982
15316
|
include Aws::Structure
|
14983
15317
|
end
|
14984
15318
|
|
@@ -15309,6 +15643,7 @@ module Aws::Pinpoint
|
|
15309
15643
|
# },
|
15310
15644
|
# next_activity: "__string",
|
15311
15645
|
# template_name: "__string",
|
15646
|
+
# template_version: "__string",
|
15312
15647
|
# },
|
15313
15648
|
# holdout: {
|
15314
15649
|
# next_activity: "__string",
|
@@ -15541,6 +15876,7 @@ module Aws::Pinpoint
|
|
15541
15876
|
# data as a hash:
|
15542
15877
|
#
|
15543
15878
|
# {
|
15879
|
+
# create_new_version: false,
|
15544
15880
|
# push_notification_template_request: { # required
|
15545
15881
|
# adm: {
|
15546
15882
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -15598,8 +15934,12 @@ module Aws::Pinpoint
|
|
15598
15934
|
# template_description: "__string",
|
15599
15935
|
# },
|
15600
15936
|
# template_name: "__string", # required
|
15937
|
+
# version: "__string",
|
15601
15938
|
# }
|
15602
15939
|
#
|
15940
|
+
# @!attribute [rw] create_new_version
|
15941
|
+
# @return [Boolean]
|
15942
|
+
#
|
15603
15943
|
# @!attribute [rw] push_notification_template_request
|
15604
15944
|
# Specifies the content and settings for a message template that can
|
15605
15945
|
# be used in messages that are sent through a push notification
|
@@ -15609,11 +15949,16 @@ module Aws::Pinpoint
|
|
15609
15949
|
# @!attribute [rw] template_name
|
15610
15950
|
# @return [String]
|
15611
15951
|
#
|
15952
|
+
# @!attribute [rw] version
|
15953
|
+
# @return [String]
|
15954
|
+
#
|
15612
15955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdatePushTemplateRequest AWS API Documentation
|
15613
15956
|
#
|
15614
15957
|
class UpdatePushTemplateRequest < Struct.new(
|
15958
|
+
:create_new_version,
|
15615
15959
|
:push_notification_template_request,
|
15616
|
-
:template_name
|
15960
|
+
:template_name,
|
15961
|
+
:version)
|
15617
15962
|
include Aws::Structure
|
15618
15963
|
end
|
15619
15964
|
|
@@ -15866,6 +16211,7 @@ module Aws::Pinpoint
|
|
15866
16211
|
# data as a hash:
|
15867
16212
|
#
|
15868
16213
|
# {
|
16214
|
+
# create_new_version: false,
|
15869
16215
|
# sms_template_request: { # required
|
15870
16216
|
# body: "__string",
|
15871
16217
|
# default_substitutions: "__string",
|
@@ -15875,8 +16221,12 @@ module Aws::Pinpoint
|
|
15875
16221
|
# template_description: "__string",
|
15876
16222
|
# },
|
15877
16223
|
# template_name: "__string", # required
|
16224
|
+
# version: "__string",
|
15878
16225
|
# }
|
15879
16226
|
#
|
16227
|
+
# @!attribute [rw] create_new_version
|
16228
|
+
# @return [Boolean]
|
16229
|
+
#
|
15880
16230
|
# @!attribute [rw] sms_template_request
|
15881
16231
|
# Specifies the content and settings for a message template that can
|
15882
16232
|
# be used in text messages that are sent through the SMS channel.
|
@@ -15885,11 +16235,16 @@ module Aws::Pinpoint
|
|
15885
16235
|
# @!attribute [rw] template_name
|
15886
16236
|
# @return [String]
|
15887
16237
|
#
|
16238
|
+
# @!attribute [rw] version
|
16239
|
+
# @return [String]
|
16240
|
+
#
|
15888
16241
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsTemplateRequest AWS API Documentation
|
15889
16242
|
#
|
15890
16243
|
class UpdateSmsTemplateRequest < Struct.new(
|
16244
|
+
:create_new_version,
|
15891
16245
|
:sms_template_request,
|
15892
|
-
:template_name
|
16246
|
+
:template_name,
|
16247
|
+
:version)
|
15893
16248
|
include Aws::Structure
|
15894
16249
|
end
|
15895
16250
|
|
@@ -15904,6 +16259,48 @@ module Aws::Pinpoint
|
|
15904
16259
|
include Aws::Structure
|
15905
16260
|
end
|
15906
16261
|
|
16262
|
+
# @note When making an API call, you may pass UpdateTemplateActiveVersionRequest
|
16263
|
+
# data as a hash:
|
16264
|
+
#
|
16265
|
+
# {
|
16266
|
+
# template_active_version_request: { # required
|
16267
|
+
# version: "__string",
|
16268
|
+
# },
|
16269
|
+
# template_name: "__string", # required
|
16270
|
+
# template_type: "__string", # required
|
16271
|
+
# }
|
16272
|
+
#
|
16273
|
+
# @!attribute [rw] template_active_version_request
|
16274
|
+
# Specifies which version of a message template to use as the active
|
16275
|
+
# version of the template.
|
16276
|
+
# @return [Types::TemplateActiveVersionRequest]
|
16277
|
+
#
|
16278
|
+
# @!attribute [rw] template_name
|
16279
|
+
# @return [String]
|
16280
|
+
#
|
16281
|
+
# @!attribute [rw] template_type
|
16282
|
+
# @return [String]
|
16283
|
+
#
|
16284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateTemplateActiveVersionRequest AWS API Documentation
|
16285
|
+
#
|
16286
|
+
class UpdateTemplateActiveVersionRequest < Struct.new(
|
16287
|
+
:template_active_version_request,
|
16288
|
+
:template_name,
|
16289
|
+
:template_type)
|
16290
|
+
include Aws::Structure
|
16291
|
+
end
|
16292
|
+
|
16293
|
+
# @!attribute [rw] message_body
|
16294
|
+
# Provides information about an API request or response.
|
16295
|
+
# @return [Types::MessageBody]
|
16296
|
+
#
|
16297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateTemplateActiveVersionResponse AWS API Documentation
|
16298
|
+
#
|
16299
|
+
class UpdateTemplateActiveVersionResponse < Struct.new(
|
16300
|
+
:message_body)
|
16301
|
+
include Aws::Structure
|
16302
|
+
end
|
16303
|
+
|
15907
16304
|
# @note When making an API call, you may pass UpdateVoiceChannelRequest
|
15908
16305
|
# data as a hash:
|
15909
16306
|
#
|
@@ -15946,7 +16343,9 @@ module Aws::Pinpoint
|
|
15946
16343
|
# data as a hash:
|
15947
16344
|
#
|
15948
16345
|
# {
|
16346
|
+
# create_new_version: false,
|
15949
16347
|
# template_name: "__string", # required
|
16348
|
+
# version: "__string",
|
15950
16349
|
# voice_template_request: { # required
|
15951
16350
|
# body: "__string",
|
15952
16351
|
# default_substitutions: "__string",
|
@@ -15959,9 +16358,15 @@ module Aws::Pinpoint
|
|
15959
16358
|
# },
|
15960
16359
|
# }
|
15961
16360
|
#
|
16361
|
+
# @!attribute [rw] create_new_version
|
16362
|
+
# @return [Boolean]
|
16363
|
+
#
|
15962
16364
|
# @!attribute [rw] template_name
|
15963
16365
|
# @return [String]
|
15964
16366
|
#
|
16367
|
+
# @!attribute [rw] version
|
16368
|
+
# @return [String]
|
16369
|
+
#
|
15965
16370
|
# @!attribute [rw] voice_template_request
|
15966
16371
|
# Specifies the content and settings for a message template that can
|
15967
16372
|
# be used in messages that are sent through the voice channel.
|
@@ -15970,7 +16375,9 @@ module Aws::Pinpoint
|
|
15970
16375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateVoiceTemplateRequest AWS API Documentation
|
15971
16376
|
#
|
15972
16377
|
class UpdateVoiceTemplateRequest < Struct.new(
|
16378
|
+
:create_new_version,
|
15973
16379
|
:template_name,
|
16380
|
+
:version,
|
15974
16381
|
:voice_template_request)
|
15975
16382
|
include Aws::Structure
|
15976
16383
|
end
|
@@ -16224,7 +16631,7 @@ module Aws::Pinpoint
|
|
16224
16631
|
# @return [String]
|
16225
16632
|
#
|
16226
16633
|
# @!attribute [rw] creation_date
|
16227
|
-
# The date when the message template was created.
|
16634
|
+
# The date, in ISO 8601 format, when the message template was created.
|
16228
16635
|
# @return [String]
|
16229
16636
|
#
|
16230
16637
|
# @!attribute [rw] default_substitutions
|
@@ -16247,7 +16654,8 @@ module Aws::Pinpoint
|
|
16247
16654
|
# @return [String]
|
16248
16655
|
#
|
16249
16656
|
# @!attribute [rw] last_modified_date
|
16250
|
-
# The date when the message template was last
|
16657
|
+
# The date, in ISO 8601 format, when the message template was last
|
16658
|
+
# modified.
|
16251
16659
|
# @return [String]
|
16252
16660
|
#
|
16253
16661
|
# @!attribute [rw] tags
|
@@ -16269,6 +16677,12 @@ module Aws::Pinpoint
|
|
16269
16677
|
# voice template, this value is VOICE.
|
16270
16678
|
# @return [String]
|
16271
16679
|
#
|
16680
|
+
# @!attribute [rw] version
|
16681
|
+
# The unique identifier, as an integer, for the active version of the
|
16682
|
+
# message template, or the version of the template that you specified
|
16683
|
+
# by using the version parameter in your request.
|
16684
|
+
# @return [String]
|
16685
|
+
#
|
16272
16686
|
# @!attribute [rw] voice_id
|
16273
16687
|
# The name of the voice that's used when delivering messages that are
|
16274
16688
|
# based on the message template. For a list of supported voices, see
|
@@ -16292,6 +16706,7 @@ module Aws::Pinpoint
|
|
16292
16706
|
:template_description,
|
16293
16707
|
:template_name,
|
16294
16708
|
:template_type,
|
16709
|
+
:version,
|
16295
16710
|
:voice_id)
|
16296
16711
|
include Aws::Structure
|
16297
16712
|
end
|
@@ -16578,15 +16993,19 @@ module Aws::Pinpoint
|
|
16578
16993
|
# template_configuration: {
|
16579
16994
|
# email_template: {
|
16580
16995
|
# name: "__string",
|
16996
|
+
# version: "__string",
|
16581
16997
|
# },
|
16582
16998
|
# push_template: {
|
16583
16999
|
# name: "__string",
|
17000
|
+
# version: "__string",
|
16584
17001
|
# },
|
16585
17002
|
# sms_template: {
|
16586
17003
|
# name: "__string",
|
17004
|
+
# version: "__string",
|
16587
17005
|
# },
|
16588
17006
|
# voice_template: {
|
16589
17007
|
# name: "__string",
|
17008
|
+
# version: "__string",
|
16590
17009
|
# },
|
16591
17010
|
# },
|
16592
17011
|
# treatment_description: "__string",
|
@@ -16731,15 +17150,19 @@ module Aws::Pinpoint
|
|
16731
17150
|
# template_configuration: {
|
16732
17151
|
# email_template: {
|
16733
17152
|
# name: "__string",
|
17153
|
+
# version: "__string",
|
16734
17154
|
# },
|
16735
17155
|
# push_template: {
|
16736
17156
|
# name: "__string",
|
17157
|
+
# version: "__string",
|
16737
17158
|
# },
|
16738
17159
|
# sms_template: {
|
16739
17160
|
# name: "__string",
|
17161
|
+
# version: "__string",
|
16740
17162
|
# },
|
16741
17163
|
# voice_template: {
|
16742
17164
|
# name: "__string",
|
17165
|
+
# version: "__string",
|
16743
17166
|
# },
|
16744
17167
|
# },
|
16745
17168
|
# treatment_description: "__string",
|
@@ -17001,6 +17424,7 @@ module Aws::Pinpoint
|
|
17001
17424
|
# },
|
17002
17425
|
# next_activity: "__string",
|
17003
17426
|
# template_name: "__string",
|
17427
|
+
# template_version: "__string",
|
17004
17428
|
# },
|
17005
17429
|
# holdout: {
|
17006
17430
|
# next_activity: "__string",
|
@@ -17156,8 +17580,12 @@ module Aws::Pinpoint
|
|
17156
17580
|
# }
|
17157
17581
|
#
|
17158
17582
|
# @!attribute [rw] activities
|
17159
|
-
#
|
17160
|
-
#
|
17583
|
+
# A map that contains a set of Activity objects, one object for each
|
17584
|
+
# activity in the journey. For each Activity object, the key is the
|
17585
|
+
# unique identifier (string) for an activity and the value is the
|
17586
|
+
# settings for the activity. An activity identifier can contain a
|
17587
|
+
# maximum of 128 characters. The characters must be alphanumeric
|
17588
|
+
# characters.
|
17161
17589
|
# @return [Hash<String,Types::Activity>]
|
17162
17590
|
#
|
17163
17591
|
# @!attribute [rw] creation_date
|
@@ -17215,7 +17643,9 @@ module Aws::Pinpoint
|
|
17215
17643
|
# @return [Types::JourneySchedule]
|
17216
17644
|
#
|
17217
17645
|
# @!attribute [rw] start_activity
|
17218
|
-
# The unique identifier for the first activity in the journey.
|
17646
|
+
# The unique identifier for the first activity in the journey. An
|
17647
|
+
# activity identifier can contain a maximum of 128 characters. The
|
17648
|
+
# characters must be alphanumeric characters.
|
17219
17649
|
# @return [String]
|
17220
17650
|
#
|
17221
17651
|
# @!attribute [rw] start_condition
|
@@ -17576,15 +18006,19 @@ module Aws::Pinpoint
|
|
17576
18006
|
# template_configuration: {
|
17577
18007
|
# email_template: {
|
17578
18008
|
# name: "__string",
|
18009
|
+
# version: "__string",
|
17579
18010
|
# },
|
17580
18011
|
# push_template: {
|
17581
18012
|
# name: "__string",
|
18013
|
+
# version: "__string",
|
17582
18014
|
# },
|
17583
18015
|
# sms_template: {
|
17584
18016
|
# name: "__string",
|
18017
|
+
# version: "__string",
|
17585
18018
|
# },
|
17586
18019
|
# voice_template: {
|
17587
18020
|
# name: "__string",
|
18021
|
+
# version: "__string",
|
17588
18022
|
# },
|
17589
18023
|
# },
|
17590
18024
|
# treatment_description: "__string",
|