aws-sdk-pinpoint 1.23.0 → 1.24.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 +320 -233
- data/lib/aws-sdk-pinpoint/client_api.rb +114 -114
- data/lib/aws-sdk-pinpoint/types.rb +2532 -1773
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c38af6d1dff6f4237015e8b926625e049f152efc
|
4
|
+
data.tar.gz: b5edaa680c9989ae2323d9ecc65d29a4ff4ec224
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: de2d899b44c6244b798b55ed828a654b5feacca75e2d1daff71df438510c006b634cb8ef7e2afdc4ea5ab0e5ce419362dfe2719899d8dc05cd3c05a6f6d0c0f2
|
7
|
+
data.tar.gz: 923e7316322d8d4ff0312bcb7b5cd3753444bb1158ee399f6c275b0b82ed24ce76b8842e11aa84ef0c823c6695d537cba8be2fd151712a1560a2024d793cfbda
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -254,10 +254,11 @@ module Aws::Pinpoint
|
|
254
254
|
|
255
255
|
# @!group API Operations
|
256
256
|
|
257
|
-
# Creates
|
257
|
+
# Creates an application.
|
258
258
|
#
|
259
259
|
# @option params [required, Types::CreateApplicationRequest] :create_application_request
|
260
|
-
#
|
260
|
+
# Specifies the display name of an application and the tags to associate
|
261
|
+
# with the application.
|
261
262
|
#
|
262
263
|
# @return [Types::CreateAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
263
264
|
#
|
@@ -267,7 +268,7 @@ module Aws::Pinpoint
|
|
267
268
|
#
|
268
269
|
# resp = client.create_app({
|
269
270
|
# create_application_request: { # required
|
270
|
-
# name: "__string",
|
271
|
+
# name: "__string", # required
|
271
272
|
# tags: {
|
272
273
|
# "__string" => "__string",
|
273
274
|
# },
|
@@ -291,12 +292,13 @@ module Aws::Pinpoint
|
|
291
292
|
req.send_request(options)
|
292
293
|
end
|
293
294
|
|
294
|
-
# Creates or updates
|
295
|
+
# Creates a new campaign for an application or updates the settings of
|
296
|
+
# an existing campaign for an application.
|
295
297
|
#
|
296
298
|
# @option params [required, String] :application_id
|
297
299
|
#
|
298
300
|
# @option params [required, Types::WriteCampaignRequest] :write_campaign_request
|
299
|
-
#
|
301
|
+
# Specifies the configuration and other settings for a campaign.
|
300
302
|
#
|
301
303
|
# @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
302
304
|
#
|
@@ -370,7 +372,7 @@ module Aws::Pinpoint
|
|
370
372
|
# body: "__string",
|
371
373
|
# from_address: "__string",
|
372
374
|
# html_body: "__string",
|
373
|
-
# title: "__string",
|
375
|
+
# title: "__string", # required
|
374
376
|
# },
|
375
377
|
# gcm_message: {
|
376
378
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -395,25 +397,25 @@ module Aws::Pinpoint
|
|
395
397
|
# schedule: {
|
396
398
|
# end_time: "__string",
|
397
399
|
# event_filter: {
|
398
|
-
# dimensions: {
|
400
|
+
# dimensions: { # required
|
399
401
|
# attributes: {
|
400
402
|
# "__string" => {
|
401
403
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
402
|
-
# values: ["__string"],
|
404
|
+
# values: ["__string"], # required
|
403
405
|
# },
|
404
406
|
# },
|
405
407
|
# event_type: {
|
406
408
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
407
|
-
# values: ["__string"],
|
409
|
+
# values: ["__string"], # required
|
408
410
|
# },
|
409
411
|
# metrics: {
|
410
412
|
# "__string" => {
|
411
|
-
# comparison_operator: "__string",
|
412
|
-
# value: 1.0,
|
413
|
+
# comparison_operator: "__string", # required
|
414
|
+
# value: 1.0, # required
|
413
415
|
# },
|
414
416
|
# },
|
415
417
|
# },
|
416
|
-
# filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
|
418
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
417
419
|
# },
|
418
420
|
# frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
|
419
421
|
# is_local_time: false,
|
@@ -421,10 +423,10 @@ module Aws::Pinpoint
|
|
421
423
|
# end: "__string",
|
422
424
|
# start: "__string",
|
423
425
|
# },
|
424
|
-
# start_time: "__string",
|
426
|
+
# start_time: "__string", # required
|
425
427
|
# timezone: "__string",
|
426
428
|
# },
|
427
|
-
# size_percent: 1,
|
429
|
+
# size_percent: 1, # required
|
428
430
|
# treatment_description: "__string",
|
429
431
|
# treatment_name: "__string",
|
430
432
|
# },
|
@@ -504,7 +506,7 @@ module Aws::Pinpoint
|
|
504
506
|
# body: "__string",
|
505
507
|
# from_address: "__string",
|
506
508
|
# html_body: "__string",
|
507
|
-
# title: "__string",
|
509
|
+
# title: "__string", # required
|
508
510
|
# },
|
509
511
|
# gcm_message: {
|
510
512
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -530,25 +532,25 @@ module Aws::Pinpoint
|
|
530
532
|
# schedule: {
|
531
533
|
# end_time: "__string",
|
532
534
|
# event_filter: {
|
533
|
-
# dimensions: {
|
535
|
+
# dimensions: { # required
|
534
536
|
# attributes: {
|
535
537
|
# "__string" => {
|
536
538
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
537
|
-
# values: ["__string"],
|
539
|
+
# values: ["__string"], # required
|
538
540
|
# },
|
539
541
|
# },
|
540
542
|
# event_type: {
|
541
543
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
542
|
-
# values: ["__string"],
|
544
|
+
# values: ["__string"], # required
|
543
545
|
# },
|
544
546
|
# metrics: {
|
545
547
|
# "__string" => {
|
546
|
-
# comparison_operator: "__string",
|
547
|
-
# value: 1.0,
|
548
|
+
# comparison_operator: "__string", # required
|
549
|
+
# value: 1.0, # required
|
548
550
|
# },
|
549
551
|
# },
|
550
552
|
# },
|
551
|
-
# filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
|
553
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
552
554
|
# },
|
553
555
|
# frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
|
554
556
|
# is_local_time: false,
|
@@ -556,7 +558,7 @@ module Aws::Pinpoint
|
|
556
558
|
# end: "__string",
|
557
559
|
# start: "__string",
|
558
560
|
# },
|
559
|
-
# start_time: "__string",
|
561
|
+
# start_time: "__string", # required
|
560
562
|
# timezone: "__string",
|
561
563
|
# },
|
562
564
|
# segment_id: "__string",
|
@@ -782,12 +784,13 @@ module Aws::Pinpoint
|
|
782
784
|
req.send_request(options)
|
783
785
|
end
|
784
786
|
|
785
|
-
# Creates
|
787
|
+
# Creates a new export job for an application.
|
786
788
|
#
|
787
789
|
# @option params [required, String] :application_id
|
788
790
|
#
|
789
791
|
# @option params [required, Types::ExportJobRequest] :export_job_request
|
790
|
-
#
|
792
|
+
# Specifies the settings for a job that exports endpoint definitions to
|
793
|
+
# an Amazon Simple Storage Service (Amazon S3) bucket.
|
791
794
|
#
|
792
795
|
# @return [Types::CreateExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
793
796
|
#
|
@@ -798,8 +801,8 @@ module Aws::Pinpoint
|
|
798
801
|
# resp = client.create_export_job({
|
799
802
|
# application_id: "__string", # required
|
800
803
|
# export_job_request: { # required
|
801
|
-
# role_arn: "__string",
|
802
|
-
# s3_url_prefix: "__string",
|
804
|
+
# role_arn: "__string", # required
|
805
|
+
# s3_url_prefix: "__string", # required
|
803
806
|
# segment_id: "__string",
|
804
807
|
# segment_version: 1,
|
805
808
|
# },
|
@@ -834,12 +837,13 @@ module Aws::Pinpoint
|
|
834
837
|
req.send_request(options)
|
835
838
|
end
|
836
839
|
|
837
|
-
# Creates
|
840
|
+
# Creates a new import job for an application.
|
838
841
|
#
|
839
842
|
# @option params [required, String] :application_id
|
840
843
|
#
|
841
844
|
# @option params [required, Types::ImportJobRequest] :import_job_request
|
842
|
-
#
|
845
|
+
# Specifies the settings for a job that imports endpoint definitions
|
846
|
+
# from an Amazon Simple Storage Service (Amazon S3) bucket.
|
843
847
|
#
|
844
848
|
# @return [Types::CreateImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
845
849
|
#
|
@@ -852,10 +856,10 @@ module Aws::Pinpoint
|
|
852
856
|
# import_job_request: { # required
|
853
857
|
# define_segment: false,
|
854
858
|
# external_id: "__string",
|
855
|
-
# format: "CSV", # accepts CSV, JSON
|
859
|
+
# format: "CSV", # required, accepts CSV, JSON
|
856
860
|
# register_endpoints: false,
|
857
|
-
# role_arn: "__string",
|
858
|
-
# s3_url: "__string",
|
861
|
+
# role_arn: "__string", # required
|
862
|
+
# s3_url: "__string", # required
|
859
863
|
# segment_id: "__string",
|
860
864
|
# segment_name: "__string",
|
861
865
|
# },
|
@@ -894,12 +898,16 @@ module Aws::Pinpoint
|
|
894
898
|
req.send_request(options)
|
895
899
|
end
|
896
900
|
|
897
|
-
#
|
901
|
+
# Creates a new segment for an application or updates the configuration,
|
902
|
+
# dimension, and other settings for an existing segment that's
|
903
|
+
# associated with an application.
|
898
904
|
#
|
899
905
|
# @option params [required, String] :application_id
|
900
906
|
#
|
901
907
|
# @option params [required, Types::WriteSegmentRequest] :write_segment_request
|
902
|
-
#
|
908
|
+
# Specifies the configuration, dimension, and other settings for a
|
909
|
+
# segment. A WriteSegmentRequest object can include a Dimensions object
|
910
|
+
# or a SegmentGroups object, but not both.
|
903
911
|
#
|
904
912
|
# @return [Types::CreateSegmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
905
913
|
#
|
@@ -914,64 +922,64 @@ module Aws::Pinpoint
|
|
914
922
|
# attributes: {
|
915
923
|
# "__string" => {
|
916
924
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
917
|
-
# values: ["__string"],
|
925
|
+
# values: ["__string"], # required
|
918
926
|
# },
|
919
927
|
# },
|
920
928
|
# behavior: {
|
921
929
|
# recency: {
|
922
|
-
# duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
|
923
|
-
# recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
|
930
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
931
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
924
932
|
# },
|
925
933
|
# },
|
926
934
|
# demographic: {
|
927
935
|
# app_version: {
|
928
936
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
929
|
-
# values: ["__string"],
|
937
|
+
# values: ["__string"], # required
|
930
938
|
# },
|
931
939
|
# channel: {
|
932
940
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
933
|
-
# values: ["__string"],
|
941
|
+
# values: ["__string"], # required
|
934
942
|
# },
|
935
943
|
# device_type: {
|
936
944
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
937
|
-
# values: ["__string"],
|
945
|
+
# values: ["__string"], # required
|
938
946
|
# },
|
939
947
|
# make: {
|
940
948
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
941
|
-
# values: ["__string"],
|
949
|
+
# values: ["__string"], # required
|
942
950
|
# },
|
943
951
|
# model: {
|
944
952
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
945
|
-
# values: ["__string"],
|
953
|
+
# values: ["__string"], # required
|
946
954
|
# },
|
947
955
|
# platform: {
|
948
956
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
949
|
-
# values: ["__string"],
|
957
|
+
# values: ["__string"], # required
|
950
958
|
# },
|
951
959
|
# },
|
952
960
|
# location: {
|
953
961
|
# country: {
|
954
962
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
955
|
-
# values: ["__string"],
|
963
|
+
# values: ["__string"], # required
|
956
964
|
# },
|
957
965
|
# gps_point: {
|
958
|
-
# coordinates: {
|
959
|
-
# latitude: 1.0,
|
960
|
-
# longitude: 1.0,
|
966
|
+
# coordinates: { # required
|
967
|
+
# latitude: 1.0, # required
|
968
|
+
# longitude: 1.0, # required
|
961
969
|
# },
|
962
970
|
# range_in_kilometers: 1.0,
|
963
971
|
# },
|
964
972
|
# },
|
965
973
|
# metrics: {
|
966
974
|
# "__string" => {
|
967
|
-
# comparison_operator: "__string",
|
968
|
-
# value: 1.0,
|
975
|
+
# comparison_operator: "__string", # required
|
976
|
+
# value: 1.0, # required
|
969
977
|
# },
|
970
978
|
# },
|
971
979
|
# user_attributes: {
|
972
980
|
# "__string" => {
|
973
981
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
974
|
-
# values: ["__string"],
|
982
|
+
# values: ["__string"], # required
|
975
983
|
# },
|
976
984
|
# },
|
977
985
|
# },
|
@@ -984,71 +992,71 @@ module Aws::Pinpoint
|
|
984
992
|
# attributes: {
|
985
993
|
# "__string" => {
|
986
994
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
987
|
-
# values: ["__string"],
|
995
|
+
# values: ["__string"], # required
|
988
996
|
# },
|
989
997
|
# },
|
990
998
|
# behavior: {
|
991
999
|
# recency: {
|
992
|
-
# duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
|
993
|
-
# recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
|
1000
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
1001
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
994
1002
|
# },
|
995
1003
|
# },
|
996
1004
|
# demographic: {
|
997
1005
|
# app_version: {
|
998
1006
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
999
|
-
# values: ["__string"],
|
1007
|
+
# values: ["__string"], # required
|
1000
1008
|
# },
|
1001
1009
|
# channel: {
|
1002
1010
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1003
|
-
# values: ["__string"],
|
1011
|
+
# values: ["__string"], # required
|
1004
1012
|
# },
|
1005
1013
|
# device_type: {
|
1006
1014
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1007
|
-
# values: ["__string"],
|
1015
|
+
# values: ["__string"], # required
|
1008
1016
|
# },
|
1009
1017
|
# make: {
|
1010
1018
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1011
|
-
# values: ["__string"],
|
1019
|
+
# values: ["__string"], # required
|
1012
1020
|
# },
|
1013
1021
|
# model: {
|
1014
1022
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1015
|
-
# values: ["__string"],
|
1023
|
+
# values: ["__string"], # required
|
1016
1024
|
# },
|
1017
1025
|
# platform: {
|
1018
1026
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1019
|
-
# values: ["__string"],
|
1027
|
+
# values: ["__string"], # required
|
1020
1028
|
# },
|
1021
1029
|
# },
|
1022
1030
|
# location: {
|
1023
1031
|
# country: {
|
1024
1032
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1025
|
-
# values: ["__string"],
|
1033
|
+
# values: ["__string"], # required
|
1026
1034
|
# },
|
1027
1035
|
# gps_point: {
|
1028
|
-
# coordinates: {
|
1029
|
-
# latitude: 1.0,
|
1030
|
-
# longitude: 1.0,
|
1036
|
+
# coordinates: { # required
|
1037
|
+
# latitude: 1.0, # required
|
1038
|
+
# longitude: 1.0, # required
|
1031
1039
|
# },
|
1032
1040
|
# range_in_kilometers: 1.0,
|
1033
1041
|
# },
|
1034
1042
|
# },
|
1035
1043
|
# metrics: {
|
1036
1044
|
# "__string" => {
|
1037
|
-
# comparison_operator: "__string",
|
1038
|
-
# value: 1.0,
|
1045
|
+
# comparison_operator: "__string", # required
|
1046
|
+
# value: 1.0, # required
|
1039
1047
|
# },
|
1040
1048
|
# },
|
1041
1049
|
# user_attributes: {
|
1042
1050
|
# "__string" => {
|
1043
1051
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
1044
|
-
# values: ["__string"],
|
1052
|
+
# values: ["__string"], # required
|
1045
1053
|
# },
|
1046
1054
|
# },
|
1047
1055
|
# },
|
1048
1056
|
# ],
|
1049
1057
|
# source_segments: [
|
1050
1058
|
# {
|
1051
|
-
# id: "__string",
|
1059
|
+
# id: "__string", # required
|
1052
1060
|
# version: 1,
|
1053
1061
|
# },
|
1054
1062
|
# ],
|
@@ -1175,7 +1183,8 @@ module Aws::Pinpoint
|
|
1175
1183
|
req.send_request(options)
|
1176
1184
|
end
|
1177
1185
|
|
1178
|
-
#
|
1186
|
+
# Disables the ADM channel for an application and deletes any existing
|
1187
|
+
# settings for the channel.
|
1179
1188
|
#
|
1180
1189
|
# @option params [required, String] :application_id
|
1181
1190
|
#
|
@@ -1211,7 +1220,8 @@ module Aws::Pinpoint
|
|
1211
1220
|
req.send_request(options)
|
1212
1221
|
end
|
1213
1222
|
|
1214
|
-
#
|
1223
|
+
# Disables the APNs channel for an application and deletes any existing
|
1224
|
+
# settings for the channel.
|
1215
1225
|
#
|
1216
1226
|
# @option params [required, String] :application_id
|
1217
1227
|
#
|
@@ -1249,7 +1259,8 @@ module Aws::Pinpoint
|
|
1249
1259
|
req.send_request(options)
|
1250
1260
|
end
|
1251
1261
|
|
1252
|
-
#
|
1262
|
+
# Disables the APNs sandbox channel for an application and deletes any
|
1263
|
+
# existing settings for the channel.
|
1253
1264
|
#
|
1254
1265
|
# @option params [required, String] :application_id
|
1255
1266
|
#
|
@@ -1287,7 +1298,8 @@ module Aws::Pinpoint
|
|
1287
1298
|
req.send_request(options)
|
1288
1299
|
end
|
1289
1300
|
|
1290
|
-
#
|
1301
|
+
# Disables the APNs VoIP channel for an application and deletes any
|
1302
|
+
# existing settings for the channel.
|
1291
1303
|
#
|
1292
1304
|
# @option params [required, String] :application_id
|
1293
1305
|
#
|
@@ -1325,7 +1337,8 @@ module Aws::Pinpoint
|
|
1325
1337
|
req.send_request(options)
|
1326
1338
|
end
|
1327
1339
|
|
1328
|
-
#
|
1340
|
+
# Disables the APNs VoIP sandbox channel for an application and deletes
|
1341
|
+
# any existing settings for the channel.
|
1329
1342
|
#
|
1330
1343
|
# @option params [required, String] :application_id
|
1331
1344
|
#
|
@@ -1363,7 +1376,7 @@ module Aws::Pinpoint
|
|
1363
1376
|
req.send_request(options)
|
1364
1377
|
end
|
1365
1378
|
|
1366
|
-
# Deletes an
|
1379
|
+
# Deletes an application.
|
1367
1380
|
#
|
1368
1381
|
# @option params [required, String] :application_id
|
1369
1382
|
#
|
@@ -1394,7 +1407,8 @@ module Aws::Pinpoint
|
|
1394
1407
|
req.send_request(options)
|
1395
1408
|
end
|
1396
1409
|
|
1397
|
-
#
|
1410
|
+
# Disables the Baidu channel for an application and deletes any existing
|
1411
|
+
# settings for the channel.
|
1398
1412
|
#
|
1399
1413
|
# @option params [required, String] :application_id
|
1400
1414
|
#
|
@@ -1431,7 +1445,7 @@ module Aws::Pinpoint
|
|
1431
1445
|
req.send_request(options)
|
1432
1446
|
end
|
1433
1447
|
|
1434
|
-
# Deletes a campaign.
|
1448
|
+
# Deletes a campaign from an application.
|
1435
1449
|
#
|
1436
1450
|
# @option params [required, String] :application_id
|
1437
1451
|
#
|
@@ -1661,7 +1675,8 @@ module Aws::Pinpoint
|
|
1661
1675
|
req.send_request(options)
|
1662
1676
|
end
|
1663
1677
|
|
1664
|
-
#
|
1678
|
+
# Disables the email channel for an application and deletes any existing
|
1679
|
+
# settings for the channel.
|
1665
1680
|
#
|
1666
1681
|
# @option params [required, String] :application_id
|
1667
1682
|
#
|
@@ -1702,7 +1717,7 @@ module Aws::Pinpoint
|
|
1702
1717
|
req.send_request(options)
|
1703
1718
|
end
|
1704
1719
|
|
1705
|
-
# Deletes an endpoint.
|
1720
|
+
# Deletes an endpoint from an application.
|
1706
1721
|
#
|
1707
1722
|
# @option params [required, String] :application_id
|
1708
1723
|
#
|
@@ -1764,7 +1779,7 @@ module Aws::Pinpoint
|
|
1764
1779
|
req.send_request(options)
|
1765
1780
|
end
|
1766
1781
|
|
1767
|
-
# Deletes the event stream for an
|
1782
|
+
# Deletes the event stream for an application.
|
1768
1783
|
#
|
1769
1784
|
# @option params [required, String] :application_id
|
1770
1785
|
#
|
@@ -1796,7 +1811,8 @@ module Aws::Pinpoint
|
|
1796
1811
|
req.send_request(options)
|
1797
1812
|
end
|
1798
1813
|
|
1799
|
-
#
|
1814
|
+
# Disables the GCM channel for an application and deletes any existing
|
1815
|
+
# settings for the channel.
|
1800
1816
|
#
|
1801
1817
|
# @option params [required, String] :application_id
|
1802
1818
|
#
|
@@ -1833,7 +1849,7 @@ module Aws::Pinpoint
|
|
1833
1849
|
req.send_request(options)
|
1834
1850
|
end
|
1835
1851
|
|
1836
|
-
# Deletes a segment.
|
1852
|
+
# Deletes a segment from an application.
|
1837
1853
|
#
|
1838
1854
|
# @option params [required, String] :application_id
|
1839
1855
|
#
|
@@ -1961,7 +1977,8 @@ module Aws::Pinpoint
|
|
1961
1977
|
req.send_request(options)
|
1962
1978
|
end
|
1963
1979
|
|
1964
|
-
#
|
1980
|
+
# Disables the SMS channel for an application and deletes any existing
|
1981
|
+
# settings for the channel.
|
1965
1982
|
#
|
1966
1983
|
# @option params [required, String] :application_id
|
1967
1984
|
#
|
@@ -2001,7 +2018,7 @@ module Aws::Pinpoint
|
|
2001
2018
|
req.send_request(options)
|
2002
2019
|
end
|
2003
2020
|
|
2004
|
-
# Deletes endpoints that are associated with a
|
2021
|
+
# Deletes all the endpoints that are associated with a specific user ID.
|
2005
2022
|
#
|
2006
2023
|
# @option params [required, String] :application_id
|
2007
2024
|
#
|
@@ -2064,7 +2081,8 @@ module Aws::Pinpoint
|
|
2064
2081
|
req.send_request(options)
|
2065
2082
|
end
|
2066
2083
|
|
2067
|
-
#
|
2084
|
+
# Disables the voice channel for an application and deletes any existing
|
2085
|
+
# settings for the channel.
|
2068
2086
|
#
|
2069
2087
|
# @option params [required, String] :application_id
|
2070
2088
|
#
|
@@ -2100,7 +2118,8 @@ module Aws::Pinpoint
|
|
2100
2118
|
req.send_request(options)
|
2101
2119
|
end
|
2102
2120
|
|
2103
|
-
#
|
2121
|
+
# Retrieves information about the status and settings of the ADM channel
|
2122
|
+
# for an application.
|
2104
2123
|
#
|
2105
2124
|
# @option params [required, String] :application_id
|
2106
2125
|
#
|
@@ -2136,7 +2155,8 @@ module Aws::Pinpoint
|
|
2136
2155
|
req.send_request(options)
|
2137
2156
|
end
|
2138
2157
|
|
2139
|
-
#
|
2158
|
+
# Retrieves information about the status and settings of the APNs
|
2159
|
+
# channel for an application.
|
2140
2160
|
#
|
2141
2161
|
# @option params [required, String] :application_id
|
2142
2162
|
#
|
@@ -2174,7 +2194,8 @@ module Aws::Pinpoint
|
|
2174
2194
|
req.send_request(options)
|
2175
2195
|
end
|
2176
2196
|
|
2177
|
-
#
|
2197
|
+
# Retrieves information about the status and settings of the APNs
|
2198
|
+
# sandbox channel for an application.
|
2178
2199
|
#
|
2179
2200
|
# @option params [required, String] :application_id
|
2180
2201
|
#
|
@@ -2212,7 +2233,8 @@ module Aws::Pinpoint
|
|
2212
2233
|
req.send_request(options)
|
2213
2234
|
end
|
2214
2235
|
|
2215
|
-
#
|
2236
|
+
# Retrieves information about the status and settings of the APNs VoIP
|
2237
|
+
# channel for an application.
|
2216
2238
|
#
|
2217
2239
|
# @option params [required, String] :application_id
|
2218
2240
|
#
|
@@ -2250,7 +2272,8 @@ module Aws::Pinpoint
|
|
2250
2272
|
req.send_request(options)
|
2251
2273
|
end
|
2252
2274
|
|
2253
|
-
#
|
2275
|
+
# Retrieves information about the status and settings of the APNs VoIP
|
2276
|
+
# sandbox channel for an application.
|
2254
2277
|
#
|
2255
2278
|
# @option params [required, String] :application_id
|
2256
2279
|
#
|
@@ -2288,7 +2311,7 @@ module Aws::Pinpoint
|
|
2288
2311
|
req.send_request(options)
|
2289
2312
|
end
|
2290
2313
|
|
2291
|
-
#
|
2314
|
+
# Retrieves information about an application.
|
2292
2315
|
#
|
2293
2316
|
# @option params [required, String] :application_id
|
2294
2317
|
#
|
@@ -2319,7 +2342,7 @@ module Aws::Pinpoint
|
|
2319
2342
|
req.send_request(options)
|
2320
2343
|
end
|
2321
2344
|
|
2322
|
-
#
|
2345
|
+
# Retrieves information about the settings for an application.
|
2323
2346
|
#
|
2324
2347
|
# @option params [required, String] :application_id
|
2325
2348
|
#
|
@@ -2356,7 +2379,7 @@ module Aws::Pinpoint
|
|
2356
2379
|
req.send_request(options)
|
2357
2380
|
end
|
2358
2381
|
|
2359
|
-
#
|
2382
|
+
# Retrieves information about all of your applications.
|
2360
2383
|
#
|
2361
2384
|
# @option params [String] :page_size
|
2362
2385
|
#
|
@@ -2392,7 +2415,8 @@ module Aws::Pinpoint
|
|
2392
2415
|
req.send_request(options)
|
2393
2416
|
end
|
2394
2417
|
|
2395
|
-
#
|
2418
|
+
# Retrieves information about the status and settings of the Baidu Cloud
|
2419
|
+
# Push channel for an application.
|
2396
2420
|
#
|
2397
2421
|
# @option params [required, String] :application_id
|
2398
2422
|
#
|
@@ -2429,7 +2453,8 @@ module Aws::Pinpoint
|
|
2429
2453
|
req.send_request(options)
|
2430
2454
|
end
|
2431
2455
|
|
2432
|
-
#
|
2456
|
+
# Retrieves information about the status, configuration, and other
|
2457
|
+
# settings for a campaign.
|
2433
2458
|
#
|
2434
2459
|
# @option params [required, String] :application_id
|
2435
2460
|
#
|
@@ -2659,7 +2684,7 @@ module Aws::Pinpoint
|
|
2659
2684
|
req.send_request(options)
|
2660
2685
|
end
|
2661
2686
|
|
2662
|
-
#
|
2687
|
+
# Retrieves information about the activity performed by a campaign.
|
2663
2688
|
#
|
2664
2689
|
# @option params [required, String] :application_id
|
2665
2690
|
#
|
@@ -2709,7 +2734,8 @@ module Aws::Pinpoint
|
|
2709
2734
|
req.send_request(options)
|
2710
2735
|
end
|
2711
2736
|
|
2712
|
-
#
|
2737
|
+
# Retrieves information about the status, configuration, and other
|
2738
|
+
# settings for a specific version of a campaign.
|
2713
2739
|
#
|
2714
2740
|
# @option params [required, String] :application_id
|
2715
2741
|
#
|
@@ -2942,7 +2968,8 @@ module Aws::Pinpoint
|
|
2942
2968
|
req.send_request(options)
|
2943
2969
|
end
|
2944
2970
|
|
2945
|
-
#
|
2971
|
+
# Retrieves information about the status, configuration, and other
|
2972
|
+
# settings for all versions of a specific campaign.
|
2946
2973
|
#
|
2947
2974
|
# @option params [required, String] :application_id
|
2948
2975
|
#
|
@@ -3180,7 +3207,9 @@ module Aws::Pinpoint
|
|
3180
3207
|
req.send_request(options)
|
3181
3208
|
end
|
3182
3209
|
|
3183
|
-
#
|
3210
|
+
# Retrieves information about the status, configuration, and other
|
3211
|
+
# settings for all the campaigns that are associated with an
|
3212
|
+
# application.
|
3184
3213
|
#
|
3185
3214
|
# @option params [required, String] :application_id
|
3186
3215
|
#
|
@@ -3415,7 +3444,8 @@ module Aws::Pinpoint
|
|
3415
3444
|
req.send_request(options)
|
3416
3445
|
end
|
3417
3446
|
|
3418
|
-
#
|
3447
|
+
# Retrieves information about the history and status of each channel for
|
3448
|
+
# an application.
|
3419
3449
|
#
|
3420
3450
|
# @option params [required, String] :application_id
|
3421
3451
|
#
|
@@ -3451,7 +3481,8 @@ module Aws::Pinpoint
|
|
3451
3481
|
req.send_request(options)
|
3452
3482
|
end
|
3453
3483
|
|
3454
|
-
#
|
3484
|
+
# Retrieves information about the status and settings of the email
|
3485
|
+
# channel for an application.
|
3455
3486
|
#
|
3456
3487
|
# @option params [required, String] :application_id
|
3457
3488
|
#
|
@@ -3492,7 +3523,8 @@ module Aws::Pinpoint
|
|
3492
3523
|
req.send_request(options)
|
3493
3524
|
end
|
3494
3525
|
|
3495
|
-
#
|
3526
|
+
# Retrieves information about the settings and attributes of a specific
|
3527
|
+
# endpoint for an application.
|
3496
3528
|
#
|
3497
3529
|
# @option params [required, String] :application_id
|
3498
3530
|
#
|
@@ -3554,7 +3586,8 @@ module Aws::Pinpoint
|
|
3554
3586
|
req.send_request(options)
|
3555
3587
|
end
|
3556
3588
|
|
3557
|
-
#
|
3589
|
+
# Retrieves information about the event stream settings for an
|
3590
|
+
# application.
|
3558
3591
|
#
|
3559
3592
|
# @option params [required, String] :application_id
|
3560
3593
|
#
|
@@ -3586,7 +3619,8 @@ module Aws::Pinpoint
|
|
3586
3619
|
req.send_request(options)
|
3587
3620
|
end
|
3588
3621
|
|
3589
|
-
#
|
3622
|
+
# Retrieves information about the status and settings of a specific
|
3623
|
+
# export job for an application.
|
3590
3624
|
#
|
3591
3625
|
# @option params [required, String] :application_id
|
3592
3626
|
#
|
@@ -3632,7 +3666,8 @@ module Aws::Pinpoint
|
|
3632
3666
|
req.send_request(options)
|
3633
3667
|
end
|
3634
3668
|
|
3635
|
-
#
|
3669
|
+
# Retrieves information about the status and settings of all the export
|
3670
|
+
# jobs for an application.
|
3636
3671
|
#
|
3637
3672
|
# @option params [required, String] :application_id
|
3638
3673
|
#
|
@@ -3683,7 +3718,8 @@ module Aws::Pinpoint
|
|
3683
3718
|
req.send_request(options)
|
3684
3719
|
end
|
3685
3720
|
|
3686
|
-
#
|
3721
|
+
# Retrieves information about the status and settings of the GCM channel
|
3722
|
+
# for an application.
|
3687
3723
|
#
|
3688
3724
|
# @option params [required, String] :application_id
|
3689
3725
|
#
|
@@ -3720,7 +3756,8 @@ module Aws::Pinpoint
|
|
3720
3756
|
req.send_request(options)
|
3721
3757
|
end
|
3722
3758
|
|
3723
|
-
#
|
3759
|
+
# Retrieves information about the status and settings of a specific
|
3760
|
+
# import job for an application.
|
3724
3761
|
#
|
3725
3762
|
# @option params [required, String] :application_id
|
3726
3763
|
#
|
@@ -3770,7 +3807,8 @@ module Aws::Pinpoint
|
|
3770
3807
|
req.send_request(options)
|
3771
3808
|
end
|
3772
3809
|
|
3773
|
-
#
|
3810
|
+
# Retrieves information about the status and settings of all the import
|
3811
|
+
# jobs for an application.
|
3774
3812
|
#
|
3775
3813
|
# @option params [required, String] :application_id
|
3776
3814
|
#
|
@@ -3825,7 +3863,9 @@ module Aws::Pinpoint
|
|
3825
3863
|
req.send_request(options)
|
3826
3864
|
end
|
3827
3865
|
|
3828
|
-
#
|
3866
|
+
# Retrieves information about the configuration, dimension, and other
|
3867
|
+
# settings for a specific segment that's associated with an
|
3868
|
+
# application.
|
3829
3869
|
#
|
3830
3870
|
# @option params [required, String] :application_id
|
3831
3871
|
#
|
@@ -3953,7 +3993,8 @@ module Aws::Pinpoint
|
|
3953
3993
|
req.send_request(options)
|
3954
3994
|
end
|
3955
3995
|
|
3956
|
-
#
|
3996
|
+
# Retrieves information about the status and settings of the export jobs
|
3997
|
+
# for a segment.
|
3957
3998
|
#
|
3958
3999
|
# @option params [required, String] :application_id
|
3959
4000
|
#
|
@@ -4007,7 +4048,8 @@ module Aws::Pinpoint
|
|
4007
4048
|
req.send_request(options)
|
4008
4049
|
end
|
4009
4050
|
|
4010
|
-
#
|
4051
|
+
# Retrieves information about the status and settings of the import jobs
|
4052
|
+
# for a segment.
|
4011
4053
|
#
|
4012
4054
|
# @option params [required, String] :application_id
|
4013
4055
|
#
|
@@ -4065,7 +4107,9 @@ module Aws::Pinpoint
|
|
4065
4107
|
req.send_request(options)
|
4066
4108
|
end
|
4067
4109
|
|
4068
|
-
#
|
4110
|
+
# Retrieves information about the configuration, dimension, and other
|
4111
|
+
# settings for a specific version of a segment that's associated with
|
4112
|
+
# an application.
|
4069
4113
|
#
|
4070
4114
|
# @option params [required, String] :application_id
|
4071
4115
|
#
|
@@ -4196,7 +4240,9 @@ module Aws::Pinpoint
|
|
4196
4240
|
req.send_request(options)
|
4197
4241
|
end
|
4198
4242
|
|
4199
|
-
#
|
4243
|
+
# Retrieves information about the configuration, dimension, and other
|
4244
|
+
# settings for all versions of a specific segment that's associated
|
4245
|
+
# with an application.
|
4200
4246
|
#
|
4201
4247
|
# @option params [required, String] :application_id
|
4202
4248
|
#
|
@@ -4332,7 +4378,8 @@ module Aws::Pinpoint
|
|
4332
4378
|
req.send_request(options)
|
4333
4379
|
end
|
4334
4380
|
|
4335
|
-
#
|
4381
|
+
# Retrieves information about the configuration, dimension, and other
|
4382
|
+
# settings for all the segments that are associated with an application.
|
4336
4383
|
#
|
4337
4384
|
# @option params [required, String] :application_id
|
4338
4385
|
#
|
@@ -4465,7 +4512,8 @@ module Aws::Pinpoint
|
|
4465
4512
|
req.send_request(options)
|
4466
4513
|
end
|
4467
4514
|
|
4468
|
-
#
|
4515
|
+
# Retrieves information about the status and settings of the SMS channel
|
4516
|
+
# for an application.
|
4469
4517
|
#
|
4470
4518
|
# @option params [required, String] :application_id
|
4471
4519
|
#
|
@@ -4505,8 +4553,8 @@ module Aws::Pinpoint
|
|
4505
4553
|
req.send_request(options)
|
4506
4554
|
end
|
4507
4555
|
|
4508
|
-
#
|
4509
|
-
#
|
4556
|
+
# Retrieves information about all the endpoints that are associated with
|
4557
|
+
# a specific user ID.
|
4510
4558
|
#
|
4511
4559
|
# @option params [required, String] :application_id
|
4512
4560
|
#
|
@@ -4569,7 +4617,8 @@ module Aws::Pinpoint
|
|
4569
4617
|
req.send_request(options)
|
4570
4618
|
end
|
4571
4619
|
|
4572
|
-
#
|
4620
|
+
# Retrieves information about the status and settings of the voice
|
4621
|
+
# channel for an application.
|
4573
4622
|
#
|
4574
4623
|
# @option params [required, String] :application_id
|
4575
4624
|
#
|
@@ -4605,7 +4654,8 @@ module Aws::Pinpoint
|
|
4605
4654
|
req.send_request(options)
|
4606
4655
|
end
|
4607
4656
|
|
4608
|
-
#
|
4657
|
+
# Retrieves all the tags (keys and values) that are associated with an
|
4658
|
+
# application, campaign, or segment.
|
4609
4659
|
#
|
4610
4660
|
# @option params [required, String] :resource_arn
|
4611
4661
|
#
|
@@ -4633,10 +4683,10 @@ module Aws::Pinpoint
|
|
4633
4683
|
req.send_request(options)
|
4634
4684
|
end
|
4635
4685
|
|
4636
|
-
#
|
4686
|
+
# Retrieves information about a phone number.
|
4637
4687
|
#
|
4638
4688
|
# @option params [required, Types::NumberValidateRequest] :number_validate_request
|
4639
|
-
#
|
4689
|
+
# Specifies a phone number to validate and retrieve information about.
|
4640
4690
|
#
|
4641
4691
|
# @return [Types::PhoneNumberValidateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4642
4692
|
#
|
@@ -4677,12 +4727,15 @@ module Aws::Pinpoint
|
|
4677
4727
|
req.send_request(options)
|
4678
4728
|
end
|
4679
4729
|
|
4680
|
-
#
|
4730
|
+
# Creates a new event stream for an application or updates the settings
|
4731
|
+
# of an existing event stream for an application.
|
4681
4732
|
#
|
4682
4733
|
# @option params [required, String] :application_id
|
4683
4734
|
#
|
4684
4735
|
# @option params [required, Types::WriteEventStream] :write_event_stream
|
4685
|
-
#
|
4736
|
+
# Specifies the Amazon Resource Name (ARN) of an event stream to publish
|
4737
|
+
# events to and the AWS Identity and Access Management (IAM) role to use
|
4738
|
+
# when publishing those events.
|
4686
4739
|
#
|
4687
4740
|
# @return [Types::PutEventStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4688
4741
|
#
|
@@ -4693,8 +4746,8 @@ module Aws::Pinpoint
|
|
4693
4746
|
# resp = client.put_event_stream({
|
4694
4747
|
# application_id: "__string", # required
|
4695
4748
|
# write_event_stream: { # required
|
4696
|
-
# destination_stream_arn: "__string",
|
4697
|
-
# role_arn: "__string",
|
4749
|
+
# destination_stream_arn: "__string", # required
|
4750
|
+
# role_arn: "__string", # required
|
4698
4751
|
# },
|
4699
4752
|
# })
|
4700
4753
|
#
|
@@ -4716,14 +4769,13 @@ module Aws::Pinpoint
|
|
4716
4769
|
req.send_request(options)
|
4717
4770
|
end
|
4718
4771
|
|
4719
|
-
#
|
4720
|
-
#
|
4721
|
-
# with.
|
4772
|
+
# Creates a new event to record for endpoints, or creates or updates
|
4773
|
+
# endpoint data that existing events are associated with.
|
4722
4774
|
#
|
4723
4775
|
# @option params [required, String] :application_id
|
4724
4776
|
#
|
4725
4777
|
# @option params [required, Types::EventsRequest] :events_request
|
4726
|
-
#
|
4778
|
+
# Specifies a batch of events to process.
|
4727
4779
|
#
|
4728
4780
|
# @return [Types::PutEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4729
4781
|
#
|
@@ -4734,9 +4786,9 @@ module Aws::Pinpoint
|
|
4734
4786
|
# resp = client.put_events({
|
4735
4787
|
# application_id: "__string", # required
|
4736
4788
|
# events_request: { # required
|
4737
|
-
# batch_item: {
|
4789
|
+
# batch_item: { # required
|
4738
4790
|
# "__string" => {
|
4739
|
-
# endpoint: {
|
4791
|
+
# endpoint: { # required
|
4740
4792
|
# address: "__string",
|
4741
4793
|
# attributes: {
|
4742
4794
|
# "__string" => ["__string"],
|
@@ -4774,7 +4826,7 @@ module Aws::Pinpoint
|
|
4774
4826
|
# user_id: "__string",
|
4775
4827
|
# },
|
4776
4828
|
# },
|
4777
|
-
# events: {
|
4829
|
+
# events: { # required
|
4778
4830
|
# "__string" => {
|
4779
4831
|
# app_package_name: "__string",
|
4780
4832
|
# app_title: "__string",
|
@@ -4783,18 +4835,18 @@ module Aws::Pinpoint
|
|
4783
4835
|
# "__string" => "__string",
|
4784
4836
|
# },
|
4785
4837
|
# client_sdk_version: "__string",
|
4786
|
-
# event_type: "__string",
|
4838
|
+
# event_type: "__string", # required
|
4787
4839
|
# metrics: {
|
4788
4840
|
# "__string" => 1.0,
|
4789
4841
|
# },
|
4790
4842
|
# sdk_name: "__string",
|
4791
4843
|
# session: {
|
4792
4844
|
# duration: 1,
|
4793
|
-
# id: "__string",
|
4794
|
-
# start_timestamp: "__string",
|
4845
|
+
# id: "__string", # required
|
4846
|
+
# start_timestamp: "__string", # required
|
4795
4847
|
# stop_timestamp: "__string",
|
4796
4848
|
# },
|
4797
|
-
# timestamp: "__string",
|
4849
|
+
# timestamp: "__string", # required
|
4798
4850
|
# },
|
4799
4851
|
# },
|
4800
4852
|
# },
|
@@ -4820,14 +4872,16 @@ module Aws::Pinpoint
|
|
4820
4872
|
req.send_request(options)
|
4821
4873
|
end
|
4822
4874
|
|
4823
|
-
#
|
4875
|
+
# Removes one or more attributes, of the same attribute type, from all
|
4876
|
+
# the endpoints that are associated with an application.
|
4824
4877
|
#
|
4825
4878
|
# @option params [required, String] :application_id
|
4826
4879
|
#
|
4827
4880
|
# @option params [required, String] :attribute_type
|
4828
4881
|
#
|
4829
4882
|
# @option params [required, Types::UpdateAttributesRequest] :update_attributes_request
|
4830
|
-
#
|
4883
|
+
# Specifies one or more attributes to remove from all the endpoints that
|
4884
|
+
# are associated with an application.
|
4831
4885
|
#
|
4832
4886
|
# @return [Types::RemoveAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4833
4887
|
#
|
@@ -4859,12 +4913,13 @@ module Aws::Pinpoint
|
|
4859
4913
|
req.send_request(options)
|
4860
4914
|
end
|
4861
4915
|
|
4862
|
-
#
|
4916
|
+
# Creates and sends a direct message.
|
4863
4917
|
#
|
4864
4918
|
# @option params [required, String] :application_id
|
4865
4919
|
#
|
4866
4920
|
# @option params [required, Types::MessageRequest] :message_request
|
4867
|
-
#
|
4921
|
+
# Specifies the objects that define configuration and other settings for
|
4922
|
+
# a message.
|
4868
4923
|
#
|
4869
4924
|
# @return [Types::SendMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4870
4925
|
#
|
@@ -4905,7 +4960,7 @@ module Aws::Pinpoint
|
|
4905
4960
|
# title_override: "__string",
|
4906
4961
|
# },
|
4907
4962
|
# },
|
4908
|
-
# message_configuration: {
|
4963
|
+
# message_configuration: { # required
|
4909
4964
|
# adm_message: {
|
4910
4965
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4911
4966
|
# body: "__string",
|
@@ -5090,12 +5145,13 @@ module Aws::Pinpoint
|
|
5090
5145
|
req.send_request(options)
|
5091
5146
|
end
|
5092
5147
|
|
5093
|
-
#
|
5148
|
+
# Creates and sends a message to a list of users.
|
5094
5149
|
#
|
5095
5150
|
# @option params [required, String] :application_id
|
5096
5151
|
#
|
5097
5152
|
# @option params [required, Types::SendUsersMessageRequest] :send_users_message_request
|
5098
|
-
#
|
5153
|
+
# Specifies the configuration and other settings for a message to send
|
5154
|
+
# to all the endpoints that are associated with a list of users.
|
5099
5155
|
#
|
5100
5156
|
# @return [Types::SendUsersMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5101
5157
|
#
|
@@ -5109,7 +5165,7 @@ module Aws::Pinpoint
|
|
5109
5165
|
# context: {
|
5110
5166
|
# "__string" => "__string",
|
5111
5167
|
# },
|
5112
|
-
# message_configuration: {
|
5168
|
+
# message_configuration: { # required
|
5113
5169
|
# adm_message: {
|
5114
5170
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
5115
5171
|
# body: "__string",
|
@@ -5264,7 +5320,7 @@ module Aws::Pinpoint
|
|
5264
5320
|
# },
|
5265
5321
|
# },
|
5266
5322
|
# trace_id: "__string",
|
5267
|
-
# users: {
|
5323
|
+
# users: { # required
|
5268
5324
|
# "__string" => {
|
5269
5325
|
# body_override: "__string",
|
5270
5326
|
# context: {
|
@@ -5302,11 +5358,14 @@ module Aws::Pinpoint
|
|
5302
5358
|
req.send_request(options)
|
5303
5359
|
end
|
5304
5360
|
|
5305
|
-
# Adds tags to
|
5361
|
+
# Adds one or more tags (keys and values) to an application, campaign,
|
5362
|
+
# or segment.
|
5306
5363
|
#
|
5307
5364
|
# @option params [required, String] :resource_arn
|
5308
5365
|
#
|
5309
5366
|
# @option params [required, Types::TagsModel] :tags_model
|
5367
|
+
# Specifies the tags (keys and values) for an application, campaign, or
|
5368
|
+
# segment.
|
5310
5369
|
#
|
5311
5370
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5312
5371
|
#
|
@@ -5330,7 +5389,8 @@ module Aws::Pinpoint
|
|
5330
5389
|
req.send_request(options)
|
5331
5390
|
end
|
5332
5391
|
|
5333
|
-
#
|
5392
|
+
# Removes one or more tags (keys and values) from an application,
|
5393
|
+
# campaign, or segment.
|
5334
5394
|
#
|
5335
5395
|
# @option params [required, String] :resource_arn
|
5336
5396
|
#
|
@@ -5354,10 +5414,11 @@ module Aws::Pinpoint
|
|
5354
5414
|
req.send_request(options)
|
5355
5415
|
end
|
5356
5416
|
|
5357
|
-
#
|
5417
|
+
# Updates the ADM channel settings for an application.
|
5358
5418
|
#
|
5359
5419
|
# @option params [required, Types::ADMChannelRequest] :adm_channel_request
|
5360
|
-
# Amazon Device Messaging
|
5420
|
+
# Specifies the status and settings of the ADM (Amazon Device Messaging)
|
5421
|
+
# channel for an application.
|
5361
5422
|
#
|
5362
5423
|
# @option params [required, String] :application_id
|
5363
5424
|
#
|
@@ -5369,8 +5430,8 @@ module Aws::Pinpoint
|
|
5369
5430
|
#
|
5370
5431
|
# resp = client.update_adm_channel({
|
5371
5432
|
# adm_channel_request: { # required
|
5372
|
-
# client_id: "__string",
|
5373
|
-
# client_secret: "__string",
|
5433
|
+
# client_id: "__string", # required
|
5434
|
+
# client_secret: "__string", # required
|
5374
5435
|
# enabled: false,
|
5375
5436
|
# },
|
5376
5437
|
# application_id: "__string", # required
|
@@ -5398,10 +5459,11 @@ module Aws::Pinpoint
|
|
5398
5459
|
req.send_request(options)
|
5399
5460
|
end
|
5400
5461
|
|
5401
|
-
#
|
5462
|
+
# Updates the APNs channel settings for an application.
|
5402
5463
|
#
|
5403
5464
|
# @option params [required, Types::APNSChannelRequest] :apns_channel_request
|
5404
|
-
# Apple Push Notification
|
5465
|
+
# Specifies the status and settings of the APNs (Apple Push Notification
|
5466
|
+
# service) channel for an application.
|
5405
5467
|
#
|
5406
5468
|
# @option params [required, String] :application_id
|
5407
5469
|
#
|
@@ -5449,10 +5511,11 @@ module Aws::Pinpoint
|
|
5449
5511
|
req.send_request(options)
|
5450
5512
|
end
|
5451
5513
|
|
5452
|
-
#
|
5514
|
+
# Updates the APNs sandbox channel settings for an application.
|
5453
5515
|
#
|
5454
5516
|
# @option params [required, Types::APNSSandboxChannelRequest] :apns_sandbox_channel_request
|
5455
|
-
#
|
5517
|
+
# Specifies the status and settings of the APNs (Apple Push Notification
|
5518
|
+
# service) sandbox channel for an application.
|
5456
5519
|
#
|
5457
5520
|
# @option params [required, String] :application_id
|
5458
5521
|
#
|
@@ -5500,10 +5563,11 @@ module Aws::Pinpoint
|
|
5500
5563
|
req.send_request(options)
|
5501
5564
|
end
|
5502
5565
|
|
5503
|
-
#
|
5566
|
+
# Updates the APNs VoIP channel settings for an application.
|
5504
5567
|
#
|
5505
5568
|
# @option params [required, Types::APNSVoipChannelRequest] :apns_voip_channel_request
|
5506
|
-
#
|
5569
|
+
# Specifies the status and settings of the APNs (Apple Push Notification
|
5570
|
+
# service) VoIP channel for an application.
|
5507
5571
|
#
|
5508
5572
|
# @option params [required, String] :application_id
|
5509
5573
|
#
|
@@ -5551,10 +5615,12 @@ module Aws::Pinpoint
|
|
5551
5615
|
req.send_request(options)
|
5552
5616
|
end
|
5553
5617
|
|
5554
|
-
#
|
5618
|
+
# Updates the settings for the APNs VoIP sandbox channel for an
|
5619
|
+
# application.
|
5555
5620
|
#
|
5556
5621
|
# @option params [required, Types::APNSVoipSandboxChannelRequest] :apns_voip_sandbox_channel_request
|
5557
|
-
#
|
5622
|
+
# Specifies the status and settings of the APNs (Apple Push Notification
|
5623
|
+
# service) VoIP sandbox channel for an application.
|
5558
5624
|
#
|
5559
5625
|
# @option params [required, String] :application_id
|
5560
5626
|
#
|
@@ -5602,12 +5668,12 @@ module Aws::Pinpoint
|
|
5602
5668
|
req.send_request(options)
|
5603
5669
|
end
|
5604
5670
|
|
5605
|
-
#
|
5671
|
+
# Updates the settings for an application.
|
5606
5672
|
#
|
5607
5673
|
# @option params [required, String] :application_id
|
5608
5674
|
#
|
5609
5675
|
# @option params [required, Types::WriteApplicationSettingsRequest] :write_application_settings_request
|
5610
|
-
#
|
5676
|
+
# Specifies the default settings for an application.
|
5611
5677
|
#
|
5612
5678
|
# @return [Types::UpdateApplicationSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5613
5679
|
#
|
@@ -5660,12 +5726,13 @@ module Aws::Pinpoint
|
|
5660
5726
|
req.send_request(options)
|
5661
5727
|
end
|
5662
5728
|
|
5663
|
-
#
|
5729
|
+
# Updates the settings of the Baidu channel for an application.
|
5664
5730
|
#
|
5665
5731
|
# @option params [required, String] :application_id
|
5666
5732
|
#
|
5667
5733
|
# @option params [required, Types::BaiduChannelRequest] :baidu_channel_request
|
5668
|
-
# Baidu Cloud Push
|
5734
|
+
# Specifies the status and settings of the Baidu (Baidu Cloud Push)
|
5735
|
+
# channel for an application.
|
5669
5736
|
#
|
5670
5737
|
# @return [Types::UpdateBaiduChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5671
5738
|
#
|
@@ -5676,9 +5743,9 @@ module Aws::Pinpoint
|
|
5676
5743
|
# resp = client.update_baidu_channel({
|
5677
5744
|
# application_id: "__string", # required
|
5678
5745
|
# baidu_channel_request: { # required
|
5679
|
-
# api_key: "__string",
|
5746
|
+
# api_key: "__string", # required
|
5680
5747
|
# enabled: false,
|
5681
|
-
# secret_key: "__string",
|
5748
|
+
# secret_key: "__string", # required
|
5682
5749
|
# },
|
5683
5750
|
# })
|
5684
5751
|
#
|
@@ -5705,14 +5772,14 @@ module Aws::Pinpoint
|
|
5705
5772
|
req.send_request(options)
|
5706
5773
|
end
|
5707
5774
|
|
5708
|
-
#
|
5775
|
+
# Updates the settings for a campaign.
|
5709
5776
|
#
|
5710
5777
|
# @option params [required, String] :application_id
|
5711
5778
|
#
|
5712
5779
|
# @option params [required, String] :campaign_id
|
5713
5780
|
#
|
5714
5781
|
# @option params [required, Types::WriteCampaignRequest] :write_campaign_request
|
5715
|
-
#
|
5782
|
+
# Specifies the configuration and other settings for a campaign.
|
5716
5783
|
#
|
5717
5784
|
# @return [Types::UpdateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5718
5785
|
#
|
@@ -5787,7 +5854,7 @@ module Aws::Pinpoint
|
|
5787
5854
|
# body: "__string",
|
5788
5855
|
# from_address: "__string",
|
5789
5856
|
# html_body: "__string",
|
5790
|
-
# title: "__string",
|
5857
|
+
# title: "__string", # required
|
5791
5858
|
# },
|
5792
5859
|
# gcm_message: {
|
5793
5860
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -5812,25 +5879,25 @@ module Aws::Pinpoint
|
|
5812
5879
|
# schedule: {
|
5813
5880
|
# end_time: "__string",
|
5814
5881
|
# event_filter: {
|
5815
|
-
# dimensions: {
|
5882
|
+
# dimensions: { # required
|
5816
5883
|
# attributes: {
|
5817
5884
|
# "__string" => {
|
5818
5885
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
5819
|
-
# values: ["__string"],
|
5886
|
+
# values: ["__string"], # required
|
5820
5887
|
# },
|
5821
5888
|
# },
|
5822
5889
|
# event_type: {
|
5823
5890
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
5824
|
-
# values: ["__string"],
|
5891
|
+
# values: ["__string"], # required
|
5825
5892
|
# },
|
5826
5893
|
# metrics: {
|
5827
5894
|
# "__string" => {
|
5828
|
-
# comparison_operator: "__string",
|
5829
|
-
# value: 1.0,
|
5895
|
+
# comparison_operator: "__string", # required
|
5896
|
+
# value: 1.0, # required
|
5830
5897
|
# },
|
5831
5898
|
# },
|
5832
5899
|
# },
|
5833
|
-
# filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
|
5900
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
5834
5901
|
# },
|
5835
5902
|
# frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
|
5836
5903
|
# is_local_time: false,
|
@@ -5838,10 +5905,10 @@ module Aws::Pinpoint
|
|
5838
5905
|
# end: "__string",
|
5839
5906
|
# start: "__string",
|
5840
5907
|
# },
|
5841
|
-
# start_time: "__string",
|
5908
|
+
# start_time: "__string", # required
|
5842
5909
|
# timezone: "__string",
|
5843
5910
|
# },
|
5844
|
-
# size_percent: 1,
|
5911
|
+
# size_percent: 1, # required
|
5845
5912
|
# treatment_description: "__string",
|
5846
5913
|
# treatment_name: "__string",
|
5847
5914
|
# },
|
@@ -5921,7 +5988,7 @@ module Aws::Pinpoint
|
|
5921
5988
|
# body: "__string",
|
5922
5989
|
# from_address: "__string",
|
5923
5990
|
# html_body: "__string",
|
5924
|
-
# title: "__string",
|
5991
|
+
# title: "__string", # required
|
5925
5992
|
# },
|
5926
5993
|
# gcm_message: {
|
5927
5994
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
@@ -5947,25 +6014,25 @@ module Aws::Pinpoint
|
|
5947
6014
|
# schedule: {
|
5948
6015
|
# end_time: "__string",
|
5949
6016
|
# event_filter: {
|
5950
|
-
# dimensions: {
|
6017
|
+
# dimensions: { # required
|
5951
6018
|
# attributes: {
|
5952
6019
|
# "__string" => {
|
5953
6020
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
5954
|
-
# values: ["__string"],
|
6021
|
+
# values: ["__string"], # required
|
5955
6022
|
# },
|
5956
6023
|
# },
|
5957
6024
|
# event_type: {
|
5958
6025
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
5959
|
-
# values: ["__string"],
|
6026
|
+
# values: ["__string"], # required
|
5960
6027
|
# },
|
5961
6028
|
# metrics: {
|
5962
6029
|
# "__string" => {
|
5963
|
-
# comparison_operator: "__string",
|
5964
|
-
# value: 1.0,
|
6030
|
+
# comparison_operator: "__string", # required
|
6031
|
+
# value: 1.0, # required
|
5965
6032
|
# },
|
5966
6033
|
# },
|
5967
6034
|
# },
|
5968
|
-
# filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
|
6035
|
+
# filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
|
5969
6036
|
# },
|
5970
6037
|
# frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
|
5971
6038
|
# is_local_time: false,
|
@@ -5973,7 +6040,7 @@ module Aws::Pinpoint
|
|
5973
6040
|
# end: "__string",
|
5974
6041
|
# start: "__string",
|
5975
6042
|
# },
|
5976
|
-
# start_time: "__string",
|
6043
|
+
# start_time: "__string", # required
|
5977
6044
|
# timezone: "__string",
|
5978
6045
|
# },
|
5979
6046
|
# segment_id: "__string",
|
@@ -6199,12 +6266,14 @@ module Aws::Pinpoint
|
|
6199
6266
|
req.send_request(options)
|
6200
6267
|
end
|
6201
6268
|
|
6202
|
-
#
|
6269
|
+
# Updates the status and settings of the email channel for an
|
6270
|
+
# application.
|
6203
6271
|
#
|
6204
6272
|
# @option params [required, String] :application_id
|
6205
6273
|
#
|
6206
6274
|
# @option params [required, Types::EmailChannelRequest] :email_channel_request
|
6207
|
-
#
|
6275
|
+
# Specifies the status and settings of the email channel for an
|
6276
|
+
# application.
|
6208
6277
|
#
|
6209
6278
|
# @return [Types::UpdateEmailChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6210
6279
|
#
|
@@ -6217,8 +6286,8 @@ module Aws::Pinpoint
|
|
6217
6286
|
# email_channel_request: { # required
|
6218
6287
|
# configuration_set: "__string",
|
6219
6288
|
# enabled: false,
|
6220
|
-
# from_address: "__string",
|
6221
|
-
# identity: "__string",
|
6289
|
+
# from_address: "__string", # required
|
6290
|
+
# identity: "__string", # required
|
6222
6291
|
# role_arn: "__string",
|
6223
6292
|
# },
|
6224
6293
|
# })
|
@@ -6250,14 +6319,17 @@ module Aws::Pinpoint
|
|
6250
6319
|
req.send_request(options)
|
6251
6320
|
end
|
6252
6321
|
|
6253
|
-
# Creates or updates
|
6322
|
+
# Creates a new endpoint for an application or updates the settings and
|
6323
|
+
# attributes of an existing endpoint for an application. You can also
|
6324
|
+
# use this operation to define custom attributes (Attributes, Metrics,
|
6325
|
+
# and UserAttributes properties) for an endpoint.
|
6254
6326
|
#
|
6255
6327
|
# @option params [required, String] :application_id
|
6256
6328
|
#
|
6257
6329
|
# @option params [required, String] :endpoint_id
|
6258
6330
|
#
|
6259
6331
|
# @option params [required, Types::EndpointRequest] :endpoint_request
|
6260
|
-
#
|
6332
|
+
# Specifies the channel type and other settings for an endpoint.
|
6261
6333
|
#
|
6262
6334
|
# @return [Types::UpdateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6263
6335
|
#
|
@@ -6322,12 +6394,17 @@ module Aws::Pinpoint
|
|
6322
6394
|
req.send_request(options)
|
6323
6395
|
end
|
6324
6396
|
|
6325
|
-
#
|
6397
|
+
# Creates a new batch of endpoints for an application or updates the
|
6398
|
+
# settings and attributes of a batch of existing endpoints for an
|
6399
|
+
# application. You can also use this operation to define custom
|
6400
|
+
# attributes (Attributes, Metrics, and UserAttributes properties) for a
|
6401
|
+
# batch of endpoints.
|
6326
6402
|
#
|
6327
6403
|
# @option params [required, String] :application_id
|
6328
6404
|
#
|
6329
6405
|
# @option params [required, Types::EndpointBatchRequest] :endpoint_batch_request
|
6330
|
-
#
|
6406
|
+
# Specifies a batch of endpoints to create or update and the settings
|
6407
|
+
# and attributes to set or change for each endpoint.
|
6331
6408
|
#
|
6332
6409
|
# @return [Types::UpdateEndpointsBatchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6333
6410
|
#
|
@@ -6338,7 +6415,7 @@ module Aws::Pinpoint
|
|
6338
6415
|
# resp = client.update_endpoints_batch({
|
6339
6416
|
# application_id: "__string", # required
|
6340
6417
|
# endpoint_batch_request: { # required
|
6341
|
-
# item: [
|
6418
|
+
# item: [ # required
|
6342
6419
|
# {
|
6343
6420
|
# address: "__string",
|
6344
6421
|
# attributes: {
|
@@ -6396,12 +6473,15 @@ module Aws::Pinpoint
|
|
6396
6473
|
req.send_request(options)
|
6397
6474
|
end
|
6398
6475
|
|
6399
|
-
#
|
6476
|
+
# Updates the status and settings of the GCM channel for an application.
|
6400
6477
|
#
|
6401
6478
|
# @option params [required, String] :application_id
|
6402
6479
|
#
|
6403
6480
|
# @option params [required, Types::GCMChannelRequest] :gcm_channel_request
|
6404
|
-
#
|
6481
|
+
# Specifies the status and settings of the GCM channel for an
|
6482
|
+
# application. This channel enables Amazon Pinpoint to send push
|
6483
|
+
# notifications through the Firebase Cloud Messaging (FCM), formerly
|
6484
|
+
# Google Cloud Messaging (GCM), service.
|
6405
6485
|
#
|
6406
6486
|
# @return [Types::UpdateGcmChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6407
6487
|
#
|
@@ -6412,7 +6492,7 @@ module Aws::Pinpoint
|
|
6412
6492
|
# resp = client.update_gcm_channel({
|
6413
6493
|
# application_id: "__string", # required
|
6414
6494
|
# gcm_channel_request: { # required
|
6415
|
-
# api_key: "__string",
|
6495
|
+
# api_key: "__string", # required
|
6416
6496
|
# enabled: false,
|
6417
6497
|
# },
|
6418
6498
|
# })
|
@@ -6440,14 +6520,18 @@ module Aws::Pinpoint
|
|
6440
6520
|
req.send_request(options)
|
6441
6521
|
end
|
6442
6522
|
|
6443
|
-
#
|
6523
|
+
# Creates a new segment for an application or updates the configuration,
|
6524
|
+
# dimension, and other settings for an existing segment that's
|
6525
|
+
# associated with an application.
|
6444
6526
|
#
|
6445
6527
|
# @option params [required, String] :application_id
|
6446
6528
|
#
|
6447
6529
|
# @option params [required, String] :segment_id
|
6448
6530
|
#
|
6449
6531
|
# @option params [required, Types::WriteSegmentRequest] :write_segment_request
|
6450
|
-
#
|
6532
|
+
# Specifies the configuration, dimension, and other settings for a
|
6533
|
+
# segment. A WriteSegmentRequest object can include a Dimensions object
|
6534
|
+
# or a SegmentGroups object, but not both.
|
6451
6535
|
#
|
6452
6536
|
# @return [Types::UpdateSegmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6453
6537
|
#
|
@@ -6463,64 +6547,64 @@ module Aws::Pinpoint
|
|
6463
6547
|
# attributes: {
|
6464
6548
|
# "__string" => {
|
6465
6549
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6466
|
-
# values: ["__string"],
|
6550
|
+
# values: ["__string"], # required
|
6467
6551
|
# },
|
6468
6552
|
# },
|
6469
6553
|
# behavior: {
|
6470
6554
|
# recency: {
|
6471
|
-
# duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
|
6472
|
-
# recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
|
6555
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
6556
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
6473
6557
|
# },
|
6474
6558
|
# },
|
6475
6559
|
# demographic: {
|
6476
6560
|
# app_version: {
|
6477
6561
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6478
|
-
# values: ["__string"],
|
6562
|
+
# values: ["__string"], # required
|
6479
6563
|
# },
|
6480
6564
|
# channel: {
|
6481
6565
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6482
|
-
# values: ["__string"],
|
6566
|
+
# values: ["__string"], # required
|
6483
6567
|
# },
|
6484
6568
|
# device_type: {
|
6485
6569
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6486
|
-
# values: ["__string"],
|
6570
|
+
# values: ["__string"], # required
|
6487
6571
|
# },
|
6488
6572
|
# make: {
|
6489
6573
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6490
|
-
# values: ["__string"],
|
6574
|
+
# values: ["__string"], # required
|
6491
6575
|
# },
|
6492
6576
|
# model: {
|
6493
6577
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6494
|
-
# values: ["__string"],
|
6578
|
+
# values: ["__string"], # required
|
6495
6579
|
# },
|
6496
6580
|
# platform: {
|
6497
6581
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6498
|
-
# values: ["__string"],
|
6582
|
+
# values: ["__string"], # required
|
6499
6583
|
# },
|
6500
6584
|
# },
|
6501
6585
|
# location: {
|
6502
6586
|
# country: {
|
6503
6587
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6504
|
-
# values: ["__string"],
|
6588
|
+
# values: ["__string"], # required
|
6505
6589
|
# },
|
6506
6590
|
# gps_point: {
|
6507
|
-
# coordinates: {
|
6508
|
-
# latitude: 1.0,
|
6509
|
-
# longitude: 1.0,
|
6591
|
+
# coordinates: { # required
|
6592
|
+
# latitude: 1.0, # required
|
6593
|
+
# longitude: 1.0, # required
|
6510
6594
|
# },
|
6511
6595
|
# range_in_kilometers: 1.0,
|
6512
6596
|
# },
|
6513
6597
|
# },
|
6514
6598
|
# metrics: {
|
6515
6599
|
# "__string" => {
|
6516
|
-
# comparison_operator: "__string",
|
6517
|
-
# value: 1.0,
|
6600
|
+
# comparison_operator: "__string", # required
|
6601
|
+
# value: 1.0, # required
|
6518
6602
|
# },
|
6519
6603
|
# },
|
6520
6604
|
# user_attributes: {
|
6521
6605
|
# "__string" => {
|
6522
6606
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6523
|
-
# values: ["__string"],
|
6607
|
+
# values: ["__string"], # required
|
6524
6608
|
# },
|
6525
6609
|
# },
|
6526
6610
|
# },
|
@@ -6533,71 +6617,71 @@ module Aws::Pinpoint
|
|
6533
6617
|
# attributes: {
|
6534
6618
|
# "__string" => {
|
6535
6619
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6536
|
-
# values: ["__string"],
|
6620
|
+
# values: ["__string"], # required
|
6537
6621
|
# },
|
6538
6622
|
# },
|
6539
6623
|
# behavior: {
|
6540
6624
|
# recency: {
|
6541
|
-
# duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
|
6542
|
-
# recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
|
6625
|
+
# duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
|
6626
|
+
# recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
6543
6627
|
# },
|
6544
6628
|
# },
|
6545
6629
|
# demographic: {
|
6546
6630
|
# app_version: {
|
6547
6631
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6548
|
-
# values: ["__string"],
|
6632
|
+
# values: ["__string"], # required
|
6549
6633
|
# },
|
6550
6634
|
# channel: {
|
6551
6635
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6552
|
-
# values: ["__string"],
|
6636
|
+
# values: ["__string"], # required
|
6553
6637
|
# },
|
6554
6638
|
# device_type: {
|
6555
6639
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6556
|
-
# values: ["__string"],
|
6640
|
+
# values: ["__string"], # required
|
6557
6641
|
# },
|
6558
6642
|
# make: {
|
6559
6643
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6560
|
-
# values: ["__string"],
|
6644
|
+
# values: ["__string"], # required
|
6561
6645
|
# },
|
6562
6646
|
# model: {
|
6563
6647
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6564
|
-
# values: ["__string"],
|
6648
|
+
# values: ["__string"], # required
|
6565
6649
|
# },
|
6566
6650
|
# platform: {
|
6567
6651
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6568
|
-
# values: ["__string"],
|
6652
|
+
# values: ["__string"], # required
|
6569
6653
|
# },
|
6570
6654
|
# },
|
6571
6655
|
# location: {
|
6572
6656
|
# country: {
|
6573
6657
|
# dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6574
|
-
# values: ["__string"],
|
6658
|
+
# values: ["__string"], # required
|
6575
6659
|
# },
|
6576
6660
|
# gps_point: {
|
6577
|
-
# coordinates: {
|
6578
|
-
# latitude: 1.0,
|
6579
|
-
# longitude: 1.0,
|
6661
|
+
# coordinates: { # required
|
6662
|
+
# latitude: 1.0, # required
|
6663
|
+
# longitude: 1.0, # required
|
6580
6664
|
# },
|
6581
6665
|
# range_in_kilometers: 1.0,
|
6582
6666
|
# },
|
6583
6667
|
# },
|
6584
6668
|
# metrics: {
|
6585
6669
|
# "__string" => {
|
6586
|
-
# comparison_operator: "__string",
|
6587
|
-
# value: 1.0,
|
6670
|
+
# comparison_operator: "__string", # required
|
6671
|
+
# value: 1.0, # required
|
6588
6672
|
# },
|
6589
6673
|
# },
|
6590
6674
|
# user_attributes: {
|
6591
6675
|
# "__string" => {
|
6592
6676
|
# attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
|
6593
|
-
# values: ["__string"],
|
6677
|
+
# values: ["__string"], # required
|
6594
6678
|
# },
|
6595
6679
|
# },
|
6596
6680
|
# },
|
6597
6681
|
# ],
|
6598
6682
|
# source_segments: [
|
6599
6683
|
# {
|
6600
|
-
# id: "__string",
|
6684
|
+
# id: "__string", # required
|
6601
6685
|
# version: 1,
|
6602
6686
|
# },
|
6603
6687
|
# ],
|
@@ -6724,12 +6808,13 @@ module Aws::Pinpoint
|
|
6724
6808
|
req.send_request(options)
|
6725
6809
|
end
|
6726
6810
|
|
6727
|
-
#
|
6811
|
+
# Updates the status and settings of the SMS channel for an application.
|
6728
6812
|
#
|
6729
6813
|
# @option params [required, String] :application_id
|
6730
6814
|
#
|
6731
6815
|
# @option params [required, Types::SMSChannelRequest] :sms_channel_request
|
6732
|
-
# SMS
|
6816
|
+
# Specifies the status and settings of the SMS channel for an
|
6817
|
+
# application.
|
6733
6818
|
#
|
6734
6819
|
# @return [Types::UpdateSmsChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6735
6820
|
#
|
@@ -6772,12 +6857,14 @@ module Aws::Pinpoint
|
|
6772
6857
|
req.send_request(options)
|
6773
6858
|
end
|
6774
6859
|
|
6775
|
-
#
|
6860
|
+
# Updates the status and settings of the voice channel for an
|
6861
|
+
# application.
|
6776
6862
|
#
|
6777
6863
|
# @option params [required, String] :application_id
|
6778
6864
|
#
|
6779
6865
|
# @option params [required, Types::VoiceChannelRequest] :voice_channel_request
|
6780
|
-
#
|
6866
|
+
# Specifies the status and settings of the voice channel for an
|
6867
|
+
# application.
|
6781
6868
|
#
|
6782
6869
|
# @return [Types::UpdateVoiceChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6783
6870
|
#
|
@@ -6827,7 +6914,7 @@ module Aws::Pinpoint
|
|
6827
6914
|
params: params,
|
6828
6915
|
config: config)
|
6829
6916
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
6830
|
-
context[:gem_version] = '1.
|
6917
|
+
context[:gem_version] = '1.24.0'
|
6831
6918
|
Seahorse::Client::Request.new(handlers, context)
|
6832
6919
|
end
|
6833
6920
|
|