aws-sdk-pinpoint 1.29.0 → 1.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +1751 -23
- data/lib/aws-sdk-pinpoint/client_api.rb +430 -1
- data/lib/aws-sdk-pinpoint/types.rb +3267 -241
- metadata +2 -2
@@ -410,6 +410,7 @@ module Aws::Pinpoint
|
|
410
410
|
# data as a hash:
|
411
411
|
#
|
412
412
|
# {
|
413
|
+
# apns_push_type: "__string",
|
413
414
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
414
415
|
# badge: 1,
|
415
416
|
# body: "__string",
|
@@ -433,6 +434,43 @@ module Aws::Pinpoint
|
|
433
434
|
# url: "__string",
|
434
435
|
# }
|
435
436
|
#
|
437
|
+
# @!attribute [rw] apns_push_type
|
438
|
+
# The type of push notification to send. Valid values are:
|
439
|
+
#
|
440
|
+
# * alert - For a standard notification that's displayed on
|
441
|
+
# recipients' devices and prompts a recipient to interact with the
|
442
|
+
# notification.
|
443
|
+
#
|
444
|
+
# * background - For a silent notification that delivers content in
|
445
|
+
# the background and isn't displayed on recipients' devices.
|
446
|
+
#
|
447
|
+
# * complication - For a notification that contains update information
|
448
|
+
# for an app’s complication timeline.
|
449
|
+
#
|
450
|
+
# * fileprovider - For a notification that signals changes to a File
|
451
|
+
# Provider extension.
|
452
|
+
#
|
453
|
+
# * mdm - For a notification that tells managed devices to contact the
|
454
|
+
# MDM server.
|
455
|
+
#
|
456
|
+
# * voip - For a notification that provides information about an
|
457
|
+
# incoming VoIP call.
|
458
|
+
#
|
459
|
+
# Amazon Pinpoint specifies this value in the apns-push-type request
|
460
|
+
# header when it sends the notification message to APNs. If you don't
|
461
|
+
# specify a value for this property, Amazon Pinpoint sets the value to
|
462
|
+
# alert or background automatically, based on the value that you
|
463
|
+
# specify for the SilentPush or RawContent property of the message.
|
464
|
+
#
|
465
|
+
# For more information about the apns-push-type request header, see
|
466
|
+
# [Sending Notification Requests to APNs][1] on the Apple Developer
|
467
|
+
# website.
|
468
|
+
#
|
469
|
+
#
|
470
|
+
#
|
471
|
+
# [1]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns
|
472
|
+
# @return [String]
|
473
|
+
#
|
436
474
|
# @!attribute [rw] action
|
437
475
|
# The action to occur if the recipient taps the push notification.
|
438
476
|
# Valid values are:
|
@@ -486,8 +524,7 @@ module Aws::Pinpoint
|
|
486
524
|
#
|
487
525
|
# @!attribute [rw] preferred_authentication_method
|
488
526
|
# The authentication method that you want Amazon Pinpoint to use when
|
489
|
-
# authenticating with
|
490
|
-
# CERTIFICATE or TOKEN.
|
527
|
+
# authenticating with APNs, CERTIFICATE or TOKEN.
|
491
528
|
# @return [String]
|
492
529
|
#
|
493
530
|
# @!attribute [rw] priority
|
@@ -510,7 +547,8 @@ module Aws::Pinpoint
|
|
510
547
|
#
|
511
548
|
# @!attribute [rw] raw_content
|
512
549
|
# The raw, JSON-formatted string to use as the payload for the
|
513
|
-
# notification message. This value overrides the
|
550
|
+
# notification message. This value overrides all other content for the
|
551
|
+
# message.
|
514
552
|
#
|
515
553
|
# <note markdown="1">If you specify the raw content of an APNs push notification, the
|
516
554
|
# message payload has to include the content-available key. The value
|
@@ -610,6 +648,7 @@ module Aws::Pinpoint
|
|
610
648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSMessage AWS API Documentation
|
611
649
|
#
|
612
650
|
class APNSMessage < Struct.new(
|
651
|
+
:apns_push_type,
|
613
652
|
:action,
|
614
653
|
:badge,
|
615
654
|
:body,
|
@@ -630,9 +669,9 @@ module Aws::Pinpoint
|
|
630
669
|
include Aws::Structure
|
631
670
|
end
|
632
671
|
|
633
|
-
# Specifies
|
634
|
-
# used in push notifications that are sent through the APNs
|
635
|
-
# Notification service) channel.
|
672
|
+
# Specifies channel-specific content and settings for a message template
|
673
|
+
# that can be used in push notifications that are sent through the APNs
|
674
|
+
# (Apple Push Notification service) channel.
|
636
675
|
#
|
637
676
|
# @note When making an API call, you may pass APNSPushNotificationTemplate
|
638
677
|
# data as a hash:
|
@@ -1179,6 +1218,301 @@ module Aws::Pinpoint
|
|
1179
1218
|
include Aws::Structure
|
1180
1219
|
end
|
1181
1220
|
|
1221
|
+
# Specifies the configuration and other settings for an activity in a
|
1222
|
+
# journey.
|
1223
|
+
#
|
1224
|
+
# @note When making an API call, you may pass Activity
|
1225
|
+
# data as a hash:
|
1226
|
+
#
|
1227
|
+
# {
|
1228
|
+
# conditional_split: {
|
1229
|
+
# condition: {
|
1230
|
+
# conditions: [
|
1231
|
+
# {
|
1232
|
+
# event_condition: {
|
1233
|
+
# dimensions: { # required
|
1234
|
+
# attributes: {
|
1235
|
+
# "__string" => {
|
1236
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1237
|
+
# values: ["__string"], # required
|
1238
|
+
# },
|
1239
|
+
# },
|
1240
|
+
# event_type: {
|
1241
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1242
|
+
# values: ["__string"], # required
|
1243
|
+
# },
|
1244
|
+
# metrics: {
|
1245
|
+
# "__string" => {
|
1246
|
+
# comparison_operator: "__string", # required
|
1247
|
+
# value: 1.0, # required
|
1248
|
+
# },
|
1249
|
+
# },
|
1250
|
+
# },
|
1251
|
+
# message_activity: "__string",
|
1252
|
+
# },
|
1253
|
+
# segment_condition: {
|
1254
|
+
# segment_id: "__string", # required
|
1255
|
+
# },
|
1256
|
+
# segment_dimensions: {
|
1257
|
+
# attributes: {
|
1258
|
+
# "__string" => {
|
1259
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1260
|
+
# values: ["__string"], # required
|
1261
|
+
# },
|
1262
|
+
# },
|
1263
|
+
# behavior: {
|
1264
|
+
# recency: {
|
1265
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
1266
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
1267
|
+
# },
|
1268
|
+
# },
|
1269
|
+
# demographic: {
|
1270
|
+
# app_version: {
|
1271
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1272
|
+
# values: ["__string"], # required
|
1273
|
+
# },
|
1274
|
+
# channel: {
|
1275
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1276
|
+
# values: ["__string"], # required
|
1277
|
+
# },
|
1278
|
+
# device_type: {
|
1279
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1280
|
+
# values: ["__string"], # required
|
1281
|
+
# },
|
1282
|
+
# make: {
|
1283
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1284
|
+
# values: ["__string"], # required
|
1285
|
+
# },
|
1286
|
+
# model: {
|
1287
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1288
|
+
# values: ["__string"], # required
|
1289
|
+
# },
|
1290
|
+
# platform: {
|
1291
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1292
|
+
# values: ["__string"], # required
|
1293
|
+
# },
|
1294
|
+
# },
|
1295
|
+
# location: {
|
1296
|
+
# country: {
|
1297
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1298
|
+
# values: ["__string"], # required
|
1299
|
+
# },
|
1300
|
+
# gps_point: {
|
1301
|
+
# coordinates: { # required
|
1302
|
+
# latitude: 1.0, # required
|
1303
|
+
# longitude: 1.0, # required
|
1304
|
+
# },
|
1305
|
+
# range_in_kilometers: 1.0,
|
1306
|
+
# },
|
1307
|
+
# },
|
1308
|
+
# metrics: {
|
1309
|
+
# "__string" => {
|
1310
|
+
# comparison_operator: "__string", # required
|
1311
|
+
# value: 1.0, # required
|
1312
|
+
# },
|
1313
|
+
# },
|
1314
|
+
# user_attributes: {
|
1315
|
+
# "__string" => {
|
1316
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1317
|
+
# values: ["__string"], # required
|
1318
|
+
# },
|
1319
|
+
# },
|
1320
|
+
# },
|
1321
|
+
# },
|
1322
|
+
# ],
|
1323
|
+
# operator: "ALL", # accepts ALL, ANY
|
1324
|
+
# },
|
1325
|
+
# evaluation_wait_time: {
|
1326
|
+
# wait_for: "__string",
|
1327
|
+
# wait_until: "__string",
|
1328
|
+
# },
|
1329
|
+
# false_activity: "__string",
|
1330
|
+
# true_activity: "__string",
|
1331
|
+
# },
|
1332
|
+
# description: "__string",
|
1333
|
+
# email: {
|
1334
|
+
# message_config: {
|
1335
|
+
# from_address: "__string",
|
1336
|
+
# },
|
1337
|
+
# next_activity: "__string",
|
1338
|
+
# template_name: "__string",
|
1339
|
+
# },
|
1340
|
+
# holdout: {
|
1341
|
+
# next_activity: "__string",
|
1342
|
+
# percentage: 1, # required
|
1343
|
+
# },
|
1344
|
+
# multi_condition: {
|
1345
|
+
# branches: [
|
1346
|
+
# {
|
1347
|
+
# condition: {
|
1348
|
+
# event_condition: {
|
1349
|
+
# dimensions: { # required
|
1350
|
+
# attributes: {
|
1351
|
+
# "__string" => {
|
1352
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1353
|
+
# values: ["__string"], # required
|
1354
|
+
# },
|
1355
|
+
# },
|
1356
|
+
# event_type: {
|
1357
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1358
|
+
# values: ["__string"], # required
|
1359
|
+
# },
|
1360
|
+
# metrics: {
|
1361
|
+
# "__string" => {
|
1362
|
+
# comparison_operator: "__string", # required
|
1363
|
+
# value: 1.0, # required
|
1364
|
+
# },
|
1365
|
+
# },
|
1366
|
+
# },
|
1367
|
+
# message_activity: "__string",
|
1368
|
+
# },
|
1369
|
+
# segment_condition: {
|
1370
|
+
# segment_id: "__string", # required
|
1371
|
+
# },
|
1372
|
+
# segment_dimensions: {
|
1373
|
+
# attributes: {
|
1374
|
+
# "__string" => {
|
1375
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1376
|
+
# values: ["__string"], # required
|
1377
|
+
# },
|
1378
|
+
# },
|
1379
|
+
# behavior: {
|
1380
|
+
# recency: {
|
1381
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
1382
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
1383
|
+
# },
|
1384
|
+
# },
|
1385
|
+
# demographic: {
|
1386
|
+
# app_version: {
|
1387
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1388
|
+
# values: ["__string"], # required
|
1389
|
+
# },
|
1390
|
+
# channel: {
|
1391
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1392
|
+
# values: ["__string"], # required
|
1393
|
+
# },
|
1394
|
+
# device_type: {
|
1395
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1396
|
+
# values: ["__string"], # required
|
1397
|
+
# },
|
1398
|
+
# make: {
|
1399
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1400
|
+
# values: ["__string"], # required
|
1401
|
+
# },
|
1402
|
+
# model: {
|
1403
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1404
|
+
# values: ["__string"], # required
|
1405
|
+
# },
|
1406
|
+
# platform: {
|
1407
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1408
|
+
# values: ["__string"], # required
|
1409
|
+
# },
|
1410
|
+
# },
|
1411
|
+
# location: {
|
1412
|
+
# country: {
|
1413
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1414
|
+
# values: ["__string"], # required
|
1415
|
+
# },
|
1416
|
+
# gps_point: {
|
1417
|
+
# coordinates: { # required
|
1418
|
+
# latitude: 1.0, # required
|
1419
|
+
# longitude: 1.0, # required
|
1420
|
+
# },
|
1421
|
+
# range_in_kilometers: 1.0,
|
1422
|
+
# },
|
1423
|
+
# },
|
1424
|
+
# metrics: {
|
1425
|
+
# "__string" => {
|
1426
|
+
# comparison_operator: "__string", # required
|
1427
|
+
# value: 1.0, # required
|
1428
|
+
# },
|
1429
|
+
# },
|
1430
|
+
# user_attributes: {
|
1431
|
+
# "__string" => {
|
1432
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1433
|
+
# values: ["__string"], # required
|
1434
|
+
# },
|
1435
|
+
# },
|
1436
|
+
# },
|
1437
|
+
# },
|
1438
|
+
# next_activity: "__string",
|
1439
|
+
# },
|
1440
|
+
# ],
|
1441
|
+
# default_activity: "__string",
|
1442
|
+
# evaluation_wait_time: {
|
1443
|
+
# wait_for: "__string",
|
1444
|
+
# wait_until: "__string",
|
1445
|
+
# },
|
1446
|
+
# },
|
1447
|
+
# random_split: {
|
1448
|
+
# branches: [
|
1449
|
+
# {
|
1450
|
+
# next_activity: "__string",
|
1451
|
+
# percentage: 1,
|
1452
|
+
# },
|
1453
|
+
# ],
|
1454
|
+
# },
|
1455
|
+
# wait: {
|
1456
|
+
# next_activity: "__string",
|
1457
|
+
# wait_time: {
|
1458
|
+
# wait_for: "__string",
|
1459
|
+
# wait_until: "__string",
|
1460
|
+
# },
|
1461
|
+
# },
|
1462
|
+
# }
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] conditional_split
|
1465
|
+
# The settings for a yes/no split activity. This type of activity
|
1466
|
+
# sends participants down one of two paths in a journey, based on
|
1467
|
+
# conditions that you specify.
|
1468
|
+
# @return [Types::ConditionalSplitActivity]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] description
|
1471
|
+
# The custom description of the activity.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] email
|
1475
|
+
# The settings for an email activity. This type of activity sends an
|
1476
|
+
# email message to participants.
|
1477
|
+
# @return [Types::EmailMessageActivity]
|
1478
|
+
#
|
1479
|
+
# @!attribute [rw] holdout
|
1480
|
+
# The settings for a holdout activity. This type of activity stops a
|
1481
|
+
# journey for a specified percentage of participants.
|
1482
|
+
# @return [Types::HoldoutActivity]
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] multi_condition
|
1485
|
+
# The settings for a multivariate split activity. This type of
|
1486
|
+
# activity sends participants down one of as many as five paths in a
|
1487
|
+
# journey, based on conditions that you specify.
|
1488
|
+
# @return [Types::MultiConditionalSplitActivity]
|
1489
|
+
#
|
1490
|
+
# @!attribute [rw] random_split
|
1491
|
+
# The settings for a random split activity. This type of activity
|
1492
|
+
# randomly sends specified percentages of participants down one of as
|
1493
|
+
# many as five paths in a journey, based on conditions that you
|
1494
|
+
# specify.
|
1495
|
+
# @return [Types::RandomSplitActivity]
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] wait
|
1498
|
+
# The settings for a wait activity. This type of activity waits for a
|
1499
|
+
# certain amount of time or until a specific date and time before
|
1500
|
+
# moving participants to the next activity in a journey.
|
1501
|
+
# @return [Types::WaitActivity]
|
1502
|
+
#
|
1503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Activity AWS API Documentation
|
1504
|
+
#
|
1505
|
+
class Activity < Struct.new(
|
1506
|
+
:conditional_split,
|
1507
|
+
:description,
|
1508
|
+
:email,
|
1509
|
+
:holdout,
|
1510
|
+
:multi_condition,
|
1511
|
+
:random_split,
|
1512
|
+
:wait)
|
1513
|
+
include Aws::Structure
|
1514
|
+
end
|
1515
|
+
|
1182
1516
|
# Provides information about an activity that was performed by a
|
1183
1517
|
# campaign.
|
1184
1518
|
#
|
@@ -1214,7 +1548,7 @@ module Aws::Pinpoint
|
|
1214
1548
|
# @return [String]
|
1215
1549
|
#
|
1216
1550
|
# @!attribute [rw] state
|
1217
|
-
# The
|
1551
|
+
# The current status of the activity. Possible values are: PENDING,
|
1218
1552
|
# INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
|
1219
1553
|
# @return [String]
|
1220
1554
|
#
|
@@ -1327,10 +1661,10 @@ module Aws::Pinpoint
|
|
1327
1661
|
include Aws::Structure
|
1328
1662
|
end
|
1329
1663
|
|
1330
|
-
# Specifies
|
1331
|
-
# in push notifications that are sent through the ADM
|
1332
|
-
# Messaging),
|
1333
|
-
# Messaging
|
1664
|
+
# Specifies channel-specific content and settings for a message template
|
1665
|
+
# that can be used in push notifications that are sent through the ADM
|
1666
|
+
# (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase
|
1667
|
+
# Cloud Messaging, formerly Google Cloud Messaging) channel.
|
1334
1668
|
#
|
1335
1669
|
# @note When making an API call, you may pass AndroidPushNotificationTemplate
|
1336
1670
|
# data as a hash:
|
@@ -1436,7 +1770,7 @@ module Aws::Pinpoint
|
|
1436
1770
|
# indicator (KPI)*, that the data was retrieved for. This value
|
1437
1771
|
# describes the associated metric and consists of two or more terms,
|
1438
1772
|
# which are comprised of lowercase alphanumeric characters, separated
|
1439
|
-
# by a hyphen. For a list of
|
1773
|
+
# by a hyphen. For a list of possible values, see the [Amazon Pinpoint
|
1440
1774
|
# Developer Guide][1].
|
1441
1775
|
#
|
1442
1776
|
#
|
@@ -1453,8 +1787,8 @@ module Aws::Pinpoint
|
|
1453
1787
|
# @!attribute [rw] next_token
|
1454
1788
|
# The string to use in a subsequent request to get the next page of
|
1455
1789
|
# results in a paginated response. This value is null for the
|
1456
|
-
# Application Metrics resource
|
1457
|
-
#
|
1790
|
+
# Application Metrics resource because the resource returns all
|
1791
|
+
# results in a single page.
|
1458
1792
|
# @return [String]
|
1459
1793
|
#
|
1460
1794
|
# @!attribute [rw] start_time
|
@@ -1530,24 +1864,26 @@ module Aws::Pinpoint
|
|
1530
1864
|
# @return [Types::CampaignLimits]
|
1531
1865
|
#
|
1532
1866
|
# @!attribute [rw] quiet_time
|
1533
|
-
# The default quiet time for campaigns in the
|
1534
|
-
# is a specific time range when
|
1535
|
-
# endpoints, if all the following conditions are met:
|
1867
|
+
# The default quiet time for campaigns and journeys in the
|
1868
|
+
# application. Quiet time is a specific time range when messages
|
1869
|
+
# aren't sent to endpoints, if all the following conditions are met:
|
1536
1870
|
#
|
1537
1871
|
# * The EndpointDemographic.Timezone property of the endpoint is set
|
1538
1872
|
# to a valid value.
|
1539
1873
|
#
|
1540
1874
|
# * The current time in the endpoint's time zone is later than or
|
1541
1875
|
# equal to the time specified by the QuietTime.Start property for
|
1542
|
-
# the application (or a campaign that has custom quiet
|
1543
|
-
# settings).
|
1876
|
+
# the application (or a campaign or journey that has custom quiet
|
1877
|
+
# time settings).
|
1544
1878
|
#
|
1545
1879
|
# * The current time in the endpoint's time zone is earlier than or
|
1546
1880
|
# equal to the time specified by the QuietTime.End property for the
|
1547
|
-
# application (or a campaign that has custom quiet time
|
1881
|
+
# application (or a campaign or journey that has custom quiet time
|
1882
|
+
# settings).
|
1548
1883
|
#
|
1549
1884
|
# If any of the preceding conditions isn't met, the endpoint will
|
1550
|
-
# receive messages from a campaign, even if quiet time is
|
1885
|
+
# receive messages from a campaign or journey, even if quiet time is
|
1886
|
+
# enabled.
|
1551
1887
|
# @return [Types::QuietTime]
|
1552
1888
|
#
|
1553
1889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ApplicationSettingsResource AWS API Documentation
|
@@ -1629,8 +1965,8 @@ module Aws::Pinpoint
|
|
1629
1965
|
# * endpoint-custom-attributes - Custom attributes that describe
|
1630
1966
|
# endpoints.
|
1631
1967
|
#
|
1632
|
-
# * endpoint-
|
1633
|
-
# Amazon Pinpoint for endpoints.
|
1968
|
+
# * endpoint-metric-attributes - Custom metrics that your app reports
|
1969
|
+
# to Amazon Pinpoint for endpoints.
|
1634
1970
|
#
|
1635
1971
|
# * endpoint-user-attributes - Custom attributes that describe users.
|
1636
1972
|
# @return [String]
|
@@ -1904,12 +2240,12 @@ module Aws::Pinpoint
|
|
1904
2240
|
end
|
1905
2241
|
|
1906
2242
|
# Provides the results of a query that retrieved the data for a standard
|
1907
|
-
# metric that applies to an application or
|
2243
|
+
# metric that applies to an application, campaign, or journey.
|
1908
2244
|
#
|
1909
2245
|
# @!attribute [rw] rows
|
1910
2246
|
# An array of objects that provides the results of a query that
|
1911
2247
|
# retrieved the data for a standard metric that applies to an
|
1912
|
-
# application or
|
2248
|
+
# application, campaign, or journey.
|
1913
2249
|
# @return [Array<Types::ResultRow>]
|
1914
2250
|
#
|
1915
2251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/BaseKpiResult AWS API Documentation
|
@@ -1943,7 +2279,7 @@ module Aws::Pinpoint
|
|
1943
2279
|
# indicator (KPI)*, that the data was retrieved for. This value
|
1944
2280
|
# describes the associated metric and consists of two or more terms,
|
1945
2281
|
# which are comprised of lowercase alphanumeric characters, separated
|
1946
|
-
# by a hyphen. For a list of
|
2282
|
+
# by a hyphen. For a list of possible values, see the [Amazon Pinpoint
|
1947
2283
|
# Developer Guide][1].
|
1948
2284
|
#
|
1949
2285
|
#
|
@@ -1960,8 +2296,8 @@ module Aws::Pinpoint
|
|
1960
2296
|
# @!attribute [rw] next_token
|
1961
2297
|
# The string to use in a subsequent request to get the next page of
|
1962
2298
|
# results in a paginated response. This value is null for the Campaign
|
1963
|
-
# Metrics resource
|
1964
|
-
#
|
2299
|
+
# Metrics resource because the resource returns all results in a
|
2300
|
+
# single page.
|
1965
2301
|
# @return [String]
|
1966
2302
|
#
|
1967
2303
|
# @!attribute [rw] start_time
|
@@ -2063,7 +2399,7 @@ module Aws::Pinpoint
|
|
2063
2399
|
# ENDPOINT, sends the campaign when an endpoint event (<link
|
2064
2400
|
# linkend="apps-application-id-events" />
|
2065
2401
|
#
|
2066
|
-
# Events</link>
|
2402
|
+
# Events resource</link>) occurs.
|
2067
2403
|
# @return [String]
|
2068
2404
|
#
|
2069
2405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignEventFilter AWS API Documentation
|
@@ -2331,10 +2667,10 @@ module Aws::Pinpoint
|
|
2331
2667
|
# Provides information about the status of a campaign.
|
2332
2668
|
#
|
2333
2669
|
# @!attribute [rw] campaign_status
|
2334
|
-
# The status of the campaign, or the status of a
|
2335
|
-
# belongs to an A/B test campaign. If a campaign uses
|
2336
|
-
# campaign has a status of COMPLETED only
|
2337
|
-
# have a status of COMPLETED.
|
2670
|
+
# The current status of the campaign, or the current status of a
|
2671
|
+
# treatment that belongs to an A/B test campaign. If a campaign uses
|
2672
|
+
# A/B testing, the campaign has a status of COMPLETED only if all
|
2673
|
+
# campaign treatments have a status of COMPLETED.
|
2338
2674
|
# @return [String]
|
2339
2675
|
#
|
2340
2676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignState AWS API Documentation
|
@@ -2440,41 +2776,306 @@ module Aws::Pinpoint
|
|
2440
2776
|
include Aws::Structure
|
2441
2777
|
end
|
2442
2778
|
|
2443
|
-
#
|
2779
|
+
# Specifies the conditions to evaluate for an activity in a journey, and
|
2780
|
+
# how to evaluate those conditions.
|
2781
|
+
#
|
2782
|
+
# @note When making an API call, you may pass Condition
|
2444
2783
|
# data as a hash:
|
2445
2784
|
#
|
2446
2785
|
# {
|
2447
|
-
#
|
2448
|
-
#
|
2449
|
-
#
|
2450
|
-
#
|
2451
|
-
#
|
2452
|
-
#
|
2453
|
-
#
|
2454
|
-
#
|
2455
|
-
#
|
2456
|
-
#
|
2457
|
-
#
|
2458
|
-
#
|
2459
|
-
#
|
2460
|
-
#
|
2461
|
-
#
|
2462
|
-
|
2463
|
-
|
2464
|
-
|
2465
|
-
|
2466
|
-
|
2467
|
-
#
|
2468
|
-
#
|
2469
|
-
#
|
2470
|
-
#
|
2471
|
-
#
|
2472
|
-
#
|
2473
|
-
|
2474
|
-
|
2475
|
-
|
2476
|
-
|
2477
|
-
|
2786
|
+
# conditions: [
|
2787
|
+
# {
|
2788
|
+
# event_condition: {
|
2789
|
+
# dimensions: { # required
|
2790
|
+
# attributes: {
|
2791
|
+
# "__string" => {
|
2792
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2793
|
+
# values: ["__string"], # required
|
2794
|
+
# },
|
2795
|
+
# },
|
2796
|
+
# event_type: {
|
2797
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2798
|
+
# values: ["__string"], # required
|
2799
|
+
# },
|
2800
|
+
# metrics: {
|
2801
|
+
# "__string" => {
|
2802
|
+
# comparison_operator: "__string", # required
|
2803
|
+
# value: 1.0, # required
|
2804
|
+
# },
|
2805
|
+
# },
|
2806
|
+
# },
|
2807
|
+
# message_activity: "__string",
|
2808
|
+
# },
|
2809
|
+
# segment_condition: {
|
2810
|
+
# segment_id: "__string", # required
|
2811
|
+
# },
|
2812
|
+
# segment_dimensions: {
|
2813
|
+
# attributes: {
|
2814
|
+
# "__string" => {
|
2815
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2816
|
+
# values: ["__string"], # required
|
2817
|
+
# },
|
2818
|
+
# },
|
2819
|
+
# behavior: {
|
2820
|
+
# recency: {
|
2821
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
2822
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
2823
|
+
# },
|
2824
|
+
# },
|
2825
|
+
# demographic: {
|
2826
|
+
# app_version: {
|
2827
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2828
|
+
# values: ["__string"], # required
|
2829
|
+
# },
|
2830
|
+
# channel: {
|
2831
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2832
|
+
# values: ["__string"], # required
|
2833
|
+
# },
|
2834
|
+
# device_type: {
|
2835
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2836
|
+
# values: ["__string"], # required
|
2837
|
+
# },
|
2838
|
+
# make: {
|
2839
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2840
|
+
# values: ["__string"], # required
|
2841
|
+
# },
|
2842
|
+
# model: {
|
2843
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2844
|
+
# values: ["__string"], # required
|
2845
|
+
# },
|
2846
|
+
# platform: {
|
2847
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2848
|
+
# values: ["__string"], # required
|
2849
|
+
# },
|
2850
|
+
# },
|
2851
|
+
# location: {
|
2852
|
+
# country: {
|
2853
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2854
|
+
# values: ["__string"], # required
|
2855
|
+
# },
|
2856
|
+
# gps_point: {
|
2857
|
+
# coordinates: { # required
|
2858
|
+
# latitude: 1.0, # required
|
2859
|
+
# longitude: 1.0, # required
|
2860
|
+
# },
|
2861
|
+
# range_in_kilometers: 1.0,
|
2862
|
+
# },
|
2863
|
+
# },
|
2864
|
+
# metrics: {
|
2865
|
+
# "__string" => {
|
2866
|
+
# comparison_operator: "__string", # required
|
2867
|
+
# value: 1.0, # required
|
2868
|
+
# },
|
2869
|
+
# },
|
2870
|
+
# user_attributes: {
|
2871
|
+
# "__string" => {
|
2872
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2873
|
+
# values: ["__string"], # required
|
2874
|
+
# },
|
2875
|
+
# },
|
2876
|
+
# },
|
2877
|
+
# },
|
2878
|
+
# ],
|
2879
|
+
# operator: "ALL", # accepts ALL, ANY
|
2880
|
+
# }
|
2881
|
+
#
|
2882
|
+
# @!attribute [rw] conditions
|
2883
|
+
# The conditions to evaluate for the activity.
|
2884
|
+
# @return [Array<Types::SimpleCondition>]
|
2885
|
+
#
|
2886
|
+
# @!attribute [rw] operator
|
2887
|
+
# Specifies how to handle multiple conditions for the activity. For
|
2888
|
+
# example, if you specify two conditions for an activity, whether both
|
2889
|
+
# or only one of the conditions must be met for the activity to be
|
2890
|
+
# performed.
|
2891
|
+
# @return [String]
|
2892
|
+
#
|
2893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Condition AWS API Documentation
|
2894
|
+
#
|
2895
|
+
class Condition < Struct.new(
|
2896
|
+
:conditions,
|
2897
|
+
:operator)
|
2898
|
+
include Aws::Structure
|
2899
|
+
end
|
2900
|
+
|
2901
|
+
# Specifies the settings for a yes/no split activity in a journey. This
|
2902
|
+
# type of activity sends participants down one of two paths in a
|
2903
|
+
# journey, based on conditions that you specify.
|
2904
|
+
#
|
2905
|
+
# @note When making an API call, you may pass ConditionalSplitActivity
|
2906
|
+
# data as a hash:
|
2907
|
+
#
|
2908
|
+
# {
|
2909
|
+
# condition: {
|
2910
|
+
# conditions: [
|
2911
|
+
# {
|
2912
|
+
# event_condition: {
|
2913
|
+
# dimensions: { # required
|
2914
|
+
# attributes: {
|
2915
|
+
# "__string" => {
|
2916
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2917
|
+
# values: ["__string"], # required
|
2918
|
+
# },
|
2919
|
+
# },
|
2920
|
+
# event_type: {
|
2921
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2922
|
+
# values: ["__string"], # required
|
2923
|
+
# },
|
2924
|
+
# metrics: {
|
2925
|
+
# "__string" => {
|
2926
|
+
# comparison_operator: "__string", # required
|
2927
|
+
# value: 1.0, # required
|
2928
|
+
# },
|
2929
|
+
# },
|
2930
|
+
# },
|
2931
|
+
# message_activity: "__string",
|
2932
|
+
# },
|
2933
|
+
# segment_condition: {
|
2934
|
+
# segment_id: "__string", # required
|
2935
|
+
# },
|
2936
|
+
# segment_dimensions: {
|
2937
|
+
# attributes: {
|
2938
|
+
# "__string" => {
|
2939
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2940
|
+
# values: ["__string"], # required
|
2941
|
+
# },
|
2942
|
+
# },
|
2943
|
+
# behavior: {
|
2944
|
+
# recency: {
|
2945
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
2946
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
2947
|
+
# },
|
2948
|
+
# },
|
2949
|
+
# demographic: {
|
2950
|
+
# app_version: {
|
2951
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2952
|
+
# values: ["__string"], # required
|
2953
|
+
# },
|
2954
|
+
# channel: {
|
2955
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2956
|
+
# values: ["__string"], # required
|
2957
|
+
# },
|
2958
|
+
# device_type: {
|
2959
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2960
|
+
# values: ["__string"], # required
|
2961
|
+
# },
|
2962
|
+
# make: {
|
2963
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2964
|
+
# values: ["__string"], # required
|
2965
|
+
# },
|
2966
|
+
# model: {
|
2967
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2968
|
+
# values: ["__string"], # required
|
2969
|
+
# },
|
2970
|
+
# platform: {
|
2971
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2972
|
+
# values: ["__string"], # required
|
2973
|
+
# },
|
2974
|
+
# },
|
2975
|
+
# location: {
|
2976
|
+
# country: {
|
2977
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2978
|
+
# values: ["__string"], # required
|
2979
|
+
# },
|
2980
|
+
# gps_point: {
|
2981
|
+
# coordinates: { # required
|
2982
|
+
# latitude: 1.0, # required
|
2983
|
+
# longitude: 1.0, # required
|
2984
|
+
# },
|
2985
|
+
# range_in_kilometers: 1.0,
|
2986
|
+
# },
|
2987
|
+
# },
|
2988
|
+
# metrics: {
|
2989
|
+
# "__string" => {
|
2990
|
+
# comparison_operator: "__string", # required
|
2991
|
+
# value: 1.0, # required
|
2992
|
+
# },
|
2993
|
+
# },
|
2994
|
+
# user_attributes: {
|
2995
|
+
# "__string" => {
|
2996
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
2997
|
+
# values: ["__string"], # required
|
2998
|
+
# },
|
2999
|
+
# },
|
3000
|
+
# },
|
3001
|
+
# },
|
3002
|
+
# ],
|
3003
|
+
# operator: "ALL", # accepts ALL, ANY
|
3004
|
+
# },
|
3005
|
+
# evaluation_wait_time: {
|
3006
|
+
# wait_for: "__string",
|
3007
|
+
# wait_until: "__string",
|
3008
|
+
# },
|
3009
|
+
# false_activity: "__string",
|
3010
|
+
# true_activity: "__string",
|
3011
|
+
# }
|
3012
|
+
#
|
3013
|
+
# @!attribute [rw] condition
|
3014
|
+
# The conditions that define the paths for the activity, and the
|
3015
|
+
# relationship between the conditions.
|
3016
|
+
# @return [Types::Condition]
|
3017
|
+
#
|
3018
|
+
# @!attribute [rw] evaluation_wait_time
|
3019
|
+
# The amount of time to wait before determining whether the conditions
|
3020
|
+
# are met, or the date and time when Amazon Pinpoint determines
|
3021
|
+
# whether the conditions are met.
|
3022
|
+
# @return [Types::WaitTime]
|
3023
|
+
#
|
3024
|
+
# @!attribute [rw] false_activity
|
3025
|
+
# The unique identifier for the activity to perform if the condition
|
3026
|
+
# isn't met.
|
3027
|
+
# @return [String]
|
3028
|
+
#
|
3029
|
+
# @!attribute [rw] true_activity
|
3030
|
+
# The unique identifier for the activity to perform if the condition
|
3031
|
+
# is met.
|
3032
|
+
# @return [String]
|
3033
|
+
#
|
3034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ConditionalSplitActivity AWS API Documentation
|
3035
|
+
#
|
3036
|
+
class ConditionalSplitActivity < Struct.new(
|
3037
|
+
:condition,
|
3038
|
+
:evaluation_wait_time,
|
3039
|
+
:false_activity,
|
3040
|
+
:true_activity)
|
3041
|
+
include Aws::Structure
|
3042
|
+
end
|
3043
|
+
|
3044
|
+
# @note When making an API call, you may pass CreateAppRequest
|
3045
|
+
# data as a hash:
|
3046
|
+
#
|
3047
|
+
# {
|
3048
|
+
# create_application_request: { # required
|
3049
|
+
# name: "__string", # required
|
3050
|
+
# tags: {
|
3051
|
+
# "__string" => "__string",
|
3052
|
+
# },
|
3053
|
+
# },
|
3054
|
+
# }
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] create_application_request
|
3057
|
+
# Specifies the display name of an application and the tags to
|
3058
|
+
# associate with the application.
|
3059
|
+
# @return [Types::CreateApplicationRequest]
|
3060
|
+
#
|
3061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateAppRequest AWS API Documentation
|
3062
|
+
#
|
3063
|
+
class CreateAppRequest < Struct.new(
|
3064
|
+
:create_application_request)
|
3065
|
+
include Aws::Structure
|
3066
|
+
end
|
3067
|
+
|
3068
|
+
# @!attribute [rw] application_response
|
3069
|
+
# Provides information about an application.
|
3070
|
+
# @return [Types::ApplicationResponse]
|
3071
|
+
#
|
3072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateAppResponse AWS API Documentation
|
3073
|
+
#
|
3074
|
+
class CreateAppResponse < Struct.new(
|
3075
|
+
:application_response)
|
3076
|
+
include Aws::Structure
|
3077
|
+
end
|
3078
|
+
|
2478
3079
|
# Specifies the display name of an application and the tags to associate
|
2479
3080
|
# with the application.
|
2480
3081
|
#
|
@@ -2856,7 +3457,7 @@ module Aws::Pinpoint
|
|
2856
3457
|
end
|
2857
3458
|
|
2858
3459
|
# @!attribute [rw] create_template_message_body
|
2859
|
-
# Provides information about
|
3460
|
+
# Provides information about a request to create a message template.
|
2860
3461
|
# @return [Types::CreateTemplateMessageBody]
|
2861
3462
|
#
|
2862
3463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateEmailTemplateResponse AWS API Documentation
|
@@ -2958,44 +3559,345 @@ module Aws::Pinpoint
|
|
2958
3559
|
include Aws::Structure
|
2959
3560
|
end
|
2960
3561
|
|
2961
|
-
# @note When making an API call, you may pass
|
3562
|
+
# @note When making an API call, you may pass CreateJourneyRequest
|
2962
3563
|
# data as a hash:
|
2963
3564
|
#
|
2964
3565
|
# {
|
2965
|
-
#
|
2966
|
-
#
|
2967
|
-
#
|
2968
|
-
#
|
2969
|
-
#
|
2970
|
-
#
|
2971
|
-
#
|
2972
|
-
#
|
2973
|
-
#
|
2974
|
-
#
|
2975
|
-
#
|
2976
|
-
#
|
2977
|
-
#
|
2978
|
-
#
|
2979
|
-
#
|
2980
|
-
#
|
2981
|
-
#
|
2982
|
-
#
|
2983
|
-
#
|
2984
|
-
#
|
2985
|
-
#
|
2986
|
-
#
|
2987
|
-
#
|
2988
|
-
#
|
2989
|
-
#
|
2990
|
-
#
|
2991
|
-
#
|
2992
|
-
#
|
2993
|
-
#
|
2994
|
-
#
|
2995
|
-
#
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
3566
|
+
# application_id: "__string", # required
|
3567
|
+
# write_journey_request: { # required
|
3568
|
+
# activities: {
|
3569
|
+
# "__string" => {
|
3570
|
+
# conditional_split: {
|
3571
|
+
# condition: {
|
3572
|
+
# conditions: [
|
3573
|
+
# {
|
3574
|
+
# event_condition: {
|
3575
|
+
# dimensions: { # required
|
3576
|
+
# attributes: {
|
3577
|
+
# "__string" => {
|
3578
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3579
|
+
# values: ["__string"], # required
|
3580
|
+
# },
|
3581
|
+
# },
|
3582
|
+
# event_type: {
|
3583
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3584
|
+
# values: ["__string"], # required
|
3585
|
+
# },
|
3586
|
+
# metrics: {
|
3587
|
+
# "__string" => {
|
3588
|
+
# comparison_operator: "__string", # required
|
3589
|
+
# value: 1.0, # required
|
3590
|
+
# },
|
3591
|
+
# },
|
3592
|
+
# },
|
3593
|
+
# message_activity: "__string",
|
3594
|
+
# },
|
3595
|
+
# segment_condition: {
|
3596
|
+
# segment_id: "__string", # required
|
3597
|
+
# },
|
3598
|
+
# segment_dimensions: {
|
3599
|
+
# attributes: {
|
3600
|
+
# "__string" => {
|
3601
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3602
|
+
# values: ["__string"], # required
|
3603
|
+
# },
|
3604
|
+
# },
|
3605
|
+
# behavior: {
|
3606
|
+
# recency: {
|
3607
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
3608
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
3609
|
+
# },
|
3610
|
+
# },
|
3611
|
+
# demographic: {
|
3612
|
+
# app_version: {
|
3613
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3614
|
+
# values: ["__string"], # required
|
3615
|
+
# },
|
3616
|
+
# channel: {
|
3617
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3618
|
+
# values: ["__string"], # required
|
3619
|
+
# },
|
3620
|
+
# device_type: {
|
3621
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3622
|
+
# values: ["__string"], # required
|
3623
|
+
# },
|
3624
|
+
# make: {
|
3625
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3626
|
+
# values: ["__string"], # required
|
3627
|
+
# },
|
3628
|
+
# model: {
|
3629
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3630
|
+
# values: ["__string"], # required
|
3631
|
+
# },
|
3632
|
+
# platform: {
|
3633
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3634
|
+
# values: ["__string"], # required
|
3635
|
+
# },
|
3636
|
+
# },
|
3637
|
+
# location: {
|
3638
|
+
# country: {
|
3639
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3640
|
+
# values: ["__string"], # required
|
3641
|
+
# },
|
3642
|
+
# gps_point: {
|
3643
|
+
# coordinates: { # required
|
3644
|
+
# latitude: 1.0, # required
|
3645
|
+
# longitude: 1.0, # required
|
3646
|
+
# },
|
3647
|
+
# range_in_kilometers: 1.0,
|
3648
|
+
# },
|
3649
|
+
# },
|
3650
|
+
# metrics: {
|
3651
|
+
# "__string" => {
|
3652
|
+
# comparison_operator: "__string", # required
|
3653
|
+
# value: 1.0, # required
|
3654
|
+
# },
|
3655
|
+
# },
|
3656
|
+
# user_attributes: {
|
3657
|
+
# "__string" => {
|
3658
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3659
|
+
# values: ["__string"], # required
|
3660
|
+
# },
|
3661
|
+
# },
|
3662
|
+
# },
|
3663
|
+
# },
|
3664
|
+
# ],
|
3665
|
+
# operator: "ALL", # accepts ALL, ANY
|
3666
|
+
# },
|
3667
|
+
# evaluation_wait_time: {
|
3668
|
+
# wait_for: "__string",
|
3669
|
+
# wait_until: "__string",
|
3670
|
+
# },
|
3671
|
+
# false_activity: "__string",
|
3672
|
+
# true_activity: "__string",
|
3673
|
+
# },
|
3674
|
+
# description: "__string",
|
3675
|
+
# email: {
|
3676
|
+
# message_config: {
|
3677
|
+
# from_address: "__string",
|
3678
|
+
# },
|
3679
|
+
# next_activity: "__string",
|
3680
|
+
# template_name: "__string",
|
3681
|
+
# },
|
3682
|
+
# holdout: {
|
3683
|
+
# next_activity: "__string",
|
3684
|
+
# percentage: 1, # required
|
3685
|
+
# },
|
3686
|
+
# multi_condition: {
|
3687
|
+
# branches: [
|
3688
|
+
# {
|
3689
|
+
# condition: {
|
3690
|
+
# event_condition: {
|
3691
|
+
# dimensions: { # required
|
3692
|
+
# attributes: {
|
3693
|
+
# "__string" => {
|
3694
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3695
|
+
# values: ["__string"], # required
|
3696
|
+
# },
|
3697
|
+
# },
|
3698
|
+
# event_type: {
|
3699
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3700
|
+
# values: ["__string"], # required
|
3701
|
+
# },
|
3702
|
+
# metrics: {
|
3703
|
+
# "__string" => {
|
3704
|
+
# comparison_operator: "__string", # required
|
3705
|
+
# value: 1.0, # required
|
3706
|
+
# },
|
3707
|
+
# },
|
3708
|
+
# },
|
3709
|
+
# message_activity: "__string",
|
3710
|
+
# },
|
3711
|
+
# segment_condition: {
|
3712
|
+
# segment_id: "__string", # required
|
3713
|
+
# },
|
3714
|
+
# segment_dimensions: {
|
3715
|
+
# attributes: {
|
3716
|
+
# "__string" => {
|
3717
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3718
|
+
# values: ["__string"], # required
|
3719
|
+
# },
|
3720
|
+
# },
|
3721
|
+
# behavior: {
|
3722
|
+
# recency: {
|
3723
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
3724
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
3725
|
+
# },
|
3726
|
+
# },
|
3727
|
+
# demographic: {
|
3728
|
+
# app_version: {
|
3729
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3730
|
+
# values: ["__string"], # required
|
3731
|
+
# },
|
3732
|
+
# channel: {
|
3733
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3734
|
+
# values: ["__string"], # required
|
3735
|
+
# },
|
3736
|
+
# device_type: {
|
3737
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3738
|
+
# values: ["__string"], # required
|
3739
|
+
# },
|
3740
|
+
# make: {
|
3741
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3742
|
+
# values: ["__string"], # required
|
3743
|
+
# },
|
3744
|
+
# model: {
|
3745
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3746
|
+
# values: ["__string"], # required
|
3747
|
+
# },
|
3748
|
+
# platform: {
|
3749
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3750
|
+
# values: ["__string"], # required
|
3751
|
+
# },
|
3752
|
+
# },
|
3753
|
+
# location: {
|
3754
|
+
# country: {
|
3755
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3756
|
+
# values: ["__string"], # required
|
3757
|
+
# },
|
3758
|
+
# gps_point: {
|
3759
|
+
# coordinates: { # required
|
3760
|
+
# latitude: 1.0, # required
|
3761
|
+
# longitude: 1.0, # required
|
3762
|
+
# },
|
3763
|
+
# range_in_kilometers: 1.0,
|
3764
|
+
# },
|
3765
|
+
# },
|
3766
|
+
# metrics: {
|
3767
|
+
# "__string" => {
|
3768
|
+
# comparison_operator: "__string", # required
|
3769
|
+
# value: 1.0, # required
|
3770
|
+
# },
|
3771
|
+
# },
|
3772
|
+
# user_attributes: {
|
3773
|
+
# "__string" => {
|
3774
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
3775
|
+
# values: ["__string"], # required
|
3776
|
+
# },
|
3777
|
+
# },
|
3778
|
+
# },
|
3779
|
+
# },
|
3780
|
+
# next_activity: "__string",
|
3781
|
+
# },
|
3782
|
+
# ],
|
3783
|
+
# default_activity: "__string",
|
3784
|
+
# evaluation_wait_time: {
|
3785
|
+
# wait_for: "__string",
|
3786
|
+
# wait_until: "__string",
|
3787
|
+
# },
|
3788
|
+
# },
|
3789
|
+
# random_split: {
|
3790
|
+
# branches: [
|
3791
|
+
# {
|
3792
|
+
# next_activity: "__string",
|
3793
|
+
# percentage: 1,
|
3794
|
+
# },
|
3795
|
+
# ],
|
3796
|
+
# },
|
3797
|
+
# wait: {
|
3798
|
+
# next_activity: "__string",
|
3799
|
+
# wait_time: {
|
3800
|
+
# wait_for: "__string",
|
3801
|
+
# wait_until: "__string",
|
3802
|
+
# },
|
3803
|
+
# },
|
3804
|
+
# },
|
3805
|
+
# },
|
3806
|
+
# creation_date: "__string",
|
3807
|
+
# last_modified_date: "__string",
|
3808
|
+
# limits: {
|
3809
|
+
# daily_cap: 1,
|
3810
|
+
# endpoint_reentry_cap: 1,
|
3811
|
+
# messages_per_second: 1,
|
3812
|
+
# },
|
3813
|
+
# local_time: false,
|
3814
|
+
# name: "__string", # required
|
3815
|
+
# quiet_time: {
|
3816
|
+
# end: "__string",
|
3817
|
+
# start: "__string",
|
3818
|
+
# },
|
3819
|
+
# refresh_frequency: "__string",
|
3820
|
+
# schedule: {
|
3821
|
+
# end_time: Time.now,
|
3822
|
+
# start_time: Time.now,
|
3823
|
+
# timezone: "__string",
|
3824
|
+
# },
|
3825
|
+
# start_activity: "__string",
|
3826
|
+
# start_condition: {
|
3827
|
+
# description: "__string",
|
3828
|
+
# segment_start_condition: {
|
3829
|
+
# segment_id: "__string", # required
|
3830
|
+
# },
|
3831
|
+
# },
|
3832
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
3833
|
+
# },
|
3834
|
+
# }
|
3835
|
+
#
|
3836
|
+
# @!attribute [rw] application_id
|
3837
|
+
# @return [String]
|
3838
|
+
#
|
3839
|
+
# @!attribute [rw] write_journey_request
|
3840
|
+
# Specifies the configuration and other settings for a journey.
|
3841
|
+
# @return [Types::WriteJourneyRequest]
|
3842
|
+
#
|
3843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateJourneyRequest AWS API Documentation
|
3844
|
+
#
|
3845
|
+
class CreateJourneyRequest < Struct.new(
|
3846
|
+
:application_id,
|
3847
|
+
:write_journey_request)
|
3848
|
+
include Aws::Structure
|
3849
|
+
end
|
3850
|
+
|
3851
|
+
# @!attribute [rw] journey_response
|
3852
|
+
# Provides information about the status, configuration, and other
|
3853
|
+
# settings for a journey.
|
3854
|
+
# @return [Types::JourneyResponse]
|
3855
|
+
#
|
3856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateJourneyResponse AWS API Documentation
|
3857
|
+
#
|
3858
|
+
class CreateJourneyResponse < Struct.new(
|
3859
|
+
:journey_response)
|
3860
|
+
include Aws::Structure
|
3861
|
+
end
|
3862
|
+
|
3863
|
+
# @note When making an API call, you may pass CreatePushTemplateRequest
|
3864
|
+
# data as a hash:
|
3865
|
+
#
|
3866
|
+
# {
|
3867
|
+
# push_notification_template_request: { # required
|
3868
|
+
# adm: {
|
3869
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3870
|
+
# body: "__string",
|
3871
|
+
# image_icon_url: "__string",
|
3872
|
+
# image_url: "__string",
|
3873
|
+
# small_image_icon_url: "__string",
|
3874
|
+
# sound: "__string",
|
3875
|
+
# title: "__string",
|
3876
|
+
# url: "__string",
|
3877
|
+
# },
|
3878
|
+
# apns: {
|
3879
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3880
|
+
# body: "__string",
|
3881
|
+
# media_url: "__string",
|
3882
|
+
# sound: "__string",
|
3883
|
+
# title: "__string",
|
3884
|
+
# url: "__string",
|
3885
|
+
# },
|
3886
|
+
# baidu: {
|
3887
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3888
|
+
# body: "__string",
|
3889
|
+
# image_icon_url: "__string",
|
3890
|
+
# image_url: "__string",
|
3891
|
+
# small_image_icon_url: "__string",
|
3892
|
+
# sound: "__string",
|
3893
|
+
# title: "__string",
|
3894
|
+
# url: "__string",
|
3895
|
+
# },
|
3896
|
+
# default: {
|
3897
|
+
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3898
|
+
# body: "__string",
|
3899
|
+
# sound: "__string",
|
3900
|
+
# title: "__string",
|
2999
3901
|
# url: "__string",
|
3000
3902
|
# },
|
3001
3903
|
# gcm: {
|
@@ -3033,7 +3935,7 @@ module Aws::Pinpoint
|
|
3033
3935
|
end
|
3034
3936
|
|
3035
3937
|
# @!attribute [rw] create_template_message_body
|
3036
|
-
# Provides information about
|
3938
|
+
# Provides information about a request to create a message template.
|
3037
3939
|
# @return [Types::CreateTemplateMessageBody]
|
3038
3940
|
#
|
3039
3941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreatePushTemplateResponse AWS API Documentation
|
@@ -3262,7 +4164,7 @@ module Aws::Pinpoint
|
|
3262
4164
|
end
|
3263
4165
|
|
3264
4166
|
# @!attribute [rw] create_template_message_body
|
3265
|
-
# Provides information about
|
4167
|
+
# Provides information about a request to create a message template.
|
3266
4168
|
# @return [Types::CreateTemplateMessageBody]
|
3267
4169
|
#
|
3268
4170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSmsTemplateResponse AWS API Documentation
|
@@ -3272,15 +4174,21 @@ module Aws::Pinpoint
|
|
3272
4174
|
include Aws::Structure
|
3273
4175
|
end
|
3274
4176
|
|
3275
|
-
# Provides information about
|
4177
|
+
# Provides information about a request to create a message template.
|
3276
4178
|
#
|
3277
4179
|
# @!attribute [rw] arn
|
4180
|
+
# The Amazon Resource Name (ARN) of the message template that was
|
4181
|
+
# created.
|
3278
4182
|
# @return [String]
|
3279
4183
|
#
|
3280
4184
|
# @!attribute [rw] message
|
4185
|
+
# The message that's returned from the API for the request to create
|
4186
|
+
# the message template.
|
3281
4187
|
# @return [String]
|
3282
4188
|
#
|
3283
4189
|
# @!attribute [rw] request_id
|
4190
|
+
# The unique identifier for the request to create the message
|
4191
|
+
# template.
|
3284
4192
|
# @return [String]
|
3285
4193
|
#
|
3286
4194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateTemplateMessageBody AWS API Documentation
|
@@ -3406,8 +4314,8 @@ module Aws::Pinpoint
|
|
3406
4314
|
include Aws::Structure
|
3407
4315
|
end
|
3408
4316
|
|
3409
|
-
# Specifies the settings and content for
|
3410
|
-
#
|
4317
|
+
# Specifies the default settings and content for a message template that
|
4318
|
+
# can be used in messages that are sent through a push notification
|
3411
4319
|
# channel.
|
3412
4320
|
#
|
3413
4321
|
# @note When making an API call, you may pass DefaultPushNotificationTemplate
|
@@ -3867,6 +4775,40 @@ module Aws::Pinpoint
|
|
3867
4775
|
include Aws::Structure
|
3868
4776
|
end
|
3869
4777
|
|
4778
|
+
# @note When making an API call, you may pass DeleteJourneyRequest
|
4779
|
+
# data as a hash:
|
4780
|
+
#
|
4781
|
+
# {
|
4782
|
+
# application_id: "__string", # required
|
4783
|
+
# journey_id: "__string", # required
|
4784
|
+
# }
|
4785
|
+
#
|
4786
|
+
# @!attribute [rw] application_id
|
4787
|
+
# @return [String]
|
4788
|
+
#
|
4789
|
+
# @!attribute [rw] journey_id
|
4790
|
+
# @return [String]
|
4791
|
+
#
|
4792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteJourneyRequest AWS API Documentation
|
4793
|
+
#
|
4794
|
+
class DeleteJourneyRequest < Struct.new(
|
4795
|
+
:application_id,
|
4796
|
+
:journey_id)
|
4797
|
+
include Aws::Structure
|
4798
|
+
end
|
4799
|
+
|
4800
|
+
# @!attribute [rw] journey_response
|
4801
|
+
# Provides information about the status, configuration, and other
|
4802
|
+
# settings for a journey.
|
4803
|
+
# @return [Types::JourneyResponse]
|
4804
|
+
#
|
4805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteJourneyResponse AWS API Documentation
|
4806
|
+
#
|
4807
|
+
class DeleteJourneyResponse < Struct.new(
|
4808
|
+
:journey_response)
|
4809
|
+
include Aws::Structure
|
4810
|
+
end
|
4811
|
+
|
3870
4812
|
# @note When making an API call, you may pass DeletePushTemplateRequest
|
3871
4813
|
# data as a hash:
|
3872
4814
|
#
|
@@ -4079,6 +5021,7 @@ module Aws::Pinpoint
|
|
4079
5021
|
# url: "__string",
|
4080
5022
|
# },
|
4081
5023
|
# apns_message: {
|
5024
|
+
# apns_push_type: "__string",
|
4082
5025
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4083
5026
|
# badge: 1,
|
4084
5027
|
# body: "__string",
|
@@ -4504,6 +5447,42 @@ module Aws::Pinpoint
|
|
4504
5447
|
include Aws::Structure
|
4505
5448
|
end
|
4506
5449
|
|
5450
|
+
# Specifies the settings for an email activity in a journey. This type
|
5451
|
+
# of activity sends an email message to participants.
|
5452
|
+
#
|
5453
|
+
# @note When making an API call, you may pass EmailMessageActivity
|
5454
|
+
# data as a hash:
|
5455
|
+
#
|
5456
|
+
# {
|
5457
|
+
# message_config: {
|
5458
|
+
# from_address: "__string",
|
5459
|
+
# },
|
5460
|
+
# next_activity: "__string",
|
5461
|
+
# template_name: "__string",
|
5462
|
+
# }
|
5463
|
+
#
|
5464
|
+
# @!attribute [rw] message_config
|
5465
|
+
# The "From" address to use for the message.
|
5466
|
+
# @return [Types::JourneyEmailMessage]
|
5467
|
+
#
|
5468
|
+
# @!attribute [rw] next_activity
|
5469
|
+
# The unique identifier for the next activity to perform, after the
|
5470
|
+
# message is sent.
|
5471
|
+
# @return [String]
|
5472
|
+
#
|
5473
|
+
# @!attribute [rw] template_name
|
5474
|
+
# The name of the email template to use for the message.
|
5475
|
+
# @return [String]
|
5476
|
+
#
|
5477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailMessageActivity AWS API Documentation
|
5478
|
+
#
|
5479
|
+
class EmailMessageActivity < Struct.new(
|
5480
|
+
:message_config,
|
5481
|
+
:next_activity,
|
5482
|
+
:template_name)
|
5483
|
+
include Aws::Structure
|
5484
|
+
end
|
5485
|
+
|
4507
5486
|
# Specifies the content and settings for a message template that can be
|
4508
5487
|
# used in messages that are sent through the email channel.
|
4509
5488
|
#
|
@@ -4559,6 +5538,7 @@ module Aws::Pinpoint
|
|
4559
5538
|
# channel.
|
4560
5539
|
#
|
4561
5540
|
# @!attribute [rw] arn
|
5541
|
+
# The Amazon Resource Name (ARN) of the message template.
|
4562
5542
|
# @return [String]
|
4563
5543
|
#
|
4564
5544
|
# @!attribute [rw] creation_date
|
@@ -5490,8 +6470,53 @@ module Aws::Pinpoint
|
|
5490
6470
|
include Aws::Structure
|
5491
6471
|
end
|
5492
6472
|
|
6473
|
+
# Specifies the conditions to evaluate for an event that applies to an
|
6474
|
+
# activity in a journey.
|
6475
|
+
#
|
6476
|
+
# @note When making an API call, you may pass EventCondition
|
6477
|
+
# data as a hash:
|
6478
|
+
#
|
6479
|
+
# {
|
6480
|
+
# dimensions: { # required
|
6481
|
+
# attributes: {
|
6482
|
+
# "__string" => {
|
6483
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6484
|
+
# values: ["__string"], # required
|
6485
|
+
# },
|
6486
|
+
# },
|
6487
|
+
# event_type: {
|
6488
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6489
|
+
# values: ["__string"], # required
|
6490
|
+
# },
|
6491
|
+
# metrics: {
|
6492
|
+
# "__string" => {
|
6493
|
+
# comparison_operator: "__string", # required
|
6494
|
+
# value: 1.0, # required
|
6495
|
+
# },
|
6496
|
+
# },
|
6497
|
+
# },
|
6498
|
+
# message_activity: "__string",
|
6499
|
+
# }
|
6500
|
+
#
|
6501
|
+
# @!attribute [rw] dimensions
|
6502
|
+
# The dimensions for the event filter to use for the activity.
|
6503
|
+
# @return [Types::EventDimensions]
|
6504
|
+
#
|
6505
|
+
# @!attribute [rw] message_activity
|
6506
|
+
# The message identifier (message\_id) for the message to use when
|
6507
|
+
# determining whether message events meet the condition.
|
6508
|
+
# @return [String]
|
6509
|
+
#
|
6510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventCondition AWS API Documentation
|
6511
|
+
#
|
6512
|
+
class EventCondition < Struct.new(
|
6513
|
+
:dimensions,
|
6514
|
+
:message_activity)
|
6515
|
+
include Aws::Structure
|
6516
|
+
end
|
6517
|
+
|
5493
6518
|
# Specifies the dimensions for an event filter that determines when a
|
5494
|
-
# campaign is sent.
|
6519
|
+
# campaign is sent or a journey activity is performed.
|
5495
6520
|
#
|
5496
6521
|
# @note When making an API call, you may pass EventDimensions
|
5497
6522
|
# data as a hash:
|
@@ -5516,21 +6541,22 @@ module Aws::Pinpoint
|
|
5516
6541
|
# }
|
5517
6542
|
#
|
5518
6543
|
# @!attribute [rw] attributes
|
5519
|
-
# One or more custom attributes that your
|
5520
|
-
# Pinpoint. You can use these attributes as selection criteria
|
5521
|
-
# you create an event filter.
|
6544
|
+
# One or more custom attributes that your application reports to
|
6545
|
+
# Amazon Pinpoint. You can use these attributes as selection criteria
|
6546
|
+
# when you create an event filter.
|
5522
6547
|
# @return [Hash<String,Types::AttributeDimension>]
|
5523
6548
|
#
|
5524
6549
|
# @!attribute [rw] event_type
|
5525
|
-
# The name of the event that causes the campaign to be sent
|
5526
|
-
#
|
5527
|
-
#
|
6550
|
+
# The name of the event that causes the campaign to be sent or the
|
6551
|
+
# journey activity to be performed. This can be a standard type of
|
6552
|
+
# event that Amazon Pinpoint generates, such as \_email.delivered, or
|
6553
|
+
# a custom event that's specific to your application.
|
5528
6554
|
# @return [Types::SetDimension]
|
5529
6555
|
#
|
5530
6556
|
# @!attribute [rw] metrics
|
5531
|
-
# One or more custom metrics that your
|
5532
|
-
# You can use these metrics as selection criteria when you
|
5533
|
-
# event filter.
|
6557
|
+
# One or more custom metrics that your application reports to Amazon
|
6558
|
+
# Pinpoint. You can use these metrics as selection criteria when you
|
6559
|
+
# create an event filter.
|
5534
6560
|
# @return [Hash<String,Types::MetricDimension>]
|
5535
6561
|
#
|
5536
6562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventDimensions AWS API Documentation
|
@@ -7299,65 +8325,253 @@ module Aws::Pinpoint
|
|
7299
8325
|
include Aws::Structure
|
7300
8326
|
end
|
7301
8327
|
|
7302
|
-
# @note When making an API call, you may pass
|
8328
|
+
# @note When making an API call, you may pass GetJourneyDateRangeKpiRequest
|
7303
8329
|
# data as a hash:
|
7304
8330
|
#
|
7305
8331
|
# {
|
7306
|
-
#
|
8332
|
+
# application_id: "__string", # required
|
8333
|
+
# end_time: Time.now,
|
8334
|
+
# journey_id: "__string", # required
|
8335
|
+
# kpi_name: "__string", # required
|
8336
|
+
# next_token: "__string",
|
8337
|
+
# page_size: "__string",
|
8338
|
+
# start_time: Time.now,
|
7307
8339
|
# }
|
7308
8340
|
#
|
7309
|
-
# @!attribute [rw]
|
8341
|
+
# @!attribute [rw] application_id
|
7310
8342
|
# @return [String]
|
7311
8343
|
#
|
7312
|
-
#
|
8344
|
+
# @!attribute [rw] end_time
|
8345
|
+
# @return [Time]
|
7313
8346
|
#
|
7314
|
-
|
7315
|
-
|
8347
|
+
# @!attribute [rw] journey_id
|
8348
|
+
# @return [String]
|
8349
|
+
#
|
8350
|
+
# @!attribute [rw] kpi_name
|
8351
|
+
# @return [String]
|
8352
|
+
#
|
8353
|
+
# @!attribute [rw] next_token
|
8354
|
+
# @return [String]
|
8355
|
+
#
|
8356
|
+
# @!attribute [rw] page_size
|
8357
|
+
# @return [String]
|
8358
|
+
#
|
8359
|
+
# @!attribute [rw] start_time
|
8360
|
+
# @return [Time]
|
8361
|
+
#
|
8362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpiRequest AWS API Documentation
|
8363
|
+
#
|
8364
|
+
class GetJourneyDateRangeKpiRequest < Struct.new(
|
8365
|
+
:application_id,
|
8366
|
+
:end_time,
|
8367
|
+
:journey_id,
|
8368
|
+
:kpi_name,
|
8369
|
+
:next_token,
|
8370
|
+
:page_size,
|
8371
|
+
:start_time)
|
7316
8372
|
include Aws::Structure
|
7317
8373
|
end
|
7318
8374
|
|
7319
|
-
# @!attribute [rw]
|
7320
|
-
# Provides
|
7321
|
-
#
|
7322
|
-
#
|
7323
|
-
# @return [Types::
|
8375
|
+
# @!attribute [rw] journey_date_range_kpi_response
|
8376
|
+
# Provides the results of a query that retrieved the data for a
|
8377
|
+
# standard engagement metric that applies to a journey, and provides
|
8378
|
+
# information about that query.
|
8379
|
+
# @return [Types::JourneyDateRangeKpiResponse]
|
7324
8380
|
#
|
7325
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/
|
8381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpiResponse AWS API Documentation
|
7326
8382
|
#
|
7327
|
-
class
|
7328
|
-
:
|
8383
|
+
class GetJourneyDateRangeKpiResponse < Struct.new(
|
8384
|
+
:journey_date_range_kpi_response)
|
7329
8385
|
include Aws::Structure
|
7330
8386
|
end
|
7331
8387
|
|
7332
|
-
# @note When making an API call, you may pass
|
8388
|
+
# @note When making an API call, you may pass GetJourneyExecutionActivityMetricsRequest
|
7333
8389
|
# data as a hash:
|
7334
8390
|
#
|
7335
8391
|
# {
|
7336
8392
|
# application_id: "__string", # required
|
8393
|
+
# journey_activity_id: "__string", # required
|
8394
|
+
# journey_id: "__string", # required
|
8395
|
+
# next_token: "__string",
|
7337
8396
|
# page_size: "__string",
|
7338
|
-
# segment_id: "__string", # required
|
7339
|
-
# token: "__string",
|
7340
8397
|
# }
|
7341
8398
|
#
|
7342
8399
|
# @!attribute [rw] application_id
|
7343
8400
|
# @return [String]
|
7344
8401
|
#
|
7345
|
-
# @!attribute [rw]
|
8402
|
+
# @!attribute [rw] journey_activity_id
|
7346
8403
|
# @return [String]
|
7347
8404
|
#
|
7348
|
-
# @!attribute [rw]
|
8405
|
+
# @!attribute [rw] journey_id
|
7349
8406
|
# @return [String]
|
7350
8407
|
#
|
7351
|
-
# @!attribute [rw]
|
8408
|
+
# @!attribute [rw] next_token
|
7352
8409
|
# @return [String]
|
7353
8410
|
#
|
7354
|
-
#
|
8411
|
+
# @!attribute [rw] page_size
|
8412
|
+
# @return [String]
|
7355
8413
|
#
|
7356
|
-
|
8414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetricsRequest AWS API Documentation
|
8415
|
+
#
|
8416
|
+
class GetJourneyExecutionActivityMetricsRequest < Struct.new(
|
7357
8417
|
:application_id,
|
7358
|
-
:
|
7359
|
-
:
|
7360
|
-
:
|
8418
|
+
:journey_activity_id,
|
8419
|
+
:journey_id,
|
8420
|
+
:next_token,
|
8421
|
+
:page_size)
|
8422
|
+
include Aws::Structure
|
8423
|
+
end
|
8424
|
+
|
8425
|
+
# @!attribute [rw] journey_execution_activity_metrics_response
|
8426
|
+
# Provides the results of a query that retrieved the data for a
|
8427
|
+
# standard execution metric that applies to a journey activity, and
|
8428
|
+
# provides information about that query.
|
8429
|
+
# @return [Types::JourneyExecutionActivityMetricsResponse]
|
8430
|
+
#
|
8431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetricsResponse AWS API Documentation
|
8432
|
+
#
|
8433
|
+
class GetJourneyExecutionActivityMetricsResponse < Struct.new(
|
8434
|
+
:journey_execution_activity_metrics_response)
|
8435
|
+
include Aws::Structure
|
8436
|
+
end
|
8437
|
+
|
8438
|
+
# @note When making an API call, you may pass GetJourneyExecutionMetricsRequest
|
8439
|
+
# data as a hash:
|
8440
|
+
#
|
8441
|
+
# {
|
8442
|
+
# application_id: "__string", # required
|
8443
|
+
# journey_id: "__string", # required
|
8444
|
+
# next_token: "__string",
|
8445
|
+
# page_size: "__string",
|
8446
|
+
# }
|
8447
|
+
#
|
8448
|
+
# @!attribute [rw] application_id
|
8449
|
+
# @return [String]
|
8450
|
+
#
|
8451
|
+
# @!attribute [rw] journey_id
|
8452
|
+
# @return [String]
|
8453
|
+
#
|
8454
|
+
# @!attribute [rw] next_token
|
8455
|
+
# @return [String]
|
8456
|
+
#
|
8457
|
+
# @!attribute [rw] page_size
|
8458
|
+
# @return [String]
|
8459
|
+
#
|
8460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetricsRequest AWS API Documentation
|
8461
|
+
#
|
8462
|
+
class GetJourneyExecutionMetricsRequest < Struct.new(
|
8463
|
+
:application_id,
|
8464
|
+
:journey_id,
|
8465
|
+
:next_token,
|
8466
|
+
:page_size)
|
8467
|
+
include Aws::Structure
|
8468
|
+
end
|
8469
|
+
|
8470
|
+
# @!attribute [rw] journey_execution_metrics_response
|
8471
|
+
# Provides the results of a query that retrieved the data for a
|
8472
|
+
# standard execution metric that applies to a journey.
|
8473
|
+
# @return [Types::JourneyExecutionMetricsResponse]
|
8474
|
+
#
|
8475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetricsResponse AWS API Documentation
|
8476
|
+
#
|
8477
|
+
class GetJourneyExecutionMetricsResponse < Struct.new(
|
8478
|
+
:journey_execution_metrics_response)
|
8479
|
+
include Aws::Structure
|
8480
|
+
end
|
8481
|
+
|
8482
|
+
# @note When making an API call, you may pass GetJourneyRequest
|
8483
|
+
# data as a hash:
|
8484
|
+
#
|
8485
|
+
# {
|
8486
|
+
# application_id: "__string", # required
|
8487
|
+
# journey_id: "__string", # required
|
8488
|
+
# }
|
8489
|
+
#
|
8490
|
+
# @!attribute [rw] application_id
|
8491
|
+
# @return [String]
|
8492
|
+
#
|
8493
|
+
# @!attribute [rw] journey_id
|
8494
|
+
# @return [String]
|
8495
|
+
#
|
8496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRequest AWS API Documentation
|
8497
|
+
#
|
8498
|
+
class GetJourneyRequest < Struct.new(
|
8499
|
+
:application_id,
|
8500
|
+
:journey_id)
|
8501
|
+
include Aws::Structure
|
8502
|
+
end
|
8503
|
+
|
8504
|
+
# @!attribute [rw] journey_response
|
8505
|
+
# Provides information about the status, configuration, and other
|
8506
|
+
# settings for a journey.
|
8507
|
+
# @return [Types::JourneyResponse]
|
8508
|
+
#
|
8509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyResponse AWS API Documentation
|
8510
|
+
#
|
8511
|
+
class GetJourneyResponse < Struct.new(
|
8512
|
+
:journey_response)
|
8513
|
+
include Aws::Structure
|
8514
|
+
end
|
8515
|
+
|
8516
|
+
# @note When making an API call, you may pass GetPushTemplateRequest
|
8517
|
+
# data as a hash:
|
8518
|
+
#
|
8519
|
+
# {
|
8520
|
+
# template_name: "__string", # required
|
8521
|
+
# }
|
8522
|
+
#
|
8523
|
+
# @!attribute [rw] template_name
|
8524
|
+
# @return [String]
|
8525
|
+
#
|
8526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplateRequest AWS API Documentation
|
8527
|
+
#
|
8528
|
+
class GetPushTemplateRequest < Struct.new(
|
8529
|
+
:template_name)
|
8530
|
+
include Aws::Structure
|
8531
|
+
end
|
8532
|
+
|
8533
|
+
# @!attribute [rw] push_notification_template_response
|
8534
|
+
# Provides information about the content and settings for a message
|
8535
|
+
# template that can be used in messages that are sent through a push
|
8536
|
+
# notification channel.
|
8537
|
+
# @return [Types::PushNotificationTemplateResponse]
|
8538
|
+
#
|
8539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplateResponse AWS API Documentation
|
8540
|
+
#
|
8541
|
+
class GetPushTemplateResponse < Struct.new(
|
8542
|
+
:push_notification_template_response)
|
8543
|
+
include Aws::Structure
|
8544
|
+
end
|
8545
|
+
|
8546
|
+
# @note When making an API call, you may pass GetSegmentExportJobsRequest
|
8547
|
+
# data as a hash:
|
8548
|
+
#
|
8549
|
+
# {
|
8550
|
+
# application_id: "__string", # required
|
8551
|
+
# page_size: "__string",
|
8552
|
+
# segment_id: "__string", # required
|
8553
|
+
# token: "__string",
|
8554
|
+
# }
|
8555
|
+
#
|
8556
|
+
# @!attribute [rw] application_id
|
8557
|
+
# @return [String]
|
8558
|
+
#
|
8559
|
+
# @!attribute [rw] page_size
|
8560
|
+
# @return [String]
|
8561
|
+
#
|
8562
|
+
# @!attribute [rw] segment_id
|
8563
|
+
# @return [String]
|
8564
|
+
#
|
8565
|
+
# @!attribute [rw] token
|
8566
|
+
# @return [String]
|
8567
|
+
#
|
8568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentExportJobsRequest AWS API Documentation
|
8569
|
+
#
|
8570
|
+
class GetSegmentExportJobsRequest < Struct.new(
|
8571
|
+
:application_id,
|
8572
|
+
:page_size,
|
8573
|
+
:segment_id,
|
8574
|
+
:token)
|
7361
8575
|
include Aws::Structure
|
7362
8576
|
end
|
7363
8577
|
|
@@ -7698,6 +8912,35 @@ module Aws::Pinpoint
|
|
7698
8912
|
include Aws::Structure
|
7699
8913
|
end
|
7700
8914
|
|
8915
|
+
# Specifies the settings for a holdout activity in a journey. This type
|
8916
|
+
# of activity stops a journey for a specified percentage of
|
8917
|
+
# participants.
|
8918
|
+
#
|
8919
|
+
# @note When making an API call, you may pass HoldoutActivity
|
8920
|
+
# data as a hash:
|
8921
|
+
#
|
8922
|
+
# {
|
8923
|
+
# next_activity: "__string",
|
8924
|
+
# percentage: 1, # required
|
8925
|
+
# }
|
8926
|
+
#
|
8927
|
+
# @!attribute [rw] next_activity
|
8928
|
+
# The unique identifier for the next activity to perform, after
|
8929
|
+
# performing the holdout activity.
|
8930
|
+
# @return [String]
|
8931
|
+
#
|
8932
|
+
# @!attribute [rw] percentage
|
8933
|
+
# The percentage of participants who shouldn't continue the journey.
|
8934
|
+
# @return [Integer]
|
8935
|
+
#
|
8936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/HoldoutActivity AWS API Documentation
|
8937
|
+
#
|
8938
|
+
class HoldoutActivity < Struct.new(
|
8939
|
+
:next_activity,
|
8940
|
+
:percentage)
|
8941
|
+
include Aws::Structure
|
8942
|
+
end
|
8943
|
+
|
7701
8944
|
# Specifies the settings for a job that imports endpoint definitions
|
7702
8945
|
# from an Amazon Simple Storage Service (Amazon S3) bucket.
|
7703
8946
|
#
|
@@ -7993,32 +9236,536 @@ module Aws::Pinpoint
|
|
7993
9236
|
# @!attribute [rw] request_id
|
7994
9237
|
# @return [String]
|
7995
9238
|
#
|
7996
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/InternalServerErrorException AWS API Documentation
|
9239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/InternalServerErrorException AWS API Documentation
|
9240
|
+
#
|
9241
|
+
class InternalServerErrorException < Struct.new(
|
9242
|
+
:message,
|
9243
|
+
:request_id)
|
9244
|
+
include Aws::Structure
|
9245
|
+
end
|
9246
|
+
|
9247
|
+
# Provides information about the results of a request to create or
|
9248
|
+
# update an endpoint that's associated with an event.
|
9249
|
+
#
|
9250
|
+
# @!attribute [rw] endpoint_item_response
|
9251
|
+
# The response that was received after the endpoint data was accepted.
|
9252
|
+
# @return [Types::EndpointItemResponse]
|
9253
|
+
#
|
9254
|
+
# @!attribute [rw] events_item_response
|
9255
|
+
# A multipart response object that contains a key and a value for each
|
9256
|
+
# event in the request. In each object, the event ID is the key and an
|
9257
|
+
# EventItemResponse object is the value.
|
9258
|
+
# @return [Hash<String,Types::EventItemResponse>]
|
9259
|
+
#
|
9260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ItemResponse AWS API Documentation
|
9261
|
+
#
|
9262
|
+
class ItemResponse < Struct.new(
|
9263
|
+
:endpoint_item_response,
|
9264
|
+
:events_item_response)
|
9265
|
+
include Aws::Structure
|
9266
|
+
end
|
9267
|
+
|
9268
|
+
# Provides the results of a query that retrieved the data for a standard
|
9269
|
+
# engagement metric that applies to a journey, and provides information
|
9270
|
+
# about that query.
|
9271
|
+
#
|
9272
|
+
# @!attribute [rw] application_id
|
9273
|
+
# The unique identifier for the application that the metric applies
|
9274
|
+
# to.
|
9275
|
+
# @return [String]
|
9276
|
+
#
|
9277
|
+
# @!attribute [rw] end_time
|
9278
|
+
# The last date and time of the date range that was used to filter the
|
9279
|
+
# query results, in extended ISO 8601 format. The date range is
|
9280
|
+
# inclusive.
|
9281
|
+
# @return [Time]
|
9282
|
+
#
|
9283
|
+
# @!attribute [rw] journey_id
|
9284
|
+
# The unique identifier for the journey that the metric applies to.
|
9285
|
+
# @return [String]
|
9286
|
+
#
|
9287
|
+
# @!attribute [rw] kpi_name
|
9288
|
+
# The name of the metric, also referred to as a *key performance
|
9289
|
+
# indicator (KPI)*, that the data was retrieved for. This value
|
9290
|
+
# describes the associated metric and consists of two or more terms,
|
9291
|
+
# which are comprised of lowercase alphanumeric characters, separated
|
9292
|
+
# by a hyphen. For a list of possible values, see the [Amazon Pinpoint
|
9293
|
+
# Developer Guide][1].
|
9294
|
+
#
|
9295
|
+
#
|
9296
|
+
#
|
9297
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
|
9298
|
+
# @return [String]
|
9299
|
+
#
|
9300
|
+
# @!attribute [rw] kpi_result
|
9301
|
+
# An array of objects that contains the results of the query. Each
|
9302
|
+
# object contains the value for the metric and metadata about that
|
9303
|
+
# value.
|
9304
|
+
# @return [Types::BaseKpiResult]
|
9305
|
+
#
|
9306
|
+
# @!attribute [rw] next_token
|
9307
|
+
# The string to use in a subsequent request to get the next page of
|
9308
|
+
# results in a paginated response. This value is null for the Journey
|
9309
|
+
# Engagement Metrics resource because the resource returns all results
|
9310
|
+
# in a single page.
|
9311
|
+
# @return [String]
|
9312
|
+
#
|
9313
|
+
# @!attribute [rw] start_time
|
9314
|
+
# The first date and time of the date range that was used to filter
|
9315
|
+
# the query results, in extended ISO 8601 format. The date range is
|
9316
|
+
# inclusive.
|
9317
|
+
# @return [Time]
|
9318
|
+
#
|
9319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyDateRangeKpiResponse AWS API Documentation
|
9320
|
+
#
|
9321
|
+
class JourneyDateRangeKpiResponse < Struct.new(
|
9322
|
+
:application_id,
|
9323
|
+
:end_time,
|
9324
|
+
:journey_id,
|
9325
|
+
:kpi_name,
|
9326
|
+
:kpi_result,
|
9327
|
+
:next_token,
|
9328
|
+
:start_time)
|
9329
|
+
include Aws::Structure
|
9330
|
+
end
|
9331
|
+
|
9332
|
+
# Specifies the "From" address for an email message that's sent to
|
9333
|
+
# participants in a journey.
|
9334
|
+
#
|
9335
|
+
# @note When making an API call, you may pass JourneyEmailMessage
|
9336
|
+
# data as a hash:
|
9337
|
+
#
|
9338
|
+
# {
|
9339
|
+
# from_address: "__string",
|
9340
|
+
# }
|
9341
|
+
#
|
9342
|
+
# @!attribute [rw] from_address
|
9343
|
+
# The verified email address to send the email message from. The
|
9344
|
+
# default address is the FromAddress specified for the email channel
|
9345
|
+
# for the application.
|
9346
|
+
# @return [String]
|
9347
|
+
#
|
9348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyEmailMessage AWS API Documentation
|
9349
|
+
#
|
9350
|
+
class JourneyEmailMessage < Struct.new(
|
9351
|
+
:from_address)
|
9352
|
+
include Aws::Structure
|
9353
|
+
end
|
9354
|
+
|
9355
|
+
# Provides the results of a query that retrieved the data for a standard
|
9356
|
+
# execution metric that applies to a journey activity, and provides
|
9357
|
+
# information about that query.
|
9358
|
+
#
|
9359
|
+
# @!attribute [rw] activity_type
|
9360
|
+
# The type of activity that the metric applies to. Possible values
|
9361
|
+
# are:
|
9362
|
+
#
|
9363
|
+
# * CONDITIONAL\_SPLIT - For a yes/no split activity, which is an
|
9364
|
+
# activity that sends participants down one of two paths in a
|
9365
|
+
# journey.
|
9366
|
+
#
|
9367
|
+
# * HOLDOUT - For a holdout activity, which is an activity that stops
|
9368
|
+
# a journey for a specified percentage of participants.
|
9369
|
+
#
|
9370
|
+
# * MESSAGE - For an email activity, which is an activity that sends
|
9371
|
+
# an email message to participants.
|
9372
|
+
#
|
9373
|
+
# * MULTI\_CONDITIONAL\_SPLIT - For a multivariate split activity,
|
9374
|
+
# which is an activity that sends participants down one of as many
|
9375
|
+
# as five paths in a journey.
|
9376
|
+
#
|
9377
|
+
# * RANDOM\_SPLIT - For a random split activity, which is an activity
|
9378
|
+
# that sends specified percentages of participants down one of as
|
9379
|
+
# many as five paths in a journey.
|
9380
|
+
#
|
9381
|
+
# * WAIT - For a wait activity, which is an activity that waits for a
|
9382
|
+
# certain amount of time or until a specific date and time before
|
9383
|
+
# moving participants to the next activity in a journey.
|
9384
|
+
# @return [String]
|
9385
|
+
#
|
9386
|
+
# @!attribute [rw] application_id
|
9387
|
+
# The unique identifier for the application that the metric applies
|
9388
|
+
# to.
|
9389
|
+
# @return [String]
|
9390
|
+
#
|
9391
|
+
# @!attribute [rw] journey_activity_id
|
9392
|
+
# The unique identifier for the activity that the metric applies to.
|
9393
|
+
# @return [String]
|
9394
|
+
#
|
9395
|
+
# @!attribute [rw] journey_id
|
9396
|
+
# The unique identifier for the journey that the metric applies to.
|
9397
|
+
# @return [String]
|
9398
|
+
#
|
9399
|
+
# @!attribute [rw] last_evaluated_time
|
9400
|
+
# The date and time, in ISO 8601 format, when Amazon Pinpoint last
|
9401
|
+
# evaluated the execution status of the activity and updated the data
|
9402
|
+
# for the metric.
|
9403
|
+
# @return [String]
|
9404
|
+
#
|
9405
|
+
# @!attribute [rw] metrics
|
9406
|
+
# A JSON object that contains the results of the query. The results
|
9407
|
+
# vary depending on the type of activity (ActivityType). For
|
9408
|
+
# information about the structure and contents of the results, see the
|
9409
|
+
# [Amazon Pinpoint Developer Guide][1].
|
9410
|
+
#
|
9411
|
+
#
|
9412
|
+
#
|
9413
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
|
9414
|
+
# @return [Hash<String,String>]
|
9415
|
+
#
|
9416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionActivityMetricsResponse AWS API Documentation
|
9417
|
+
#
|
9418
|
+
class JourneyExecutionActivityMetricsResponse < Struct.new(
|
9419
|
+
:activity_type,
|
9420
|
+
:application_id,
|
9421
|
+
:journey_activity_id,
|
9422
|
+
:journey_id,
|
9423
|
+
:last_evaluated_time,
|
9424
|
+
:metrics)
|
9425
|
+
include Aws::Structure
|
9426
|
+
end
|
9427
|
+
|
9428
|
+
# Provides the results of a query that retrieved the data for a standard
|
9429
|
+
# execution metric that applies to a journey.
|
9430
|
+
#
|
9431
|
+
# @!attribute [rw] application_id
|
9432
|
+
# The unique identifier for the application that the metric applies
|
9433
|
+
# to.
|
9434
|
+
# @return [String]
|
9435
|
+
#
|
9436
|
+
# @!attribute [rw] journey_id
|
9437
|
+
# The unique identifier for the journey that the metric applies to.
|
9438
|
+
# @return [String]
|
9439
|
+
#
|
9440
|
+
# @!attribute [rw] last_evaluated_time
|
9441
|
+
# The date and time, in ISO 8601 format, when Amazon Pinpoint last
|
9442
|
+
# evaluated the journey and updated the data for the metric.
|
9443
|
+
# @return [String]
|
9444
|
+
#
|
9445
|
+
# @!attribute [rw] metrics
|
9446
|
+
# A JSON object that contains the results of the query. For
|
9447
|
+
# information about the structure and contents of the results, see the
|
9448
|
+
# [Amazon Pinpoint Developer Guide][1].
|
9449
|
+
#
|
9450
|
+
#
|
9451
|
+
#
|
9452
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
|
9453
|
+
# @return [Hash<String,String>]
|
9454
|
+
#
|
9455
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionMetricsResponse AWS API Documentation
|
9456
|
+
#
|
9457
|
+
class JourneyExecutionMetricsResponse < Struct.new(
|
9458
|
+
:application_id,
|
9459
|
+
:journey_id,
|
9460
|
+
:last_evaluated_time,
|
9461
|
+
:metrics)
|
9462
|
+
include Aws::Structure
|
9463
|
+
end
|
9464
|
+
|
9465
|
+
# Specifies limits on the messages that a journey can send and the
|
9466
|
+
# number of times participants can enter a journey.
|
9467
|
+
#
|
9468
|
+
# @note When making an API call, you may pass JourneyLimits
|
9469
|
+
# data as a hash:
|
9470
|
+
#
|
9471
|
+
# {
|
9472
|
+
# daily_cap: 1,
|
9473
|
+
# endpoint_reentry_cap: 1,
|
9474
|
+
# messages_per_second: 1,
|
9475
|
+
# }
|
9476
|
+
#
|
9477
|
+
# @!attribute [rw] daily_cap
|
9478
|
+
# The maximum number of messages that the journey can send to a single
|
9479
|
+
# participant during a 24-hour period. The maximum value is 100.
|
9480
|
+
# @return [Integer]
|
9481
|
+
#
|
9482
|
+
# @!attribute [rw] endpoint_reentry_cap
|
9483
|
+
# The maximum number of times that a participant can enter the
|
9484
|
+
# journey. The maximum value is 100. To allow participants to enter
|
9485
|
+
# the journey an unlimited number of times, set this value to 0.
|
9486
|
+
# @return [Integer]
|
9487
|
+
#
|
9488
|
+
# @!attribute [rw] messages_per_second
|
9489
|
+
# The maximum number of messages that the journey can send each
|
9490
|
+
# second.
|
9491
|
+
# @return [Integer]
|
9492
|
+
#
|
9493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyLimits AWS API Documentation
|
9494
|
+
#
|
9495
|
+
class JourneyLimits < Struct.new(
|
9496
|
+
:daily_cap,
|
9497
|
+
:endpoint_reentry_cap,
|
9498
|
+
:messages_per_second)
|
9499
|
+
include Aws::Structure
|
9500
|
+
end
|
9501
|
+
|
9502
|
+
# Provides information about the status, configuration, and other
|
9503
|
+
# settings for a journey.
|
9504
|
+
#
|
9505
|
+
# @!attribute [rw] activities
|
9506
|
+
# The configuration and other settings for the activities that
|
9507
|
+
# comprise the journey.
|
9508
|
+
# @return [Hash<String,Types::Activity>]
|
9509
|
+
#
|
9510
|
+
# @!attribute [rw] application_id
|
9511
|
+
# The unique identifier for the application that the journey applies
|
9512
|
+
# to.
|
9513
|
+
# @return [String]
|
9514
|
+
#
|
9515
|
+
# @!attribute [rw] creation_date
|
9516
|
+
# The date, in ISO 8601 format, when the journey was created.
|
9517
|
+
# @return [String]
|
9518
|
+
#
|
9519
|
+
# @!attribute [rw] id
|
9520
|
+
# The unique identifier for the journey.
|
9521
|
+
# @return [String]
|
9522
|
+
#
|
9523
|
+
# @!attribute [rw] last_modified_date
|
9524
|
+
# The date, in ISO 8601 format, when the journey was last modified.
|
9525
|
+
# @return [String]
|
9526
|
+
#
|
9527
|
+
# @!attribute [rw] limits
|
9528
|
+
# The messaging and entry limits for the journey.
|
9529
|
+
# @return [Types::JourneyLimits]
|
9530
|
+
#
|
9531
|
+
# @!attribute [rw] local_time
|
9532
|
+
# Specifies whether the journey's scheduled start and end times use
|
9533
|
+
# each participant's local time. If this value is true, the schedule
|
9534
|
+
# uses each participant's local time.
|
9535
|
+
# @return [Boolean]
|
9536
|
+
#
|
9537
|
+
# @!attribute [rw] name
|
9538
|
+
# The name of the journey.
|
9539
|
+
# @return [String]
|
9540
|
+
#
|
9541
|
+
# @!attribute [rw] quiet_time
|
9542
|
+
# The quiet time settings for the journey. Quiet time is a specific
|
9543
|
+
# time range when a journey doesn't send messages to participants, if
|
9544
|
+
# all the following conditions are met:
|
9545
|
+
#
|
9546
|
+
# * The EndpointDemographic.Timezone property of the endpoint for the
|
9547
|
+
# participant is set to a valid value.
|
9548
|
+
#
|
9549
|
+
# * The current time in the participant's time zone is later than or
|
9550
|
+
# equal to the time specified by the QuietTime.Start property for
|
9551
|
+
# the journey.
|
9552
|
+
#
|
9553
|
+
# * The current time in the participant's time zone is earlier than
|
9554
|
+
# or equal to the time specified by the QuietTime.End property for
|
9555
|
+
# the journey.
|
9556
|
+
#
|
9557
|
+
# If any of the preceding conditions isn't met, the participant will
|
9558
|
+
# receive messages from the journey, even if quiet time is enabled.
|
9559
|
+
# @return [Types::QuietTime]
|
9560
|
+
#
|
9561
|
+
# @!attribute [rw] refresh_frequency
|
9562
|
+
# The frequency with which Amazon Pinpoint evaluates segment and event
|
9563
|
+
# data for the journey, as a duration in ISO 8601 format.
|
9564
|
+
# @return [String]
|
9565
|
+
#
|
9566
|
+
# @!attribute [rw] schedule
|
9567
|
+
# The schedule settings for the journey.
|
9568
|
+
# @return [Types::JourneySchedule]
|
9569
|
+
#
|
9570
|
+
# @!attribute [rw] start_activity
|
9571
|
+
# The unique identifier for the first activity in the journey.
|
9572
|
+
# @return [String]
|
9573
|
+
#
|
9574
|
+
# @!attribute [rw] start_condition
|
9575
|
+
# The segment that defines which users are participants in the
|
9576
|
+
# journey.
|
9577
|
+
# @return [Types::StartCondition]
|
9578
|
+
#
|
9579
|
+
# @!attribute [rw] state
|
9580
|
+
# The current status of the journey. Possible values are:
|
9581
|
+
#
|
9582
|
+
# * DRAFT - The journey is being developed and hasn't been published
|
9583
|
+
# yet.
|
9584
|
+
#
|
9585
|
+
# * ACTIVE - The journey has been developed and published. Depending
|
9586
|
+
# on the journey's schedule, the journey may currently be running
|
9587
|
+
# or scheduled to start running at a later time. If a journey's
|
9588
|
+
# status is ACTIVE, you can't add, change, or remove activities
|
9589
|
+
# from it.
|
9590
|
+
#
|
9591
|
+
# * COMPLETED - The journey has been published and has finished
|
9592
|
+
# running. All participants have entered the journey and no
|
9593
|
+
# participants are waiting to complete the journey or any activities
|
9594
|
+
# in the journey.
|
9595
|
+
#
|
9596
|
+
# * CANCELLED - The journey has been stopped. If a journey's status
|
9597
|
+
# is CANCELLED, you can't add, change, or remove activities or
|
9598
|
+
# segment settings from the journey.
|
9599
|
+
#
|
9600
|
+
# * CLOSED - The journey has been published and has started running.
|
9601
|
+
# It may have also passed its scheduled end time, or passed its
|
9602
|
+
# scheduled start time and a refresh frequency hasn't been
|
9603
|
+
# specified for it. If a journey's status is CLOSED, you can't add
|
9604
|
+
# participants to it, and no existing participants can enter the
|
9605
|
+
# journey for the first time. However, any existing participants who
|
9606
|
+
# are currently waiting to start an activity may resume the journey.
|
9607
|
+
# @return [String]
|
9608
|
+
#
|
9609
|
+
# @!attribute [rw] tags
|
9610
|
+
# A string-to-string map of key-value pairs that identifies the tags
|
9611
|
+
# that are associated with the journey. Each tag consists of a
|
9612
|
+
# required tag key and an associated tag value.
|
9613
|
+
# @return [Hash<String,String>]
|
9614
|
+
#
|
9615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyResponse AWS API Documentation
|
9616
|
+
#
|
9617
|
+
class JourneyResponse < Struct.new(
|
9618
|
+
:activities,
|
9619
|
+
:application_id,
|
9620
|
+
:creation_date,
|
9621
|
+
:id,
|
9622
|
+
:last_modified_date,
|
9623
|
+
:limits,
|
9624
|
+
:local_time,
|
9625
|
+
:name,
|
9626
|
+
:quiet_time,
|
9627
|
+
:refresh_frequency,
|
9628
|
+
:schedule,
|
9629
|
+
:start_activity,
|
9630
|
+
:start_condition,
|
9631
|
+
:state,
|
9632
|
+
:tags)
|
9633
|
+
include Aws::Structure
|
9634
|
+
end
|
9635
|
+
|
9636
|
+
# Specifies the schedule settings for a journey.
|
9637
|
+
#
|
9638
|
+
# @note When making an API call, you may pass JourneySchedule
|
9639
|
+
# data as a hash:
|
9640
|
+
#
|
9641
|
+
# {
|
9642
|
+
# end_time: Time.now,
|
9643
|
+
# start_time: Time.now,
|
9644
|
+
# timezone: "__string",
|
9645
|
+
# }
|
9646
|
+
#
|
9647
|
+
# @!attribute [rw] end_time
|
9648
|
+
# The scheduled time, in ISO 8601 format, when the journey ended or
|
9649
|
+
# will end.
|
9650
|
+
# @return [Time]
|
9651
|
+
#
|
9652
|
+
# @!attribute [rw] start_time
|
9653
|
+
# The scheduled time, in ISO 8601 format, when the journey began or
|
9654
|
+
# will begin.
|
9655
|
+
# @return [Time]
|
9656
|
+
#
|
9657
|
+
# @!attribute [rw] timezone
|
9658
|
+
# The starting UTC offset for the journey schedule, if the value of
|
9659
|
+
# the journey's LocalTime property is true. Valid values are: UTC,
|
9660
|
+
# UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,
|
9661
|
+
# UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45,
|
9662
|
+
# UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45,
|
9663
|
+
# UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04,
|
9664
|
+
# UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and
|
9665
|
+
# UTC-11.
|
9666
|
+
# @return [String]
|
9667
|
+
#
|
9668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneySchedule AWS API Documentation
|
9669
|
+
#
|
9670
|
+
class JourneySchedule < Struct.new(
|
9671
|
+
:end_time,
|
9672
|
+
:start_time,
|
9673
|
+
:timezone)
|
9674
|
+
include Aws::Structure
|
9675
|
+
end
|
9676
|
+
|
9677
|
+
# Changes the status of a journey.
|
9678
|
+
#
|
9679
|
+
# @note When making an API call, you may pass JourneyStateRequest
|
9680
|
+
# data as a hash:
|
9681
|
+
#
|
9682
|
+
# {
|
9683
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
9684
|
+
# }
|
9685
|
+
#
|
9686
|
+
# @!attribute [rw] state
|
9687
|
+
# The status of the journey. Currently, the only supported value is
|
9688
|
+
# CANCELLED.
|
9689
|
+
#
|
9690
|
+
# If you cancel a journey, Amazon Pinpoint continues to perform
|
9691
|
+
# activities that are currently in progress, until those activities
|
9692
|
+
# are complete. Amazon Pinpoint also continues to collect and
|
9693
|
+
# aggregate analytics data for those activities, until they are
|
9694
|
+
# complete, and any activities that were complete when you cancelled
|
9695
|
+
# the journey.
|
9696
|
+
#
|
9697
|
+
# After you cancel a journey, you can't add, change, or remove any
|
9698
|
+
# activities from the journey. In addition, Amazon Pinpoint stops
|
9699
|
+
# evaluating the journey and doesn't perform any activities that
|
9700
|
+
# haven't started.
|
9701
|
+
# @return [String]
|
9702
|
+
#
|
9703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyStateRequest AWS API Documentation
|
9704
|
+
#
|
9705
|
+
class JourneyStateRequest < Struct.new(
|
9706
|
+
:state)
|
9707
|
+
include Aws::Structure
|
9708
|
+
end
|
9709
|
+
|
9710
|
+
# Provides information about the status, configuration, and other
|
9711
|
+
# settings for all the journeys that are associated with an application.
|
9712
|
+
#
|
9713
|
+
# @!attribute [rw] item
|
9714
|
+
# An array of responses, one for each journey that's associated with
|
9715
|
+
# the application.
|
9716
|
+
# @return [Array<Types::JourneyResponse>]
|
9717
|
+
#
|
9718
|
+
# @!attribute [rw] next_token
|
9719
|
+
# The string to use in a subsequent request to get the next page of
|
9720
|
+
# results in a paginated response. This value is null if there are no
|
9721
|
+
# additional pages.
|
9722
|
+
# @return [String]
|
9723
|
+
#
|
9724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneysResponse AWS API Documentation
|
9725
|
+
#
|
9726
|
+
class JourneysResponse < Struct.new(
|
9727
|
+
:item,
|
9728
|
+
:next_token)
|
9729
|
+
include Aws::Structure
|
9730
|
+
end
|
9731
|
+
|
9732
|
+
# @note When making an API call, you may pass ListJourneysRequest
|
9733
|
+
# data as a hash:
|
9734
|
+
#
|
9735
|
+
# {
|
9736
|
+
# application_id: "__string", # required
|
9737
|
+
# page_size: "__string",
|
9738
|
+
# token: "__string",
|
9739
|
+
# }
|
9740
|
+
#
|
9741
|
+
# @!attribute [rw] application_id
|
9742
|
+
# @return [String]
|
9743
|
+
#
|
9744
|
+
# @!attribute [rw] page_size
|
9745
|
+
# @return [String]
|
9746
|
+
#
|
9747
|
+
# @!attribute [rw] token
|
9748
|
+
# @return [String]
|
9749
|
+
#
|
9750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListJourneysRequest AWS API Documentation
|
7997
9751
|
#
|
7998
|
-
class
|
7999
|
-
:
|
8000
|
-
:
|
9752
|
+
class ListJourneysRequest < Struct.new(
|
9753
|
+
:application_id,
|
9754
|
+
:page_size,
|
9755
|
+
:token)
|
8001
9756
|
include Aws::Structure
|
8002
9757
|
end
|
8003
9758
|
|
8004
|
-
#
|
8005
|
-
#
|
8006
|
-
#
|
8007
|
-
#
|
8008
|
-
#
|
8009
|
-
# @return [Types::EndpointItemResponse]
|
8010
|
-
#
|
8011
|
-
# @!attribute [rw] events_item_response
|
8012
|
-
# A multipart response object that contains a key and a value for each
|
8013
|
-
# event in the request. In each object, the event ID is the key and an
|
8014
|
-
# EventItemResponse object is the value.
|
8015
|
-
# @return [Hash<String,Types::EventItemResponse>]
|
9759
|
+
# @!attribute [rw] journeys_response
|
9760
|
+
# Provides information about the status, configuration, and other
|
9761
|
+
# settings for all the journeys that are associated with an
|
9762
|
+
# application.
|
9763
|
+
# @return [Types::JourneysResponse]
|
8016
9764
|
#
|
8017
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/
|
9765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListJourneysResponse AWS API Documentation
|
8018
9766
|
#
|
8019
|
-
class
|
8020
|
-
:
|
8021
|
-
:events_item_response)
|
9767
|
+
class ListJourneysResponse < Struct.new(
|
9768
|
+
:journeys_response)
|
8022
9769
|
include Aws::Structure
|
8023
9770
|
end
|
8024
9771
|
|
@@ -8041,7 +9788,7 @@ module Aws::Pinpoint
|
|
8041
9788
|
|
8042
9789
|
# @!attribute [rw] tags_model
|
8043
9790
|
# Specifies the tags (keys and values) for an application, campaign,
|
8044
|
-
# message template, or segment.
|
9791
|
+
# journey, message template, or segment.
|
8045
9792
|
# @return [Types::TagsModel]
|
8046
9793
|
#
|
8047
9794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTagsForResourceResponse AWS API Documentation
|
@@ -8430,6 +10177,7 @@ module Aws::Pinpoint
|
|
8430
10177
|
# url: "__string",
|
8431
10178
|
# },
|
8432
10179
|
# apns_message: {
|
10180
|
+
# apns_push_type: "__string",
|
8433
10181
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8434
10182
|
# badge: 1,
|
8435
10183
|
# body: "__string",
|
@@ -8767,6 +10515,257 @@ module Aws::Pinpoint
|
|
8767
10515
|
include Aws::Structure
|
8768
10516
|
end
|
8769
10517
|
|
10518
|
+
# Specifies a condition to evaluate for an activity path in a journey.
|
10519
|
+
#
|
10520
|
+
# @note When making an API call, you may pass MultiConditionalBranch
|
10521
|
+
# data as a hash:
|
10522
|
+
#
|
10523
|
+
# {
|
10524
|
+
# condition: {
|
10525
|
+
# event_condition: {
|
10526
|
+
# dimensions: { # required
|
10527
|
+
# attributes: {
|
10528
|
+
# "__string" => {
|
10529
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10530
|
+
# values: ["__string"], # required
|
10531
|
+
# },
|
10532
|
+
# },
|
10533
|
+
# event_type: {
|
10534
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10535
|
+
# values: ["__string"], # required
|
10536
|
+
# },
|
10537
|
+
# metrics: {
|
10538
|
+
# "__string" => {
|
10539
|
+
# comparison_operator: "__string", # required
|
10540
|
+
# value: 1.0, # required
|
10541
|
+
# },
|
10542
|
+
# },
|
10543
|
+
# },
|
10544
|
+
# message_activity: "__string",
|
10545
|
+
# },
|
10546
|
+
# segment_condition: {
|
10547
|
+
# segment_id: "__string", # required
|
10548
|
+
# },
|
10549
|
+
# segment_dimensions: {
|
10550
|
+
# attributes: {
|
10551
|
+
# "__string" => {
|
10552
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10553
|
+
# values: ["__string"], # required
|
10554
|
+
# },
|
10555
|
+
# },
|
10556
|
+
# behavior: {
|
10557
|
+
# recency: {
|
10558
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
10559
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
10560
|
+
# },
|
10561
|
+
# },
|
10562
|
+
# demographic: {
|
10563
|
+
# app_version: {
|
10564
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10565
|
+
# values: ["__string"], # required
|
10566
|
+
# },
|
10567
|
+
# channel: {
|
10568
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10569
|
+
# values: ["__string"], # required
|
10570
|
+
# },
|
10571
|
+
# device_type: {
|
10572
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10573
|
+
# values: ["__string"], # required
|
10574
|
+
# },
|
10575
|
+
# make: {
|
10576
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10577
|
+
# values: ["__string"], # required
|
10578
|
+
# },
|
10579
|
+
# model: {
|
10580
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10581
|
+
# values: ["__string"], # required
|
10582
|
+
# },
|
10583
|
+
# platform: {
|
10584
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10585
|
+
# values: ["__string"], # required
|
10586
|
+
# },
|
10587
|
+
# },
|
10588
|
+
# location: {
|
10589
|
+
# country: {
|
10590
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10591
|
+
# values: ["__string"], # required
|
10592
|
+
# },
|
10593
|
+
# gps_point: {
|
10594
|
+
# coordinates: { # required
|
10595
|
+
# latitude: 1.0, # required
|
10596
|
+
# longitude: 1.0, # required
|
10597
|
+
# },
|
10598
|
+
# range_in_kilometers: 1.0,
|
10599
|
+
# },
|
10600
|
+
# },
|
10601
|
+
# metrics: {
|
10602
|
+
# "__string" => {
|
10603
|
+
# comparison_operator: "__string", # required
|
10604
|
+
# value: 1.0, # required
|
10605
|
+
# },
|
10606
|
+
# },
|
10607
|
+
# user_attributes: {
|
10608
|
+
# "__string" => {
|
10609
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10610
|
+
# values: ["__string"], # required
|
10611
|
+
# },
|
10612
|
+
# },
|
10613
|
+
# },
|
10614
|
+
# },
|
10615
|
+
# next_activity: "__string",
|
10616
|
+
# }
|
10617
|
+
#
|
10618
|
+
# @!attribute [rw] condition
|
10619
|
+
# The condition to evaluate for the activity path.
|
10620
|
+
# @return [Types::SimpleCondition]
|
10621
|
+
#
|
10622
|
+
# @!attribute [rw] next_activity
|
10623
|
+
# The unique identifier for the next activity to perform, after
|
10624
|
+
# completing the activity for the path.
|
10625
|
+
# @return [String]
|
10626
|
+
#
|
10627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MultiConditionalBranch AWS API Documentation
|
10628
|
+
#
|
10629
|
+
class MultiConditionalBranch < Struct.new(
|
10630
|
+
:condition,
|
10631
|
+
:next_activity)
|
10632
|
+
include Aws::Structure
|
10633
|
+
end
|
10634
|
+
|
10635
|
+
# Specifies the settings for a multivariate split activity in a journey.
|
10636
|
+
# This type of activity sends participants down one of as many as five
|
10637
|
+
# paths in a journey, based on conditions that you specify.
|
10638
|
+
#
|
10639
|
+
# @note When making an API call, you may pass MultiConditionalSplitActivity
|
10640
|
+
# data as a hash:
|
10641
|
+
#
|
10642
|
+
# {
|
10643
|
+
# branches: [
|
10644
|
+
# {
|
10645
|
+
# condition: {
|
10646
|
+
# event_condition: {
|
10647
|
+
# dimensions: { # required
|
10648
|
+
# attributes: {
|
10649
|
+
# "__string" => {
|
10650
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10651
|
+
# values: ["__string"], # required
|
10652
|
+
# },
|
10653
|
+
# },
|
10654
|
+
# event_type: {
|
10655
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10656
|
+
# values: ["__string"], # required
|
10657
|
+
# },
|
10658
|
+
# metrics: {
|
10659
|
+
# "__string" => {
|
10660
|
+
# comparison_operator: "__string", # required
|
10661
|
+
# value: 1.0, # required
|
10662
|
+
# },
|
10663
|
+
# },
|
10664
|
+
# },
|
10665
|
+
# message_activity: "__string",
|
10666
|
+
# },
|
10667
|
+
# segment_condition: {
|
10668
|
+
# segment_id: "__string", # required
|
10669
|
+
# },
|
10670
|
+
# segment_dimensions: {
|
10671
|
+
# attributes: {
|
10672
|
+
# "__string" => {
|
10673
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10674
|
+
# values: ["__string"], # required
|
10675
|
+
# },
|
10676
|
+
# },
|
10677
|
+
# behavior: {
|
10678
|
+
# recency: {
|
10679
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
10680
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
10681
|
+
# },
|
10682
|
+
# },
|
10683
|
+
# demographic: {
|
10684
|
+
# app_version: {
|
10685
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10686
|
+
# values: ["__string"], # required
|
10687
|
+
# },
|
10688
|
+
# channel: {
|
10689
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10690
|
+
# values: ["__string"], # required
|
10691
|
+
# },
|
10692
|
+
# device_type: {
|
10693
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10694
|
+
# values: ["__string"], # required
|
10695
|
+
# },
|
10696
|
+
# make: {
|
10697
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10698
|
+
# values: ["__string"], # required
|
10699
|
+
# },
|
10700
|
+
# model: {
|
10701
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10702
|
+
# values: ["__string"], # required
|
10703
|
+
# },
|
10704
|
+
# platform: {
|
10705
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10706
|
+
# values: ["__string"], # required
|
10707
|
+
# },
|
10708
|
+
# },
|
10709
|
+
# location: {
|
10710
|
+
# country: {
|
10711
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10712
|
+
# values: ["__string"], # required
|
10713
|
+
# },
|
10714
|
+
# gps_point: {
|
10715
|
+
# coordinates: { # required
|
10716
|
+
# latitude: 1.0, # required
|
10717
|
+
# longitude: 1.0, # required
|
10718
|
+
# },
|
10719
|
+
# range_in_kilometers: 1.0,
|
10720
|
+
# },
|
10721
|
+
# },
|
10722
|
+
# metrics: {
|
10723
|
+
# "__string" => {
|
10724
|
+
# comparison_operator: "__string", # required
|
10725
|
+
# value: 1.0, # required
|
10726
|
+
# },
|
10727
|
+
# },
|
10728
|
+
# user_attributes: {
|
10729
|
+
# "__string" => {
|
10730
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
10731
|
+
# values: ["__string"], # required
|
10732
|
+
# },
|
10733
|
+
# },
|
10734
|
+
# },
|
10735
|
+
# },
|
10736
|
+
# next_activity: "__string",
|
10737
|
+
# },
|
10738
|
+
# ],
|
10739
|
+
# default_activity: "__string",
|
10740
|
+
# evaluation_wait_time: {
|
10741
|
+
# wait_for: "__string",
|
10742
|
+
# wait_until: "__string",
|
10743
|
+
# },
|
10744
|
+
# }
|
10745
|
+
#
|
10746
|
+
# @!attribute [rw] branches
|
10747
|
+
# The paths for the activity, including the conditions for entering
|
10748
|
+
# each path and the activity to perform for each path.
|
10749
|
+
# @return [Array<Types::MultiConditionalBranch>]
|
10750
|
+
#
|
10751
|
+
# @!attribute [rw] default_activity
|
10752
|
+
# The activity to perform by default for any path in the activity.
|
10753
|
+
# @return [String]
|
10754
|
+
#
|
10755
|
+
# @!attribute [rw] evaluation_wait_time
|
10756
|
+
# The amount of time to wait or the date and time when Amazon Pinpoint
|
10757
|
+
# determines whether the conditions are met.
|
10758
|
+
# @return [Types::WaitTime]
|
10759
|
+
#
|
10760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MultiConditionalSplitActivity AWS API Documentation
|
10761
|
+
#
|
10762
|
+
class MultiConditionalSplitActivity < Struct.new(
|
10763
|
+
:branches,
|
10764
|
+
:default_activity,
|
10765
|
+
:evaluation_wait_time)
|
10766
|
+
include Aws::Structure
|
10767
|
+
end
|
10768
|
+
|
8770
10769
|
# Provides information about an API request or response.
|
8771
10770
|
#
|
8772
10771
|
# @!attribute [rw] message
|
@@ -9191,6 +11190,7 @@ module Aws::Pinpoint
|
|
9191
11190
|
# @return [Types::APNSPushNotificationTemplate]
|
9192
11191
|
#
|
9193
11192
|
# @!attribute [rw] arn
|
11193
|
+
# The Amazon Resource Name (ARN) of the message template.
|
9194
11194
|
# @return [String]
|
9195
11195
|
#
|
9196
11196
|
# @!attribute [rw] baidu
|
@@ -9418,11 +11418,68 @@ module Aws::Pinpoint
|
|
9418
11418
|
# use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
|
9419
11419
|
# @return [String]
|
9420
11420
|
#
|
9421
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/QuietTime AWS API Documentation
|
11421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/QuietTime AWS API Documentation
|
11422
|
+
#
|
11423
|
+
class QuietTime < Struct.new(
|
11424
|
+
:end,
|
11425
|
+
:start)
|
11426
|
+
include Aws::Structure
|
11427
|
+
end
|
11428
|
+
|
11429
|
+
# Specifies the settings for a random split activity in a journey. This
|
11430
|
+
# type of activity randomly sends specified percentages of participants
|
11431
|
+
# down one of as many as five paths in a journey, based on conditions
|
11432
|
+
# that you specify.
|
11433
|
+
#
|
11434
|
+
# @note When making an API call, you may pass RandomSplitActivity
|
11435
|
+
# data as a hash:
|
11436
|
+
#
|
11437
|
+
# {
|
11438
|
+
# branches: [
|
11439
|
+
# {
|
11440
|
+
# next_activity: "__string",
|
11441
|
+
# percentage: 1,
|
11442
|
+
# },
|
11443
|
+
# ],
|
11444
|
+
# }
|
11445
|
+
#
|
11446
|
+
# @!attribute [rw] branches
|
11447
|
+
# The paths for the activity, including the percentage of participants
|
11448
|
+
# to enter each path and the activity to perform for each path.
|
11449
|
+
# @return [Array<Types::RandomSplitEntry>]
|
11450
|
+
#
|
11451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RandomSplitActivity AWS API Documentation
|
11452
|
+
#
|
11453
|
+
class RandomSplitActivity < Struct.new(
|
11454
|
+
:branches)
|
11455
|
+
include Aws::Structure
|
11456
|
+
end
|
11457
|
+
|
11458
|
+
# Specifies the settings for a path in a random split activity in a
|
11459
|
+
# journey.
|
11460
|
+
#
|
11461
|
+
# @note When making an API call, you may pass RandomSplitEntry
|
11462
|
+
# data as a hash:
|
11463
|
+
#
|
11464
|
+
# {
|
11465
|
+
# next_activity: "__string",
|
11466
|
+
# percentage: 1,
|
11467
|
+
# }
|
11468
|
+
#
|
11469
|
+
# @!attribute [rw] next_activity
|
11470
|
+
# The unique identifier for the next activity to perform, after
|
11471
|
+
# completing the activity for the path.
|
11472
|
+
# @return [String]
|
11473
|
+
#
|
11474
|
+
# @!attribute [rw] percentage
|
11475
|
+
# The percentage of participants to send down the activity path.
|
11476
|
+
# @return [Integer]
|
9422
11477
|
#
|
9423
|
-
|
9424
|
-
|
9425
|
-
|
11478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RandomSplitEntry AWS API Documentation
|
11479
|
+
#
|
11480
|
+
class RandomSplitEntry < Struct.new(
|
11481
|
+
:next_activity,
|
11482
|
+
:percentage)
|
9426
11483
|
include Aws::Structure
|
9427
11484
|
end
|
9428
11485
|
|
@@ -9525,7 +11582,7 @@ module Aws::Pinpoint
|
|
9525
11582
|
end
|
9526
11583
|
|
9527
11584
|
# Provides the results of a query that retrieved the data for a standard
|
9528
|
-
# metric that applies to an application or
|
11585
|
+
# metric that applies to an application, campaign, or journey.
|
9529
11586
|
#
|
9530
11587
|
# @!attribute [rw] grouped_bys
|
9531
11588
|
# An array of objects that defines the field and field values that
|
@@ -9536,7 +11593,8 @@ module Aws::Pinpoint
|
|
9536
11593
|
#
|
9537
11594
|
# @!attribute [rw] values
|
9538
11595
|
# An array of objects that provides pre-aggregated values for a
|
9539
|
-
# standard metric that applies to an application or
|
11596
|
+
# standard metric that applies to an application, campaign, or
|
11597
|
+
# journey.
|
9540
11598
|
# @return [Array<Types::ResultRowValue>]
|
9541
11599
|
#
|
9542
11600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ResultRow AWS API Documentation
|
@@ -9549,11 +11607,11 @@ module Aws::Pinpoint
|
|
9549
11607
|
|
9550
11608
|
# Provides a single value and metadata about that value as part of an
|
9551
11609
|
# array of query results for a standard metric that applies to an
|
9552
|
-
# application or
|
11610
|
+
# application, campaign, or journey.
|
9553
11611
|
#
|
9554
11612
|
# @!attribute [rw] key
|
9555
|
-
# The name of the
|
9556
|
-
#
|
11613
|
+
# The friendly name of the metric whose value is specified by the
|
11614
|
+
# Value property.
|
9557
11615
|
# @return [String]
|
9558
11616
|
#
|
9559
11617
|
# @!attribute [rw] type
|
@@ -9801,6 +11859,7 @@ module Aws::Pinpoint
|
|
9801
11859
|
# SMS channel.
|
9802
11860
|
#
|
9803
11861
|
# @!attribute [rw] arn
|
11862
|
+
# The Amazon Resource Name (ARN) of the message template.
|
9804
11863
|
# @return [String]
|
9805
11864
|
#
|
9806
11865
|
# @!attribute [rw] body
|
@@ -9883,7 +11942,8 @@ module Aws::Pinpoint
|
|
9883
11942
|
# }
|
9884
11943
|
#
|
9885
11944
|
# @!attribute [rw] end_time
|
9886
|
-
# The scheduled time, in ISO 8601 format,
|
11945
|
+
# The scheduled time, in ISO 8601 format, when the campaign ended or
|
11946
|
+
# will end.
|
9887
11947
|
# @return [String]
|
9888
11948
|
#
|
9889
11949
|
# @!attribute [rw] event_filter
|
@@ -9923,7 +11983,8 @@ module Aws::Pinpoint
|
|
9923
11983
|
# @return [Types::QuietTime]
|
9924
11984
|
#
|
9925
11985
|
# @!attribute [rw] start_time
|
9926
|
-
# The scheduled time, in ISO 8601 format,
|
11986
|
+
# The scheduled time, in ISO 8601 format, when the campaign began or
|
11987
|
+
# will begin.
|
9927
11988
|
# @return [String]
|
9928
11989
|
#
|
9929
11990
|
# @!attribute [rw] timezone
|
@@ -9973,6 +12034,27 @@ module Aws::Pinpoint
|
|
9973
12034
|
include Aws::Structure
|
9974
12035
|
end
|
9975
12036
|
|
12037
|
+
# Specifies a segment to associate with an activity in a journey.
|
12038
|
+
#
|
12039
|
+
# @note When making an API call, you may pass SegmentCondition
|
12040
|
+
# data as a hash:
|
12041
|
+
#
|
12042
|
+
# {
|
12043
|
+
# segment_id: "__string", # required
|
12044
|
+
# }
|
12045
|
+
#
|
12046
|
+
# @!attribute [rw] segment_id
|
12047
|
+
# The unique identifier for the segment to associate with the
|
12048
|
+
# activity.
|
12049
|
+
# @return [String]
|
12050
|
+
#
|
12051
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentCondition AWS API Documentation
|
12052
|
+
#
|
12053
|
+
class SegmentCondition < Struct.new(
|
12054
|
+
:segment_id)
|
12055
|
+
include Aws::Structure
|
12056
|
+
end
|
12057
|
+
|
9976
12058
|
# Specifies demographic-based dimension settings for including or
|
9977
12059
|
# excluding endpoints from a segment. These settings derive from
|
9978
12060
|
# characteristics of endpoint devices, such as platform, make, and
|
@@ -10669,6 +12751,7 @@ module Aws::Pinpoint
|
|
10669
12751
|
# url: "__string",
|
10670
12752
|
# },
|
10671
12753
|
# apns_message: {
|
12754
|
+
# apns_push_type: "__string",
|
10672
12755
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
10673
12756
|
# badge: 1,
|
10674
12757
|
# body: "__string",
|
@@ -10876,6 +12959,7 @@ module Aws::Pinpoint
|
|
10876
12959
|
# url: "__string",
|
10877
12960
|
# },
|
10878
12961
|
# apns_message: {
|
12962
|
+
# apns_push_type: "__string",
|
10879
12963
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
10880
12964
|
# badge: 1,
|
10881
12965
|
# body: "__string",
|
@@ -11134,6 +13218,7 @@ module Aws::Pinpoint
|
|
11134
13218
|
# url: "__string",
|
11135
13219
|
# },
|
11136
13220
|
# apns_message: {
|
13221
|
+
# apns_push_type: "__string",
|
11137
13222
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
11138
13223
|
# badge: 1,
|
11139
13224
|
# body: "__string",
|
@@ -11389,6 +13474,126 @@ module Aws::Pinpoint
|
|
11389
13474
|
include Aws::Structure
|
11390
13475
|
end
|
11391
13476
|
|
13477
|
+
# Specifies a condition to evaluate for an activity in a journey.
|
13478
|
+
#
|
13479
|
+
# @note When making an API call, you may pass SimpleCondition
|
13480
|
+
# data as a hash:
|
13481
|
+
#
|
13482
|
+
# {
|
13483
|
+
# event_condition: {
|
13484
|
+
# dimensions: { # required
|
13485
|
+
# attributes: {
|
13486
|
+
# "__string" => {
|
13487
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13488
|
+
# values: ["__string"], # required
|
13489
|
+
# },
|
13490
|
+
# },
|
13491
|
+
# event_type: {
|
13492
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13493
|
+
# values: ["__string"], # required
|
13494
|
+
# },
|
13495
|
+
# metrics: {
|
13496
|
+
# "__string" => {
|
13497
|
+
# comparison_operator: "__string", # required
|
13498
|
+
# value: 1.0, # required
|
13499
|
+
# },
|
13500
|
+
# },
|
13501
|
+
# },
|
13502
|
+
# message_activity: "__string",
|
13503
|
+
# },
|
13504
|
+
# segment_condition: {
|
13505
|
+
# segment_id: "__string", # required
|
13506
|
+
# },
|
13507
|
+
# segment_dimensions: {
|
13508
|
+
# attributes: {
|
13509
|
+
# "__string" => {
|
13510
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13511
|
+
# values: ["__string"], # required
|
13512
|
+
# },
|
13513
|
+
# },
|
13514
|
+
# behavior: {
|
13515
|
+
# recency: {
|
13516
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
13517
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
13518
|
+
# },
|
13519
|
+
# },
|
13520
|
+
# demographic: {
|
13521
|
+
# app_version: {
|
13522
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13523
|
+
# values: ["__string"], # required
|
13524
|
+
# },
|
13525
|
+
# channel: {
|
13526
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13527
|
+
# values: ["__string"], # required
|
13528
|
+
# },
|
13529
|
+
# device_type: {
|
13530
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13531
|
+
# values: ["__string"], # required
|
13532
|
+
# },
|
13533
|
+
# make: {
|
13534
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13535
|
+
# values: ["__string"], # required
|
13536
|
+
# },
|
13537
|
+
# model: {
|
13538
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13539
|
+
# values: ["__string"], # required
|
13540
|
+
# },
|
13541
|
+
# platform: {
|
13542
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13543
|
+
# values: ["__string"], # required
|
13544
|
+
# },
|
13545
|
+
# },
|
13546
|
+
# location: {
|
13547
|
+
# country: {
|
13548
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13549
|
+
# values: ["__string"], # required
|
13550
|
+
# },
|
13551
|
+
# gps_point: {
|
13552
|
+
# coordinates: { # required
|
13553
|
+
# latitude: 1.0, # required
|
13554
|
+
# longitude: 1.0, # required
|
13555
|
+
# },
|
13556
|
+
# range_in_kilometers: 1.0,
|
13557
|
+
# },
|
13558
|
+
# },
|
13559
|
+
# metrics: {
|
13560
|
+
# "__string" => {
|
13561
|
+
# comparison_operator: "__string", # required
|
13562
|
+
# value: 1.0, # required
|
13563
|
+
# },
|
13564
|
+
# },
|
13565
|
+
# user_attributes: {
|
13566
|
+
# "__string" => {
|
13567
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
13568
|
+
# values: ["__string"], # required
|
13569
|
+
# },
|
13570
|
+
# },
|
13571
|
+
# },
|
13572
|
+
# }
|
13573
|
+
#
|
13574
|
+
# @!attribute [rw] event_condition
|
13575
|
+
# The dimension settings for the event that's associated with the
|
13576
|
+
# activity.
|
13577
|
+
# @return [Types::EventCondition]
|
13578
|
+
#
|
13579
|
+
# @!attribute [rw] segment_condition
|
13580
|
+
# The segment that's associated with the activity.
|
13581
|
+
# @return [Types::SegmentCondition]
|
13582
|
+
#
|
13583
|
+
# @!attribute [rw] segment_dimensions
|
13584
|
+
# The dimension settings for the segment that's associated with the
|
13585
|
+
# activity.
|
13586
|
+
# @return [Types::SegmentDimensions]
|
13587
|
+
#
|
13588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SimpleCondition AWS API Documentation
|
13589
|
+
#
|
13590
|
+
class SimpleCondition < Struct.new(
|
13591
|
+
:event_condition,
|
13592
|
+
:segment_condition,
|
13593
|
+
:segment_dimensions)
|
13594
|
+
include Aws::Structure
|
13595
|
+
end
|
13596
|
+
|
11392
13597
|
# Specifies the contents of an email message, composed of a subject, a
|
11393
13598
|
# text part, and an HTML part.
|
11394
13599
|
#
|
@@ -11462,6 +13667,38 @@ module Aws::Pinpoint
|
|
11462
13667
|
include Aws::Structure
|
11463
13668
|
end
|
11464
13669
|
|
13670
|
+
# Specifies the conditions for the first activity in a journey. This
|
13671
|
+
# activity and its conditions determine which users are participants in
|
13672
|
+
# a journey.
|
13673
|
+
#
|
13674
|
+
# @note When making an API call, you may pass StartCondition
|
13675
|
+
# data as a hash:
|
13676
|
+
#
|
13677
|
+
# {
|
13678
|
+
# description: "__string",
|
13679
|
+
# segment_start_condition: {
|
13680
|
+
# segment_id: "__string", # required
|
13681
|
+
# },
|
13682
|
+
# }
|
13683
|
+
#
|
13684
|
+
# @!attribute [rw] description
|
13685
|
+
# The custom description of the condition.
|
13686
|
+
# @return [String]
|
13687
|
+
#
|
13688
|
+
# @!attribute [rw] segment_start_condition
|
13689
|
+
# The segment that's associated with the first activity in the
|
13690
|
+
# journey. This segment determines which users are participants in the
|
13691
|
+
# journey.
|
13692
|
+
# @return [Types::SegmentCondition]
|
13693
|
+
#
|
13694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/StartCondition AWS API Documentation
|
13695
|
+
#
|
13696
|
+
class StartCondition < Struct.new(
|
13697
|
+
:description,
|
13698
|
+
:segment_start_condition)
|
13699
|
+
include Aws::Structure
|
13700
|
+
end
|
13701
|
+
|
11465
13702
|
# @note When making an API call, you may pass TagResourceRequest
|
11466
13703
|
# data as a hash:
|
11467
13704
|
#
|
@@ -11479,7 +13716,7 @@ module Aws::Pinpoint
|
|
11479
13716
|
#
|
11480
13717
|
# @!attribute [rw] tags_model
|
11481
13718
|
# Specifies the tags (keys and values) for an application, campaign,
|
11482
|
-
# message template, or segment.
|
13719
|
+
# journey, message template, or segment.
|
11483
13720
|
# @return [Types::TagsModel]
|
11484
13721
|
#
|
11485
13722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TagResourceRequest AWS API Documentation
|
@@ -11491,7 +13728,7 @@ module Aws::Pinpoint
|
|
11491
13728
|
end
|
11492
13729
|
|
11493
13730
|
# Specifies the tags (keys and values) for an application, campaign,
|
11494
|
-
# message template, or segment.
|
13731
|
+
# journey, message template, or segment.
|
11495
13732
|
#
|
11496
13733
|
# @note When making an API call, you may pass TagsModel
|
11497
13734
|
# data as a hash:
|
@@ -11504,9 +13741,8 @@ module Aws::Pinpoint
|
|
11504
13741
|
#
|
11505
13742
|
# @!attribute [rw] tags
|
11506
13743
|
# A string-to-string map of key-value pairs that defines the tags for
|
11507
|
-
# an application, campaign, message template, or segment.
|
11508
|
-
#
|
11509
|
-
# of 50 tags.
|
13744
|
+
# an application, campaign, journey, message template, or segment.
|
13745
|
+
# Each of these resources can have a maximum of 50 tags.
|
11510
13746
|
#
|
11511
13747
|
# Each tag consists of a required tag key and an associated tag value.
|
11512
13748
|
# The maximum length of a tag key is 128 characters. The maximum
|
@@ -11542,8 +13778,7 @@ module Aws::Pinpoint
|
|
11542
13778
|
include Aws::Structure
|
11543
13779
|
end
|
11544
13780
|
|
11545
|
-
# Specifies the message template
|
11546
|
-
# of channel.
|
13781
|
+
# Specifies the message template for each type of channel.
|
11547
13782
|
#
|
11548
13783
|
# @note When making an API call, you may pass TemplateConfiguration
|
11549
13784
|
# data as a hash:
|
@@ -11682,11 +13917,11 @@ module Aws::Pinpoint
|
|
11682
13917
|
# @return [Integer]
|
11683
13918
|
#
|
11684
13919
|
# @!attribute [rw] state
|
11685
|
-
# The status of the treatment.
|
13920
|
+
# The current status of the treatment.
|
11686
13921
|
# @return [Types::CampaignState]
|
11687
13922
|
#
|
11688
13923
|
# @!attribute [rw] template_configuration
|
11689
|
-
# The message template
|
13924
|
+
# The message template to use for the treatment.
|
11690
13925
|
# @return [Types::TemplateConfiguration]
|
11691
13926
|
#
|
11692
13927
|
# @!attribute [rw] treatment_description
|
@@ -12589,89 +14824,437 @@ module Aws::Pinpoint
|
|
12589
14824
|
# postal_code: "__string",
|
12590
14825
|
# region: "__string",
|
12591
14826
|
# },
|
12592
|
-
# metrics: {
|
12593
|
-
# "__string" => 1.0,
|
14827
|
+
# metrics: {
|
14828
|
+
# "__string" => 1.0,
|
14829
|
+
# },
|
14830
|
+
# opt_out: "__string",
|
14831
|
+
# request_id: "__string",
|
14832
|
+
# user: {
|
14833
|
+
# user_attributes: {
|
14834
|
+
# "__string" => ["__string"],
|
14835
|
+
# },
|
14836
|
+
# user_id: "__string",
|
14837
|
+
# },
|
14838
|
+
# },
|
14839
|
+
# ],
|
14840
|
+
# },
|
14841
|
+
# }
|
14842
|
+
#
|
14843
|
+
# @!attribute [rw] application_id
|
14844
|
+
# @return [String]
|
14845
|
+
#
|
14846
|
+
# @!attribute [rw] endpoint_batch_request
|
14847
|
+
# Specifies a batch of endpoints to create or update and the settings
|
14848
|
+
# and attributes to set or change for each endpoint.
|
14849
|
+
# @return [Types::EndpointBatchRequest]
|
14850
|
+
#
|
14851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointsBatchRequest AWS API Documentation
|
14852
|
+
#
|
14853
|
+
class UpdateEndpointsBatchRequest < Struct.new(
|
14854
|
+
:application_id,
|
14855
|
+
:endpoint_batch_request)
|
14856
|
+
include Aws::Structure
|
14857
|
+
end
|
14858
|
+
|
14859
|
+
# @!attribute [rw] message_body
|
14860
|
+
# Provides information about an API request or response.
|
14861
|
+
# @return [Types::MessageBody]
|
14862
|
+
#
|
14863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointsBatchResponse AWS API Documentation
|
14864
|
+
#
|
14865
|
+
class UpdateEndpointsBatchResponse < Struct.new(
|
14866
|
+
:message_body)
|
14867
|
+
include Aws::Structure
|
14868
|
+
end
|
14869
|
+
|
14870
|
+
# @note When making an API call, you may pass UpdateGcmChannelRequest
|
14871
|
+
# data as a hash:
|
14872
|
+
#
|
14873
|
+
# {
|
14874
|
+
# application_id: "__string", # required
|
14875
|
+
# gcm_channel_request: { # required
|
14876
|
+
# api_key: "__string", # required
|
14877
|
+
# enabled: false,
|
14878
|
+
# },
|
14879
|
+
# }
|
14880
|
+
#
|
14881
|
+
# @!attribute [rw] application_id
|
14882
|
+
# @return [String]
|
14883
|
+
#
|
14884
|
+
# @!attribute [rw] gcm_channel_request
|
14885
|
+
# Specifies the status and settings of the GCM channel for an
|
14886
|
+
# application. This channel enables Amazon Pinpoint to send push
|
14887
|
+
# notifications through the Firebase Cloud Messaging (FCM), formerly
|
14888
|
+
# Google Cloud Messaging (GCM), service.
|
14889
|
+
# @return [Types::GCMChannelRequest]
|
14890
|
+
#
|
14891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannelRequest AWS API Documentation
|
14892
|
+
#
|
14893
|
+
class UpdateGcmChannelRequest < Struct.new(
|
14894
|
+
:application_id,
|
14895
|
+
:gcm_channel_request)
|
14896
|
+
include Aws::Structure
|
14897
|
+
end
|
14898
|
+
|
14899
|
+
# @!attribute [rw] gcm_channel_response
|
14900
|
+
# Provides information about the status and settings of the GCM
|
14901
|
+
# channel for an application. The GCM channel enables Amazon Pinpoint
|
14902
|
+
# to send push notifications through the Firebase Cloud Messaging
|
14903
|
+
# (FCM), formerly Google Cloud Messaging (GCM), service.
|
14904
|
+
# @return [Types::GCMChannelResponse]
|
14905
|
+
#
|
14906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannelResponse AWS API Documentation
|
14907
|
+
#
|
14908
|
+
class UpdateGcmChannelResponse < Struct.new(
|
14909
|
+
:gcm_channel_response)
|
14910
|
+
include Aws::Structure
|
14911
|
+
end
|
14912
|
+
|
14913
|
+
# @note When making an API call, you may pass UpdateJourneyRequest
|
14914
|
+
# data as a hash:
|
14915
|
+
#
|
14916
|
+
# {
|
14917
|
+
# application_id: "__string", # required
|
14918
|
+
# journey_id: "__string", # required
|
14919
|
+
# write_journey_request: { # required
|
14920
|
+
# activities: {
|
14921
|
+
# "__string" => {
|
14922
|
+
# conditional_split: {
|
14923
|
+
# condition: {
|
14924
|
+
# conditions: [
|
14925
|
+
# {
|
14926
|
+
# event_condition: {
|
14927
|
+
# dimensions: { # required
|
14928
|
+
# attributes: {
|
14929
|
+
# "__string" => {
|
14930
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14931
|
+
# values: ["__string"], # required
|
14932
|
+
# },
|
14933
|
+
# },
|
14934
|
+
# event_type: {
|
14935
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14936
|
+
# values: ["__string"], # required
|
14937
|
+
# },
|
14938
|
+
# metrics: {
|
14939
|
+
# "__string" => {
|
14940
|
+
# comparison_operator: "__string", # required
|
14941
|
+
# value: 1.0, # required
|
14942
|
+
# },
|
14943
|
+
# },
|
14944
|
+
# },
|
14945
|
+
# message_activity: "__string",
|
14946
|
+
# },
|
14947
|
+
# segment_condition: {
|
14948
|
+
# segment_id: "__string", # required
|
14949
|
+
# },
|
14950
|
+
# segment_dimensions: {
|
14951
|
+
# attributes: {
|
14952
|
+
# "__string" => {
|
14953
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14954
|
+
# values: ["__string"], # required
|
14955
|
+
# },
|
14956
|
+
# },
|
14957
|
+
# behavior: {
|
14958
|
+
# recency: {
|
14959
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
14960
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
14961
|
+
# },
|
14962
|
+
# },
|
14963
|
+
# demographic: {
|
14964
|
+
# app_version: {
|
14965
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14966
|
+
# values: ["__string"], # required
|
14967
|
+
# },
|
14968
|
+
# channel: {
|
14969
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14970
|
+
# values: ["__string"], # required
|
14971
|
+
# },
|
14972
|
+
# device_type: {
|
14973
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14974
|
+
# values: ["__string"], # required
|
14975
|
+
# },
|
14976
|
+
# make: {
|
14977
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14978
|
+
# values: ["__string"], # required
|
14979
|
+
# },
|
14980
|
+
# model: {
|
14981
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14982
|
+
# values: ["__string"], # required
|
14983
|
+
# },
|
14984
|
+
# platform: {
|
14985
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14986
|
+
# values: ["__string"], # required
|
14987
|
+
# },
|
14988
|
+
# },
|
14989
|
+
# location: {
|
14990
|
+
# country: {
|
14991
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
14992
|
+
# values: ["__string"], # required
|
14993
|
+
# },
|
14994
|
+
# gps_point: {
|
14995
|
+
# coordinates: { # required
|
14996
|
+
# latitude: 1.0, # required
|
14997
|
+
# longitude: 1.0, # required
|
14998
|
+
# },
|
14999
|
+
# range_in_kilometers: 1.0,
|
15000
|
+
# },
|
15001
|
+
# },
|
15002
|
+
# metrics: {
|
15003
|
+
# "__string" => {
|
15004
|
+
# comparison_operator: "__string", # required
|
15005
|
+
# value: 1.0, # required
|
15006
|
+
# },
|
15007
|
+
# },
|
15008
|
+
# user_attributes: {
|
15009
|
+
# "__string" => {
|
15010
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15011
|
+
# values: ["__string"], # required
|
15012
|
+
# },
|
15013
|
+
# },
|
15014
|
+
# },
|
15015
|
+
# },
|
15016
|
+
# ],
|
15017
|
+
# operator: "ALL", # accepts ALL, ANY
|
15018
|
+
# },
|
15019
|
+
# evaluation_wait_time: {
|
15020
|
+
# wait_for: "__string",
|
15021
|
+
# wait_until: "__string",
|
15022
|
+
# },
|
15023
|
+
# false_activity: "__string",
|
15024
|
+
# true_activity: "__string",
|
15025
|
+
# },
|
15026
|
+
# description: "__string",
|
15027
|
+
# email: {
|
15028
|
+
# message_config: {
|
15029
|
+
# from_address: "__string",
|
15030
|
+
# },
|
15031
|
+
# next_activity: "__string",
|
15032
|
+
# template_name: "__string",
|
15033
|
+
# },
|
15034
|
+
# holdout: {
|
15035
|
+
# next_activity: "__string",
|
15036
|
+
# percentage: 1, # required
|
15037
|
+
# },
|
15038
|
+
# multi_condition: {
|
15039
|
+
# branches: [
|
15040
|
+
# {
|
15041
|
+
# condition: {
|
15042
|
+
# event_condition: {
|
15043
|
+
# dimensions: { # required
|
15044
|
+
# attributes: {
|
15045
|
+
# "__string" => {
|
15046
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15047
|
+
# values: ["__string"], # required
|
15048
|
+
# },
|
15049
|
+
# },
|
15050
|
+
# event_type: {
|
15051
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15052
|
+
# values: ["__string"], # required
|
15053
|
+
# },
|
15054
|
+
# metrics: {
|
15055
|
+
# "__string" => {
|
15056
|
+
# comparison_operator: "__string", # required
|
15057
|
+
# value: 1.0, # required
|
15058
|
+
# },
|
15059
|
+
# },
|
15060
|
+
# },
|
15061
|
+
# message_activity: "__string",
|
15062
|
+
# },
|
15063
|
+
# segment_condition: {
|
15064
|
+
# segment_id: "__string", # required
|
15065
|
+
# },
|
15066
|
+
# segment_dimensions: {
|
15067
|
+
# attributes: {
|
15068
|
+
# "__string" => {
|
15069
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15070
|
+
# values: ["__string"], # required
|
15071
|
+
# },
|
15072
|
+
# },
|
15073
|
+
# behavior: {
|
15074
|
+
# recency: {
|
15075
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
15076
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
15077
|
+
# },
|
15078
|
+
# },
|
15079
|
+
# demographic: {
|
15080
|
+
# app_version: {
|
15081
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15082
|
+
# values: ["__string"], # required
|
15083
|
+
# },
|
15084
|
+
# channel: {
|
15085
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15086
|
+
# values: ["__string"], # required
|
15087
|
+
# },
|
15088
|
+
# device_type: {
|
15089
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15090
|
+
# values: ["__string"], # required
|
15091
|
+
# },
|
15092
|
+
# make: {
|
15093
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15094
|
+
# values: ["__string"], # required
|
15095
|
+
# },
|
15096
|
+
# model: {
|
15097
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15098
|
+
# values: ["__string"], # required
|
15099
|
+
# },
|
15100
|
+
# platform: {
|
15101
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15102
|
+
# values: ["__string"], # required
|
15103
|
+
# },
|
15104
|
+
# },
|
15105
|
+
# location: {
|
15106
|
+
# country: {
|
15107
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15108
|
+
# values: ["__string"], # required
|
15109
|
+
# },
|
15110
|
+
# gps_point: {
|
15111
|
+
# coordinates: { # required
|
15112
|
+
# latitude: 1.0, # required
|
15113
|
+
# longitude: 1.0, # required
|
15114
|
+
# },
|
15115
|
+
# range_in_kilometers: 1.0,
|
15116
|
+
# },
|
15117
|
+
# },
|
15118
|
+
# metrics: {
|
15119
|
+
# "__string" => {
|
15120
|
+
# comparison_operator: "__string", # required
|
15121
|
+
# value: 1.0, # required
|
15122
|
+
# },
|
15123
|
+
# },
|
15124
|
+
# user_attributes: {
|
15125
|
+
# "__string" => {
|
15126
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
15127
|
+
# values: ["__string"], # required
|
15128
|
+
# },
|
15129
|
+
# },
|
15130
|
+
# },
|
15131
|
+
# },
|
15132
|
+
# next_activity: "__string",
|
15133
|
+
# },
|
15134
|
+
# ],
|
15135
|
+
# default_activity: "__string",
|
15136
|
+
# evaluation_wait_time: {
|
15137
|
+
# wait_for: "__string",
|
15138
|
+
# wait_until: "__string",
|
15139
|
+
# },
|
15140
|
+
# },
|
15141
|
+
# random_split: {
|
15142
|
+
# branches: [
|
15143
|
+
# {
|
15144
|
+
# next_activity: "__string",
|
15145
|
+
# percentage: 1,
|
15146
|
+
# },
|
15147
|
+
# ],
|
12594
15148
|
# },
|
12595
|
-
#
|
12596
|
-
#
|
12597
|
-
#
|
12598
|
-
#
|
12599
|
-
#
|
15149
|
+
# wait: {
|
15150
|
+
# next_activity: "__string",
|
15151
|
+
# wait_time: {
|
15152
|
+
# wait_for: "__string",
|
15153
|
+
# wait_until: "__string",
|
12600
15154
|
# },
|
12601
|
-
# user_id: "__string",
|
12602
15155
|
# },
|
12603
15156
|
# },
|
12604
|
-
#
|
15157
|
+
# },
|
15158
|
+
# creation_date: "__string",
|
15159
|
+
# last_modified_date: "__string",
|
15160
|
+
# limits: {
|
15161
|
+
# daily_cap: 1,
|
15162
|
+
# endpoint_reentry_cap: 1,
|
15163
|
+
# messages_per_second: 1,
|
15164
|
+
# },
|
15165
|
+
# local_time: false,
|
15166
|
+
# name: "__string", # required
|
15167
|
+
# quiet_time: {
|
15168
|
+
# end: "__string",
|
15169
|
+
# start: "__string",
|
15170
|
+
# },
|
15171
|
+
# refresh_frequency: "__string",
|
15172
|
+
# schedule: {
|
15173
|
+
# end_time: Time.now,
|
15174
|
+
# start_time: Time.now,
|
15175
|
+
# timezone: "__string",
|
15176
|
+
# },
|
15177
|
+
# start_activity: "__string",
|
15178
|
+
# start_condition: {
|
15179
|
+
# description: "__string",
|
15180
|
+
# segment_start_condition: {
|
15181
|
+
# segment_id: "__string", # required
|
15182
|
+
# },
|
15183
|
+
# },
|
15184
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
12605
15185
|
# },
|
12606
15186
|
# }
|
12607
15187
|
#
|
12608
15188
|
# @!attribute [rw] application_id
|
12609
15189
|
# @return [String]
|
12610
15190
|
#
|
12611
|
-
# @!attribute [rw]
|
12612
|
-
#
|
12613
|
-
# and attributes to set or change for each endpoint.
|
12614
|
-
# @return [Types::EndpointBatchRequest]
|
15191
|
+
# @!attribute [rw] journey_id
|
15192
|
+
# @return [String]
|
12615
15193
|
#
|
12616
|
-
#
|
15194
|
+
# @!attribute [rw] write_journey_request
|
15195
|
+
# Specifies the configuration and other settings for a journey.
|
15196
|
+
# @return [Types::WriteJourneyRequest]
|
12617
15197
|
#
|
12618
|
-
|
15198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourneyRequest AWS API Documentation
|
15199
|
+
#
|
15200
|
+
class UpdateJourneyRequest < Struct.new(
|
12619
15201
|
:application_id,
|
12620
|
-
:
|
15202
|
+
:journey_id,
|
15203
|
+
:write_journey_request)
|
12621
15204
|
include Aws::Structure
|
12622
15205
|
end
|
12623
15206
|
|
12624
|
-
# @!attribute [rw]
|
12625
|
-
# Provides information about
|
12626
|
-
#
|
15207
|
+
# @!attribute [rw] journey_response
|
15208
|
+
# Provides information about the status, configuration, and other
|
15209
|
+
# settings for a journey.
|
15210
|
+
# @return [Types::JourneyResponse]
|
12627
15211
|
#
|
12628
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/
|
15212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourneyResponse AWS API Documentation
|
12629
15213
|
#
|
12630
|
-
class
|
12631
|
-
:
|
15214
|
+
class UpdateJourneyResponse < Struct.new(
|
15215
|
+
:journey_response)
|
12632
15216
|
include Aws::Structure
|
12633
15217
|
end
|
12634
15218
|
|
12635
|
-
# @note When making an API call, you may pass
|
15219
|
+
# @note When making an API call, you may pass UpdateJourneyStateRequest
|
12636
15220
|
# data as a hash:
|
12637
15221
|
#
|
12638
15222
|
# {
|
12639
15223
|
# application_id: "__string", # required
|
12640
|
-
#
|
12641
|
-
#
|
12642
|
-
#
|
15224
|
+
# journey_id: "__string", # required
|
15225
|
+
# journey_state_request: { # required
|
15226
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
12643
15227
|
# },
|
12644
15228
|
# }
|
12645
15229
|
#
|
12646
15230
|
# @!attribute [rw] application_id
|
12647
15231
|
# @return [String]
|
12648
15232
|
#
|
12649
|
-
# @!attribute [rw]
|
12650
|
-
#
|
12651
|
-
# application. This channel enables Amazon Pinpoint to send push
|
12652
|
-
# notifications through the Firebase Cloud Messaging (FCM), formerly
|
12653
|
-
# Google Cloud Messaging (GCM), service.
|
12654
|
-
# @return [Types::GCMChannelRequest]
|
15233
|
+
# @!attribute [rw] journey_id
|
15234
|
+
# @return [String]
|
12655
15235
|
#
|
12656
|
-
#
|
15236
|
+
# @!attribute [rw] journey_state_request
|
15237
|
+
# Changes the status of a journey.
|
15238
|
+
# @return [Types::JourneyStateRequest]
|
12657
15239
|
#
|
12658
|
-
|
15240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourneyStateRequest AWS API Documentation
|
15241
|
+
#
|
15242
|
+
class UpdateJourneyStateRequest < Struct.new(
|
12659
15243
|
:application_id,
|
12660
|
-
:
|
15244
|
+
:journey_id,
|
15245
|
+
:journey_state_request)
|
12661
15246
|
include Aws::Structure
|
12662
15247
|
end
|
12663
15248
|
|
12664
|
-
# @!attribute [rw]
|
12665
|
-
# Provides information about the status and
|
12666
|
-
#
|
12667
|
-
#
|
12668
|
-
# (FCM), formerly Google Cloud Messaging (GCM), service.
|
12669
|
-
# @return [Types::GCMChannelResponse]
|
15249
|
+
# @!attribute [rw] journey_response
|
15250
|
+
# Provides information about the status, configuration, and other
|
15251
|
+
# settings for a journey.
|
15252
|
+
# @return [Types::JourneyResponse]
|
12670
15253
|
#
|
12671
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/
|
15254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourneyStateResponse AWS API Documentation
|
12672
15255
|
#
|
12673
|
-
class
|
12674
|
-
:
|
15256
|
+
class UpdateJourneyStateResponse < Struct.new(
|
15257
|
+
:journey_response)
|
12675
15258
|
include Aws::Structure
|
12676
15259
|
end
|
12677
15260
|
|
@@ -13133,9 +15716,6 @@ module Aws::Pinpoint
|
|
13133
15716
|
# last modified.
|
13134
15717
|
# @return [String]
|
13135
15718
|
#
|
13136
|
-
# @!attribute [rw] origination_number
|
13137
|
-
# @return [String]
|
13138
|
-
#
|
13139
15719
|
# @!attribute [rw] platform
|
13140
15720
|
# The type of messaging or notification platform for the channel. For
|
13141
15721
|
# the voice channel, this value is VOICE.
|
@@ -13156,7 +15736,6 @@ module Aws::Pinpoint
|
|
13156
15736
|
:is_archived,
|
13157
15737
|
:last_modified_by,
|
13158
15738
|
:last_modified_date,
|
13159
|
-
:origination_number,
|
13160
15739
|
:platform,
|
13161
15740
|
:version)
|
13162
15741
|
include Aws::Structure
|
@@ -13218,6 +15797,71 @@ module Aws::Pinpoint
|
|
13218
15797
|
include Aws::Structure
|
13219
15798
|
end
|
13220
15799
|
|
15800
|
+
# Specifies the settings for a wait activity in a journey. This type of
|
15801
|
+
# activity waits for a certain amount of time or until a specific date
|
15802
|
+
# and time before moving participants to the next activity in a journey.
|
15803
|
+
#
|
15804
|
+
# @note When making an API call, you may pass WaitActivity
|
15805
|
+
# data as a hash:
|
15806
|
+
#
|
15807
|
+
# {
|
15808
|
+
# next_activity: "__string",
|
15809
|
+
# wait_time: {
|
15810
|
+
# wait_for: "__string",
|
15811
|
+
# wait_until: "__string",
|
15812
|
+
# },
|
15813
|
+
# }
|
15814
|
+
#
|
15815
|
+
# @!attribute [rw] next_activity
|
15816
|
+
# The unique identifier for the next activity to perform, after
|
15817
|
+
# performing the wait activity.
|
15818
|
+
# @return [String]
|
15819
|
+
#
|
15820
|
+
# @!attribute [rw] wait_time
|
15821
|
+
# The amount of time to wait or the date and time when the activity
|
15822
|
+
# moves participants to the next activity in the journey.
|
15823
|
+
# @return [Types::WaitTime]
|
15824
|
+
#
|
15825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WaitActivity AWS API Documentation
|
15826
|
+
#
|
15827
|
+
class WaitActivity < Struct.new(
|
15828
|
+
:next_activity,
|
15829
|
+
:wait_time)
|
15830
|
+
include Aws::Structure
|
15831
|
+
end
|
15832
|
+
|
15833
|
+
# Specifies a duration or a date and time that indicates when Amazon
|
15834
|
+
# Pinpoint determines whether an activity's conditions have been met or
|
15835
|
+
# an activity moves participants to the next activity in a journey.
|
15836
|
+
#
|
15837
|
+
# @note When making an API call, you may pass WaitTime
|
15838
|
+
# data as a hash:
|
15839
|
+
#
|
15840
|
+
# {
|
15841
|
+
# wait_for: "__string",
|
15842
|
+
# wait_until: "__string",
|
15843
|
+
# }
|
15844
|
+
#
|
15845
|
+
# @!attribute [rw] wait_for
|
15846
|
+
# The amount of time, as a duration in ISO 8601 format, to wait before
|
15847
|
+
# determining whether the activity's conditions have been met or
|
15848
|
+
# moving participants to the next activity in the journey.
|
15849
|
+
# @return [String]
|
15850
|
+
#
|
15851
|
+
# @!attribute [rw] wait_until
|
15852
|
+
# The date and time, in ISO 8601 format, when Amazon Pinpoint
|
15853
|
+
# determines whether the activity's conditions have been met or the
|
15854
|
+
# activity moves participants to the next activity in the journey.
|
15855
|
+
# @return [String]
|
15856
|
+
#
|
15857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WaitTime AWS API Documentation
|
15858
|
+
#
|
15859
|
+
class WaitTime < Struct.new(
|
15860
|
+
:wait_for,
|
15861
|
+
:wait_until)
|
15862
|
+
include Aws::Structure
|
15863
|
+
end
|
15864
|
+
|
13221
15865
|
# Specifies the default settings for an application.
|
13222
15866
|
#
|
13223
15867
|
# @note When making an API call, you may pass WriteApplicationSettingsRequest
|
@@ -13266,30 +15910,36 @@ module Aws::Pinpoint
|
|
13266
15910
|
# @return [Types::CampaignLimits]
|
13267
15911
|
#
|
13268
15912
|
# @!attribute [rw] quiet_time
|
13269
|
-
# The default quiet time for campaigns in the
|
13270
|
-
# is a specific time range when
|
13271
|
-
# endpoints, if all the following conditions are met:
|
15913
|
+
# The default quiet time for campaigns and journeys in the
|
15914
|
+
# application. Quiet time is a specific time range when messages
|
15915
|
+
# aren't sent to endpoints, if all the following conditions are met:
|
13272
15916
|
#
|
13273
15917
|
# * The EndpointDemographic.Timezone property of the endpoint is set
|
13274
15918
|
# to a valid value.
|
13275
15919
|
#
|
13276
15920
|
# * The current time in the endpoint's time zone is later than or
|
13277
15921
|
# equal to the time specified by the QuietTime.Start property for
|
13278
|
-
# the application (or a campaign that has custom quiet
|
13279
|
-
# settings).
|
15922
|
+
# the application (or a campaign or journey that has custom quiet
|
15923
|
+
# time settings).
|
13280
15924
|
#
|
13281
15925
|
# * The current time in the endpoint's time zone is earlier than or
|
13282
15926
|
# equal to the time specified by the QuietTime.End property for the
|
13283
|
-
# application (or a campaign that has custom quiet time
|
15927
|
+
# application (or a campaign or journey that has custom quiet time
|
15928
|
+
# settings).
|
13284
15929
|
#
|
13285
15930
|
# If any of the preceding conditions isn't met, the endpoint will
|
13286
|
-
# receive messages from a campaign, even if quiet time is
|
15931
|
+
# receive messages from a campaign or journey, even if quiet time is
|
15932
|
+
# enabled.
|
15933
|
+
#
|
15934
|
+
# To override the default quiet time settings for a specific campaign
|
15935
|
+
# or journey, use the <link
|
15936
|
+
# linkend="apps-application-id-campaigns-campaign-id" />
|
13287
15937
|
#
|
13288
|
-
#
|
13289
|
-
#
|
15938
|
+
# Campaign</link> resource or the <link
|
15939
|
+
# linkend="apps-application-id-journeys-journey-id" />
|
13290
15940
|
#
|
13291
|
-
#
|
13292
|
-
# campaign.
|
15941
|
+
# Journey</link> resource to define a custom quiet time for the
|
15942
|
+
# campaign or journey.
|
13293
15943
|
# @return [Types::QuietTime]
|
13294
15944
|
#
|
13295
15945
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteApplicationSettingsRequest AWS API Documentation
|
@@ -13727,6 +16377,382 @@ module Aws::Pinpoint
|
|
13727
16377
|
include Aws::Structure
|
13728
16378
|
end
|
13729
16379
|
|
16380
|
+
# Specifies the configuration and other settings for a journey.
|
16381
|
+
#
|
16382
|
+
# @note When making an API call, you may pass WriteJourneyRequest
|
16383
|
+
# data as a hash:
|
16384
|
+
#
|
16385
|
+
# {
|
16386
|
+
# activities: {
|
16387
|
+
# "__string" => {
|
16388
|
+
# conditional_split: {
|
16389
|
+
# condition: {
|
16390
|
+
# conditions: [
|
16391
|
+
# {
|
16392
|
+
# event_condition: {
|
16393
|
+
# dimensions: { # required
|
16394
|
+
# attributes: {
|
16395
|
+
# "__string" => {
|
16396
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16397
|
+
# values: ["__string"], # required
|
16398
|
+
# },
|
16399
|
+
# },
|
16400
|
+
# event_type: {
|
16401
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16402
|
+
# values: ["__string"], # required
|
16403
|
+
# },
|
16404
|
+
# metrics: {
|
16405
|
+
# "__string" => {
|
16406
|
+
# comparison_operator: "__string", # required
|
16407
|
+
# value: 1.0, # required
|
16408
|
+
# },
|
16409
|
+
# },
|
16410
|
+
# },
|
16411
|
+
# message_activity: "__string",
|
16412
|
+
# },
|
16413
|
+
# segment_condition: {
|
16414
|
+
# segment_id: "__string", # required
|
16415
|
+
# },
|
16416
|
+
# segment_dimensions: {
|
16417
|
+
# attributes: {
|
16418
|
+
# "__string" => {
|
16419
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16420
|
+
# values: ["__string"], # required
|
16421
|
+
# },
|
16422
|
+
# },
|
16423
|
+
# behavior: {
|
16424
|
+
# recency: {
|
16425
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
16426
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
16427
|
+
# },
|
16428
|
+
# },
|
16429
|
+
# demographic: {
|
16430
|
+
# app_version: {
|
16431
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16432
|
+
# values: ["__string"], # required
|
16433
|
+
# },
|
16434
|
+
# channel: {
|
16435
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16436
|
+
# values: ["__string"], # required
|
16437
|
+
# },
|
16438
|
+
# device_type: {
|
16439
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16440
|
+
# values: ["__string"], # required
|
16441
|
+
# },
|
16442
|
+
# make: {
|
16443
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16444
|
+
# values: ["__string"], # required
|
16445
|
+
# },
|
16446
|
+
# model: {
|
16447
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16448
|
+
# values: ["__string"], # required
|
16449
|
+
# },
|
16450
|
+
# platform: {
|
16451
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16452
|
+
# values: ["__string"], # required
|
16453
|
+
# },
|
16454
|
+
# },
|
16455
|
+
# location: {
|
16456
|
+
# country: {
|
16457
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16458
|
+
# values: ["__string"], # required
|
16459
|
+
# },
|
16460
|
+
# gps_point: {
|
16461
|
+
# coordinates: { # required
|
16462
|
+
# latitude: 1.0, # required
|
16463
|
+
# longitude: 1.0, # required
|
16464
|
+
# },
|
16465
|
+
# range_in_kilometers: 1.0,
|
16466
|
+
# },
|
16467
|
+
# },
|
16468
|
+
# metrics: {
|
16469
|
+
# "__string" => {
|
16470
|
+
# comparison_operator: "__string", # required
|
16471
|
+
# value: 1.0, # required
|
16472
|
+
# },
|
16473
|
+
# },
|
16474
|
+
# user_attributes: {
|
16475
|
+
# "__string" => {
|
16476
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16477
|
+
# values: ["__string"], # required
|
16478
|
+
# },
|
16479
|
+
# },
|
16480
|
+
# },
|
16481
|
+
# },
|
16482
|
+
# ],
|
16483
|
+
# operator: "ALL", # accepts ALL, ANY
|
16484
|
+
# },
|
16485
|
+
# evaluation_wait_time: {
|
16486
|
+
# wait_for: "__string",
|
16487
|
+
# wait_until: "__string",
|
16488
|
+
# },
|
16489
|
+
# false_activity: "__string",
|
16490
|
+
# true_activity: "__string",
|
16491
|
+
# },
|
16492
|
+
# description: "__string",
|
16493
|
+
# email: {
|
16494
|
+
# message_config: {
|
16495
|
+
# from_address: "__string",
|
16496
|
+
# },
|
16497
|
+
# next_activity: "__string",
|
16498
|
+
# template_name: "__string",
|
16499
|
+
# },
|
16500
|
+
# holdout: {
|
16501
|
+
# next_activity: "__string",
|
16502
|
+
# percentage: 1, # required
|
16503
|
+
# },
|
16504
|
+
# multi_condition: {
|
16505
|
+
# branches: [
|
16506
|
+
# {
|
16507
|
+
# condition: {
|
16508
|
+
# event_condition: {
|
16509
|
+
# dimensions: { # required
|
16510
|
+
# attributes: {
|
16511
|
+
# "__string" => {
|
16512
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16513
|
+
# values: ["__string"], # required
|
16514
|
+
# },
|
16515
|
+
# },
|
16516
|
+
# event_type: {
|
16517
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16518
|
+
# values: ["__string"], # required
|
16519
|
+
# },
|
16520
|
+
# metrics: {
|
16521
|
+
# "__string" => {
|
16522
|
+
# comparison_operator: "__string", # required
|
16523
|
+
# value: 1.0, # required
|
16524
|
+
# },
|
16525
|
+
# },
|
16526
|
+
# },
|
16527
|
+
# message_activity: "__string",
|
16528
|
+
# },
|
16529
|
+
# segment_condition: {
|
16530
|
+
# segment_id: "__string", # required
|
16531
|
+
# },
|
16532
|
+
# segment_dimensions: {
|
16533
|
+
# attributes: {
|
16534
|
+
# "__string" => {
|
16535
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16536
|
+
# values: ["__string"], # required
|
16537
|
+
# },
|
16538
|
+
# },
|
16539
|
+
# behavior: {
|
16540
|
+
# recency: {
|
16541
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
16542
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
16543
|
+
# },
|
16544
|
+
# },
|
16545
|
+
# demographic: {
|
16546
|
+
# app_version: {
|
16547
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16548
|
+
# values: ["__string"], # required
|
16549
|
+
# },
|
16550
|
+
# channel: {
|
16551
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16552
|
+
# values: ["__string"], # required
|
16553
|
+
# },
|
16554
|
+
# device_type: {
|
16555
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16556
|
+
# values: ["__string"], # required
|
16557
|
+
# },
|
16558
|
+
# make: {
|
16559
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16560
|
+
# values: ["__string"], # required
|
16561
|
+
# },
|
16562
|
+
# model: {
|
16563
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16564
|
+
# values: ["__string"], # required
|
16565
|
+
# },
|
16566
|
+
# platform: {
|
16567
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16568
|
+
# values: ["__string"], # required
|
16569
|
+
# },
|
16570
|
+
# },
|
16571
|
+
# location: {
|
16572
|
+
# country: {
|
16573
|
+
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16574
|
+
# values: ["__string"], # required
|
16575
|
+
# },
|
16576
|
+
# gps_point: {
|
16577
|
+
# coordinates: { # required
|
16578
|
+
# latitude: 1.0, # required
|
16579
|
+
# longitude: 1.0, # required
|
16580
|
+
# },
|
16581
|
+
# range_in_kilometers: 1.0,
|
16582
|
+
# },
|
16583
|
+
# },
|
16584
|
+
# metrics: {
|
16585
|
+
# "__string" => {
|
16586
|
+
# comparison_operator: "__string", # required
|
16587
|
+
# value: 1.0, # required
|
16588
|
+
# },
|
16589
|
+
# },
|
16590
|
+
# user_attributes: {
|
16591
|
+
# "__string" => {
|
16592
|
+
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
16593
|
+
# values: ["__string"], # required
|
16594
|
+
# },
|
16595
|
+
# },
|
16596
|
+
# },
|
16597
|
+
# },
|
16598
|
+
# next_activity: "__string",
|
16599
|
+
# },
|
16600
|
+
# ],
|
16601
|
+
# default_activity: "__string",
|
16602
|
+
# evaluation_wait_time: {
|
16603
|
+
# wait_for: "__string",
|
16604
|
+
# wait_until: "__string",
|
16605
|
+
# },
|
16606
|
+
# },
|
16607
|
+
# random_split: {
|
16608
|
+
# branches: [
|
16609
|
+
# {
|
16610
|
+
# next_activity: "__string",
|
16611
|
+
# percentage: 1,
|
16612
|
+
# },
|
16613
|
+
# ],
|
16614
|
+
# },
|
16615
|
+
# wait: {
|
16616
|
+
# next_activity: "__string",
|
16617
|
+
# wait_time: {
|
16618
|
+
# wait_for: "__string",
|
16619
|
+
# wait_until: "__string",
|
16620
|
+
# },
|
16621
|
+
# },
|
16622
|
+
# },
|
16623
|
+
# },
|
16624
|
+
# creation_date: "__string",
|
16625
|
+
# last_modified_date: "__string",
|
16626
|
+
# limits: {
|
16627
|
+
# daily_cap: 1,
|
16628
|
+
# endpoint_reentry_cap: 1,
|
16629
|
+
# messages_per_second: 1,
|
16630
|
+
# },
|
16631
|
+
# local_time: false,
|
16632
|
+
# name: "__string", # required
|
16633
|
+
# quiet_time: {
|
16634
|
+
# end: "__string",
|
16635
|
+
# start: "__string",
|
16636
|
+
# },
|
16637
|
+
# refresh_frequency: "__string",
|
16638
|
+
# schedule: {
|
16639
|
+
# end_time: Time.now,
|
16640
|
+
# start_time: Time.now,
|
16641
|
+
# timezone: "__string",
|
16642
|
+
# },
|
16643
|
+
# start_activity: "__string",
|
16644
|
+
# start_condition: {
|
16645
|
+
# description: "__string",
|
16646
|
+
# segment_start_condition: {
|
16647
|
+
# segment_id: "__string", # required
|
16648
|
+
# },
|
16649
|
+
# },
|
16650
|
+
# state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
|
16651
|
+
# }
|
16652
|
+
#
|
16653
|
+
# @!attribute [rw] activities
|
16654
|
+
# The configuration and other settings for the activities that
|
16655
|
+
# comprise the journey.
|
16656
|
+
# @return [Hash<String,Types::Activity>]
|
16657
|
+
#
|
16658
|
+
# @!attribute [rw] creation_date
|
16659
|
+
# The date, in ISO 8601 format, when the journey was created.
|
16660
|
+
# @return [String]
|
16661
|
+
#
|
16662
|
+
# @!attribute [rw] last_modified_date
|
16663
|
+
# The date, in ISO 8601 format, when the journey was last modified.
|
16664
|
+
# @return [String]
|
16665
|
+
#
|
16666
|
+
# @!attribute [rw] limits
|
16667
|
+
# The messaging and entry limits for the journey.
|
16668
|
+
# @return [Types::JourneyLimits]
|
16669
|
+
#
|
16670
|
+
# @!attribute [rw] local_time
|
16671
|
+
# Specifies whether the journey's scheduled start and end times use
|
16672
|
+
# each participant's local time. To base the schedule on each
|
16673
|
+
# participant's local time, set this value to true.
|
16674
|
+
# @return [Boolean]
|
16675
|
+
#
|
16676
|
+
# @!attribute [rw] name
|
16677
|
+
# The name of the journey. A journey name can contain a maximum of 150
|
16678
|
+
# characters. The characters can be alphanumeric characters or
|
16679
|
+
# symbols, such as underscores (\_) or hyphens (-). A journey name
|
16680
|
+
# can't contain any spaces.
|
16681
|
+
# @return [String]
|
16682
|
+
#
|
16683
|
+
# @!attribute [rw] quiet_time
|
16684
|
+
# The quiet time settings for the journey. Quiet time is a specific
|
16685
|
+
# time range when a journey doesn't send messages to participants, if
|
16686
|
+
# all the following conditions are met:
|
16687
|
+
#
|
16688
|
+
# * The EndpointDemographic.Timezone property of the endpoint for the
|
16689
|
+
# participant is set to a valid value.
|
16690
|
+
#
|
16691
|
+
# * The current time in the participant's time zone is later than or
|
16692
|
+
# equal to the time specified by the QuietTime.Start property for
|
16693
|
+
# the journey.
|
16694
|
+
#
|
16695
|
+
# * The current time in the participant's time zone is earlier than
|
16696
|
+
# or equal to the time specified by the QuietTime.End property for
|
16697
|
+
# the journey.
|
16698
|
+
#
|
16699
|
+
# If any of the preceding conditions isn't met, the participant will
|
16700
|
+
# receive messages from the journey, even if quiet time is enabled.
|
16701
|
+
# @return [Types::QuietTime]
|
16702
|
+
#
|
16703
|
+
# @!attribute [rw] refresh_frequency
|
16704
|
+
# The frequency with which Amazon Pinpoint evaluates segment and event
|
16705
|
+
# data for the journey, as a duration in ISO 8601 format.
|
16706
|
+
# @return [String]
|
16707
|
+
#
|
16708
|
+
# @!attribute [rw] schedule
|
16709
|
+
# The schedule settings for the journey.
|
16710
|
+
# @return [Types::JourneySchedule]
|
16711
|
+
#
|
16712
|
+
# @!attribute [rw] start_activity
|
16713
|
+
# The unique identifier for the first activity in the journey.
|
16714
|
+
# @return [String]
|
16715
|
+
#
|
16716
|
+
# @!attribute [rw] start_condition
|
16717
|
+
# The segment that defines which users are participants in the
|
16718
|
+
# journey.
|
16719
|
+
# @return [Types::StartCondition]
|
16720
|
+
#
|
16721
|
+
# @!attribute [rw] state
|
16722
|
+
# The status of the journey. Valid values are:
|
16723
|
+
#
|
16724
|
+
# * DRAFT - Saves the journey and doesn't publish it.
|
16725
|
+
#
|
16726
|
+
# * ACTIVE - Saves and publishes the journey. Depending on the
|
16727
|
+
# journey's schedule, the journey starts running immediately or at
|
16728
|
+
# the scheduled start time. If a journey's status is ACTIVE, you
|
16729
|
+
# can't add, change, or remove activities from it.
|
16730
|
+
#
|
16731
|
+
# The CANCELLED, COMPLETED, and CLOSED values are not supported in
|
16732
|
+
# requests to create or update a journey. To cancel a journey, use the
|
16733
|
+
# <link linkend="apps-application-id-journeys-journey-id-state" />
|
16734
|
+
#
|
16735
|
+
# Journey State</link> resource.
|
16736
|
+
# @return [String]
|
16737
|
+
#
|
16738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteJourneyRequest AWS API Documentation
|
16739
|
+
#
|
16740
|
+
class WriteJourneyRequest < Struct.new(
|
16741
|
+
:activities,
|
16742
|
+
:creation_date,
|
16743
|
+
:last_modified_date,
|
16744
|
+
:limits,
|
16745
|
+
:local_time,
|
16746
|
+
:name,
|
16747
|
+
:quiet_time,
|
16748
|
+
:refresh_frequency,
|
16749
|
+
:schedule,
|
16750
|
+
:start_activity,
|
16751
|
+
:start_condition,
|
16752
|
+
:state)
|
16753
|
+
include Aws::Structure
|
16754
|
+
end
|
16755
|
+
|
13730
16756
|
# Specifies the configuration, dimension, and other settings for a
|
13731
16757
|
# segment. A WriteSegmentRequest object can include a Dimensions object
|
13732
16758
|
# or a SegmentGroups object, but not both.
|