aws-sdk-pinpoint 1.6.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +119 -41
- data/lib/aws-sdk-pinpoint/client_api.rb +104 -0
- data/lib/aws-sdk-pinpoint/types.rb +747 -129
- metadata +2 -2
@@ -20,15 +20,18 @@ module Aws::Pinpoint
|
|
20
20
|
# }
|
21
21
|
#
|
22
22
|
# @!attribute [rw] client_id
|
23
|
-
# Client ID
|
23
|
+
# The Client ID that you obtained from the Amazon App Distribution
|
24
|
+
# Portal.
|
24
25
|
# @return [String]
|
25
26
|
#
|
26
27
|
# @!attribute [rw] client_secret
|
27
|
-
# Client
|
28
|
+
# The Client Secret that you obtained from the Amazon App Distribution
|
29
|
+
# Portal.
|
28
30
|
# @return [String]
|
29
31
|
#
|
30
32
|
# @!attribute [rw] enabled
|
31
|
-
#
|
33
|
+
# Indicates whether or not the channel is enabled for sending
|
34
|
+
# messages.
|
32
35
|
# @return [Boolean]
|
33
36
|
#
|
34
37
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ADMChannelRequest AWS API Documentation
|
@@ -47,11 +50,12 @@ module Aws::Pinpoint
|
|
47
50
|
# @return [String]
|
48
51
|
#
|
49
52
|
# @!attribute [rw] creation_date
|
50
|
-
#
|
53
|
+
# The date and time when this channel was created.
|
51
54
|
# @return [String]
|
52
55
|
#
|
53
56
|
# @!attribute [rw] enabled
|
54
|
-
#
|
57
|
+
# Indicates whether or not the channel is enabled for sending
|
58
|
+
# messages.
|
55
59
|
# @return [Boolean]
|
56
60
|
#
|
57
61
|
# @!attribute [rw] has_credential
|
@@ -59,27 +63,28 @@ module Aws::Pinpoint
|
|
59
63
|
# @return [Boolean]
|
60
64
|
#
|
61
65
|
# @!attribute [rw] id
|
62
|
-
#
|
66
|
+
# (Deprecated) An identifier for the channel. Retained for backwards
|
67
|
+
# compatibility.
|
63
68
|
# @return [String]
|
64
69
|
#
|
65
70
|
# @!attribute [rw] is_archived
|
66
|
-
#
|
71
|
+
# Indicates whether or not the channel is archived.
|
67
72
|
# @return [Boolean]
|
68
73
|
#
|
69
74
|
# @!attribute [rw] last_modified_by
|
70
|
-
#
|
75
|
+
# The user who last updated this channel.
|
71
76
|
# @return [String]
|
72
77
|
#
|
73
78
|
# @!attribute [rw] last_modified_date
|
74
|
-
#
|
79
|
+
# The date and time when this channel was last modified.
|
75
80
|
# @return [String]
|
76
81
|
#
|
77
82
|
# @!attribute [rw] platform
|
78
|
-
#
|
83
|
+
# The platform type. For this channel, the value is always "ADM."
|
79
84
|
# @return [String]
|
80
85
|
#
|
81
86
|
# @!attribute [rw] version
|
82
|
-
#
|
87
|
+
# The channel version.
|
83
88
|
# @return [Integer]
|
84
89
|
#
|
85
90
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ADMChannelResponse AWS API Documentation
|
@@ -138,8 +143,7 @@ module Aws::Pinpoint
|
|
138
143
|
# @return [String]
|
139
144
|
#
|
140
145
|
# @!attribute [rw] body
|
141
|
-
# The message body of the notification
|
142
|
-
# message.
|
146
|
+
# The message body of the notification.
|
143
147
|
# @return [String]
|
144
148
|
#
|
145
149
|
# @!attribute [rw] consolidation_key
|
@@ -301,11 +305,11 @@ module Aws::Pinpoint
|
|
301
305
|
# Apple Distribution Push Notification Service channel definition.
|
302
306
|
#
|
303
307
|
# @!attribute [rw] application_id
|
304
|
-
# The ID of the application
|
308
|
+
# The ID of the application that the channel applies to.
|
305
309
|
# @return [String]
|
306
310
|
#
|
307
311
|
# @!attribute [rw] creation_date
|
308
|
-
#
|
312
|
+
# The date and time when this channel was created.
|
309
313
|
# @return [String]
|
310
314
|
#
|
311
315
|
# @!attribute [rw] default_authentication_method
|
@@ -327,27 +331,28 @@ module Aws::Pinpoint
|
|
327
331
|
# @return [Boolean]
|
328
332
|
#
|
329
333
|
# @!attribute [rw] id
|
330
|
-
#
|
334
|
+
# (Deprecated) An identifier for the channel. Retained for backwards
|
335
|
+
# compatibility.
|
331
336
|
# @return [String]
|
332
337
|
#
|
333
338
|
# @!attribute [rw] is_archived
|
334
|
-
#
|
339
|
+
# Indicates whether or not the channel is archived.
|
335
340
|
# @return [Boolean]
|
336
341
|
#
|
337
342
|
# @!attribute [rw] last_modified_by
|
338
|
-
#
|
343
|
+
# The user who last updated this channel.
|
339
344
|
# @return [String]
|
340
345
|
#
|
341
346
|
# @!attribute [rw] last_modified_date
|
342
|
-
#
|
347
|
+
# The date and time when this channel was last modified.
|
343
348
|
# @return [String]
|
344
349
|
#
|
345
350
|
# @!attribute [rw] platform
|
346
|
-
# The platform type.
|
351
|
+
# The platform type. For this channel, the value is always "ADM."
|
347
352
|
# @return [String]
|
348
353
|
#
|
349
354
|
# @!attribute [rw] version
|
350
|
-
#
|
355
|
+
# The channel version.
|
351
356
|
# @return [Integer]
|
352
357
|
#
|
353
358
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/APNSChannelResponse AWS API Documentation
|
@@ -416,8 +421,7 @@ module Aws::Pinpoint
|
|
416
421
|
# @return [Integer]
|
417
422
|
#
|
418
423
|
# @!attribute [rw] body
|
419
|
-
# The message body of the notification
|
420
|
-
# message.
|
424
|
+
# The message body of the notification.
|
421
425
|
# @return [String]
|
422
426
|
#
|
423
427
|
# @!attribute [rw] category
|
@@ -932,10 +936,16 @@ module Aws::Pinpoint
|
|
932
936
|
# List of campaign activities
|
933
937
|
# @return [Array<Types::ActivityResponse>]
|
934
938
|
#
|
939
|
+
# @!attribute [rw] next_token
|
940
|
+
# The string that you use in a subsequent request to get the next page
|
941
|
+
# of results in a paginated response.
|
942
|
+
# @return [String]
|
943
|
+
#
|
935
944
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ActivitiesResponse AWS API Documentation
|
936
945
|
#
|
937
946
|
class ActivitiesResponse < Struct.new(
|
938
|
-
:item
|
947
|
+
:item,
|
948
|
+
:next_token)
|
939
949
|
include Aws::Structure
|
940
950
|
end
|
941
951
|
|
@@ -1339,8 +1349,7 @@ module Aws::Pinpoint
|
|
1339
1349
|
# @return [String]
|
1340
1350
|
#
|
1341
1351
|
# @!attribute [rw] body
|
1342
|
-
# The message body of the notification
|
1343
|
-
# message.
|
1352
|
+
# The message body of the notification.
|
1344
1353
|
# @return [String]
|
1345
1354
|
#
|
1346
1355
|
# @!attribute [rw] data
|
@@ -2317,7 +2326,7 @@ module Aws::Pinpoint
|
|
2317
2326
|
# version: 1,
|
2318
2327
|
# },
|
2319
2328
|
# ],
|
2320
|
-
# source_type: "ALL", # accepts ALL, ANY
|
2329
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
2321
2330
|
# type: "ALL", # accepts ALL, ANY, NONE
|
2322
2331
|
# },
|
2323
2332
|
# ],
|
@@ -2352,7 +2361,7 @@ module Aws::Pinpoint
|
|
2352
2361
|
include Aws::Structure
|
2353
2362
|
end
|
2354
2363
|
|
2355
|
-
#
|
2364
|
+
# The default message to use across all channels.
|
2356
2365
|
#
|
2357
2366
|
# @note When making an API call, you may pass DefaultMessage
|
2358
2367
|
# data as a hash:
|
@@ -2413,8 +2422,7 @@ module Aws::Pinpoint
|
|
2413
2422
|
# @return [String]
|
2414
2423
|
#
|
2415
2424
|
# @!attribute [rw] body
|
2416
|
-
# The message body of the notification
|
2417
|
-
# message.
|
2425
|
+
# The message body of the notification.
|
2418
2426
|
# @return [String]
|
2419
2427
|
#
|
2420
2428
|
# @!attribute [rw] data
|
@@ -3235,7 +3243,7 @@ module Aws::Pinpoint
|
|
3235
3243
|
# address varies by channel. For mobile push channels, use the token
|
3236
3244
|
# provided by the push notification service, such as the APNs device
|
3237
3245
|
# token or the FCM registration token. For the SMS channel, use a
|
3238
|
-
# phone number in E.164 format, such as +
|
3246
|
+
# phone number in E.164 format, such as +12065550100. For the email
|
3239
3247
|
# channel, use an email address.
|
3240
3248
|
# @return [String]
|
3241
3249
|
#
|
@@ -3373,7 +3381,7 @@ module Aws::Pinpoint
|
|
3373
3381
|
include Aws::Structure
|
3374
3382
|
end
|
3375
3383
|
|
3376
|
-
#
|
3384
|
+
# Demographic information about the endpoint.
|
3377
3385
|
#
|
3378
3386
|
# @note When making an API call, you may pass EndpointDemographic
|
3379
3387
|
# data as a hash:
|
@@ -3400,23 +3408,23 @@ module Aws::Pinpoint
|
|
3400
3408
|
# @return [String]
|
3401
3409
|
#
|
3402
3410
|
# @!attribute [rw] make
|
3403
|
-
# The endpoint
|
3411
|
+
# The manufacturer of the endpoint device, such as Apple or Samsung.
|
3404
3412
|
# @return [String]
|
3405
3413
|
#
|
3406
3414
|
# @!attribute [rw] model
|
3407
|
-
# The endpoint
|
3415
|
+
# The model name or number of the endpoint device, such as iPhone.
|
3408
3416
|
# @return [String]
|
3409
3417
|
#
|
3410
3418
|
# @!attribute [rw] model_version
|
3411
|
-
# The
|
3419
|
+
# The model version of the endpoint device.
|
3412
3420
|
# @return [String]
|
3413
3421
|
#
|
3414
3422
|
# @!attribute [rw] platform
|
3415
|
-
# The endpoint
|
3423
|
+
# The platform of the endpoint device, such as iOS or Android.
|
3416
3424
|
# @return [String]
|
3417
3425
|
#
|
3418
3426
|
# @!attribute [rw] platform_version
|
3419
|
-
# The
|
3427
|
+
# The platform version of the endpoint device.
|
3420
3428
|
# @return [String]
|
3421
3429
|
#
|
3422
3430
|
# @!attribute [rw] timezone
|
@@ -3438,7 +3446,28 @@ module Aws::Pinpoint
|
|
3438
3446
|
include Aws::Structure
|
3439
3447
|
end
|
3440
3448
|
|
3441
|
-
#
|
3449
|
+
# The responses that are returned after you create or update an endpoint
|
3450
|
+
# and record an event.
|
3451
|
+
#
|
3452
|
+
# @!attribute [rw] message
|
3453
|
+
# A custom message associated with the registration of an endpoint
|
3454
|
+
# when issuing a response.
|
3455
|
+
# @return [String]
|
3456
|
+
#
|
3457
|
+
# @!attribute [rw] status_code
|
3458
|
+
# The status code to respond with for a particular endpoint id after
|
3459
|
+
# endpoint registration
|
3460
|
+
# @return [Integer]
|
3461
|
+
#
|
3462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointItemResponse AWS API Documentation
|
3463
|
+
#
|
3464
|
+
class EndpointItemResponse < Struct.new(
|
3465
|
+
:message,
|
3466
|
+
:status_code)
|
3467
|
+
include Aws::Structure
|
3468
|
+
end
|
3469
|
+
|
3470
|
+
# Location data for the endpoint.
|
3442
3471
|
#
|
3443
3472
|
# @note When making an API call, you may pass EndpointLocation
|
3444
3473
|
# data as a hash:
|
@@ -3457,17 +3486,18 @@ module Aws::Pinpoint
|
|
3457
3486
|
# @return [String]
|
3458
3487
|
#
|
3459
3488
|
# @!attribute [rw] country
|
3460
|
-
#
|
3489
|
+
# The two-letter code for the country or region of the endpoint.
|
3490
|
+
# Specified as an ISO 3166-1 Alpha-2 code, such as "US" for the
|
3491
|
+
# United States.
|
3461
3492
|
# @return [String]
|
3462
3493
|
#
|
3463
3494
|
# @!attribute [rw] latitude
|
3464
|
-
# The latitude of the endpoint location
|
3465
|
-
# (Roughly corresponding to a mile).
|
3495
|
+
# The latitude of the endpoint location, rounded to one decimal place.
|
3466
3496
|
# @return [Float]
|
3467
3497
|
#
|
3468
3498
|
# @!attribute [rw] longitude
|
3469
|
-
# The longitude of the endpoint location
|
3470
|
-
#
|
3499
|
+
# The longitude of the endpoint location, rounded to one decimal
|
3500
|
+
# place.
|
3471
3501
|
# @return [Float]
|
3472
3502
|
#
|
3473
3503
|
# @!attribute [rw] postal_code
|
@@ -3475,8 +3505,8 @@ module Aws::Pinpoint
|
|
3475
3505
|
# @return [String]
|
3476
3506
|
#
|
3477
3507
|
# @!attribute [rw] region
|
3478
|
-
# The region of the endpoint location. For example,
|
3479
|
-
#
|
3508
|
+
# The region of the endpoint location. For example, in the United
|
3509
|
+
# States, this corresponds to a state.
|
3480
3510
|
# @return [String]
|
3481
3511
|
#
|
3482
3512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointLocation AWS API Documentation
|
@@ -3498,7 +3528,22 @@ module Aws::Pinpoint
|
|
3498
3528
|
# @return [String]
|
3499
3529
|
#
|
3500
3530
|
# @!attribute [rw] delivery_status
|
3501
|
-
#
|
3531
|
+
# The delivery status of the message. Possible values: SUCCESS - The
|
3532
|
+
# message was successfully delivered to the endpoint.
|
3533
|
+
# TRANSIENT\_FAILURE - A temporary error occurred. Amazon Pinpoint
|
3534
|
+
# will attempt to deliver the message again later. FAILURE\_PERMANENT
|
3535
|
+
# - An error occurred when delivering the message to the endpoint.
|
3536
|
+
# Amazon Pinpoint won't attempt to send the message again. TIMEOUT -
|
3537
|
+
# The message couldn't be sent within the timeout period. QUIET\_TIME
|
3538
|
+
# - The local time for the endpoint was within the Quiet Hours for the
|
3539
|
+
# campaign. DAILY\_CAP - The endpoint has received the maximum number
|
3540
|
+
# of messages it can receive within a 24-hour period. HOLDOUT - The
|
3541
|
+
# endpoint was in a hold out treatment for the campaign. THROTTLED -
|
3542
|
+
# Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The
|
3543
|
+
# endpoint address is expired. CAMPAIGN\_CAP - The endpoint received
|
3544
|
+
# the maximum number of messages allowed by the campaign.
|
3545
|
+
# SERVICE\_FAILURE - A service-level failure prevented Amazon Pinpoint
|
3546
|
+
# from delivering the message. UNKNOWN - An unknown error occurred.
|
3502
3547
|
# @return [String]
|
3503
3548
|
#
|
3504
3549
|
# @!attribute [rw] message_id
|
@@ -3578,7 +3623,7 @@ module Aws::Pinpoint
|
|
3578
3623
|
# address varies by channel. For mobile push channels, use the token
|
3579
3624
|
# provided by the push notification service, such as the APNs device
|
3580
3625
|
# token or the FCM registration token. For the SMS channel, use a
|
3581
|
-
# phone number in E.164 format, such as +
|
3626
|
+
# phone number in E.164 format, such as +12065550100. For the email
|
3582
3627
|
# channel, use an email address.
|
3583
3628
|
# @return [String]
|
3584
3629
|
#
|
@@ -3600,11 +3645,12 @@ module Aws::Pinpoint
|
|
3600
3645
|
# @return [String]
|
3601
3646
|
#
|
3602
3647
|
# @!attribute [rw] demographic
|
3603
|
-
#
|
3648
|
+
# Demographic attributes for the endpoint.
|
3604
3649
|
# @return [Types::EndpointDemographic]
|
3605
3650
|
#
|
3606
3651
|
# @!attribute [rw] effective_date
|
3607
|
-
# The
|
3652
|
+
# The date and time when the endpoint was updated, shown in ISO 8601
|
3653
|
+
# format.
|
3608
3654
|
# @return [String]
|
3609
3655
|
#
|
3610
3656
|
# @!attribute [rw] endpoint_status
|
@@ -3654,24 +3700,24 @@ module Aws::Pinpoint
|
|
3654
3700
|
# Endpoint response
|
3655
3701
|
#
|
3656
3702
|
# @!attribute [rw] address
|
3657
|
-
# The address
|
3658
|
-
#
|
3703
|
+
# The address of the endpoint as provided by your push provider. For
|
3704
|
+
# example, the DeviceToken or RegistrationId.
|
3659
3705
|
# @return [String]
|
3660
3706
|
#
|
3661
3707
|
# @!attribute [rw] application_id
|
3662
|
-
# The ID of the application associated with the endpoint.
|
3708
|
+
# The ID of the application that is associated with the endpoint.
|
3663
3709
|
# @return [String]
|
3664
3710
|
#
|
3665
3711
|
# @!attribute [rw] attributes
|
3666
3712
|
# Custom attributes that describe the endpoint by associating a name
|
3667
3713
|
# with an array of values. For example, an attribute named
|
3668
|
-
# "interests" might have the values \["science",
|
3669
|
-
# "travel"\]. You can use these attributes as
|
3670
|
-
# when you create
|
3671
|
-
#
|
3672
|
-
#
|
3673
|
-
#
|
3674
|
-
#
|
3714
|
+
# "interests" might have the following values: \["science",
|
3715
|
+
# "politics", "travel"\]. You can use these attributes as
|
3716
|
+
# selection criteria when you create segments. The Amazon Pinpoint
|
3717
|
+
# console can't display attribute names that include the following
|
3718
|
+
# characters: hash/pound sign (#), colon (:), question mark (?),
|
3719
|
+
# backslash (\\), and forward slash (/). For this reason, you should
|
3720
|
+
# avoid using these characters in the names of custom attributes.
|
3675
3721
|
# @return [Hash<String,Array<String>>]
|
3676
3722
|
#
|
3677
3723
|
# @!attribute [rw] channel_type
|
@@ -3680,7 +3726,7 @@ module Aws::Pinpoint
|
|
3680
3726
|
# @return [String]
|
3681
3727
|
#
|
3682
3728
|
# @!attribute [rw] cohort_id
|
3683
|
-
# A number from 0
|
3729
|
+
# A number from 0-99 that represents the cohort the endpoint is
|
3684
3730
|
# assigned to. Endpoints are grouped into cohorts randomly, and each
|
3685
3731
|
# cohort contains approximately 1 percent of the endpoints for an app.
|
3686
3732
|
# Amazon Pinpoint assigns cohorts to the holdout or treatment
|
@@ -3688,7 +3734,8 @@ module Aws::Pinpoint
|
|
3688
3734
|
# @return [String]
|
3689
3735
|
#
|
3690
3736
|
# @!attribute [rw] creation_date
|
3691
|
-
# The
|
3737
|
+
# The date and time when the endpoint was created, shown in ISO 8601
|
3738
|
+
# format.
|
3692
3739
|
# @return [String]
|
3693
3740
|
#
|
3694
3741
|
# @!attribute [rw] demographic
|
@@ -3696,7 +3743,8 @@ module Aws::Pinpoint
|
|
3696
3743
|
# @return [Types::EndpointDemographic]
|
3697
3744
|
#
|
3698
3745
|
# @!attribute [rw] effective_date
|
3699
|
-
# The
|
3746
|
+
# The date and time when the endpoint was last updated, shown in ISO
|
3747
|
+
# 8601 format.
|
3700
3748
|
# @return [String]
|
3701
3749
|
#
|
3702
3750
|
# @!attribute [rw] endpoint_status
|
@@ -3705,8 +3753,8 @@ module Aws::Pinpoint
|
|
3705
3753
|
#
|
3706
3754
|
# @!attribute [rw] id
|
3707
3755
|
# The unique ID that you assigned to the endpoint. The ID should be a
|
3708
|
-
# globally unique identifier (GUID) to ensure that it
|
3709
|
-
#
|
3756
|
+
# globally unique identifier (GUID) to ensure that it doesn't
|
3757
|
+
# conflict with other endpoint IDs associated with the application.
|
3710
3758
|
# @return [String]
|
3711
3759
|
#
|
3712
3760
|
# @!attribute [rw] location
|
@@ -3821,15 +3869,15 @@ module Aws::Pinpoint
|
|
3821
3869
|
# }
|
3822
3870
|
#
|
3823
3871
|
# @!attribute [rw] user_attributes
|
3824
|
-
# Custom attributes that describe
|
3825
|
-
#
|
3826
|
-
#
|
3872
|
+
# Custom attributes that describe the user by associating a name with
|
3873
|
+
# an array of values. For example, an attribute named "interests"
|
3874
|
+
# might have the following values: \["science", "politics",
|
3827
3875
|
# "travel"\]. You can use these attributes as selection criteria
|
3828
|
-
# when you create
|
3829
|
-
#
|
3830
|
-
#
|
3831
|
-
#
|
3832
|
-
#
|
3876
|
+
# when you create segments. The Amazon Pinpoint console can't display
|
3877
|
+
# attribute names that include the following characters: hash/pound
|
3878
|
+
# sign (#), colon (:), question mark (?), backslash (\\), and forward
|
3879
|
+
# slash (/). For this reason, you should avoid using these characters
|
3880
|
+
# in the names of custom attributes.
|
3833
3881
|
# @return [Hash<String,Array<String>>]
|
3834
3882
|
#
|
3835
3883
|
# @!attribute [rw] user_id
|
@@ -3857,6 +3905,84 @@ module Aws::Pinpoint
|
|
3857
3905
|
include Aws::Structure
|
3858
3906
|
end
|
3859
3907
|
|
3908
|
+
# Model for creating or updating events.
|
3909
|
+
#
|
3910
|
+
# @note When making an API call, you may pass Event
|
3911
|
+
# data as a hash:
|
3912
|
+
#
|
3913
|
+
# {
|
3914
|
+
# attributes: {
|
3915
|
+
# "__string" => "__string",
|
3916
|
+
# },
|
3917
|
+
# client_sdk_version: "__string",
|
3918
|
+
# event_type: "__string",
|
3919
|
+
# metrics: {
|
3920
|
+
# "__string" => 1.0,
|
3921
|
+
# },
|
3922
|
+
# session: {
|
3923
|
+
# duration: 1,
|
3924
|
+
# id: "__string",
|
3925
|
+
# start_timestamp: "__string",
|
3926
|
+
# stop_timestamp: "__string",
|
3927
|
+
# },
|
3928
|
+
# timestamp: "__string",
|
3929
|
+
# }
|
3930
|
+
#
|
3931
|
+
# @!attribute [rw] attributes
|
3932
|
+
# Custom attributes that are associated with the event you're adding
|
3933
|
+
# or updating.
|
3934
|
+
# @return [Hash<String,String>]
|
3935
|
+
#
|
3936
|
+
# @!attribute [rw] client_sdk_version
|
3937
|
+
# The version of the SDK that's running on the client device.
|
3938
|
+
# @return [String]
|
3939
|
+
#
|
3940
|
+
# @!attribute [rw] event_type
|
3941
|
+
# The name of the custom event that you're recording.
|
3942
|
+
# @return [String]
|
3943
|
+
#
|
3944
|
+
# @!attribute [rw] metrics
|
3945
|
+
# Event metrics
|
3946
|
+
# @return [Hash<String,Float>]
|
3947
|
+
#
|
3948
|
+
# @!attribute [rw] session
|
3949
|
+
# The session
|
3950
|
+
# @return [Types::Session]
|
3951
|
+
#
|
3952
|
+
# @!attribute [rw] timestamp
|
3953
|
+
# The date and time when the event occurred, in ISO 8601 format.
|
3954
|
+
# @return [String]
|
3955
|
+
#
|
3956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Event AWS API Documentation
|
3957
|
+
#
|
3958
|
+
class Event < Struct.new(
|
3959
|
+
:attributes,
|
3960
|
+
:client_sdk_version,
|
3961
|
+
:event_type,
|
3962
|
+
:metrics,
|
3963
|
+
:session,
|
3964
|
+
:timestamp)
|
3965
|
+
include Aws::Structure
|
3966
|
+
end
|
3967
|
+
|
3968
|
+
# The responses that are returned after you record an event.
|
3969
|
+
#
|
3970
|
+
# @!attribute [rw] message
|
3971
|
+
# A custom message that is associated with the processing of an event.
|
3972
|
+
# @return [String]
|
3973
|
+
#
|
3974
|
+
# @!attribute [rw] status_code
|
3975
|
+
# The status code to respond with for a particular event id
|
3976
|
+
# @return [Integer]
|
3977
|
+
#
|
3978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventItemResponse AWS API Documentation
|
3979
|
+
#
|
3980
|
+
class EventItemResponse < Struct.new(
|
3981
|
+
:message,
|
3982
|
+
:status_code)
|
3983
|
+
include Aws::Structure
|
3984
|
+
end
|
3985
|
+
|
3860
3986
|
# Model for an event publishing subscription export.
|
3861
3987
|
#
|
3862
3988
|
# @!attribute [rw] application_id
|
@@ -3872,7 +3998,7 @@ module Aws::Pinpoint
|
|
3872
3998
|
# @return [String]
|
3873
3999
|
#
|
3874
4000
|
# @!attribute [rw] external_id
|
3875
|
-
#
|
4001
|
+
# (Deprecated) Your AWS account ID, which you assigned to the
|
3876
4002
|
# ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to
|
3877
4003
|
# assume an IAM role. This requirement is removed, and external IDs
|
3878
4004
|
# are not recommended for IAM roles assumed by Amazon Pinpoint.
|
@@ -3903,6 +4029,183 @@ module Aws::Pinpoint
|
|
3903
4029
|
include Aws::Structure
|
3904
4030
|
end
|
3905
4031
|
|
4032
|
+
# Events batch definition
|
4033
|
+
#
|
4034
|
+
# @note When making an API call, you may pass EventsBatch
|
4035
|
+
# data as a hash:
|
4036
|
+
#
|
4037
|
+
# {
|
4038
|
+
# endpoint: {
|
4039
|
+
# address: "__string",
|
4040
|
+
# attributes: {
|
4041
|
+
# "__string" => ["__string"],
|
4042
|
+
# },
|
4043
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
|
4044
|
+
# demographic: {
|
4045
|
+
# app_version: "__string",
|
4046
|
+
# locale: "__string",
|
4047
|
+
# make: "__string",
|
4048
|
+
# model: "__string",
|
4049
|
+
# model_version: "__string",
|
4050
|
+
# platform: "__string",
|
4051
|
+
# platform_version: "__string",
|
4052
|
+
# timezone: "__string",
|
4053
|
+
# },
|
4054
|
+
# effective_date: "__string",
|
4055
|
+
# endpoint_status: "__string",
|
4056
|
+
# location: {
|
4057
|
+
# city: "__string",
|
4058
|
+
# country: "__string",
|
4059
|
+
# latitude: 1.0,
|
4060
|
+
# longitude: 1.0,
|
4061
|
+
# postal_code: "__string",
|
4062
|
+
# region: "__string",
|
4063
|
+
# },
|
4064
|
+
# metrics: {
|
4065
|
+
# "__string" => 1.0,
|
4066
|
+
# },
|
4067
|
+
# opt_out: "__string",
|
4068
|
+
# request_id: "__string",
|
4069
|
+
# user: {
|
4070
|
+
# user_attributes: {
|
4071
|
+
# "__string" => ["__string"],
|
4072
|
+
# },
|
4073
|
+
# user_id: "__string",
|
4074
|
+
# },
|
4075
|
+
# },
|
4076
|
+
# events: {
|
4077
|
+
# "__string" => {
|
4078
|
+
# attributes: {
|
4079
|
+
# "__string" => "__string",
|
4080
|
+
# },
|
4081
|
+
# client_sdk_version: "__string",
|
4082
|
+
# event_type: "__string",
|
4083
|
+
# metrics: {
|
4084
|
+
# "__string" => 1.0,
|
4085
|
+
# },
|
4086
|
+
# session: {
|
4087
|
+
# duration: 1,
|
4088
|
+
# id: "__string",
|
4089
|
+
# start_timestamp: "__string",
|
4090
|
+
# stop_timestamp: "__string",
|
4091
|
+
# },
|
4092
|
+
# timestamp: "__string",
|
4093
|
+
# },
|
4094
|
+
# },
|
4095
|
+
# }
|
4096
|
+
#
|
4097
|
+
# @!attribute [rw] endpoint
|
4098
|
+
# Endpoint information
|
4099
|
+
# @return [Types::PublicEndpoint]
|
4100
|
+
#
|
4101
|
+
# @!attribute [rw] events
|
4102
|
+
# Events
|
4103
|
+
# @return [Hash<String,Types::Event>]
|
4104
|
+
#
|
4105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventsBatch AWS API Documentation
|
4106
|
+
#
|
4107
|
+
class EventsBatch < Struct.new(
|
4108
|
+
:endpoint,
|
4109
|
+
:events)
|
4110
|
+
include Aws::Structure
|
4111
|
+
end
|
4112
|
+
|
4113
|
+
# Put Events request
|
4114
|
+
#
|
4115
|
+
# @note When making an API call, you may pass EventsRequest
|
4116
|
+
# data as a hash:
|
4117
|
+
#
|
4118
|
+
# {
|
4119
|
+
# batch_item: {
|
4120
|
+
# "__string" => {
|
4121
|
+
# endpoint: {
|
4122
|
+
# address: "__string",
|
4123
|
+
# attributes: {
|
4124
|
+
# "__string" => ["__string"],
|
4125
|
+
# },
|
4126
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
|
4127
|
+
# demographic: {
|
4128
|
+
# app_version: "__string",
|
4129
|
+
# locale: "__string",
|
4130
|
+
# make: "__string",
|
4131
|
+
# model: "__string",
|
4132
|
+
# model_version: "__string",
|
4133
|
+
# platform: "__string",
|
4134
|
+
# platform_version: "__string",
|
4135
|
+
# timezone: "__string",
|
4136
|
+
# },
|
4137
|
+
# effective_date: "__string",
|
4138
|
+
# endpoint_status: "__string",
|
4139
|
+
# location: {
|
4140
|
+
# city: "__string",
|
4141
|
+
# country: "__string",
|
4142
|
+
# latitude: 1.0,
|
4143
|
+
# longitude: 1.0,
|
4144
|
+
# postal_code: "__string",
|
4145
|
+
# region: "__string",
|
4146
|
+
# },
|
4147
|
+
# metrics: {
|
4148
|
+
# "__string" => 1.0,
|
4149
|
+
# },
|
4150
|
+
# opt_out: "__string",
|
4151
|
+
# request_id: "__string",
|
4152
|
+
# user: {
|
4153
|
+
# user_attributes: {
|
4154
|
+
# "__string" => ["__string"],
|
4155
|
+
# },
|
4156
|
+
# user_id: "__string",
|
4157
|
+
# },
|
4158
|
+
# },
|
4159
|
+
# events: {
|
4160
|
+
# "__string" => {
|
4161
|
+
# attributes: {
|
4162
|
+
# "__string" => "__string",
|
4163
|
+
# },
|
4164
|
+
# client_sdk_version: "__string",
|
4165
|
+
# event_type: "__string",
|
4166
|
+
# metrics: {
|
4167
|
+
# "__string" => 1.0,
|
4168
|
+
# },
|
4169
|
+
# session: {
|
4170
|
+
# duration: 1,
|
4171
|
+
# id: "__string",
|
4172
|
+
# start_timestamp: "__string",
|
4173
|
+
# stop_timestamp: "__string",
|
4174
|
+
# },
|
4175
|
+
# timestamp: "__string",
|
4176
|
+
# },
|
4177
|
+
# },
|
4178
|
+
# },
|
4179
|
+
# },
|
4180
|
+
# }
|
4181
|
+
#
|
4182
|
+
# @!attribute [rw] batch_item
|
4183
|
+
# Batch of events with endpoint id as the key and an object of
|
4184
|
+
# EventsBatch as value. The EventsBatch object has the PublicEndpoint
|
4185
|
+
# and a map of event Id's to events
|
4186
|
+
# @return [Hash<String,Types::EventsBatch>]
|
4187
|
+
#
|
4188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventsRequest AWS API Documentation
|
4189
|
+
#
|
4190
|
+
class EventsRequest < Struct.new(
|
4191
|
+
:batch_item)
|
4192
|
+
include Aws::Structure
|
4193
|
+
end
|
4194
|
+
|
4195
|
+
# The results from processing a put events request
|
4196
|
+
#
|
4197
|
+
# @!attribute [rw] results
|
4198
|
+
# A map containing a multi part response for each endpoint, with the
|
4199
|
+
# endpoint id as the key and item response as the value
|
4200
|
+
# @return [Hash<String,Types::ItemResponse>]
|
4201
|
+
#
|
4202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventsResponse AWS API Documentation
|
4203
|
+
#
|
4204
|
+
class EventsResponse < Struct.new(
|
4205
|
+
:results)
|
4206
|
+
include Aws::Structure
|
4207
|
+
end
|
4208
|
+
|
3906
4209
|
# Export job request.
|
3907
4210
|
#
|
3908
4211
|
# @note When making an API call, you may pass ExportJobRequest
|
@@ -3988,7 +4291,7 @@ module Aws::Pinpoint
|
|
3988
4291
|
# Export job response.
|
3989
4292
|
#
|
3990
4293
|
# @!attribute [rw] application_id
|
3991
|
-
# The unique ID of the application
|
4294
|
+
# The unique ID of the application associated with the export job.
|
3992
4295
|
# @return [String]
|
3993
4296
|
#
|
3994
4297
|
# @!attribute [rw] completed_pieces
|
@@ -4214,8 +4517,7 @@ module Aws::Pinpoint
|
|
4214
4517
|
# @return [String]
|
4215
4518
|
#
|
4216
4519
|
# @!attribute [rw] body
|
4217
|
-
# The message body of the notification
|
4218
|
-
# message.
|
4520
|
+
# The message body of the notification.
|
4219
4521
|
# @return [String]
|
4220
4522
|
#
|
4221
4523
|
# @!attribute [rw] collapse_key
|
@@ -5443,7 +5745,7 @@ module Aws::Pinpoint
|
|
5443
5745
|
# @return [Boolean]
|
5444
5746
|
#
|
5445
5747
|
# @!attribute [rw] external_id
|
5446
|
-
#
|
5748
|
+
# (Deprecated) Your AWS account ID, which you assigned to the
|
5447
5749
|
# ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to
|
5448
5750
|
# assume an IAM role. This requirement is removed, and external IDs
|
5449
5751
|
# are not recommended for IAM roles assumed by Amazon Pinpoint.
|
@@ -5466,10 +5768,10 @@ module Aws::Pinpoint
|
|
5466
5768
|
# @return [String]
|
5467
5769
|
#
|
5468
5770
|
# @!attribute [rw] s3_url
|
5469
|
-
#
|
5470
|
-
#
|
5471
|
-
#
|
5472
|
-
# s3://bucket-name/folder-name/file-name Amazon Pinpoint
|
5771
|
+
# The URL of the S3 bucket that contains the segment information to
|
5772
|
+
# import. The location can be a folder or a single file. The URL
|
5773
|
+
# should use the following format:
|
5774
|
+
# s3://bucket-name/folder-name/file-name Amazon Pinpoint imports
|
5473
5775
|
# endpoints from this location and any subfolders it contains.
|
5474
5776
|
# @return [String]
|
5475
5777
|
#
|
@@ -5504,7 +5806,7 @@ module Aws::Pinpoint
|
|
5504
5806
|
# @return [Boolean]
|
5505
5807
|
#
|
5506
5808
|
# @!attribute [rw] external_id
|
5507
|
-
#
|
5809
|
+
# (Deprecated) Your AWS account ID, which you assigned to the
|
5508
5810
|
# ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to
|
5509
5811
|
# assume an IAM role. This requirement is removed, and external IDs
|
5510
5812
|
# are not recommended for IAM roles assumed by Amazon Pinpoint.
|
@@ -5527,10 +5829,10 @@ module Aws::Pinpoint
|
|
5527
5829
|
# @return [String]
|
5528
5830
|
#
|
5529
5831
|
# @!attribute [rw] s3_url
|
5530
|
-
#
|
5531
|
-
#
|
5532
|
-
#
|
5533
|
-
# s3://bucket-name/folder-name/file-name Amazon Pinpoint
|
5832
|
+
# The URL of the S3 bucket that contains the segment information to
|
5833
|
+
# import. The location can be a folder or a single file. The URL
|
5834
|
+
# should use the following format:
|
5835
|
+
# s3://bucket-name/folder-name/file-name Amazon Pinpoint imports
|
5534
5836
|
# endpoints from this location and any subfolders it contains.
|
5535
5837
|
# @return [String]
|
5536
5838
|
#
|
@@ -5658,6 +5960,25 @@ module Aws::Pinpoint
|
|
5658
5960
|
include Aws::Structure
|
5659
5961
|
end
|
5660
5962
|
|
5963
|
+
# The endpoint and events combined response definition
|
5964
|
+
#
|
5965
|
+
# @!attribute [rw] endpoint_item_response
|
5966
|
+
# Endpoint item response after endpoint registration
|
5967
|
+
# @return [Types::EndpointItemResponse]
|
5968
|
+
#
|
5969
|
+
# @!attribute [rw] events_item_response
|
5970
|
+
# Events item response is a multipart response object per event Id,
|
5971
|
+
# with eventId as the key and EventItemResponse object as the value
|
5972
|
+
# @return [Hash<String,Types::EventItemResponse>]
|
5973
|
+
#
|
5974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ItemResponse AWS API Documentation
|
5975
|
+
#
|
5976
|
+
class ItemResponse < Struct.new(
|
5977
|
+
:endpoint_item_response,
|
5978
|
+
:events_item_response)
|
5979
|
+
include Aws::Structure
|
5980
|
+
end
|
5981
|
+
|
5661
5982
|
# Message to send
|
5662
5983
|
#
|
5663
5984
|
# @note When making an API call, you may pass Message
|
@@ -6070,6 +6391,7 @@ module Aws::Pinpoint
|
|
6070
6391
|
# },
|
6071
6392
|
# },
|
6072
6393
|
# },
|
6394
|
+
# trace_id: "__string",
|
6073
6395
|
# }
|
6074
6396
|
#
|
6075
6397
|
# @!attribute [rw] addresses
|
@@ -6096,13 +6418,19 @@ module Aws::Pinpoint
|
|
6096
6418
|
# Message configuration.
|
6097
6419
|
# @return [Types::DirectMessageConfiguration]
|
6098
6420
|
#
|
6421
|
+
# @!attribute [rw] trace_id
|
6422
|
+
# A unique ID that you can use to trace a message. This ID is visible
|
6423
|
+
# to recipients.
|
6424
|
+
# @return [String]
|
6425
|
+
#
|
6099
6426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MessageRequest AWS API Documentation
|
6100
6427
|
#
|
6101
6428
|
class MessageRequest < Struct.new(
|
6102
6429
|
:addresses,
|
6103
6430
|
:context,
|
6104
6431
|
:endpoints,
|
6105
|
-
:message_configuration
|
6432
|
+
:message_configuration,
|
6433
|
+
:trace_id)
|
6106
6434
|
include Aws::Structure
|
6107
6435
|
end
|
6108
6436
|
|
@@ -6140,7 +6468,22 @@ module Aws::Pinpoint
|
|
6140
6468
|
# The result from sending a message to an address.
|
6141
6469
|
#
|
6142
6470
|
# @!attribute [rw] delivery_status
|
6143
|
-
#
|
6471
|
+
# The delivery status of the message. Possible values: SUCCESS - The
|
6472
|
+
# message was successfully delivered to the endpoint.
|
6473
|
+
# TRANSIENT\_FAILURE - A temporary error occurred. Amazon Pinpoint
|
6474
|
+
# will attempt to deliver the message again later. FAILURE\_PERMANENT
|
6475
|
+
# - An error occurred when delivering the message to the endpoint.
|
6476
|
+
# Amazon Pinpoint won't attempt to send the message again. TIMEOUT -
|
6477
|
+
# The message couldn't be sent within the timeout period. QUIET\_TIME
|
6478
|
+
# - The local time for the endpoint was within the Quiet Hours for the
|
6479
|
+
# campaign. DAILY\_CAP - The endpoint has received the maximum number
|
6480
|
+
# of messages it can receive within a 24-hour period. HOLDOUT - The
|
6481
|
+
# endpoint was in a hold out treatment for the campaign. THROTTLED -
|
6482
|
+
# Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The
|
6483
|
+
# endpoint address is expired. CAMPAIGN\_CAP - The endpoint received
|
6484
|
+
# the maximum number of messages allowed by the campaign.
|
6485
|
+
# SERVICE\_FAILURE - A service-level failure prevented Amazon Pinpoint
|
6486
|
+
# from delivering the message. UNKNOWN - An unknown error occurred.
|
6144
6487
|
# @return [String]
|
6145
6488
|
#
|
6146
6489
|
# @!attribute [rw] message_id
|
@@ -6208,12 +6551,15 @@ module Aws::Pinpoint
|
|
6208
6551
|
# }
|
6209
6552
|
#
|
6210
6553
|
# @!attribute [rw] iso_country_code
|
6211
|
-
# (Optional) The two-character ISO country code for the country
|
6212
|
-
# the phone number was originally registered.
|
6554
|
+
# (Optional) The two-character ISO country code for the country or
|
6555
|
+
# region where the phone number was originally registered.
|
6213
6556
|
# @return [String]
|
6214
6557
|
#
|
6215
6558
|
# @!attribute [rw] phone_number
|
6216
|
-
# The phone number to get information about.
|
6559
|
+
# The phone number to get information about. The phone number that you
|
6560
|
+
# provide should include a country code. If the number doesn't
|
6561
|
+
# include a valid country code, the operation might result in an
|
6562
|
+
# error.
|
6217
6563
|
# @return [String]
|
6218
6564
|
#
|
6219
6565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/NumberValidateRequest AWS API Documentation
|
@@ -6227,7 +6573,8 @@ module Aws::Pinpoint
|
|
6227
6573
|
# Phone Number Information response.
|
6228
6574
|
#
|
6229
6575
|
# @!attribute [rw] carrier
|
6230
|
-
# The carrier that the phone number is
|
6576
|
+
# The carrier or servive provider that the phone number is currently
|
6577
|
+
# registered with.
|
6231
6578
|
# @return [String]
|
6232
6579
|
#
|
6233
6580
|
# @!attribute [rw] city
|
@@ -6235,25 +6582,26 @@ module Aws::Pinpoint
|
|
6235
6582
|
# @return [String]
|
6236
6583
|
#
|
6237
6584
|
# @!attribute [rw] cleansed_phone_number_e164
|
6238
|
-
# The cleansed
|
6585
|
+
# The cleansed phone number, shown in E.164 format.
|
6239
6586
|
# @return [String]
|
6240
6587
|
#
|
6241
6588
|
# @!attribute [rw] cleansed_phone_number_national
|
6242
|
-
# The cleansed phone number in
|
6589
|
+
# The cleansed phone number, shown in the local phone number format.
|
6243
6590
|
# @return [String]
|
6244
6591
|
#
|
6245
6592
|
# @!attribute [rw] country
|
6246
|
-
# The country where the phone number was originally
|
6593
|
+
# The country or region where the phone number was originally
|
6594
|
+
# registered.
|
6247
6595
|
# @return [String]
|
6248
6596
|
#
|
6249
6597
|
# @!attribute [rw] country_code_iso_2
|
6250
|
-
# The two-character ISO
|
6598
|
+
# The two-character ISO code for the country or region where the phone
|
6251
6599
|
# number was originally registered.
|
6252
6600
|
# @return [String]
|
6253
6601
|
#
|
6254
6602
|
# @!attribute [rw] country_code_numeric
|
6255
|
-
# The numeric
|
6256
|
-
# originally registered.
|
6603
|
+
# The numeric code for the country or region where the phone number
|
6604
|
+
# was originally registered.
|
6257
6605
|
# @return [String]
|
6258
6606
|
#
|
6259
6607
|
# @!attribute [rw] county
|
@@ -6261,8 +6609,8 @@ module Aws::Pinpoint
|
|
6261
6609
|
# @return [String]
|
6262
6610
|
#
|
6263
6611
|
# @!attribute [rw] original_country_code_iso_2
|
6264
|
-
# The two-character ISO
|
6265
|
-
# body.
|
6612
|
+
# The two-character ISO code for the country or region that you
|
6613
|
+
# included in the request body.
|
6266
6614
|
# @return [String]
|
6267
6615
|
#
|
6268
6616
|
# @!attribute [rw] original_phone_number
|
@@ -6270,13 +6618,14 @@ module Aws::Pinpoint
|
|
6270
6618
|
# @return [String]
|
6271
6619
|
#
|
6272
6620
|
# @!attribute [rw] phone_type
|
6273
|
-
# A description of the phone type. Possible values
|
6274
|
-
# LANDLINE, VOIP, INVALID, and OTHER.
|
6621
|
+
# A description of the phone type. Possible values are MOBILE,
|
6622
|
+
# LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
|
6275
6623
|
# @return [String]
|
6276
6624
|
#
|
6277
6625
|
# @!attribute [rw] phone_type_code
|
6278
|
-
# The phone type
|
6279
|
-
# (LANDLINE), 2 (VOIP), 3 (INVALID),
|
6626
|
+
# The phone type, represented by an integer. Possible values include 0
|
6627
|
+
# (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5
|
6628
|
+
# (PREPAID).
|
6280
6629
|
# @return [Integer]
|
6281
6630
|
#
|
6282
6631
|
# @!attribute [rw] timezone
|
@@ -6285,8 +6634,8 @@ module Aws::Pinpoint
|
|
6285
6634
|
# @return [String]
|
6286
6635
|
#
|
6287
6636
|
# @!attribute [rw] zip_code
|
6288
|
-
# The
|
6289
|
-
# registered.
|
6637
|
+
# The postal code for the location where the phone number was
|
6638
|
+
# originally registered.
|
6290
6639
|
# @return [String]
|
6291
6640
|
#
|
6292
6641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/NumberValidateResponse AWS API Documentation
|
@@ -6341,6 +6690,120 @@ module Aws::Pinpoint
|
|
6341
6690
|
include Aws::Structure
|
6342
6691
|
end
|
6343
6692
|
|
6693
|
+
# Public endpoint attributes.
|
6694
|
+
#
|
6695
|
+
# @note When making an API call, you may pass PublicEndpoint
|
6696
|
+
# data as a hash:
|
6697
|
+
#
|
6698
|
+
# {
|
6699
|
+
# address: "__string",
|
6700
|
+
# attributes: {
|
6701
|
+
# "__string" => ["__string"],
|
6702
|
+
# },
|
6703
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
|
6704
|
+
# demographic: {
|
6705
|
+
# app_version: "__string",
|
6706
|
+
# locale: "__string",
|
6707
|
+
# make: "__string",
|
6708
|
+
# model: "__string",
|
6709
|
+
# model_version: "__string",
|
6710
|
+
# platform: "__string",
|
6711
|
+
# platform_version: "__string",
|
6712
|
+
# timezone: "__string",
|
6713
|
+
# },
|
6714
|
+
# effective_date: "__string",
|
6715
|
+
# endpoint_status: "__string",
|
6716
|
+
# location: {
|
6717
|
+
# city: "__string",
|
6718
|
+
# country: "__string",
|
6719
|
+
# latitude: 1.0,
|
6720
|
+
# longitude: 1.0,
|
6721
|
+
# postal_code: "__string",
|
6722
|
+
# region: "__string",
|
6723
|
+
# },
|
6724
|
+
# metrics: {
|
6725
|
+
# "__string" => 1.0,
|
6726
|
+
# },
|
6727
|
+
# opt_out: "__string",
|
6728
|
+
# request_id: "__string",
|
6729
|
+
# user: {
|
6730
|
+
# user_attributes: {
|
6731
|
+
# "__string" => ["__string"],
|
6732
|
+
# },
|
6733
|
+
# user_id: "__string",
|
6734
|
+
# },
|
6735
|
+
# }
|
6736
|
+
#
|
6737
|
+
# @!attribute [rw] address
|
6738
|
+
# The unique identifier for the recipient. For example, an address
|
6739
|
+
# could be a device token or an endpoint ID.
|
6740
|
+
# @return [String]
|
6741
|
+
#
|
6742
|
+
# @!attribute [rw] attributes
|
6743
|
+
# Custom attributes that your app reports to Amazon Pinpoint. You can
|
6744
|
+
# use these attributes as selection criteria when you create a
|
6745
|
+
# segment.
|
6746
|
+
# @return [Hash<String,Array<String>>]
|
6747
|
+
#
|
6748
|
+
# @!attribute [rw] channel_type
|
6749
|
+
# The channel type. Valid values: APNS, GCM
|
6750
|
+
# @return [String]
|
6751
|
+
#
|
6752
|
+
# @!attribute [rw] demographic
|
6753
|
+
# The endpoint demographic attributes.
|
6754
|
+
# @return [Types::EndpointDemographic]
|
6755
|
+
#
|
6756
|
+
# @!attribute [rw] effective_date
|
6757
|
+
# The date and time when the endpoint was last updated.
|
6758
|
+
# @return [String]
|
6759
|
+
#
|
6760
|
+
# @!attribute [rw] endpoint_status
|
6761
|
+
# The status of the endpoint. If the update fails, the value is
|
6762
|
+
# INACTIVE. If the endpoint is updated successfully, the value is
|
6763
|
+
# ACTIVE.
|
6764
|
+
# @return [String]
|
6765
|
+
#
|
6766
|
+
# @!attribute [rw] location
|
6767
|
+
# The endpoint location attributes.
|
6768
|
+
# @return [Types::EndpointLocation]
|
6769
|
+
#
|
6770
|
+
# @!attribute [rw] metrics
|
6771
|
+
# Custom metrics that your app reports to Amazon Pinpoint.
|
6772
|
+
# @return [Hash<String,Float>]
|
6773
|
+
#
|
6774
|
+
# @!attribute [rw] opt_out
|
6775
|
+
# Indicates whether a user has opted out of receiving messages with
|
6776
|
+
# one of the following values: ALL - User has opted out of all
|
6777
|
+
# messages. NONE - Users has not opted out and receives all messages.
|
6778
|
+
# @return [String]
|
6779
|
+
#
|
6780
|
+
# @!attribute [rw] request_id
|
6781
|
+
# A unique identifier that is generated each time the endpoint is
|
6782
|
+
# updated.
|
6783
|
+
# @return [String]
|
6784
|
+
#
|
6785
|
+
# @!attribute [rw] user
|
6786
|
+
# Custom user-specific attributes that your app reports to Amazon
|
6787
|
+
# Pinpoint.
|
6788
|
+
# @return [Types::EndpointUser]
|
6789
|
+
#
|
6790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PublicEndpoint AWS API Documentation
|
6791
|
+
#
|
6792
|
+
class PublicEndpoint < Struct.new(
|
6793
|
+
:address,
|
6794
|
+
:attributes,
|
6795
|
+
:channel_type,
|
6796
|
+
:demographic,
|
6797
|
+
:effective_date,
|
6798
|
+
:endpoint_status,
|
6799
|
+
:location,
|
6800
|
+
:metrics,
|
6801
|
+
:opt_out,
|
6802
|
+
:request_id,
|
6803
|
+
:user)
|
6804
|
+
include Aws::Structure
|
6805
|
+
end
|
6806
|
+
|
6344
6807
|
# @note When making an API call, you may pass PutEventStreamRequest
|
6345
6808
|
# data as a hash:
|
6346
6809
|
#
|
@@ -6378,6 +6841,102 @@ module Aws::Pinpoint
|
|
6378
6841
|
include Aws::Structure
|
6379
6842
|
end
|
6380
6843
|
|
6844
|
+
# @note When making an API call, you may pass PutEventsRequest
|
6845
|
+
# data as a hash:
|
6846
|
+
#
|
6847
|
+
# {
|
6848
|
+
# application_id: "__string", # required
|
6849
|
+
# events_request: { # required
|
6850
|
+
# batch_item: {
|
6851
|
+
# "__string" => {
|
6852
|
+
# endpoint: {
|
6853
|
+
# address: "__string",
|
6854
|
+
# attributes: {
|
6855
|
+
# "__string" => ["__string"],
|
6856
|
+
# },
|
6857
|
+
# channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
|
6858
|
+
# demographic: {
|
6859
|
+
# app_version: "__string",
|
6860
|
+
# locale: "__string",
|
6861
|
+
# make: "__string",
|
6862
|
+
# model: "__string",
|
6863
|
+
# model_version: "__string",
|
6864
|
+
# platform: "__string",
|
6865
|
+
# platform_version: "__string",
|
6866
|
+
# timezone: "__string",
|
6867
|
+
# },
|
6868
|
+
# effective_date: "__string",
|
6869
|
+
# endpoint_status: "__string",
|
6870
|
+
# location: {
|
6871
|
+
# city: "__string",
|
6872
|
+
# country: "__string",
|
6873
|
+
# latitude: 1.0,
|
6874
|
+
# longitude: 1.0,
|
6875
|
+
# postal_code: "__string",
|
6876
|
+
# region: "__string",
|
6877
|
+
# },
|
6878
|
+
# metrics: {
|
6879
|
+
# "__string" => 1.0,
|
6880
|
+
# },
|
6881
|
+
# opt_out: "__string",
|
6882
|
+
# request_id: "__string",
|
6883
|
+
# user: {
|
6884
|
+
# user_attributes: {
|
6885
|
+
# "__string" => ["__string"],
|
6886
|
+
# },
|
6887
|
+
# user_id: "__string",
|
6888
|
+
# },
|
6889
|
+
# },
|
6890
|
+
# events: {
|
6891
|
+
# "__string" => {
|
6892
|
+
# attributes: {
|
6893
|
+
# "__string" => "__string",
|
6894
|
+
# },
|
6895
|
+
# client_sdk_version: "__string",
|
6896
|
+
# event_type: "__string",
|
6897
|
+
# metrics: {
|
6898
|
+
# "__string" => 1.0,
|
6899
|
+
# },
|
6900
|
+
# session: {
|
6901
|
+
# duration: 1,
|
6902
|
+
# id: "__string",
|
6903
|
+
# start_timestamp: "__string",
|
6904
|
+
# stop_timestamp: "__string",
|
6905
|
+
# },
|
6906
|
+
# timestamp: "__string",
|
6907
|
+
# },
|
6908
|
+
# },
|
6909
|
+
# },
|
6910
|
+
# },
|
6911
|
+
# },
|
6912
|
+
# }
|
6913
|
+
#
|
6914
|
+
# @!attribute [rw] application_id
|
6915
|
+
# @return [String]
|
6916
|
+
#
|
6917
|
+
# @!attribute [rw] events_request
|
6918
|
+
# Put Events request
|
6919
|
+
# @return [Types::EventsRequest]
|
6920
|
+
#
|
6921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventsRequest AWS API Documentation
|
6922
|
+
#
|
6923
|
+
class PutEventsRequest < Struct.new(
|
6924
|
+
:application_id,
|
6925
|
+
:events_request)
|
6926
|
+
include Aws::Structure
|
6927
|
+
end
|
6928
|
+
|
6929
|
+
# @!attribute [rw] events_response
|
6930
|
+
# The results from processing a put events request
|
6931
|
+
# @return [Types::EventsResponse]
|
6932
|
+
#
|
6933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventsResponse AWS API Documentation
|
6934
|
+
#
|
6935
|
+
class PutEventsResponse < Struct.new(
|
6936
|
+
:events_response)
|
6937
|
+
include Aws::Structure
|
6938
|
+
end
|
6939
|
+
|
6381
6940
|
# Quiet Time
|
6382
6941
|
#
|
6383
6942
|
# @note When making an API call, you may pass QuietTime
|
@@ -6980,7 +7539,7 @@ module Aws::Pinpoint
|
|
6980
7539
|
# version: 1,
|
6981
7540
|
# },
|
6982
7541
|
# ],
|
6983
|
-
# source_type: "ALL", # accepts ALL, ANY
|
7542
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
6984
7543
|
# type: "ALL", # accepts ALL, ANY, NONE
|
6985
7544
|
# }
|
6986
7545
|
#
|
@@ -6989,16 +7548,24 @@ module Aws::Pinpoint
|
|
6989
7548
|
# @return [Array<Types::SegmentDimensions>]
|
6990
7549
|
#
|
6991
7550
|
# @!attribute [rw] source_segments
|
6992
|
-
#
|
6993
|
-
#
|
7551
|
+
# The base segment that you build your segment on. The source segment
|
7552
|
+
# defines the starting "universe" of endpoints. When you add
|
7553
|
+
# dimensions to the segment, it filters the source segment based on
|
7554
|
+
# the dimensions that you specify. You can specify more than one
|
7555
|
+
# dimensional segment. You can only specify one imported segment.
|
6994
7556
|
# @return [Array<Types::SegmentReference>]
|
6995
7557
|
#
|
6996
7558
|
# @!attribute [rw] source_type
|
6997
|
-
#
|
7559
|
+
# Specify how to handle multiple source segments. For example, if you
|
7560
|
+
# specify three source segments, should the resulting segment be based
|
7561
|
+
# on any or all of the segments? Acceptable values: ANY or ALL.
|
6998
7562
|
# @return [String]
|
6999
7563
|
#
|
7000
7564
|
# @!attribute [rw] type
|
7001
|
-
#
|
7565
|
+
# Specify how to handle multiple segment dimensions. For example, if
|
7566
|
+
# you specify three dimensions, should the resulting segment include
|
7567
|
+
# endpoints that are matched by all, any, or none of the dimensions?
|
7568
|
+
# Acceptable values: ALL, ANY, or NONE.
|
7002
7569
|
# @return [String]
|
7003
7570
|
#
|
7004
7571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentGroup AWS API Documentation
|
@@ -7092,7 +7659,7 @@ module Aws::Pinpoint
|
|
7092
7659
|
# version: 1,
|
7093
7660
|
# },
|
7094
7661
|
# ],
|
7095
|
-
# source_type: "ALL", # accepts ALL, ANY
|
7662
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
7096
7663
|
# type: "ALL", # accepts ALL, ANY, NONE
|
7097
7664
|
# },
|
7098
7665
|
# ],
|
@@ -7100,11 +7667,14 @@ module Aws::Pinpoint
|
|
7100
7667
|
# }
|
7101
7668
|
#
|
7102
7669
|
# @!attribute [rw] groups
|
7103
|
-
#
|
7670
|
+
# A set of segment criteria to evaluate.
|
7104
7671
|
# @return [Array<Types::SegmentGroup>]
|
7105
7672
|
#
|
7106
7673
|
# @!attribute [rw] include
|
7107
|
-
#
|
7674
|
+
# Specify how to handle multiple segment groups. For example, if the
|
7675
|
+
# segment includes three segment groups, should the resulting segment
|
7676
|
+
# include endpoints that are matched by all, any, or none of the
|
7677
|
+
# segment groups you created. Acceptable values: ALL, ANY, or NONE.
|
7108
7678
|
# @return [String]
|
7109
7679
|
#
|
7110
7680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentGroupList AWS API Documentation
|
@@ -7118,11 +7688,11 @@ module Aws::Pinpoint
|
|
7118
7688
|
# Segment import definition.
|
7119
7689
|
#
|
7120
7690
|
# @!attribute [rw] channel_counts
|
7121
|
-
#
|
7691
|
+
# The number of channel types in the imported segment.
|
7122
7692
|
# @return [Hash<String,Integer>]
|
7123
7693
|
#
|
7124
7694
|
# @!attribute [rw] external_id
|
7125
|
-
#
|
7695
|
+
# (Deprecated) Your AWS account ID, which you assigned to the
|
7126
7696
|
# ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to
|
7127
7697
|
# assume an IAM role. This requirement is removed, and external IDs
|
7128
7698
|
# are not recommended for IAM roles assumed by Amazon Pinpoint.
|
@@ -7139,8 +7709,7 @@ module Aws::Pinpoint
|
|
7139
7709
|
# @return [String]
|
7140
7710
|
#
|
7141
7711
|
# @!attribute [rw] s3_url
|
7142
|
-
#
|
7143
|
-
# for this segment were imported.
|
7712
|
+
# The URL of the S3 bucket that the segment was imported from.
|
7144
7713
|
# @return [String]
|
7145
7714
|
#
|
7146
7715
|
# @!attribute [rw] size
|
@@ -7206,7 +7775,7 @@ module Aws::Pinpoint
|
|
7206
7775
|
# }
|
7207
7776
|
#
|
7208
7777
|
# @!attribute [rw] id
|
7209
|
-
#
|
7778
|
+
# A unique identifier for the segment.
|
7210
7779
|
# @return [String]
|
7211
7780
|
#
|
7212
7781
|
# @!attribute [rw] version
|
@@ -7224,11 +7793,11 @@ module Aws::Pinpoint
|
|
7224
7793
|
# Segment definition.
|
7225
7794
|
#
|
7226
7795
|
# @!attribute [rw] application_id
|
7227
|
-
# The ID of the application
|
7796
|
+
# The ID of the application that the segment applies to.
|
7228
7797
|
# @return [String]
|
7229
7798
|
#
|
7230
7799
|
# @!attribute [rw] creation_date
|
7231
|
-
# The date the segment was created
|
7800
|
+
# The date and time when the segment was created.
|
7232
7801
|
# @return [String]
|
7233
7802
|
#
|
7234
7803
|
# @!attribute [rw] dimensions
|
@@ -7244,16 +7813,16 @@ module Aws::Pinpoint
|
|
7244
7813
|
# @return [Types::SegmentImportResource]
|
7245
7814
|
#
|
7246
7815
|
# @!attribute [rw] last_modified_date
|
7247
|
-
# The date the segment was last
|
7816
|
+
# The date and time when the segment was last modified.
|
7248
7817
|
# @return [String]
|
7249
7818
|
#
|
7250
7819
|
# @!attribute [rw] name
|
7251
|
-
# The name of segment
|
7820
|
+
# The name of the segment.
|
7252
7821
|
# @return [String]
|
7253
7822
|
#
|
7254
7823
|
# @!attribute [rw] segment_groups
|
7255
|
-
#
|
7256
|
-
#
|
7824
|
+
# A segment group, which consists of zero or more source segments,
|
7825
|
+
# plus dimensions that are applied to those source segments.
|
7257
7826
|
# @return [Types::SegmentGroupList]
|
7258
7827
|
#
|
7259
7828
|
# @!attribute [rw] segment_type
|
@@ -7461,6 +8030,7 @@ module Aws::Pinpoint
|
|
7461
8030
|
# },
|
7462
8031
|
# },
|
7463
8032
|
# },
|
8033
|
+
# trace_id: "__string",
|
7464
8034
|
# },
|
7465
8035
|
# }
|
7466
8036
|
#
|
@@ -7618,6 +8188,7 @@ module Aws::Pinpoint
|
|
7618
8188
|
# },
|
7619
8189
|
# },
|
7620
8190
|
# },
|
8191
|
+
# trace_id: "__string",
|
7621
8192
|
# users: {
|
7622
8193
|
# "__string" => {
|
7623
8194
|
# body_override: "__string",
|
@@ -7645,6 +8216,11 @@ module Aws::Pinpoint
|
|
7645
8216
|
# are tailored for specific channels.
|
7646
8217
|
# @return [Types::DirectMessageConfiguration]
|
7647
8218
|
#
|
8219
|
+
# @!attribute [rw] trace_id
|
8220
|
+
# A unique ID that you can use to trace a message. This ID is visible
|
8221
|
+
# to recipients.
|
8222
|
+
# @return [String]
|
8223
|
+
#
|
7648
8224
|
# @!attribute [rw] users
|
7649
8225
|
# A map that associates user IDs with EndpointSendConfiguration
|
7650
8226
|
# objects. Within an EndpointSendConfiguration object, you can tailor
|
@@ -7657,6 +8233,7 @@ module Aws::Pinpoint
|
|
7657
8233
|
class SendUsersMessageRequest < Struct.new(
|
7658
8234
|
:context,
|
7659
8235
|
:message_configuration,
|
8236
|
+
:trace_id,
|
7660
8237
|
:users)
|
7661
8238
|
include Aws::Structure
|
7662
8239
|
end
|
@@ -7816,6 +8393,7 @@ module Aws::Pinpoint
|
|
7816
8393
|
# },
|
7817
8394
|
# },
|
7818
8395
|
# },
|
8396
|
+
# trace_id: "__string",
|
7819
8397
|
# users: {
|
7820
8398
|
# "__string" => {
|
7821
8399
|
# body_override: "__string",
|
@@ -7858,6 +8436,44 @@ module Aws::Pinpoint
|
|
7858
8436
|
include Aws::Structure
|
7859
8437
|
end
|
7860
8438
|
|
8439
|
+
# Information about a session.
|
8440
|
+
#
|
8441
|
+
# @note When making an API call, you may pass Session
|
8442
|
+
# data as a hash:
|
8443
|
+
#
|
8444
|
+
# {
|
8445
|
+
# duration: 1,
|
8446
|
+
# id: "__string",
|
8447
|
+
# start_timestamp: "__string",
|
8448
|
+
# stop_timestamp: "__string",
|
8449
|
+
# }
|
8450
|
+
#
|
8451
|
+
# @!attribute [rw] duration
|
8452
|
+
# Session duration in millis
|
8453
|
+
# @return [Integer]
|
8454
|
+
#
|
8455
|
+
# @!attribute [rw] id
|
8456
|
+
# A unique identifier for the session.
|
8457
|
+
# @return [String]
|
8458
|
+
#
|
8459
|
+
# @!attribute [rw] start_timestamp
|
8460
|
+
# The date and time when the session began.
|
8461
|
+
# @return [String]
|
8462
|
+
#
|
8463
|
+
# @!attribute [rw] stop_timestamp
|
8464
|
+
# The date and time when the session ended.
|
8465
|
+
# @return [String]
|
8466
|
+
#
|
8467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/Session AWS API Documentation
|
8468
|
+
#
|
8469
|
+
class Session < Struct.new(
|
8470
|
+
:duration,
|
8471
|
+
:id,
|
8472
|
+
:start_timestamp,
|
8473
|
+
:stop_timestamp)
|
8474
|
+
include Aws::Structure
|
8475
|
+
end
|
8476
|
+
|
7861
8477
|
# Dimension specification of a segment.
|
7862
8478
|
#
|
7863
8479
|
# @note When making an API call, you may pass SetDimension
|
@@ -8881,7 +9497,7 @@ module Aws::Pinpoint
|
|
8881
9497
|
# version: 1,
|
8882
9498
|
# },
|
8883
9499
|
# ],
|
8884
|
-
# source_type: "ALL", # accepts ALL, ANY
|
9500
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
8885
9501
|
# type: "ALL", # accepts ALL, ANY, NONE
|
8886
9502
|
# },
|
8887
9503
|
# ],
|
@@ -9486,7 +10102,7 @@ module Aws::Pinpoint
|
|
9486
10102
|
# version: 1,
|
9487
10103
|
# },
|
9488
10104
|
# ],
|
9489
|
-
# source_type: "ALL", # accepts ALL, ANY
|
10105
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
9490
10106
|
# type: "ALL", # accepts ALL, ANY, NONE
|
9491
10107
|
# },
|
9492
10108
|
# ],
|
@@ -9503,8 +10119,10 @@ module Aws::Pinpoint
|
|
9503
10119
|
# @return [String]
|
9504
10120
|
#
|
9505
10121
|
# @!attribute [rw] segment_groups
|
9506
|
-
#
|
9507
|
-
#
|
10122
|
+
# A segment group, which consists of zero or more source segments,
|
10123
|
+
# plus dimensions that are applied to those source segments. Your
|
10124
|
+
# request can only include one segment group. Your request can include
|
10125
|
+
# either a SegmentGroups object or a Dimensions object, but not both.
|
9508
10126
|
# @return [Types::SegmentGroupList]
|
9509
10127
|
#
|
9510
10128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteSegmentRequest AWS API Documentation
|