aws-sdk-pinpoint 1.5.0 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -55,10 +55,7 @@ module Aws::Pinpoint
55
55
  # @return [Boolean]
56
56
  #
57
57
  # @!attribute [rw] has_credential
58
- # Indicates whether the channel is configured with ADM credentials.
59
- # Amazon Pinpoint uses your credentials to authenticate push
60
- # notifications with ADM. Provide your credentials by setting the
61
- # ClientId and ClientSecret attributes.
58
+ # Not used. Retained for backwards compatibility.
62
59
  # @return [Boolean]
63
60
  #
64
61
  # @!attribute [rw] id
@@ -203,6 +200,8 @@ module Aws::Pinpoint
203
200
  # @return [String]
204
201
  #
205
202
  # @!attribute [rw] substitutions
203
+ # Default message substitutions. Can be overridden by individual
204
+ # address substitutions.
206
205
  # @return [Hash<String,Array<String>>]
207
206
  #
208
207
  # @!attribute [rw] title
@@ -318,12 +317,7 @@ module Aws::Pinpoint
318
317
  # @return [Boolean]
319
318
  #
320
319
  # @!attribute [rw] has_credential
321
- # Indicates whether the channel is configured with APNs credentials.
322
- # Amazon Pinpoint uses your credentials to authenticate push
323
- # notifications with APNs. To use APNs token authentication, set the
324
- # BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use
325
- # certificate authentication, set the Certificate and PrivateKey
326
- # attributes.
320
+ # Not used. Retained for backwards compatibility.
327
321
  # @return [Boolean]
328
322
  #
329
323
  # @!attribute [rw] has_token_key
@@ -488,6 +482,8 @@ module Aws::Pinpoint
488
482
  # @return [String]
489
483
  #
490
484
  # @!attribute [rw] substitutions
485
+ # Default message substitutions. Can be overridden by individual
486
+ # address substitutions.
491
487
  # @return [Hash<String,Array<String>>]
492
488
  #
493
489
  # @!attribute [rw] thread_id
@@ -619,12 +615,7 @@ module Aws::Pinpoint
619
615
  # @return [Boolean]
620
616
  #
621
617
  # @!attribute [rw] has_credential
622
- # Indicates whether the channel is configured with APNs credentials.
623
- # Amazon Pinpoint uses your credentials to authenticate push
624
- # notifications with APNs. To use APNs token authentication, set the
625
- # BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use
626
- # certificate authentication, set the Certificate and PrivateKey
627
- # attributes.
618
+ # Not used. Retained for backwards compatibility.
628
619
  # @return [Boolean]
629
620
  #
630
621
  # @!attribute [rw] has_token_key
@@ -756,7 +747,7 @@ module Aws::Pinpoint
756
747
  # @return [Boolean]
757
748
  #
758
749
  # @!attribute [rw] has_credential
759
- # If the channel is registered with a credential for authentication.
750
+ # Not used. Retained for backwards compatibility.
760
751
  # @return [Boolean]
761
752
  #
762
753
  # @!attribute [rw] has_token_key
@@ -886,7 +877,7 @@ module Aws::Pinpoint
886
877
  # @return [Boolean]
887
878
  #
888
879
  # @!attribute [rw] has_credential
889
- # If the channel is registered with a credential for authentication.
880
+ # Not used. Retained for backwards compatibility.
890
881
  # @return [Boolean]
891
882
  #
892
883
  # @!attribute [rw] has_token_key
@@ -1066,6 +1057,9 @@ module Aws::Pinpoint
1066
1057
  # @return [String]
1067
1058
  #
1068
1059
  # @!attribute [rw] substitutions
1060
+ # A map of substitution values for the message to be merged with the
1061
+ # DefaultMessage's substitutions. Substitutions on this map take
1062
+ # precedence over the all other substitutions.
1069
1063
  # @return [Hash<String,Array<String>>]
1070
1064
  #
1071
1065
  # @!attribute [rw] title_override
@@ -1176,6 +1170,9 @@ module Aws::Pinpoint
1176
1170
  # @return [String]
1177
1171
  #
1178
1172
  # @!attribute [rw] values
1173
+ # The criteria values for the segment dimension. Endpoints with
1174
+ # matching attribute values are included or excluded from the segment,
1175
+ # depending on the setting for Type.
1179
1176
  # @return [Array<String>]
1180
1177
  #
1181
1178
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/AttributeDimension AWS API Documentation
@@ -1186,6 +1183,29 @@ module Aws::Pinpoint
1186
1183
  include Aws::Structure
1187
1184
  end
1188
1185
 
1186
+ # Attributes.
1187
+ #
1188
+ # @!attribute [rw] application_id
1189
+ # The unique ID for the application.
1190
+ # @return [String]
1191
+ #
1192
+ # @!attribute [rw] attribute_type
1193
+ # The attribute type for the application.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] attributes
1197
+ # The attributes for the application.
1198
+ # @return [Array<String>]
1199
+ #
1200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/AttributesResource AWS API Documentation
1201
+ #
1202
+ class AttributesResource < Struct.new(
1203
+ :application_id,
1204
+ :attribute_type,
1205
+ :attributes)
1206
+ include Aws::Structure
1207
+ end
1208
+
1189
1209
  # Baidu Cloud Push credentials
1190
1210
  #
1191
1211
  # @note When making an API call, you may pass BaiduChannelRequest
@@ -1237,10 +1257,7 @@ module Aws::Pinpoint
1237
1257
  # @return [Boolean]
1238
1258
  #
1239
1259
  # @!attribute [rw] has_credential
1240
- # Indicates whether the channel is configured with Baidu Cloud Push
1241
- # credentials. Amazon Pinpoint uses your credentials to authenticate
1242
- # push notifications with Baidu Cloud Push. Provide your credentials
1243
- # by setting the ApiKey and SecretKey attributes.
1260
+ # Not used. Retained for backwards compatibility.
1244
1261
  # @return [Boolean]
1245
1262
  #
1246
1263
  # @!attribute [rw] id
@@ -1305,6 +1322,7 @@ module Aws::Pinpoint
1305
1322
  # substitutions: {
1306
1323
  # "__string" => ["__string"],
1307
1324
  # },
1325
+ # time_to_live: 1,
1308
1326
  # title: "__string",
1309
1327
  # url: "__string",
1310
1328
  # }
@@ -1367,8 +1385,17 @@ module Aws::Pinpoint
1367
1385
  # @return [String]
1368
1386
  #
1369
1387
  # @!attribute [rw] substitutions
1388
+ # Default message substitutions. Can be overridden by individual
1389
+ # address substitutions.
1370
1390
  # @return [Hash<String,Array<String>>]
1371
1391
  #
1392
+ # @!attribute [rw] time_to_live
1393
+ # This parameter specifies how long (in seconds) the message should be
1394
+ # kept in Baidu storage if the device is offline. The and the default
1395
+ # value and the maximum time to live supported is 7 days (604800
1396
+ # seconds)
1397
+ # @return [Integer]
1398
+ #
1372
1399
  # @!attribute [rw] title
1373
1400
  # The message title that displays above the message on the user's
1374
1401
  # device.
@@ -1393,6 +1420,7 @@ module Aws::Pinpoint
1393
1420
  :small_image_icon_url,
1394
1421
  :sound,
1395
1422
  :substitutions,
1423
+ :time_to_live,
1396
1424
  :title,
1397
1425
  :url)
1398
1426
  include Aws::Structure
@@ -1437,6 +1465,8 @@ module Aws::Pinpoint
1437
1465
  include Aws::Structure
1438
1466
  end
1439
1467
 
1468
+ # Campaign hook information.
1469
+ #
1440
1470
  # @note When making an API call, you may pass CampaignHook
1441
1471
  # data as a hash:
1442
1472
  #
@@ -1689,6 +1719,73 @@ module Aws::Pinpoint
1689
1719
  include Aws::Structure
1690
1720
  end
1691
1721
 
1722
+ # Base definition for channel response.
1723
+ #
1724
+ # @!attribute [rw] application_id
1725
+ # Application id
1726
+ # @return [String]
1727
+ #
1728
+ # @!attribute [rw] creation_date
1729
+ # When was this segment created
1730
+ # @return [String]
1731
+ #
1732
+ # @!attribute [rw] enabled
1733
+ # If the channel is enabled for sending messages.
1734
+ # @return [Boolean]
1735
+ #
1736
+ # @!attribute [rw] has_credential
1737
+ # Not used. Retained for backwards compatibility.
1738
+ # @return [Boolean]
1739
+ #
1740
+ # @!attribute [rw] id
1741
+ # Channel ID. Not used, only for backwards compatibility.
1742
+ # @return [String]
1743
+ #
1744
+ # @!attribute [rw] is_archived
1745
+ # Is this channel archived
1746
+ # @return [Boolean]
1747
+ #
1748
+ # @!attribute [rw] last_modified_by
1749
+ # Who made the last change
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] last_modified_date
1753
+ # Last date this was updated
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] version
1757
+ # Version of channel
1758
+ # @return [Integer]
1759
+ #
1760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ChannelResponse AWS API Documentation
1761
+ #
1762
+ class ChannelResponse < Struct.new(
1763
+ :application_id,
1764
+ :creation_date,
1765
+ :enabled,
1766
+ :has_credential,
1767
+ :id,
1768
+ :is_archived,
1769
+ :last_modified_by,
1770
+ :last_modified_date,
1771
+ :version)
1772
+ include Aws::Structure
1773
+ end
1774
+
1775
+ # Get channels definition
1776
+ #
1777
+ # @!attribute [rw] channels
1778
+ # A map of channels, with the ChannelType as the key and the Channel
1779
+ # as the value.
1780
+ # @return [Hash<String,Types::ChannelResponse>]
1781
+ #
1782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ChannelsResponse AWS API Documentation
1783
+ #
1784
+ class ChannelsResponse < Struct.new(
1785
+ :channels)
1786
+ include Aws::Structure
1787
+ end
1788
+
1692
1789
  # @note When making an API call, you may pass CreateAppRequest
1693
1790
  # data as a hash:
1694
1791
  #
@@ -1760,6 +1857,7 @@ module Aws::Pinpoint
1760
1857
  # media_url: "__string",
1761
1858
  # raw_content: "__string",
1762
1859
  # silent_push: false,
1860
+ # time_to_live: 1,
1763
1861
  # title: "__string",
1764
1862
  # url: "__string",
1765
1863
  # },
@@ -1773,6 +1871,7 @@ module Aws::Pinpoint
1773
1871
  # media_url: "__string",
1774
1872
  # raw_content: "__string",
1775
1873
  # silent_push: false,
1874
+ # time_to_live: 1,
1776
1875
  # title: "__string",
1777
1876
  # url: "__string",
1778
1877
  # },
@@ -1786,6 +1885,7 @@ module Aws::Pinpoint
1786
1885
  # media_url: "__string",
1787
1886
  # raw_content: "__string",
1788
1887
  # silent_push: false,
1888
+ # time_to_live: 1,
1789
1889
  # title: "__string",
1790
1890
  # url: "__string",
1791
1891
  # },
@@ -1799,6 +1899,7 @@ module Aws::Pinpoint
1799
1899
  # media_url: "__string",
1800
1900
  # raw_content: "__string",
1801
1901
  # silent_push: false,
1902
+ # time_to_live: 1,
1802
1903
  # title: "__string",
1803
1904
  # url: "__string",
1804
1905
  # },
@@ -1818,6 +1919,7 @@ module Aws::Pinpoint
1818
1919
  # media_url: "__string",
1819
1920
  # raw_content: "__string",
1820
1921
  # silent_push: false,
1922
+ # time_to_live: 1,
1821
1923
  # title: "__string",
1822
1924
  # url: "__string",
1823
1925
  # },
@@ -1868,6 +1970,7 @@ module Aws::Pinpoint
1868
1970
  # media_url: "__string",
1869
1971
  # raw_content: "__string",
1870
1972
  # silent_push: false,
1973
+ # time_to_live: 1,
1871
1974
  # title: "__string",
1872
1975
  # url: "__string",
1873
1976
  # },
@@ -1881,6 +1984,7 @@ module Aws::Pinpoint
1881
1984
  # media_url: "__string",
1882
1985
  # raw_content: "__string",
1883
1986
  # silent_push: false,
1987
+ # time_to_live: 1,
1884
1988
  # title: "__string",
1885
1989
  # url: "__string",
1886
1990
  # },
@@ -1894,6 +1998,7 @@ module Aws::Pinpoint
1894
1998
  # media_url: "__string",
1895
1999
  # raw_content: "__string",
1896
2000
  # silent_push: false,
2001
+ # time_to_live: 1,
1897
2002
  # title: "__string",
1898
2003
  # url: "__string",
1899
2004
  # },
@@ -1907,6 +2012,7 @@ module Aws::Pinpoint
1907
2012
  # media_url: "__string",
1908
2013
  # raw_content: "__string",
1909
2014
  # silent_push: false,
2015
+ # time_to_live: 1,
1910
2016
  # title: "__string",
1911
2017
  # url: "__string",
1912
2018
  # },
@@ -1926,6 +2032,7 @@ module Aws::Pinpoint
1926
2032
  # media_url: "__string",
1927
2033
  # raw_content: "__string",
1928
2034
  # silent_push: false,
2035
+ # time_to_live: 1,
1929
2036
  # title: "__string",
1930
2037
  # url: "__string",
1931
2038
  # },
@@ -1989,6 +2096,7 @@ module Aws::Pinpoint
1989
2096
  # role_arn: "__string",
1990
2097
  # s3_url_prefix: "__string",
1991
2098
  # segment_id: "__string",
2099
+ # segment_version: 1,
1992
2100
  # },
1993
2101
  # }
1994
2102
  #
@@ -1996,6 +2104,7 @@ module Aws::Pinpoint
1996
2104
  # @return [String]
1997
2105
  #
1998
2106
  # @!attribute [rw] export_job_request
2107
+ # Export job request.
1999
2108
  # @return [Types::ExportJobRequest]
2000
2109
  #
2001
2110
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJobRequest AWS API Documentation
@@ -2007,6 +2116,7 @@ module Aws::Pinpoint
2007
2116
  end
2008
2117
 
2009
2118
  # @!attribute [rw] export_job_response
2119
+ # Export job response.
2010
2120
  # @return [Types::ExportJobResponse]
2011
2121
  #
2012
2122
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJobResponse AWS API Documentation
@@ -2037,6 +2147,7 @@ module Aws::Pinpoint
2037
2147
  # @return [String]
2038
2148
  #
2039
2149
  # @!attribute [rw] import_job_request
2150
+ # Import job request.
2040
2151
  # @return [Types::ImportJobRequest]
2041
2152
  #
2042
2153
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJobRequest AWS API Documentation
@@ -2048,6 +2159,7 @@ module Aws::Pinpoint
2048
2159
  end
2049
2160
 
2050
2161
  # @!attribute [rw] import_job_response
2162
+ # Import job response.
2051
2163
  # @return [Types::ImportJobResponse]
2052
2164
  #
2053
2165
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJobResponse AWS API Documentation
@@ -2107,6 +2219,19 @@ module Aws::Pinpoint
2107
2219
  # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2108
2220
  # values: ["__string"],
2109
2221
  # },
2222
+ # gps_point: {
2223
+ # coordinates: {
2224
+ # latitude: 1.0,
2225
+ # longitude: 1.0,
2226
+ # },
2227
+ # range_in_kilometers: 1.0,
2228
+ # },
2229
+ # },
2230
+ # metrics: {
2231
+ # "__string" => {
2232
+ # comparison_operator: "__string",
2233
+ # value: 1.0,
2234
+ # },
2110
2235
  # },
2111
2236
  # user_attributes: {
2112
2237
  # "__string" => {
@@ -2116,6 +2241,88 @@ module Aws::Pinpoint
2116
2241
  # },
2117
2242
  # },
2118
2243
  # name: "__string",
2244
+ # segment_groups: {
2245
+ # groups: [
2246
+ # {
2247
+ # dimensions: [
2248
+ # {
2249
+ # attributes: {
2250
+ # "__string" => {
2251
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2252
+ # values: ["__string"],
2253
+ # },
2254
+ # },
2255
+ # behavior: {
2256
+ # recency: {
2257
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
2258
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
2259
+ # },
2260
+ # },
2261
+ # demographic: {
2262
+ # app_version: {
2263
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2264
+ # values: ["__string"],
2265
+ # },
2266
+ # channel: {
2267
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2268
+ # values: ["__string"],
2269
+ # },
2270
+ # device_type: {
2271
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2272
+ # values: ["__string"],
2273
+ # },
2274
+ # make: {
2275
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2276
+ # values: ["__string"],
2277
+ # },
2278
+ # model: {
2279
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2280
+ # values: ["__string"],
2281
+ # },
2282
+ # platform: {
2283
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2284
+ # values: ["__string"],
2285
+ # },
2286
+ # },
2287
+ # location: {
2288
+ # country: {
2289
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2290
+ # values: ["__string"],
2291
+ # },
2292
+ # gps_point: {
2293
+ # coordinates: {
2294
+ # latitude: 1.0,
2295
+ # longitude: 1.0,
2296
+ # },
2297
+ # range_in_kilometers: 1.0,
2298
+ # },
2299
+ # },
2300
+ # metrics: {
2301
+ # "__string" => {
2302
+ # comparison_operator: "__string",
2303
+ # value: 1.0,
2304
+ # },
2305
+ # },
2306
+ # user_attributes: {
2307
+ # "__string" => {
2308
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2309
+ # values: ["__string"],
2310
+ # },
2311
+ # },
2312
+ # },
2313
+ # ],
2314
+ # source_segments: [
2315
+ # {
2316
+ # id: "__string",
2317
+ # version: 1,
2318
+ # },
2319
+ # ],
2320
+ # source_type: "ALL", # accepts ALL, ANY
2321
+ # type: "ALL", # accepts ALL, ANY, NONE
2322
+ # },
2323
+ # ],
2324
+ # include: "ALL", # accepts ALL, ANY, NONE
2325
+ # },
2119
2326
  # },
2120
2327
  # }
2121
2328
  #
@@ -2163,6 +2370,8 @@ module Aws::Pinpoint
2163
2370
  # @return [String]
2164
2371
  #
2165
2372
  # @!attribute [rw] substitutions
2373
+ # Default message substitutions. Can be overridden by individual
2374
+ # address substitutions.
2166
2375
  # @return [Hash<String,Array<String>>]
2167
2376
  #
2168
2377
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DefaultMessage AWS API Documentation
@@ -2220,6 +2429,8 @@ module Aws::Pinpoint
2220
2429
  # @return [Boolean]
2221
2430
  #
2222
2431
  # @!attribute [rw] substitutions
2432
+ # Default message substitutions. Can be overridden by individual
2433
+ # address substitutions.
2223
2434
  # @return [Hash<String,Array<String>>]
2224
2435
  #
2225
2436
  # @!attribute [rw] title
@@ -2543,7 +2754,6 @@ module Aws::Pinpoint
2543
2754
  # }
2544
2755
  #
2545
2756
  # @!attribute [rw] application_id
2546
- # Application Id.
2547
2757
  # @return [String]
2548
2758
  #
2549
2759
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStreamRequest AWS API Documentation
@@ -2653,7 +2863,41 @@ module Aws::Pinpoint
2653
2863
  include Aws::Structure
2654
2864
  end
2655
2865
 
2656
- # The message configuration.
2866
+ # @note When making an API call, you may pass DeleteUserEndpointsRequest
2867
+ # data as a hash:
2868
+ #
2869
+ # {
2870
+ # application_id: "__string", # required
2871
+ # user_id: "__string", # required
2872
+ # }
2873
+ #
2874
+ # @!attribute [rw] application_id
2875
+ # @return [String]
2876
+ #
2877
+ # @!attribute [rw] user_id
2878
+ # @return [String]
2879
+ #
2880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteUserEndpointsRequest AWS API Documentation
2881
+ #
2882
+ class DeleteUserEndpointsRequest < Struct.new(
2883
+ :application_id,
2884
+ :user_id)
2885
+ include Aws::Structure
2886
+ end
2887
+
2888
+ # @!attribute [rw] endpoints_response
2889
+ # List of endpoints
2890
+ # @return [Types::EndpointsResponse]
2891
+ #
2892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteUserEndpointsResponse AWS API Documentation
2893
+ #
2894
+ class DeleteUserEndpointsResponse < Struct.new(
2895
+ :endpoints_response)
2896
+ include Aws::Structure
2897
+ end
2898
+
2899
+ # Message definitions for the default message and any messages that are
2900
+ # tailored for specific channels.
2657
2901
  #
2658
2902
  # @note When making an API call, you may pass DirectMessageConfiguration
2659
2903
  # data as a hash:
@@ -2720,6 +2964,7 @@ module Aws::Pinpoint
2720
2964
  # substitutions: {
2721
2965
  # "__string" => ["__string"],
2722
2966
  # },
2967
+ # time_to_live: 1,
2723
2968
  # title: "__string",
2724
2969
  # url: "__string",
2725
2970
  # },
@@ -2767,6 +3012,7 @@ module Aws::Pinpoint
2767
3012
  # },
2768
3013
  # sms_message: {
2769
3014
  # body: "__string",
3015
+ # keyword: "__string",
2770
3016
  # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
2771
3017
  # origination_number: "__string",
2772
3018
  # sender_id: "__string",
@@ -2879,7 +3125,7 @@ module Aws::Pinpoint
2879
3125
  # @return [String]
2880
3126
  #
2881
3127
  # @!attribute [rw] has_credential
2882
- # If the channel is registered with a credential for authentication.
3128
+ # Not used. Retained for backwards compatibility.
2883
3129
  # @return [Boolean]
2884
3130
  #
2885
3131
  # @!attribute [rw] id
@@ -2902,6 +3148,10 @@ module Aws::Pinpoint
2902
3148
  # Last date this was updated
2903
3149
  # @return [String]
2904
3150
  #
3151
+ # @!attribute [rw] messages_per_second
3152
+ # Messages per second that can be sent
3153
+ # @return [Integer]
3154
+ #
2905
3155
  # @!attribute [rw] platform
2906
3156
  # Platform type. Will be "EMAIL"
2907
3157
  # @return [String]
@@ -2928,6 +3178,7 @@ module Aws::Pinpoint
2928
3178
  :is_archived,
2929
3179
  :last_modified_by,
2930
3180
  :last_modified_date,
3181
+ :messages_per_second,
2931
3182
  :platform,
2932
3183
  :role_arn,
2933
3184
  :version)
@@ -2980,11 +3231,24 @@ module Aws::Pinpoint
2980
3231
  # }
2981
3232
  #
2982
3233
  # @!attribute [rw] address
2983
- # The address or token of the endpoint as provided by your push
2984
- # provider (e.g. DeviceToken or RegistrationId).
3234
+ # The destination for messages that you send to this endpoint. The
3235
+ # address varies by channel. For mobile push channels, use the token
3236
+ # provided by the push notification service, such as the APNs device
3237
+ # token or the FCM registration token. For the SMS channel, use a
3238
+ # phone number in E.164 format, such as +1206XXX5550100. For the email
3239
+ # channel, use an email address.
2985
3240
  # @return [String]
2986
3241
  #
2987
3242
  # @!attribute [rw] attributes
3243
+ # Custom attributes that describe the endpoint by associating a name
3244
+ # with an array of values. For example, an attribute named
3245
+ # "interests" might have the values \["science", "politics",
3246
+ # "travel"\]. You can use these attributes as selection criteria
3247
+ # when you create a segment of users to engage with a messaging
3248
+ # campaign. The following characters are not recommended in attribute
3249
+ # names: # : ? \\ /. The Amazon Pinpoint console does not display
3250
+ # attributes that include these characters in the name. This
3251
+ # limitation does not apply to attribute values.
2988
3252
  # @return [Hash<String,Array<String>>]
2989
3253
  #
2990
3254
  # @!attribute [rw] channel_type
@@ -3001,9 +3265,7 @@ module Aws::Pinpoint
3001
3265
  # @return [String]
3002
3266
  #
3003
3267
  # @!attribute [rw] endpoint_status
3004
- # The endpoint status. Can be either ACTIVE or INACTIVE. Will be set
3005
- # to INACTIVE if a delivery fails. Will be set to ACTIVE if the
3006
- # address is updated.
3268
+ # Unused.
3007
3269
  # @return [String]
3008
3270
  #
3009
3271
  # @!attribute [rw] id
@@ -3239,6 +3501,10 @@ module Aws::Pinpoint
3239
3501
  # Delivery status of message.
3240
3502
  # @return [String]
3241
3503
  #
3504
+ # @!attribute [rw] message_id
3505
+ # Unique message identifier associated with the message that was sent.
3506
+ # @return [String]
3507
+ #
3242
3508
  # @!attribute [rw] status_code
3243
3509
  # Downstream service status code.
3244
3510
  # @return [Integer]
@@ -3256,6 +3522,7 @@ module Aws::Pinpoint
3256
3522
  class EndpointMessageResult < Struct.new(
3257
3523
  :address,
3258
3524
  :delivery_status,
3525
+ :message_id,
3259
3526
  :status_code,
3260
3527
  :status_message,
3261
3528
  :updated_token)
@@ -3307,11 +3574,24 @@ module Aws::Pinpoint
3307
3574
  # }
3308
3575
  #
3309
3576
  # @!attribute [rw] address
3310
- # The address or token of the endpoint as provided by your push
3311
- # provider (e.g. DeviceToken or RegistrationId).
3577
+ # The destination for messages that you send to this endpoint. The
3578
+ # address varies by channel. For mobile push channels, use the token
3579
+ # provided by the push notification service, such as the APNs device
3580
+ # token or the FCM registration token. For the SMS channel, use a
3581
+ # phone number in E.164 format, such as +1206XXX5550100. For the email
3582
+ # channel, use an email address.
3312
3583
  # @return [String]
3313
3584
  #
3314
3585
  # @!attribute [rw] attributes
3586
+ # Custom attributes that describe the endpoint by associating a name
3587
+ # with an array of values. For example, an attribute named
3588
+ # "interests" might have the values \["science", "politics",
3589
+ # "travel"\]. You can use these attributes as selection criteria
3590
+ # when you create a segment of users to engage with a messaging
3591
+ # campaign. The following characters are not recommended in attribute
3592
+ # names: # : ? \\ /. The Amazon Pinpoint console does not display
3593
+ # attributes that include these characters in the name. This
3594
+ # limitation does not apply to attribute values.
3315
3595
  # @return [Hash<String,Array<String>>]
3316
3596
  #
3317
3597
  # @!attribute [rw] channel_type
@@ -3328,9 +3608,7 @@ module Aws::Pinpoint
3328
3608
  # @return [String]
3329
3609
  #
3330
3610
  # @!attribute [rw] endpoint_status
3331
- # The endpoint status. Can be either ACTIVE or INACTIVE. Will be set
3332
- # to INACTIVE if a delivery fails. Will be set to ACTIVE if the
3333
- # address is updated.
3611
+ # Unused.
3334
3612
  # @return [String]
3335
3613
  #
3336
3614
  # @!attribute [rw] location
@@ -3385,6 +3663,15 @@ module Aws::Pinpoint
3385
3663
  # @return [String]
3386
3664
  #
3387
3665
  # @!attribute [rw] attributes
3666
+ # Custom attributes that describe the endpoint by associating a name
3667
+ # with an array of values. For example, an attribute named
3668
+ # "interests" might have the values \["science", "politics",
3669
+ # "travel"\]. You can use these attributes as selection criteria
3670
+ # when you create a segment of users to engage with a messaging
3671
+ # campaign. The following characters are not recommended in attribute
3672
+ # names: # : ? \\ /. The Amazon Pinpoint console does not display
3673
+ # attributes that include these characters in the name. This
3674
+ # limitation does not apply to attribute values.
3388
3675
  # @return [Hash<String,Array<String>>]
3389
3676
  #
3390
3677
  # @!attribute [rw] channel_type
@@ -3413,9 +3700,7 @@ module Aws::Pinpoint
3413
3700
  # @return [String]
3414
3701
  #
3415
3702
  # @!attribute [rw] endpoint_status
3416
- # The endpoint status. Can be either ACTIVE or INACTIVE. Will be set
3417
- # to INACTIVE if a delivery fails. Will be set to ACTIVE if the
3418
- # address is updated.
3703
+ # Unused.
3419
3704
  # @return [String]
3420
3705
  #
3421
3706
  # @!attribute [rw] id
@@ -3502,6 +3787,9 @@ module Aws::Pinpoint
3502
3787
  # @return [String]
3503
3788
  #
3504
3789
  # @!attribute [rw] substitutions
3790
+ # A map of substitution values for the message to be merged with the
3791
+ # DefaultMessage's substitutions. Substitutions on this map take
3792
+ # precedence over the all other substitutions.
3505
3793
  # @return [Hash<String,Array<String>>]
3506
3794
  #
3507
3795
  # @!attribute [rw] title_override
@@ -3533,6 +3821,15 @@ module Aws::Pinpoint
3533
3821
  # }
3534
3822
  #
3535
3823
  # @!attribute [rw] user_attributes
3824
+ # Custom attributes that describe an end user by associating a name
3825
+ # with an array of values. For example, an attribute named
3826
+ # "interests" might have the values \["science", "politics",
3827
+ # "travel"\]. You can use these attributes as selection criteria
3828
+ # when you create a segment of users to engage with a messaging
3829
+ # campaign. The following characters are not recommended in attribute
3830
+ # names: # : ? \\ /. The Amazon Pinpoint console does not display
3831
+ # attributes that include these characters in the name. This
3832
+ # limitation does not apply to attribute values.
3536
3833
  # @return [Hash<String,Array<String>>]
3537
3834
  #
3538
3835
  # @!attribute [rw] user_id
@@ -3547,6 +3844,19 @@ module Aws::Pinpoint
3547
3844
  include Aws::Structure
3548
3845
  end
3549
3846
 
3847
+ # List of endpoints
3848
+ #
3849
+ # @!attribute [rw] item
3850
+ # The list of endpoints.
3851
+ # @return [Array<Types::EndpointResponse>]
3852
+ #
3853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointsResponse AWS API Documentation
3854
+ #
3855
+ class EndpointsResponse < Struct.new(
3856
+ :item)
3857
+ include Aws::Structure
3858
+ end
3859
+
3550
3860
  # Model for an event publishing subscription export.
3551
3861
  #
3552
3862
  # @!attribute [rw] application_id
@@ -3593,6 +3903,8 @@ module Aws::Pinpoint
3593
3903
  include Aws::Structure
3594
3904
  end
3595
3905
 
3906
+ # Export job request.
3907
+ #
3596
3908
  # @note When making an API call, you may pass ExportJobRequest
3597
3909
  # data as a hash:
3598
3910
  #
@@ -3600,6 +3912,7 @@ module Aws::Pinpoint
3600
3912
  # role_arn: "__string",
3601
3913
  # s3_url_prefix: "__string",
3602
3914
  # segment_id: "__string",
3915
+ # segment_version: 1,
3603
3916
  # }
3604
3917
  #
3605
3918
  # @!attribute [rw] role_arn
@@ -3617,19 +3930,27 @@ module Aws::Pinpoint
3617
3930
  # @return [String]
3618
3931
  #
3619
3932
  # @!attribute [rw] segment_id
3620
- # The ID of the segment to export endpoints from. If not present, all
3621
- # endpoints will be exported.
3933
+ # The ID of the segment to export endpoints from. If not present,
3934
+ # Amazon Pinpoint exports all of the endpoints that belong to the
3935
+ # application.
3622
3936
  # @return [String]
3623
3937
  #
3938
+ # @!attribute [rw] segment_version
3939
+ # The version of the segment to export if specified.
3940
+ # @return [Integer]
3941
+ #
3624
3942
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ExportJobRequest AWS API Documentation
3625
3943
  #
3626
3944
  class ExportJobRequest < Struct.new(
3627
3945
  :role_arn,
3628
3946
  :s3_url_prefix,
3629
- :segment_id)
3947
+ :segment_id,
3948
+ :segment_version)
3630
3949
  include Aws::Structure
3631
3950
  end
3632
3951
 
3952
+ # Export job resource.
3953
+ #
3633
3954
  # @!attribute [rw] role_arn
3634
3955
  # The Amazon Resource Name (ARN) of an IAM role that grants Amazon
3635
3956
  # Pinpoint access to the Amazon S3 location that endpoints will be
@@ -3645,19 +3966,27 @@ module Aws::Pinpoint
3645
3966
  # @return [String]
3646
3967
  #
3647
3968
  # @!attribute [rw] segment_id
3648
- # The ID of the segment to export endpoints from. If not present all
3649
- # endpoints will be exported.
3969
+ # The ID of the segment to export endpoints from. If not present,
3970
+ # Amazon Pinpoint exports all of the endpoints that belong to the
3971
+ # application.
3650
3972
  # @return [String]
3651
3973
  #
3974
+ # @!attribute [rw] segment_version
3975
+ # The version of the segment to export if specified.
3976
+ # @return [Integer]
3977
+ #
3652
3978
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ExportJobResource AWS API Documentation
3653
3979
  #
3654
3980
  class ExportJobResource < Struct.new(
3655
3981
  :role_arn,
3656
3982
  :s3_url_prefix,
3657
- :segment_id)
3983
+ :segment_id,
3984
+ :segment_version)
3658
3985
  include Aws::Structure
3659
3986
  end
3660
3987
 
3988
+ # Export job response.
3989
+ #
3661
3990
  # @!attribute [rw] application_id
3662
3991
  # The unique ID of the application to which the job applies.
3663
3992
  # @return [String]
@@ -3685,6 +4014,8 @@ module Aws::Pinpoint
3685
4014
  # @return [Integer]
3686
4015
  #
3687
4016
  # @!attribute [rw] failures
4017
+ # Provides up to 100 of the first failed entries for the job, if any
4018
+ # exist.
3688
4019
  # @return [Array<String>]
3689
4020
  #
3690
4021
  # @!attribute [rw] id
@@ -3692,7 +4023,7 @@ module Aws::Pinpoint
3692
4023
  # @return [String]
3693
4024
  #
3694
4025
  # @!attribute [rw] job_status
3695
- # The status of the export job. Valid values: CREATED, INITIALIZING,
4026
+ # The status of the job. Valid values: CREATED, INITIALIZING,
3696
4027
  # PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is
3697
4028
  # FAILED if one or more pieces failed.
3698
4029
  # @return [String]
@@ -3798,10 +4129,7 @@ module Aws::Pinpoint
3798
4129
  # @return [Boolean]
3799
4130
  #
3800
4131
  # @!attribute [rw] has_credential
3801
- # Indicates whether the channel is configured with FCM or GCM
3802
- # credentials. Amazon Pinpoint uses your credentials to authenticate
3803
- # push notifications with FCM or GCM. Provide your credentials by
3804
- # setting the ApiKey attribute.
4132
+ # Not used. Retained for backwards compatibility.
3805
4133
  # @return [Boolean]
3806
4134
  #
3807
4135
  # @!attribute [rw] id
@@ -3957,6 +4285,8 @@ module Aws::Pinpoint
3957
4285
  # @return [String]
3958
4286
  #
3959
4287
  # @!attribute [rw] substitutions
4288
+ # Default message substitutions. Can be overridden by individual
4289
+ # address substitutions.
3960
4290
  # @return [Hash<String,Array<String>>]
3961
4291
  #
3962
4292
  # @!attribute [rw] time_to_live
@@ -3999,6 +4329,61 @@ module Aws::Pinpoint
3999
4329
  include Aws::Structure
4000
4330
  end
4001
4331
 
4332
+ # GPS coordinates
4333
+ #
4334
+ # @note When making an API call, you may pass GPSCoordinates
4335
+ # data as a hash:
4336
+ #
4337
+ # {
4338
+ # latitude: 1.0,
4339
+ # longitude: 1.0,
4340
+ # }
4341
+ #
4342
+ # @!attribute [rw] latitude
4343
+ # Latitude
4344
+ # @return [Float]
4345
+ #
4346
+ # @!attribute [rw] longitude
4347
+ # Longitude
4348
+ # @return [Float]
4349
+ #
4350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GPSCoordinates AWS API Documentation
4351
+ #
4352
+ class GPSCoordinates < Struct.new(
4353
+ :latitude,
4354
+ :longitude)
4355
+ include Aws::Structure
4356
+ end
4357
+
4358
+ # GPS point location dimension
4359
+ #
4360
+ # @note When making an API call, you may pass GPSPointDimension
4361
+ # data as a hash:
4362
+ #
4363
+ # {
4364
+ # coordinates: {
4365
+ # latitude: 1.0,
4366
+ # longitude: 1.0,
4367
+ # },
4368
+ # range_in_kilometers: 1.0,
4369
+ # }
4370
+ #
4371
+ # @!attribute [rw] coordinates
4372
+ # Coordinate to measure distance from.
4373
+ # @return [Types::GPSCoordinates]
4374
+ #
4375
+ # @!attribute [rw] range_in_kilometers
4376
+ # Range in kilometers from the coordinate.
4377
+ # @return [Float]
4378
+ #
4379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GPSPointDimension AWS API Documentation
4380
+ #
4381
+ class GPSPointDimension < Struct.new(
4382
+ :coordinates,
4383
+ :range_in_kilometers)
4384
+ include Aws::Structure
4385
+ end
4386
+
4002
4387
  # @note When making an API call, you may pass GetAdmChannelRequest
4003
4388
  # data as a hash:
4004
4389
  #
@@ -4451,6 +4836,34 @@ module Aws::Pinpoint
4451
4836
  include Aws::Structure
4452
4837
  end
4453
4838
 
4839
+ # @note When making an API call, you may pass GetChannelsRequest
4840
+ # data as a hash:
4841
+ #
4842
+ # {
4843
+ # application_id: "__string", # required
4844
+ # }
4845
+ #
4846
+ # @!attribute [rw] application_id
4847
+ # @return [String]
4848
+ #
4849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetChannelsRequest AWS API Documentation
4850
+ #
4851
+ class GetChannelsRequest < Struct.new(
4852
+ :application_id)
4853
+ include Aws::Structure
4854
+ end
4855
+
4856
+ # @!attribute [rw] channels_response
4857
+ # Get channels definition
4858
+ # @return [Types::ChannelsResponse]
4859
+ #
4860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetChannelsResponse AWS API Documentation
4861
+ #
4862
+ class GetChannelsResponse < Struct.new(
4863
+ :channels_response)
4864
+ include Aws::Structure
4865
+ end
4866
+
4454
4867
  # @note When making an API call, you may pass GetEmailChannelRequest
4455
4868
  # data as a hash:
4456
4869
  #
@@ -4520,7 +4933,6 @@ module Aws::Pinpoint
4520
4933
  # }
4521
4934
  #
4522
4935
  # @!attribute [rw] application_id
4523
- # Application Id.
4524
4936
  # @return [String]
4525
4937
  #
4526
4938
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEventStreamRequest AWS API Documentation
@@ -4564,6 +4976,7 @@ module Aws::Pinpoint
4564
4976
  end
4565
4977
 
4566
4978
  # @!attribute [rw] export_job_response
4979
+ # Export job response.
4567
4980
  # @return [Types::ExportJobResponse]
4568
4981
  #
4569
4982
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJobResponse AWS API Documentation
@@ -4662,6 +5075,7 @@ module Aws::Pinpoint
4662
5075
  end
4663
5076
 
4664
5077
  # @!attribute [rw] import_job_response
5078
+ # Import job response.
4665
5079
  # @return [Types::ImportJobResponse]
4666
5080
  #
4667
5081
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobResponse AWS API Documentation
@@ -4975,6 +5389,41 @@ module Aws::Pinpoint
4975
5389
  include Aws::Structure
4976
5390
  end
4977
5391
 
5392
+ # @note When making an API call, you may pass GetUserEndpointsRequest
5393
+ # data as a hash:
5394
+ #
5395
+ # {
5396
+ # application_id: "__string", # required
5397
+ # user_id: "__string", # required
5398
+ # }
5399
+ #
5400
+ # @!attribute [rw] application_id
5401
+ # @return [String]
5402
+ #
5403
+ # @!attribute [rw] user_id
5404
+ # @return [String]
5405
+ #
5406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetUserEndpointsRequest AWS API Documentation
5407
+ #
5408
+ class GetUserEndpointsRequest < Struct.new(
5409
+ :application_id,
5410
+ :user_id)
5411
+ include Aws::Structure
5412
+ end
5413
+
5414
+ # @!attribute [rw] endpoints_response
5415
+ # List of endpoints
5416
+ # @return [Types::EndpointsResponse]
5417
+ #
5418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetUserEndpointsResponse AWS API Documentation
5419
+ #
5420
+ class GetUserEndpointsResponse < Struct.new(
5421
+ :endpoints_response)
5422
+ include Aws::Structure
5423
+ end
5424
+
5425
+ # Import job request.
5426
+ #
4978
5427
  # @note When making an API call, you may pass ImportJobRequest
4979
5428
  # data as a hash:
4980
5429
  #
@@ -5048,6 +5497,8 @@ module Aws::Pinpoint
5048
5497
  include Aws::Structure
5049
5498
  end
5050
5499
 
5500
+ # Import job resource
5501
+ #
5051
5502
  # @!attribute [rw] define_segment
5052
5503
  # Sets whether the endpoints create a segment when they are imported.
5053
5504
  # @return [Boolean]
@@ -5107,6 +5558,8 @@ module Aws::Pinpoint
5107
5558
  include Aws::Structure
5108
5559
  end
5109
5560
 
5561
+ # Import job response.
5562
+ #
5110
5563
  # @!attribute [rw] application_id
5111
5564
  # The unique ID of the application to which the import job applies.
5112
5565
  # @return [String]
@@ -5134,6 +5587,8 @@ module Aws::Pinpoint
5134
5587
  # @return [Integer]
5135
5588
  #
5136
5589
  # @!attribute [rw] failures
5590
+ # Provides up to 100 of the first failed entries for the job, if any
5591
+ # exist.
5137
5592
  # @return [Array<String>]
5138
5593
  #
5139
5594
  # @!attribute [rw] id
@@ -5203,6 +5658,8 @@ module Aws::Pinpoint
5203
5658
  include Aws::Structure
5204
5659
  end
5205
5660
 
5661
+ # Message to send
5662
+ #
5206
5663
  # @note When making an API call, you may pass Message
5207
5664
  # data as a hash:
5208
5665
  #
@@ -5216,6 +5673,7 @@ module Aws::Pinpoint
5216
5673
  # media_url: "__string",
5217
5674
  # raw_content: "__string",
5218
5675
  # silent_push: false,
5676
+ # time_to_live: 1,
5219
5677
  # title: "__string",
5220
5678
  # url: "__string",
5221
5679
  # }
@@ -5268,6 +5726,15 @@ module Aws::Pinpoint
5268
5726
  # cases.
5269
5727
  # @return [Boolean]
5270
5728
  #
5729
+ # @!attribute [rw] time_to_live
5730
+ # This parameter specifies how long (in seconds) the message should be
5731
+ # kept if the service is unable to deliver the notification the first
5732
+ # time. If the value is 0, it treats the notification as if it expires
5733
+ # immediately and does not store the notification or attempt to
5734
+ # redeliver it. This value is converted to the expiration field when
5735
+ # sent to the service. It only applies to APNs and GCM
5736
+ # @return [Integer]
5737
+ #
5271
5738
  # @!attribute [rw] title
5272
5739
  # The message title that displays above the message on the user's
5273
5740
  # device.
@@ -5290,6 +5757,7 @@ module Aws::Pinpoint
5290
5757
  :media_url,
5291
5758
  :raw_content,
5292
5759
  :silent_push,
5760
+ :time_to_live,
5293
5761
  :title,
5294
5762
  :url)
5295
5763
  include Aws::Structure
@@ -5298,7 +5766,7 @@ module Aws::Pinpoint
5298
5766
  # Simple message object.
5299
5767
  #
5300
5768
  # @!attribute [rw] message
5301
- # The error message returned from the API.
5769
+ # The error message that's returned from the API.
5302
5770
  # @return [String]
5303
5771
  #
5304
5772
  # @!attribute [rw] request_id
@@ -5329,6 +5797,7 @@ module Aws::Pinpoint
5329
5797
  # media_url: "__string",
5330
5798
  # raw_content: "__string",
5331
5799
  # silent_push: false,
5800
+ # time_to_live: 1,
5332
5801
  # title: "__string",
5333
5802
  # url: "__string",
5334
5803
  # },
@@ -5342,6 +5811,7 @@ module Aws::Pinpoint
5342
5811
  # media_url: "__string",
5343
5812
  # raw_content: "__string",
5344
5813
  # silent_push: false,
5814
+ # time_to_live: 1,
5345
5815
  # title: "__string",
5346
5816
  # url: "__string",
5347
5817
  # },
@@ -5355,6 +5825,7 @@ module Aws::Pinpoint
5355
5825
  # media_url: "__string",
5356
5826
  # raw_content: "__string",
5357
5827
  # silent_push: false,
5828
+ # time_to_live: 1,
5358
5829
  # title: "__string",
5359
5830
  # url: "__string",
5360
5831
  # },
@@ -5368,6 +5839,7 @@ module Aws::Pinpoint
5368
5839
  # media_url: "__string",
5369
5840
  # raw_content: "__string",
5370
5841
  # silent_push: false,
5842
+ # time_to_live: 1,
5371
5843
  # title: "__string",
5372
5844
  # url: "__string",
5373
5845
  # },
@@ -5387,6 +5859,7 @@ module Aws::Pinpoint
5387
5859
  # media_url: "__string",
5388
5860
  # raw_content: "__string",
5389
5861
  # silent_push: false,
5862
+ # time_to_live: 1,
5390
5863
  # title: "__string",
5391
5864
  # url: "__string",
5392
5865
  # },
@@ -5540,6 +6013,7 @@ module Aws::Pinpoint
5540
6013
  # substitutions: {
5541
6014
  # "__string" => ["__string"],
5542
6015
  # },
6016
+ # time_to_live: 1,
5543
6017
  # title: "__string",
5544
6018
  # url: "__string",
5545
6019
  # },
@@ -5587,6 +6061,7 @@ module Aws::Pinpoint
5587
6061
  # },
5588
6062
  # sms_message: {
5589
6063
  # body: "__string",
6064
+ # keyword: "__string",
5590
6065
  # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
5591
6066
  # origination_number: "__string",
5592
6067
  # sender_id: "__string",
@@ -5598,9 +6073,9 @@ module Aws::Pinpoint
5598
6073
  # }
5599
6074
  #
5600
6075
  # @!attribute [rw] addresses
5601
- # A map of destination addresses, with the address as the key(Email
5602
- # address, phone number or push token) and the Address Configuration
5603
- # as the value.
6076
+ # A map of key-value pairs, where each key is an address and each
6077
+ # value is an AddressConfiguration object. An address can be a push
6078
+ # notification token, a phone number, or an email address.
5604
6079
  # @return [Hash<String,Types::AddressConfiguration>]
5605
6080
  #
5606
6081
  # @!attribute [rw] context
@@ -5611,9 +6086,10 @@ module Aws::Pinpoint
5611
6086
  # @return [Hash<String,String>]
5612
6087
  #
5613
6088
  # @!attribute [rw] endpoints
5614
- # A map of destination addresses, with the address as the key(Email
5615
- # address, phone number or push token) and the Address Configuration
5616
- # as the value.
6089
+ # A map of key-value pairs, where each key is an endpoint ID and each
6090
+ # value is an EndpointSendConfiguration object. Within an
6091
+ # EndpointSendConfiguration object, you can tailor the message for an
6092
+ # endpoint by specifying message overrides or substitutions.
5617
6093
  # @return [Hash<String,Types::EndpointSendConfiguration>]
5618
6094
  #
5619
6095
  # @!attribute [rw] message_configuration
@@ -5667,6 +6143,10 @@ module Aws::Pinpoint
5667
6143
  # Delivery status of message.
5668
6144
  # @return [String]
5669
6145
  #
6146
+ # @!attribute [rw] message_id
6147
+ # Unique message identifier associated with the message that was sent.
6148
+ # @return [String]
6149
+ #
5670
6150
  # @!attribute [rw] status_code
5671
6151
  # Downstream service status code.
5672
6152
  # @return [Integer]
@@ -5683,30 +6163,201 @@ module Aws::Pinpoint
5683
6163
  #
5684
6164
  class MessageResult < Struct.new(
5685
6165
  :delivery_status,
6166
+ :message_id,
5686
6167
  :status_code,
5687
6168
  :status_message,
5688
6169
  :updated_token)
5689
6170
  include Aws::Structure
5690
6171
  end
5691
6172
 
5692
- # @note When making an API call, you may pass PutEventStreamRequest
6173
+ # Custom metric dimension
6174
+ #
6175
+ # @note When making an API call, you may pass MetricDimension
5693
6176
  # data as a hash:
5694
6177
  #
5695
6178
  # {
5696
- # application_id: "__string", # required
5697
- # write_event_stream: { # required
5698
- # destination_stream_arn: "__string",
5699
- # role_arn: "__string",
5700
- # },
6179
+ # comparison_operator: "__string",
6180
+ # value: 1.0,
5701
6181
  # }
5702
6182
  #
5703
- # @!attribute [rw] application_id
5704
- # Application Id.
6183
+ # @!attribute [rw] comparison_operator
6184
+ # GREATER\_THAN \| LESS\_THAN \| GREATER\_THAN\_OR\_EQUAL \|
6185
+ # LESS\_THAN\_OR\_EQUAL \| EQUAL
5705
6186
  # @return [String]
5706
6187
  #
5707
- # @!attribute [rw] write_event_stream
5708
- # Write event stream wrapper.
5709
- # @return [Types::WriteEventStream]
6188
+ # @!attribute [rw] value
6189
+ # Value to be compared.
6190
+ # @return [Float]
6191
+ #
6192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/MetricDimension AWS API Documentation
6193
+ #
6194
+ class MetricDimension < Struct.new(
6195
+ :comparison_operator,
6196
+ :value)
6197
+ include Aws::Structure
6198
+ end
6199
+
6200
+ # Phone Number Information request.
6201
+ #
6202
+ # @note When making an API call, you may pass NumberValidateRequest
6203
+ # data as a hash:
6204
+ #
6205
+ # {
6206
+ # iso_country_code: "__string",
6207
+ # phone_number: "__string",
6208
+ # }
6209
+ #
6210
+ # @!attribute [rw] iso_country_code
6211
+ # (Optional) The two-character ISO country code for the country where
6212
+ # the phone number was originally registered.
6213
+ # @return [String]
6214
+ #
6215
+ # @!attribute [rw] phone_number
6216
+ # The phone number to get information about.
6217
+ # @return [String]
6218
+ #
6219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/NumberValidateRequest AWS API Documentation
6220
+ #
6221
+ class NumberValidateRequest < Struct.new(
6222
+ :iso_country_code,
6223
+ :phone_number)
6224
+ include Aws::Structure
6225
+ end
6226
+
6227
+ # Phone Number Information response.
6228
+ #
6229
+ # @!attribute [rw] carrier
6230
+ # The carrier that the phone number is registered with.
6231
+ # @return [String]
6232
+ #
6233
+ # @!attribute [rw] city
6234
+ # The city where the phone number was originally registered.
6235
+ # @return [String]
6236
+ #
6237
+ # @!attribute [rw] cleansed_phone_number_e164
6238
+ # The cleansed (standardized) phone number in E.164 format.
6239
+ # @return [String]
6240
+ #
6241
+ # @!attribute [rw] cleansed_phone_number_national
6242
+ # The cleansed phone number in national format.
6243
+ # @return [String]
6244
+ #
6245
+ # @!attribute [rw] country
6246
+ # The country where the phone number was originally registered.
6247
+ # @return [String]
6248
+ #
6249
+ # @!attribute [rw] country_code_iso_2
6250
+ # The two-character ISO country code for the country where the phone
6251
+ # number was originally registered.
6252
+ # @return [String]
6253
+ #
6254
+ # @!attribute [rw] country_code_numeric
6255
+ # The numeric country code for the country where the phone number was
6256
+ # originally registered.
6257
+ # @return [String]
6258
+ #
6259
+ # @!attribute [rw] county
6260
+ # The county where the phone number was originally registered.
6261
+ # @return [String]
6262
+ #
6263
+ # @!attribute [rw] original_country_code_iso_2
6264
+ # The two-character ISO country code that was included in the request
6265
+ # body.
6266
+ # @return [String]
6267
+ #
6268
+ # @!attribute [rw] original_phone_number
6269
+ # The phone number that you included in the request body.
6270
+ # @return [String]
6271
+ #
6272
+ # @!attribute [rw] phone_type
6273
+ # A description of the phone type. Possible values include MOBILE,
6274
+ # LANDLINE, VOIP, INVALID, and OTHER.
6275
+ # @return [String]
6276
+ #
6277
+ # @!attribute [rw] phone_type_code
6278
+ # The phone type as an integer. Possible values include 0 (MOBILE), 1
6279
+ # (LANDLINE), 2 (VOIP), 3 (INVALID), and 4 (OTHER).
6280
+ # @return [Integer]
6281
+ #
6282
+ # @!attribute [rw] timezone
6283
+ # The time zone for the location where the phone number was originally
6284
+ # registered.
6285
+ # @return [String]
6286
+ #
6287
+ # @!attribute [rw] zip_code
6288
+ # The zip code for the location where the phone number was originally
6289
+ # registered.
6290
+ # @return [String]
6291
+ #
6292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/NumberValidateResponse AWS API Documentation
6293
+ #
6294
+ class NumberValidateResponse < Struct.new(
6295
+ :carrier,
6296
+ :city,
6297
+ :cleansed_phone_number_e164,
6298
+ :cleansed_phone_number_national,
6299
+ :country,
6300
+ :country_code_iso_2,
6301
+ :country_code_numeric,
6302
+ :county,
6303
+ :original_country_code_iso_2,
6304
+ :original_phone_number,
6305
+ :phone_type,
6306
+ :phone_type_code,
6307
+ :timezone,
6308
+ :zip_code)
6309
+ include Aws::Structure
6310
+ end
6311
+
6312
+ # @note When making an API call, you may pass PhoneNumberValidateRequest
6313
+ # data as a hash:
6314
+ #
6315
+ # {
6316
+ # number_validate_request: { # required
6317
+ # iso_country_code: "__string",
6318
+ # phone_number: "__string",
6319
+ # },
6320
+ # }
6321
+ #
6322
+ # @!attribute [rw] number_validate_request
6323
+ # Phone Number Information request.
6324
+ # @return [Types::NumberValidateRequest]
6325
+ #
6326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PhoneNumberValidateRequest AWS API Documentation
6327
+ #
6328
+ class PhoneNumberValidateRequest < Struct.new(
6329
+ :number_validate_request)
6330
+ include Aws::Structure
6331
+ end
6332
+
6333
+ # @!attribute [rw] number_validate_response
6334
+ # Phone Number Information response.
6335
+ # @return [Types::NumberValidateResponse]
6336
+ #
6337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PhoneNumberValidateResponse AWS API Documentation
6338
+ #
6339
+ class PhoneNumberValidateResponse < Struct.new(
6340
+ :number_validate_response)
6341
+ include Aws::Structure
6342
+ end
6343
+
6344
+ # @note When making an API call, you may pass PutEventStreamRequest
6345
+ # data as a hash:
6346
+ #
6347
+ # {
6348
+ # application_id: "__string", # required
6349
+ # write_event_stream: { # required
6350
+ # destination_stream_arn: "__string",
6351
+ # role_arn: "__string",
6352
+ # },
6353
+ # }
6354
+ #
6355
+ # @!attribute [rw] application_id
6356
+ # @return [String]
6357
+ #
6358
+ # @!attribute [rw] write_event_stream
6359
+ # Request to save an EventStream.
6360
+ # @return [Types::WriteEventStream]
5710
6361
  #
5711
6362
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventStreamRequest AWS API Documentation
5712
6363
  #
@@ -5783,6 +6434,47 @@ module Aws::Pinpoint
5783
6434
  include Aws::Structure
5784
6435
  end
5785
6436
 
6437
+ # @note When making an API call, you may pass RemoveAttributesRequest
6438
+ # data as a hash:
6439
+ #
6440
+ # {
6441
+ # application_id: "__string", # required
6442
+ # attribute_type: "__string", # required
6443
+ # update_attributes_request: { # required
6444
+ # blacklist: ["__string"],
6445
+ # },
6446
+ # }
6447
+ #
6448
+ # @!attribute [rw] application_id
6449
+ # @return [String]
6450
+ #
6451
+ # @!attribute [rw] attribute_type
6452
+ # @return [String]
6453
+ #
6454
+ # @!attribute [rw] update_attributes_request
6455
+ # Update attributes request
6456
+ # @return [Types::UpdateAttributesRequest]
6457
+ #
6458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RemoveAttributesRequest AWS API Documentation
6459
+ #
6460
+ class RemoveAttributesRequest < Struct.new(
6461
+ :application_id,
6462
+ :attribute_type,
6463
+ :update_attributes_request)
6464
+ include Aws::Structure
6465
+ end
6466
+
6467
+ # @!attribute [rw] attributes_resource
6468
+ # Attributes.
6469
+ # @return [Types::AttributesResource]
6470
+ #
6471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RemoveAttributesResponse AWS API Documentation
6472
+ #
6473
+ class RemoveAttributesResponse < Struct.new(
6474
+ :attributes_resource)
6475
+ include Aws::Structure
6476
+ end
6477
+
5786
6478
  # SMS Channel Request
5787
6479
  #
5788
6480
  # @note When making an API call, you may pass SMSChannelRequest
@@ -5830,7 +6522,7 @@ module Aws::Pinpoint
5830
6522
  # @return [Boolean]
5831
6523
  #
5832
6524
  # @!attribute [rw] has_credential
5833
- # If the channel is registered with a credential for authentication.
6525
+ # Not used. Retained for backwards compatibility.
5834
6526
  # @return [Boolean]
5835
6527
  #
5836
6528
  # @!attribute [rw] id
@@ -5853,6 +6545,10 @@ module Aws::Pinpoint
5853
6545
  # Platform type. Will be "SMS"
5854
6546
  # @return [String]
5855
6547
  #
6548
+ # @!attribute [rw] promotional_messages_per_second
6549
+ # Promotional messages per second that can be sent
6550
+ # @return [Integer]
6551
+ #
5856
6552
  # @!attribute [rw] sender_id
5857
6553
  # Sender identifier of your messages.
5858
6554
  # @return [String]
@@ -5861,6 +6557,10 @@ module Aws::Pinpoint
5861
6557
  # The short code registered with the phone provider.
5862
6558
  # @return [String]
5863
6559
  #
6560
+ # @!attribute [rw] transactional_messages_per_second
6561
+ # Transactional messages per second that can be sent
6562
+ # @return [Integer]
6563
+ #
5864
6564
  # @!attribute [rw] version
5865
6565
  # Version of channel
5866
6566
  # @return [Integer]
@@ -5877,8 +6577,10 @@ module Aws::Pinpoint
5877
6577
  :last_modified_by,
5878
6578
  :last_modified_date,
5879
6579
  :platform,
6580
+ :promotional_messages_per_second,
5880
6581
  :sender_id,
5881
6582
  :short_code,
6583
+ :transactional_messages_per_second,
5882
6584
  :version)
5883
6585
  include Aws::Structure
5884
6586
  end
@@ -5890,6 +6592,7 @@ module Aws::Pinpoint
5890
6592
  #
5891
6593
  # {
5892
6594
  # body: "__string",
6595
+ # keyword: "__string",
5893
6596
  # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
5894
6597
  # origination_number: "__string",
5895
6598
  # sender_id: "__string",
@@ -5899,8 +6602,12 @@ module Aws::Pinpoint
5899
6602
  # }
5900
6603
  #
5901
6604
  # @!attribute [rw] body
5902
- # The message body of the notification, the email body or the text
5903
- # message.
6605
+ # The body of the SMS message.
6606
+ # @return [String]
6607
+ #
6608
+ # @!attribute [rw] keyword
6609
+ # The SMS program name that you provided to AWS Support when you
6610
+ # requested your dedicated number.
5904
6611
  # @return [String]
5905
6612
  #
5906
6613
  # @!attribute [rw] message_type
@@ -5921,12 +6628,15 @@ module Aws::Pinpoint
5921
6628
  # @return [String]
5922
6629
  #
5923
6630
  # @!attribute [rw] substitutions
6631
+ # Default message substitutions. Can be overridden by individual
6632
+ # address substitutions.
5924
6633
  # @return [Hash<String,Array<String>>]
5925
6634
  #
5926
6635
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSMessage AWS API Documentation
5927
6636
  #
5928
6637
  class SMSMessage < Struct.new(
5929
6638
  :body,
6639
+ :keyword,
5930
6640
  :message_type,
5931
6641
  :origination_number,
5932
6642
  :sender_id,
@@ -6133,6 +6843,19 @@ module Aws::Pinpoint
6133
6843
  # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6134
6844
  # values: ["__string"],
6135
6845
  # },
6846
+ # gps_point: {
6847
+ # coordinates: {
6848
+ # latitude: 1.0,
6849
+ # longitude: 1.0,
6850
+ # },
6851
+ # range_in_kilometers: 1.0,
6852
+ # },
6853
+ # },
6854
+ # metrics: {
6855
+ # "__string" => {
6856
+ # comparison_operator: "__string",
6857
+ # value: 1.0,
6858
+ # },
6136
6859
  # },
6137
6860
  # user_attributes: {
6138
6861
  # "__string" => {
@@ -6158,6 +6881,10 @@ module Aws::Pinpoint
6158
6881
  # The segment location attributes.
6159
6882
  # @return [Types::SegmentLocation]
6160
6883
  #
6884
+ # @!attribute [rw] metrics
6885
+ # Custom segment metrics.
6886
+ # @return [Hash<String,Types::MetricDimension>]
6887
+ #
6161
6888
  # @!attribute [rw] user_attributes
6162
6889
  # Custom segment user attributes.
6163
6890
  # @return [Hash<String,Types::AttributeDimension>]
@@ -6169,10 +6896,225 @@ module Aws::Pinpoint
6169
6896
  :behavior,
6170
6897
  :demographic,
6171
6898
  :location,
6899
+ :metrics,
6172
6900
  :user_attributes)
6173
6901
  include Aws::Structure
6174
6902
  end
6175
6903
 
6904
+ # Segment group definition.
6905
+ #
6906
+ # @note When making an API call, you may pass SegmentGroup
6907
+ # data as a hash:
6908
+ #
6909
+ # {
6910
+ # dimensions: [
6911
+ # {
6912
+ # attributes: {
6913
+ # "__string" => {
6914
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6915
+ # values: ["__string"],
6916
+ # },
6917
+ # },
6918
+ # behavior: {
6919
+ # recency: {
6920
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
6921
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
6922
+ # },
6923
+ # },
6924
+ # demographic: {
6925
+ # app_version: {
6926
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6927
+ # values: ["__string"],
6928
+ # },
6929
+ # channel: {
6930
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6931
+ # values: ["__string"],
6932
+ # },
6933
+ # device_type: {
6934
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6935
+ # values: ["__string"],
6936
+ # },
6937
+ # make: {
6938
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6939
+ # values: ["__string"],
6940
+ # },
6941
+ # model: {
6942
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6943
+ # values: ["__string"],
6944
+ # },
6945
+ # platform: {
6946
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6947
+ # values: ["__string"],
6948
+ # },
6949
+ # },
6950
+ # location: {
6951
+ # country: {
6952
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6953
+ # values: ["__string"],
6954
+ # },
6955
+ # gps_point: {
6956
+ # coordinates: {
6957
+ # latitude: 1.0,
6958
+ # longitude: 1.0,
6959
+ # },
6960
+ # range_in_kilometers: 1.0,
6961
+ # },
6962
+ # },
6963
+ # metrics: {
6964
+ # "__string" => {
6965
+ # comparison_operator: "__string",
6966
+ # value: 1.0,
6967
+ # },
6968
+ # },
6969
+ # user_attributes: {
6970
+ # "__string" => {
6971
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6972
+ # values: ["__string"],
6973
+ # },
6974
+ # },
6975
+ # },
6976
+ # ],
6977
+ # source_segments: [
6978
+ # {
6979
+ # id: "__string",
6980
+ # version: 1,
6981
+ # },
6982
+ # ],
6983
+ # source_type: "ALL", # accepts ALL, ANY
6984
+ # type: "ALL", # accepts ALL, ANY, NONE
6985
+ # }
6986
+ #
6987
+ # @!attribute [rw] dimensions
6988
+ # List of dimensions to include or exclude.
6989
+ # @return [Array<Types::SegmentDimensions>]
6990
+ #
6991
+ # @!attribute [rw] source_segments
6992
+ # Segments that define the source of this segment. Currently a maximum
6993
+ # of 1 import segment is supported.
6994
+ # @return [Array<Types::SegmentReference>]
6995
+ #
6996
+ # @!attribute [rw] source_type
6997
+ # Include or exclude the source.
6998
+ # @return [String]
6999
+ #
7000
+ # @!attribute [rw] type
7001
+ # How should the dimensions be applied for the result
7002
+ # @return [String]
7003
+ #
7004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentGroup AWS API Documentation
7005
+ #
7006
+ class SegmentGroup < Struct.new(
7007
+ :dimensions,
7008
+ :source_segments,
7009
+ :source_type,
7010
+ :type)
7011
+ include Aws::Structure
7012
+ end
7013
+
7014
+ # Segment group definition.
7015
+ #
7016
+ # @note When making an API call, you may pass SegmentGroupList
7017
+ # data as a hash:
7018
+ #
7019
+ # {
7020
+ # groups: [
7021
+ # {
7022
+ # dimensions: [
7023
+ # {
7024
+ # attributes: {
7025
+ # "__string" => {
7026
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7027
+ # values: ["__string"],
7028
+ # },
7029
+ # },
7030
+ # behavior: {
7031
+ # recency: {
7032
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
7033
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
7034
+ # },
7035
+ # },
7036
+ # demographic: {
7037
+ # app_version: {
7038
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7039
+ # values: ["__string"],
7040
+ # },
7041
+ # channel: {
7042
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7043
+ # values: ["__string"],
7044
+ # },
7045
+ # device_type: {
7046
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7047
+ # values: ["__string"],
7048
+ # },
7049
+ # make: {
7050
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7051
+ # values: ["__string"],
7052
+ # },
7053
+ # model: {
7054
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7055
+ # values: ["__string"],
7056
+ # },
7057
+ # platform: {
7058
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7059
+ # values: ["__string"],
7060
+ # },
7061
+ # },
7062
+ # location: {
7063
+ # country: {
7064
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7065
+ # values: ["__string"],
7066
+ # },
7067
+ # gps_point: {
7068
+ # coordinates: {
7069
+ # latitude: 1.0,
7070
+ # longitude: 1.0,
7071
+ # },
7072
+ # range_in_kilometers: 1.0,
7073
+ # },
7074
+ # },
7075
+ # metrics: {
7076
+ # "__string" => {
7077
+ # comparison_operator: "__string",
7078
+ # value: 1.0,
7079
+ # },
7080
+ # },
7081
+ # user_attributes: {
7082
+ # "__string" => {
7083
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7084
+ # values: ["__string"],
7085
+ # },
7086
+ # },
7087
+ # },
7088
+ # ],
7089
+ # source_segments: [
7090
+ # {
7091
+ # id: "__string",
7092
+ # version: 1,
7093
+ # },
7094
+ # ],
7095
+ # source_type: "ALL", # accepts ALL, ANY
7096
+ # type: "ALL", # accepts ALL, ANY, NONE
7097
+ # },
7098
+ # ],
7099
+ # include: "ALL", # accepts ALL, ANY, NONE
7100
+ # }
7101
+ #
7102
+ # @!attribute [rw] groups
7103
+ # List of dimension groups to evaluate.
7104
+ # @return [Array<Types::SegmentGroup>]
7105
+ #
7106
+ # @!attribute [rw] include
7107
+ # How should the groups be applied for the result
7108
+ # @return [String]
7109
+ #
7110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentGroupList AWS API Documentation
7111
+ #
7112
+ class SegmentGroupList < Struct.new(
7113
+ :groups,
7114
+ :include)
7115
+ include Aws::Structure
7116
+ end
7117
+
6176
7118
  # Segment import definition.
6177
7119
  #
6178
7120
  # @!attribute [rw] channel_counts
@@ -6228,16 +7170,54 @@ module Aws::Pinpoint
6228
7170
  # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
6229
7171
  # values: ["__string"],
6230
7172
  # },
7173
+ # gps_point: {
7174
+ # coordinates: {
7175
+ # latitude: 1.0,
7176
+ # longitude: 1.0,
7177
+ # },
7178
+ # range_in_kilometers: 1.0,
7179
+ # },
6231
7180
  # }
6232
7181
  #
6233
7182
  # @!attribute [rw] country
6234
7183
  # The country filter according to ISO 3166-1 Alpha-2 codes.
6235
7184
  # @return [Types::SetDimension]
6236
7185
  #
7186
+ # @!attribute [rw] gps_point
7187
+ # The GPS Point dimension.
7188
+ # @return [Types::GPSPointDimension]
7189
+ #
6237
7190
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentLocation AWS API Documentation
6238
7191
  #
6239
7192
  class SegmentLocation < Struct.new(
6240
- :country)
7193
+ :country,
7194
+ :gps_point)
7195
+ include Aws::Structure
7196
+ end
7197
+
7198
+ # Segment reference.
7199
+ #
7200
+ # @note When making an API call, you may pass SegmentReference
7201
+ # data as a hash:
7202
+ #
7203
+ # {
7204
+ # id: "__string",
7205
+ # version: 1,
7206
+ # }
7207
+ #
7208
+ # @!attribute [rw] id
7209
+ # Segment Id.
7210
+ # @return [String]
7211
+ #
7212
+ # @!attribute [rw] version
7213
+ # If specified contains a specific version of the segment included.
7214
+ # @return [Integer]
7215
+ #
7216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SegmentReference AWS API Documentation
7217
+ #
7218
+ class SegmentReference < Struct.new(
7219
+ :id,
7220
+ :version)
6241
7221
  include Aws::Structure
6242
7222
  end
6243
7223
 
@@ -6271,6 +7251,11 @@ module Aws::Pinpoint
6271
7251
  # The name of segment
6272
7252
  # @return [String]
6273
7253
  #
7254
+ # @!attribute [rw] segment_groups
7255
+ # Segment definition groups. We currently only support one. If
7256
+ # specified Dimensions must be empty.
7257
+ # @return [Types::SegmentGroupList]
7258
+ #
6274
7259
  # @!attribute [rw] segment_type
6275
7260
  # The segment type: DIMENSIONAL - A dynamic segment built from
6276
7261
  # selection criteria based on endpoint data reported by your app. You
@@ -6296,6 +7281,7 @@ module Aws::Pinpoint
6296
7281
  :import_definition,
6297
7282
  :last_modified_date,
6298
7283
  :name,
7284
+ :segment_groups,
6299
7285
  :segment_type,
6300
7286
  :version)
6301
7287
  include Aws::Structure
@@ -6418,6 +7404,7 @@ module Aws::Pinpoint
6418
7404
  # substitutions: {
6419
7405
  # "__string" => ["__string"],
6420
7406
  # },
7407
+ # time_to_live: 1,
6421
7408
  # title: "__string",
6422
7409
  # url: "__string",
6423
7410
  # },
@@ -6465,6 +7452,7 @@ module Aws::Pinpoint
6465
7452
  # },
6466
7453
  # sms_message: {
6467
7454
  # body: "__string",
7455
+ # keyword: "__string",
6468
7456
  # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
6469
7457
  # origination_number: "__string",
6470
7458
  # sender_id: "__string",
@@ -6573,6 +7561,7 @@ module Aws::Pinpoint
6573
7561
  # substitutions: {
6574
7562
  # "__string" => ["__string"],
6575
7563
  # },
7564
+ # time_to_live: 1,
6576
7565
  # title: "__string",
6577
7566
  # url: "__string",
6578
7567
  # },
@@ -6620,6 +7609,7 @@ module Aws::Pinpoint
6620
7609
  # },
6621
7610
  # sms_message: {
6622
7611
  # body: "__string",
7612
+ # keyword: "__string",
6623
7613
  # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
6624
7614
  # origination_number: "__string",
6625
7615
  # sender_id: "__string",
@@ -6644,19 +7634,22 @@ module Aws::Pinpoint
6644
7634
  # }
6645
7635
  #
6646
7636
  # @!attribute [rw] context
6647
- # A map of custom attributes to attributes to be attached to the
6648
- # message. This payload is added to the push notification's
6649
- # 'data.pinpoint' object or added to the email/sms delivery receipt
6650
- # event attributes.
7637
+ # A map of custom attribute-value pairs. Amazon Pinpoint adds these
7638
+ # attributes to the data.pinpoint object in the body of the push
7639
+ # notification payload. Amazon Pinpoint also provides these attributes
7640
+ # in the events that it generates for users-messages deliveries.
6651
7641
  # @return [Hash<String,String>]
6652
7642
  #
6653
7643
  # @!attribute [rw] message_configuration
6654
- # Message configuration.
7644
+ # Message definitions for the default message and any messages that
7645
+ # are tailored for specific channels.
6655
7646
  # @return [Types::DirectMessageConfiguration]
6656
7647
  #
6657
7648
  # @!attribute [rw] users
6658
- # A map of destination endpoints, with the EndpointId as the key
6659
- # Endpoint Message Configuration as the value.
7649
+ # A map that associates user IDs with EndpointSendConfiguration
7650
+ # objects. Within an EndpointSendConfiguration object, you can tailor
7651
+ # the message for a user by specifying message overrides or
7652
+ # substitutions.
6660
7653
  # @return [Hash<String,Types::EndpointSendConfiguration>]
6661
7654
  #
6662
7655
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessageRequest AWS API Documentation
@@ -6671,16 +7664,19 @@ module Aws::Pinpoint
6671
7664
  # User send message response.
6672
7665
  #
6673
7666
  # @!attribute [rw] application_id
6674
- # Application id of the message.
7667
+ # The unique ID of the Amazon Pinpoint project used to send the
7668
+ # message.
6675
7669
  # @return [String]
6676
7670
  #
6677
7671
  # @!attribute [rw] request_id
6678
- # Original request Id for which this message was delivered.
7672
+ # The unique ID assigned to the users-messages request.
6679
7673
  # @return [String]
6680
7674
  #
6681
7675
  # @!attribute [rw] result
6682
- # A map containing of UserId to Map of EndpointId to Endpoint Message
6683
- # Result.
7676
+ # An object that shows the endpoints that were messaged for each user.
7677
+ # The object provides a list of user IDs. For each user ID, it
7678
+ # provides the endpoint IDs that were messaged. For each endpoint ID,
7679
+ # it provides an EndpointMessageResult object.
6684
7680
  # @return [Hash<String,Hash<String,Types::EndpointMessageResult>>]
6685
7681
  #
6686
7682
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessageResponse AWS API Documentation
@@ -6763,6 +7759,7 @@ module Aws::Pinpoint
6763
7759
  # substitutions: {
6764
7760
  # "__string" => ["__string"],
6765
7761
  # },
7762
+ # time_to_live: 1,
6766
7763
  # title: "__string",
6767
7764
  # url: "__string",
6768
7765
  # },
@@ -6810,6 +7807,7 @@ module Aws::Pinpoint
6810
7807
  # },
6811
7808
  # sms_message: {
6812
7809
  # body: "__string",
7810
+ # keyword: "__string",
6813
7811
  # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
6814
7812
  # origination_number: "__string",
6815
7813
  # sender_id: "__string",
@@ -6877,6 +7875,9 @@ module Aws::Pinpoint
6877
7875
  # @return [String]
6878
7876
  #
6879
7877
  # @!attribute [rw] values
7878
+ # The criteria values for the segment dimension. Endpoints with
7879
+ # matching attribute values are included or excluded from the segment,
7880
+ # depending on the setting for Type.
6880
7881
  # @return [Array<String>]
6881
7882
  #
6882
7883
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SetDimension AWS API Documentation
@@ -7151,6 +8152,7 @@ module Aws::Pinpoint
7151
8152
  # mode: "DELIVERY", # accepts DELIVERY, FILTER
7152
8153
  # web_url: "__string",
7153
8154
  # },
8155
+ # cloud_watch_metrics_enabled: false,
7154
8156
  # limits: {
7155
8157
  # daily: 1,
7156
8158
  # maximum_duration: 1,
@@ -7190,6 +8192,26 @@ module Aws::Pinpoint
7190
8192
  include Aws::Structure
7191
8193
  end
7192
8194
 
8195
+ # Update attributes request
8196
+ #
8197
+ # @note When making an API call, you may pass UpdateAttributesRequest
8198
+ # data as a hash:
8199
+ #
8200
+ # {
8201
+ # blacklist: ["__string"],
8202
+ # }
8203
+ #
8204
+ # @!attribute [rw] blacklist
8205
+ # The GLOB wildcard for removing the attributes in the application
8206
+ # @return [Array<String>]
8207
+ #
8208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateAttributesRequest AWS API Documentation
8209
+ #
8210
+ class UpdateAttributesRequest < Struct.new(
8211
+ :blacklist)
8212
+ include Aws::Structure
8213
+ end
8214
+
7193
8215
  # @note When making an API call, you may pass UpdateBaiduChannelRequest
7194
8216
  # data as a hash:
7195
8217
  #
@@ -7248,6 +8270,7 @@ module Aws::Pinpoint
7248
8270
  # media_url: "__string",
7249
8271
  # raw_content: "__string",
7250
8272
  # silent_push: false,
8273
+ # time_to_live: 1,
7251
8274
  # title: "__string",
7252
8275
  # url: "__string",
7253
8276
  # },
@@ -7261,6 +8284,7 @@ module Aws::Pinpoint
7261
8284
  # media_url: "__string",
7262
8285
  # raw_content: "__string",
7263
8286
  # silent_push: false,
8287
+ # time_to_live: 1,
7264
8288
  # title: "__string",
7265
8289
  # url: "__string",
7266
8290
  # },
@@ -7274,6 +8298,7 @@ module Aws::Pinpoint
7274
8298
  # media_url: "__string",
7275
8299
  # raw_content: "__string",
7276
8300
  # silent_push: false,
8301
+ # time_to_live: 1,
7277
8302
  # title: "__string",
7278
8303
  # url: "__string",
7279
8304
  # },
@@ -7287,6 +8312,7 @@ module Aws::Pinpoint
7287
8312
  # media_url: "__string",
7288
8313
  # raw_content: "__string",
7289
8314
  # silent_push: false,
8315
+ # time_to_live: 1,
7290
8316
  # title: "__string",
7291
8317
  # url: "__string",
7292
8318
  # },
@@ -7306,6 +8332,7 @@ module Aws::Pinpoint
7306
8332
  # media_url: "__string",
7307
8333
  # raw_content: "__string",
7308
8334
  # silent_push: false,
8335
+ # time_to_live: 1,
7309
8336
  # title: "__string",
7310
8337
  # url: "__string",
7311
8338
  # },
@@ -7356,6 +8383,7 @@ module Aws::Pinpoint
7356
8383
  # media_url: "__string",
7357
8384
  # raw_content: "__string",
7358
8385
  # silent_push: false,
8386
+ # time_to_live: 1,
7359
8387
  # title: "__string",
7360
8388
  # url: "__string",
7361
8389
  # },
@@ -7369,6 +8397,7 @@ module Aws::Pinpoint
7369
8397
  # media_url: "__string",
7370
8398
  # raw_content: "__string",
7371
8399
  # silent_push: false,
8400
+ # time_to_live: 1,
7372
8401
  # title: "__string",
7373
8402
  # url: "__string",
7374
8403
  # },
@@ -7382,6 +8411,7 @@ module Aws::Pinpoint
7382
8411
  # media_url: "__string",
7383
8412
  # raw_content: "__string",
7384
8413
  # silent_push: false,
8414
+ # time_to_live: 1,
7385
8415
  # title: "__string",
7386
8416
  # url: "__string",
7387
8417
  # },
@@ -7395,6 +8425,7 @@ module Aws::Pinpoint
7395
8425
  # media_url: "__string",
7396
8426
  # raw_content: "__string",
7397
8427
  # silent_push: false,
8428
+ # time_to_live: 1,
7398
8429
  # title: "__string",
7399
8430
  # url: "__string",
7400
8431
  # },
@@ -7414,6 +8445,7 @@ module Aws::Pinpoint
7414
8445
  # media_url: "__string",
7415
8446
  # raw_content: "__string",
7416
8447
  # silent_push: false,
8448
+ # time_to_live: 1,
7417
8449
  # title: "__string",
7418
8450
  # url: "__string",
7419
8451
  # },
@@ -7751,6 +8783,19 @@ module Aws::Pinpoint
7751
8783
  # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
7752
8784
  # values: ["__string"],
7753
8785
  # },
8786
+ # gps_point: {
8787
+ # coordinates: {
8788
+ # latitude: 1.0,
8789
+ # longitude: 1.0,
8790
+ # },
8791
+ # range_in_kilometers: 1.0,
8792
+ # },
8793
+ # },
8794
+ # metrics: {
8795
+ # "__string" => {
8796
+ # comparison_operator: "__string",
8797
+ # value: 1.0,
8798
+ # },
7754
8799
  # },
7755
8800
  # user_attributes: {
7756
8801
  # "__string" => {
@@ -7760,6 +8805,88 @@ module Aws::Pinpoint
7760
8805
  # },
7761
8806
  # },
7762
8807
  # name: "__string",
8808
+ # segment_groups: {
8809
+ # groups: [
8810
+ # {
8811
+ # dimensions: [
8812
+ # {
8813
+ # attributes: {
8814
+ # "__string" => {
8815
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8816
+ # values: ["__string"],
8817
+ # },
8818
+ # },
8819
+ # behavior: {
8820
+ # recency: {
8821
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
8822
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
8823
+ # },
8824
+ # },
8825
+ # demographic: {
8826
+ # app_version: {
8827
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8828
+ # values: ["__string"],
8829
+ # },
8830
+ # channel: {
8831
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8832
+ # values: ["__string"],
8833
+ # },
8834
+ # device_type: {
8835
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8836
+ # values: ["__string"],
8837
+ # },
8838
+ # make: {
8839
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8840
+ # values: ["__string"],
8841
+ # },
8842
+ # model: {
8843
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8844
+ # values: ["__string"],
8845
+ # },
8846
+ # platform: {
8847
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8848
+ # values: ["__string"],
8849
+ # },
8850
+ # },
8851
+ # location: {
8852
+ # country: {
8853
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8854
+ # values: ["__string"],
8855
+ # },
8856
+ # gps_point: {
8857
+ # coordinates: {
8858
+ # latitude: 1.0,
8859
+ # longitude: 1.0,
8860
+ # },
8861
+ # range_in_kilometers: 1.0,
8862
+ # },
8863
+ # },
8864
+ # metrics: {
8865
+ # "__string" => {
8866
+ # comparison_operator: "__string",
8867
+ # value: 1.0,
8868
+ # },
8869
+ # },
8870
+ # user_attributes: {
8871
+ # "__string" => {
8872
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8873
+ # values: ["__string"],
8874
+ # },
8875
+ # },
8876
+ # },
8877
+ # ],
8878
+ # source_segments: [
8879
+ # {
8880
+ # id: "__string",
8881
+ # version: 1,
8882
+ # },
8883
+ # ],
8884
+ # source_type: "ALL", # accepts ALL, ANY
8885
+ # type: "ALL", # accepts ALL, ANY, NONE
8886
+ # },
8887
+ # ],
8888
+ # include: "ALL", # accepts ALL, ANY, NONE
8889
+ # },
7763
8890
  # },
7764
8891
  # }
7765
8892
  #
@@ -7842,6 +8969,7 @@ module Aws::Pinpoint
7842
8969
  # mode: "DELIVERY", # accepts DELIVERY, FILTER
7843
8970
  # web_url: "__string",
7844
8971
  # },
8972
+ # cloud_watch_metrics_enabled: false,
7845
8973
  # limits: {
7846
8974
  # daily: 1,
7847
8975
  # maximum_duration: 1,
@@ -7858,6 +8986,10 @@ module Aws::Pinpoint
7858
8986
  # Default campaign hook information.
7859
8987
  # @return [Types::CampaignHook]
7860
8988
  #
8989
+ # @!attribute [rw] cloud_watch_metrics_enabled
8990
+ # The CloudWatchMetrics settings for the app.
8991
+ # @return [Boolean]
8992
+ #
7861
8993
  # @!attribute [rw] limits
7862
8994
  # The default campaign limits for the app. These limits apply to each
7863
8995
  # campaign for the app, unless the campaign overrides the default with
@@ -7874,6 +9006,7 @@ module Aws::Pinpoint
7874
9006
  #
7875
9007
  class WriteApplicationSettingsRequest < Struct.new(
7876
9008
  :campaign_hook,
9009
+ :cloud_watch_metrics_enabled,
7877
9010
  :limits,
7878
9011
  :quiet_time)
7879
9012
  include Aws::Structure
@@ -7898,6 +9031,7 @@ module Aws::Pinpoint
7898
9031
  # media_url: "__string",
7899
9032
  # raw_content: "__string",
7900
9033
  # silent_push: false,
9034
+ # time_to_live: 1,
7901
9035
  # title: "__string",
7902
9036
  # url: "__string",
7903
9037
  # },
@@ -7911,6 +9045,7 @@ module Aws::Pinpoint
7911
9045
  # media_url: "__string",
7912
9046
  # raw_content: "__string",
7913
9047
  # silent_push: false,
9048
+ # time_to_live: 1,
7914
9049
  # title: "__string",
7915
9050
  # url: "__string",
7916
9051
  # },
@@ -7924,6 +9059,7 @@ module Aws::Pinpoint
7924
9059
  # media_url: "__string",
7925
9060
  # raw_content: "__string",
7926
9061
  # silent_push: false,
9062
+ # time_to_live: 1,
7927
9063
  # title: "__string",
7928
9064
  # url: "__string",
7929
9065
  # },
@@ -7937,6 +9073,7 @@ module Aws::Pinpoint
7937
9073
  # media_url: "__string",
7938
9074
  # raw_content: "__string",
7939
9075
  # silent_push: false,
9076
+ # time_to_live: 1,
7940
9077
  # title: "__string",
7941
9078
  # url: "__string",
7942
9079
  # },
@@ -7956,6 +9093,7 @@ module Aws::Pinpoint
7956
9093
  # media_url: "__string",
7957
9094
  # raw_content: "__string",
7958
9095
  # silent_push: false,
9096
+ # time_to_live: 1,
7959
9097
  # title: "__string",
7960
9098
  # url: "__string",
7961
9099
  # },
@@ -8006,6 +9144,7 @@ module Aws::Pinpoint
8006
9144
  # media_url: "__string",
8007
9145
  # raw_content: "__string",
8008
9146
  # silent_push: false,
9147
+ # time_to_live: 1,
8009
9148
  # title: "__string",
8010
9149
  # url: "__string",
8011
9150
  # },
@@ -8019,6 +9158,7 @@ module Aws::Pinpoint
8019
9158
  # media_url: "__string",
8020
9159
  # raw_content: "__string",
8021
9160
  # silent_push: false,
9161
+ # time_to_live: 1,
8022
9162
  # title: "__string",
8023
9163
  # url: "__string",
8024
9164
  # },
@@ -8032,6 +9172,7 @@ module Aws::Pinpoint
8032
9172
  # media_url: "__string",
8033
9173
  # raw_content: "__string",
8034
9174
  # silent_push: false,
9175
+ # time_to_live: 1,
8035
9176
  # title: "__string",
8036
9177
  # url: "__string",
8037
9178
  # },
@@ -8045,6 +9186,7 @@ module Aws::Pinpoint
8045
9186
  # media_url: "__string",
8046
9187
  # raw_content: "__string",
8047
9188
  # silent_push: false,
9189
+ # time_to_live: 1,
8048
9190
  # title: "__string",
8049
9191
  # url: "__string",
8050
9192
  # },
@@ -8064,6 +9206,7 @@ module Aws::Pinpoint
8064
9206
  # media_url: "__string",
8065
9207
  # raw_content: "__string",
8066
9208
  # silent_push: false,
9209
+ # time_to_live: 1,
8067
9210
  # title: "__string",
8068
9211
  # url: "__string",
8069
9212
  # },
@@ -8245,6 +9388,19 @@ module Aws::Pinpoint
8245
9388
  # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
8246
9389
  # values: ["__string"],
8247
9390
  # },
9391
+ # gps_point: {
9392
+ # coordinates: {
9393
+ # latitude: 1.0,
9394
+ # longitude: 1.0,
9395
+ # },
9396
+ # range_in_kilometers: 1.0,
9397
+ # },
9398
+ # },
9399
+ # metrics: {
9400
+ # "__string" => {
9401
+ # comparison_operator: "__string",
9402
+ # value: 1.0,
9403
+ # },
8248
9404
  # },
8249
9405
  # user_attributes: {
8250
9406
  # "__string" => {
@@ -8254,6 +9410,88 @@ module Aws::Pinpoint
8254
9410
  # },
8255
9411
  # },
8256
9412
  # name: "__string",
9413
+ # segment_groups: {
9414
+ # groups: [
9415
+ # {
9416
+ # dimensions: [
9417
+ # {
9418
+ # attributes: {
9419
+ # "__string" => {
9420
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9421
+ # values: ["__string"],
9422
+ # },
9423
+ # },
9424
+ # behavior: {
9425
+ # recency: {
9426
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
9427
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
9428
+ # },
9429
+ # },
9430
+ # demographic: {
9431
+ # app_version: {
9432
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9433
+ # values: ["__string"],
9434
+ # },
9435
+ # channel: {
9436
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9437
+ # values: ["__string"],
9438
+ # },
9439
+ # device_type: {
9440
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9441
+ # values: ["__string"],
9442
+ # },
9443
+ # make: {
9444
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9445
+ # values: ["__string"],
9446
+ # },
9447
+ # model: {
9448
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9449
+ # values: ["__string"],
9450
+ # },
9451
+ # platform: {
9452
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9453
+ # values: ["__string"],
9454
+ # },
9455
+ # },
9456
+ # location: {
9457
+ # country: {
9458
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9459
+ # values: ["__string"],
9460
+ # },
9461
+ # gps_point: {
9462
+ # coordinates: {
9463
+ # latitude: 1.0,
9464
+ # longitude: 1.0,
9465
+ # },
9466
+ # range_in_kilometers: 1.0,
9467
+ # },
9468
+ # },
9469
+ # metrics: {
9470
+ # "__string" => {
9471
+ # comparison_operator: "__string",
9472
+ # value: 1.0,
9473
+ # },
9474
+ # },
9475
+ # user_attributes: {
9476
+ # "__string" => {
9477
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
9478
+ # values: ["__string"],
9479
+ # },
9480
+ # },
9481
+ # },
9482
+ # ],
9483
+ # source_segments: [
9484
+ # {
9485
+ # id: "__string",
9486
+ # version: 1,
9487
+ # },
9488
+ # ],
9489
+ # source_type: "ALL", # accepts ALL, ANY
9490
+ # type: "ALL", # accepts ALL, ANY, NONE
9491
+ # },
9492
+ # ],
9493
+ # include: "ALL", # accepts ALL, ANY, NONE
9494
+ # },
8257
9495
  # }
8258
9496
  #
8259
9497
  # @!attribute [rw] dimensions
@@ -8264,11 +9502,17 @@ module Aws::Pinpoint
8264
9502
  # The name of segment
8265
9503
  # @return [String]
8266
9504
  #
9505
+ # @!attribute [rw] segment_groups
9506
+ # Segment definition groups. We currently only support one. If
9507
+ # specified Dimensions must be empty.
9508
+ # @return [Types::SegmentGroupList]
9509
+ #
8267
9510
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteSegmentRequest AWS API Documentation
8268
9511
  #
8269
9512
  class WriteSegmentRequest < Struct.new(
8270
9513
  :dimensions,
8271
- :name)
9514
+ :name,
9515
+ :segment_groups)
8272
9516
  include Aws::Structure
8273
9517
  end
8274
9518
 
@@ -8289,6 +9533,7 @@ module Aws::Pinpoint
8289
9533
  # media_url: "__string",
8290
9534
  # raw_content: "__string",
8291
9535
  # silent_push: false,
9536
+ # time_to_live: 1,
8292
9537
  # title: "__string",
8293
9538
  # url: "__string",
8294
9539
  # },
@@ -8302,6 +9547,7 @@ module Aws::Pinpoint
8302
9547
  # media_url: "__string",
8303
9548
  # raw_content: "__string",
8304
9549
  # silent_push: false,
9550
+ # time_to_live: 1,
8305
9551
  # title: "__string",
8306
9552
  # url: "__string",
8307
9553
  # },
@@ -8315,6 +9561,7 @@ module Aws::Pinpoint
8315
9561
  # media_url: "__string",
8316
9562
  # raw_content: "__string",
8317
9563
  # silent_push: false,
9564
+ # time_to_live: 1,
8318
9565
  # title: "__string",
8319
9566
  # url: "__string",
8320
9567
  # },
@@ -8328,6 +9575,7 @@ module Aws::Pinpoint
8328
9575
  # media_url: "__string",
8329
9576
  # raw_content: "__string",
8330
9577
  # silent_push: false,
9578
+ # time_to_live: 1,
8331
9579
  # title: "__string",
8332
9580
  # url: "__string",
8333
9581
  # },
@@ -8347,6 +9595,7 @@ module Aws::Pinpoint
8347
9595
  # media_url: "__string",
8348
9596
  # raw_content: "__string",
8349
9597
  # silent_push: false,
9598
+ # time_to_live: 1,
8350
9599
  # title: "__string",
8351
9600
  # url: "__string",
8352
9601
  # },