aws-sdk-pinpoint 1.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4c544fa6a5d6cb4bba12a980f6013e1ca5e53bf7
4
+ data.tar.gz: 04885ca289678f58a9d3d224e7afd551c2e33cd9
5
+ SHA512:
6
+ metadata.gz: 3e6530f0ace75e6459959b597f5c5e0464013439b8ed16e8c56af2722d2a74df918222dc37032bb84a130017324121aae19b69262b4a5b880ed6ccaddf63bb4e
7
+ data.tar.gz: 1f41067e88e44fcedaa8bbadfcb897683d41764c73161b99511d3594af4f32e3fabb671c24774c9731ce47d7be553c133b5e60d7080b57351d8e2fab4eb8dd6a
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-pinpoint/types'
12
+ require_relative 'aws-sdk-pinpoint/client_api'
13
+ require_relative 'aws-sdk-pinpoint/client'
14
+ require_relative 'aws-sdk-pinpoint/errors'
15
+ require_relative 'aws-sdk-pinpoint/resource'
16
+ require_relative 'aws-sdk-pinpoint/customizations'
17
+
18
+ # This module provides support for Amazon Pinpoint. This module is available in the
19
+ # `aws-sdk-pinpoint` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon Pinpoint all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::Pinpoint::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::Pinpoint
44
+
45
+ GEM_VERSION = '1.0.0.rc2'
46
+
47
+ end
@@ -0,0 +1,2333 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/signature_v4.rb'
22
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
23
+
24
+ Aws::Plugins::GlobalConfiguration.add_identifier(:pinpoint)
25
+
26
+ module Aws
27
+ module Pinpoint
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :pinpoint
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::SignatureV4)
50
+ add_plugin(Aws::Plugins::Protocols::RestJson)
51
+
52
+ # @option options [required, Aws::CredentialProvider] :credentials
53
+ # Your AWS credentials. This can be an instance of any one of the
54
+ # following classes:
55
+ #
56
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
+ # credentials.
58
+ #
59
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
+ # from an EC2 IMDS on an EC2 instance.
61
+ #
62
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
63
+ # shared file, such as `~/.aws/config`.
64
+ #
65
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
+ #
67
+ # When `:credentials` are not configured directly, the following
68
+ # locations will be searched for credentials:
69
+ #
70
+ # * `Aws.config[:credentials]`
71
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
+ # * `~/.aws/credentials`
74
+ # * `~/.aws/config`
75
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
76
+ # very aggressive. Construct and pass an instance of
77
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
78
+ # timeouts.
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ # @option options [String] :access_key_id
91
+ # @option options [Boolean] :convert_params (true)
92
+ # When `true`, an attempt is made to coerce request parameters into
93
+ # the required types.
94
+ # @option options [String] :endpoint
95
+ # The client endpoint is normally constructed from the `:region`
96
+ # option. You should only configure an `:endpoint` when connecting
97
+ # to test endpoints. This should be avalid HTTP(S) URI.
98
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
+ # The log formatter.
100
+ # @option options [Symbol] :log_level (:info)
101
+ # The log level to send messages to the `:logger` at.
102
+ # @option options [Logger] :logger
103
+ # The Logger instance to send log messages to. If this option
104
+ # is not set, logging will be disabled.
105
+ # @option options [String] :profile ("default")
106
+ # Used when loading credentials from the shared credentials file
107
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
108
+ # @option options [Integer] :retry_limit (3)
109
+ # The maximum number of times to retry failed requests. Only
110
+ # ~ 500 level server errors and certain ~ 400 level client errors
111
+ # are retried. Generally, these are throttling errors, data
112
+ # checksum errors, networking errors, timeout errors and auth
113
+ # errors from expired credentials.
114
+ # @option options [String] :secret_access_key
115
+ # @option options [String] :session_token
116
+ # @option options [Boolean] :stub_responses (false)
117
+ # Causes the client to return stubbed responses. By default
118
+ # fake responses are generated and returned. You can specify
119
+ # the response data to return or errors to raise by calling
120
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
121
+ #
122
+ # ** Please note ** When response stubbing is enabled, no HTTP
123
+ # requests are made, and retries are disabled.
124
+ # @option options [Boolean] :validate_params (true)
125
+ # When `true`, request parameters are validated before
126
+ # sending the request.
127
+ def initialize(*args)
128
+ super
129
+ end
130
+
131
+ # @!group API Operations
132
+
133
+ # Creates or updates a campaign.
134
+ # @option params [required, String] :application_id
135
+ # @option params [required, Types::WriteCampaignRequest] :write_campaign_request
136
+ # @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
137
+ #
138
+ # * {Types::CreateCampaignResponse#campaign_response #CampaignResponse} => Types::CampaignResponse
139
+ #
140
+ # @example Request syntax with placeholder values
141
+ # resp = client.create_campaign({
142
+ # application_id: "__string", # required
143
+ # write_campaign_request: { # required
144
+ # additional_treatments: [
145
+ # {
146
+ # message_configuration: {
147
+ # apns_message: {
148
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
149
+ # body: "__string",
150
+ # image_icon_url: "__string",
151
+ # image_url: "__string",
152
+ # json_body: "__string",
153
+ # media_url: "__string",
154
+ # silent_push: false,
155
+ # title: "__string",
156
+ # url: "__string",
157
+ # },
158
+ # default_message: {
159
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
160
+ # body: "__string",
161
+ # image_icon_url: "__string",
162
+ # image_url: "__string",
163
+ # json_body: "__string",
164
+ # media_url: "__string",
165
+ # silent_push: false,
166
+ # title: "__string",
167
+ # url: "__string",
168
+ # },
169
+ # gcm_message: {
170
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
171
+ # body: "__string",
172
+ # image_icon_url: "__string",
173
+ # image_url: "__string",
174
+ # json_body: "__string",
175
+ # media_url: "__string",
176
+ # silent_push: false,
177
+ # title: "__string",
178
+ # url: "__string",
179
+ # },
180
+ # },
181
+ # schedule: {
182
+ # end_time: "__string",
183
+ # frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
184
+ # is_local_time: false,
185
+ # quiet_time: {
186
+ # end: "__string",
187
+ # start: "__string",
188
+ # },
189
+ # start_time: "__string",
190
+ # timezone: "__string",
191
+ # },
192
+ # size_percent: 1,
193
+ # treatment_description: "__string",
194
+ # treatment_name: "__string",
195
+ # },
196
+ # ],
197
+ # description: "__string",
198
+ # holdout_percent: 1,
199
+ # is_paused: false,
200
+ # limits: {
201
+ # daily: 1,
202
+ # total: 1,
203
+ # },
204
+ # message_configuration: {
205
+ # apns_message: {
206
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
207
+ # body: "__string",
208
+ # image_icon_url: "__string",
209
+ # image_url: "__string",
210
+ # json_body: "__string",
211
+ # media_url: "__string",
212
+ # silent_push: false,
213
+ # title: "__string",
214
+ # url: "__string",
215
+ # },
216
+ # default_message: {
217
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
218
+ # body: "__string",
219
+ # image_icon_url: "__string",
220
+ # image_url: "__string",
221
+ # json_body: "__string",
222
+ # media_url: "__string",
223
+ # silent_push: false,
224
+ # title: "__string",
225
+ # url: "__string",
226
+ # },
227
+ # gcm_message: {
228
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
229
+ # body: "__string",
230
+ # image_icon_url: "__string",
231
+ # image_url: "__string",
232
+ # json_body: "__string",
233
+ # media_url: "__string",
234
+ # silent_push: false,
235
+ # title: "__string",
236
+ # url: "__string",
237
+ # },
238
+ # },
239
+ # name: "__string",
240
+ # schedule: {
241
+ # end_time: "__string",
242
+ # frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
243
+ # is_local_time: false,
244
+ # quiet_time: {
245
+ # end: "__string",
246
+ # start: "__string",
247
+ # },
248
+ # start_time: "__string",
249
+ # timezone: "__string",
250
+ # },
251
+ # segment_id: "__string",
252
+ # segment_version: 1,
253
+ # treatment_description: "__string",
254
+ # treatment_name: "__string",
255
+ # },
256
+ # })
257
+ #
258
+ # @example Response structure
259
+ # resp.campaign_response.additional_treatments #=> Array
260
+ # resp.campaign_response.additional_treatments[0].id #=> String
261
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
262
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
263
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
264
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
265
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
266
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
267
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
268
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
269
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
270
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
271
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
272
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
273
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
274
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
275
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
276
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
277
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
278
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
279
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
280
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
281
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
282
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
283
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
284
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
285
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
286
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
287
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
288
+ # resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
289
+ # resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
290
+ # resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> Boolean
291
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
292
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
293
+ # resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
294
+ # resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
295
+ # resp.campaign_response.additional_treatments[0].size_percent #=> Integer
296
+ # resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
297
+ # resp.campaign_response.additional_treatments[0].treatment_description #=> String
298
+ # resp.campaign_response.additional_treatments[0].treatment_name #=> String
299
+ # resp.campaign_response.application_id #=> String
300
+ # resp.campaign_response.creation_date #=> String
301
+ # resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
302
+ # resp.campaign_response.description #=> String
303
+ # resp.campaign_response.holdout_percent #=> Integer
304
+ # resp.campaign_response.id #=> String
305
+ # resp.campaign_response.is_paused #=> Boolean
306
+ # resp.campaign_response.last_modified_date #=> String
307
+ # resp.campaign_response.limits.daily #=> Integer
308
+ # resp.campaign_response.limits.total #=> Integer
309
+ # resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
310
+ # resp.campaign_response.message_configuration.apns_message.body #=> String
311
+ # resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
312
+ # resp.campaign_response.message_configuration.apns_message.image_url #=> String
313
+ # resp.campaign_response.message_configuration.apns_message.json_body #=> String
314
+ # resp.campaign_response.message_configuration.apns_message.media_url #=> String
315
+ # resp.campaign_response.message_configuration.apns_message.silent_push #=> Boolean
316
+ # resp.campaign_response.message_configuration.apns_message.title #=> String
317
+ # resp.campaign_response.message_configuration.apns_message.url #=> String
318
+ # resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
319
+ # resp.campaign_response.message_configuration.default_message.body #=> String
320
+ # resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
321
+ # resp.campaign_response.message_configuration.default_message.image_url #=> String
322
+ # resp.campaign_response.message_configuration.default_message.json_body #=> String
323
+ # resp.campaign_response.message_configuration.default_message.media_url #=> String
324
+ # resp.campaign_response.message_configuration.default_message.silent_push #=> Boolean
325
+ # resp.campaign_response.message_configuration.default_message.title #=> String
326
+ # resp.campaign_response.message_configuration.default_message.url #=> String
327
+ # resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
328
+ # resp.campaign_response.message_configuration.gcm_message.body #=> String
329
+ # resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
330
+ # resp.campaign_response.message_configuration.gcm_message.image_url #=> String
331
+ # resp.campaign_response.message_configuration.gcm_message.json_body #=> String
332
+ # resp.campaign_response.message_configuration.gcm_message.media_url #=> String
333
+ # resp.campaign_response.message_configuration.gcm_message.silent_push #=> Boolean
334
+ # resp.campaign_response.message_configuration.gcm_message.title #=> String
335
+ # resp.campaign_response.message_configuration.gcm_message.url #=> String
336
+ # resp.campaign_response.name #=> String
337
+ # resp.campaign_response.schedule.end_time #=> String
338
+ # resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
339
+ # resp.campaign_response.schedule.is_local_time #=> Boolean
340
+ # resp.campaign_response.schedule.quiet_time.end #=> String
341
+ # resp.campaign_response.schedule.quiet_time.start #=> String
342
+ # resp.campaign_response.schedule.start_time #=> String
343
+ # resp.campaign_response.schedule.timezone #=> String
344
+ # resp.campaign_response.segment_id #=> String
345
+ # resp.campaign_response.segment_version #=> Integer
346
+ # resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
347
+ # resp.campaign_response.treatment_description #=> String
348
+ # resp.campaign_response.treatment_name #=> String
349
+ # resp.campaign_response.version #=> Integer
350
+ # @overload create_campaign(params = {})
351
+ # @param [Hash] params ({})
352
+ def create_campaign(params = {}, options = {})
353
+ req = build_request(:create_campaign, params)
354
+ req.send_request(options)
355
+ end
356
+
357
+ # Creates or updates an import job.
358
+ # @option params [required, String] :application_id
359
+ # @option params [required, Types::ImportJobRequest] :import_job_request
360
+ # @return [Types::CreateImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
361
+ #
362
+ # * {Types::CreateImportJobResponse#import_job_response #ImportJobResponse} => Types::ImportJobResponse
363
+ #
364
+ # @example Request syntax with placeholder values
365
+ # resp = client.create_import_job({
366
+ # application_id: "__string", # required
367
+ # import_job_request: { # required
368
+ # define_segment: false,
369
+ # external_id: "__string",
370
+ # format: "CSV", # accepts CSV, JSON
371
+ # register_endpoints: false,
372
+ # role_arn: "__string",
373
+ # s3_url: "__string",
374
+ # segment_id: "__string",
375
+ # segment_name: "__string",
376
+ # },
377
+ # })
378
+ #
379
+ # @example Response structure
380
+ # resp.import_job_response.application_id #=> String
381
+ # resp.import_job_response.completed_pieces #=> Integer
382
+ # resp.import_job_response.completion_date #=> String
383
+ # resp.import_job_response.creation_date #=> String
384
+ # resp.import_job_response.definition.define_segment #=> Boolean
385
+ # resp.import_job_response.definition.external_id #=> String
386
+ # resp.import_job_response.definition.format #=> String, one of "CSV", "JSON"
387
+ # resp.import_job_response.definition.register_endpoints #=> Boolean
388
+ # resp.import_job_response.definition.role_arn #=> String
389
+ # resp.import_job_response.definition.s3_url #=> String
390
+ # resp.import_job_response.definition.segment_id #=> String
391
+ # resp.import_job_response.definition.segment_name #=> String
392
+ # resp.import_job_response.failed_pieces #=> Integer
393
+ # resp.import_job_response.failures #=> Array
394
+ # resp.import_job_response.failures[0] #=> String
395
+ # resp.import_job_response.id #=> String
396
+ # resp.import_job_response.job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
397
+ # resp.import_job_response.total_failures #=> Integer
398
+ # resp.import_job_response.total_pieces #=> Integer
399
+ # resp.import_job_response.total_processed #=> Integer
400
+ # resp.import_job_response.type #=> String
401
+ # @overload create_import_job(params = {})
402
+ # @param [Hash] params ({})
403
+ def create_import_job(params = {}, options = {})
404
+ req = build_request(:create_import_job, params)
405
+ req.send_request(options)
406
+ end
407
+
408
+ # Used to create or update a segment.
409
+ # @option params [required, String] :application_id
410
+ # @option params [required, Types::WriteSegmentRequest] :write_segment_request
411
+ # @return [Types::CreateSegmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
412
+ #
413
+ # * {Types::CreateSegmentResponse#segment_response #SegmentResponse} => Types::SegmentResponse
414
+ #
415
+ # @example Request syntax with placeholder values
416
+ # resp = client.create_segment({
417
+ # application_id: "__string", # required
418
+ # write_segment_request: { # required
419
+ # dimensions: {
420
+ # attributes: {
421
+ # "__string" => {
422
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
423
+ # values: ["__string"],
424
+ # },
425
+ # },
426
+ # behavior: {
427
+ # recency: {
428
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
429
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
430
+ # },
431
+ # },
432
+ # demographic: {
433
+ # app_version: {
434
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
435
+ # values: ["__string"],
436
+ # },
437
+ # device_type: {
438
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
439
+ # values: ["__string"],
440
+ # },
441
+ # make: {
442
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
443
+ # values: ["__string"],
444
+ # },
445
+ # model: {
446
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
447
+ # values: ["__string"],
448
+ # },
449
+ # platform: {
450
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
451
+ # values: ["__string"],
452
+ # },
453
+ # },
454
+ # location: {
455
+ # country: {
456
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
457
+ # values: ["__string"],
458
+ # },
459
+ # },
460
+ # },
461
+ # name: "__string",
462
+ # },
463
+ # })
464
+ #
465
+ # @example Response structure
466
+ # resp.segment_response.application_id #=> String
467
+ # resp.segment_response.creation_date #=> String
468
+ # resp.segment_response.dimensions.attributes #=> Hash
469
+ # resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
470
+ # resp.segment_response.dimensions.attributes["__string"].values #=> Array
471
+ # resp.segment_response.dimensions.attributes["__string"].values[0] #=> String
472
+ # resp.segment_response.dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
473
+ # resp.segment_response.dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
474
+ # resp.segment_response.dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
475
+ # resp.segment_response.dimensions.demographic.app_version.values #=> Array
476
+ # resp.segment_response.dimensions.demographic.app_version.values[0] #=> String
477
+ # resp.segment_response.dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
478
+ # resp.segment_response.dimensions.demographic.device_type.values #=> Array
479
+ # resp.segment_response.dimensions.demographic.device_type.values[0] #=> String
480
+ # resp.segment_response.dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
481
+ # resp.segment_response.dimensions.demographic.make.values #=> Array
482
+ # resp.segment_response.dimensions.demographic.make.values[0] #=> String
483
+ # resp.segment_response.dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
484
+ # resp.segment_response.dimensions.demographic.model.values #=> Array
485
+ # resp.segment_response.dimensions.demographic.model.values[0] #=> String
486
+ # resp.segment_response.dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
487
+ # resp.segment_response.dimensions.demographic.platform.values #=> Array
488
+ # resp.segment_response.dimensions.demographic.platform.values[0] #=> String
489
+ # resp.segment_response.dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
490
+ # resp.segment_response.dimensions.location.country.values #=> Array
491
+ # resp.segment_response.dimensions.location.country.values[0] #=> String
492
+ # resp.segment_response.id #=> String
493
+ # resp.segment_response.import_definition.external_id #=> String
494
+ # resp.segment_response.import_definition.format #=> String, one of "CSV", "JSON"
495
+ # resp.segment_response.import_definition.role_arn #=> String
496
+ # resp.segment_response.import_definition.s3_url #=> String
497
+ # resp.segment_response.import_definition.size #=> Integer
498
+ # resp.segment_response.last_modified_date #=> String
499
+ # resp.segment_response.name #=> String
500
+ # resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
501
+ # resp.segment_response.version #=> Integer
502
+ # @overload create_segment(params = {})
503
+ # @param [Hash] params ({})
504
+ def create_segment(params = {}, options = {})
505
+ req = build_request(:create_segment, params)
506
+ req.send_request(options)
507
+ end
508
+
509
+ # Deletes the APNs channel for an app.
510
+ # @option params [required, String] :application_id
511
+ # @return [Types::DeleteApnsChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
512
+ #
513
+ # * {Types::DeleteApnsChannelResponse#apns_channel_response #APNSChannelResponse} => Types::APNSChannelResponse
514
+ #
515
+ # @example Request syntax with placeholder values
516
+ # resp = client.delete_apns_channel({
517
+ # application_id: "__string", # required
518
+ # })
519
+ #
520
+ # @example Response structure
521
+ # resp.apns_channel_response.application_id #=> String
522
+ # resp.apns_channel_response.creation_date #=> String
523
+ # resp.apns_channel_response.id #=> String
524
+ # resp.apns_channel_response.is_archived #=> Boolean
525
+ # resp.apns_channel_response.last_modified_by #=> String
526
+ # resp.apns_channel_response.last_modified_date #=> String
527
+ # resp.apns_channel_response.platform #=> String
528
+ # resp.apns_channel_response.version #=> Integer
529
+ # @overload delete_apns_channel(params = {})
530
+ # @param [Hash] params ({})
531
+ def delete_apns_channel(params = {}, options = {})
532
+ req = build_request(:delete_apns_channel, params)
533
+ req.send_request(options)
534
+ end
535
+
536
+ # Deletes a campaign.
537
+ # @option params [required, String] :application_id
538
+ # @option params [required, String] :campaign_id
539
+ # @return [Types::DeleteCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
540
+ #
541
+ # * {Types::DeleteCampaignResponse#campaign_response #CampaignResponse} => Types::CampaignResponse
542
+ #
543
+ # @example Request syntax with placeholder values
544
+ # resp = client.delete_campaign({
545
+ # application_id: "__string", # required
546
+ # campaign_id: "__string", # required
547
+ # })
548
+ #
549
+ # @example Response structure
550
+ # resp.campaign_response.additional_treatments #=> Array
551
+ # resp.campaign_response.additional_treatments[0].id #=> String
552
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
553
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
554
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
555
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
556
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
557
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
558
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
559
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
560
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
561
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
562
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
563
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
564
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
565
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
566
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
567
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
568
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
569
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
570
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
571
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
572
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
573
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
574
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
575
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
576
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
577
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
578
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
579
+ # resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
580
+ # resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
581
+ # resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> Boolean
582
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
583
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
584
+ # resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
585
+ # resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
586
+ # resp.campaign_response.additional_treatments[0].size_percent #=> Integer
587
+ # resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
588
+ # resp.campaign_response.additional_treatments[0].treatment_description #=> String
589
+ # resp.campaign_response.additional_treatments[0].treatment_name #=> String
590
+ # resp.campaign_response.application_id #=> String
591
+ # resp.campaign_response.creation_date #=> String
592
+ # resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
593
+ # resp.campaign_response.description #=> String
594
+ # resp.campaign_response.holdout_percent #=> Integer
595
+ # resp.campaign_response.id #=> String
596
+ # resp.campaign_response.is_paused #=> Boolean
597
+ # resp.campaign_response.last_modified_date #=> String
598
+ # resp.campaign_response.limits.daily #=> Integer
599
+ # resp.campaign_response.limits.total #=> Integer
600
+ # resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
601
+ # resp.campaign_response.message_configuration.apns_message.body #=> String
602
+ # resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
603
+ # resp.campaign_response.message_configuration.apns_message.image_url #=> String
604
+ # resp.campaign_response.message_configuration.apns_message.json_body #=> String
605
+ # resp.campaign_response.message_configuration.apns_message.media_url #=> String
606
+ # resp.campaign_response.message_configuration.apns_message.silent_push #=> Boolean
607
+ # resp.campaign_response.message_configuration.apns_message.title #=> String
608
+ # resp.campaign_response.message_configuration.apns_message.url #=> String
609
+ # resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
610
+ # resp.campaign_response.message_configuration.default_message.body #=> String
611
+ # resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
612
+ # resp.campaign_response.message_configuration.default_message.image_url #=> String
613
+ # resp.campaign_response.message_configuration.default_message.json_body #=> String
614
+ # resp.campaign_response.message_configuration.default_message.media_url #=> String
615
+ # resp.campaign_response.message_configuration.default_message.silent_push #=> Boolean
616
+ # resp.campaign_response.message_configuration.default_message.title #=> String
617
+ # resp.campaign_response.message_configuration.default_message.url #=> String
618
+ # resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
619
+ # resp.campaign_response.message_configuration.gcm_message.body #=> String
620
+ # resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
621
+ # resp.campaign_response.message_configuration.gcm_message.image_url #=> String
622
+ # resp.campaign_response.message_configuration.gcm_message.json_body #=> String
623
+ # resp.campaign_response.message_configuration.gcm_message.media_url #=> String
624
+ # resp.campaign_response.message_configuration.gcm_message.silent_push #=> Boolean
625
+ # resp.campaign_response.message_configuration.gcm_message.title #=> String
626
+ # resp.campaign_response.message_configuration.gcm_message.url #=> String
627
+ # resp.campaign_response.name #=> String
628
+ # resp.campaign_response.schedule.end_time #=> String
629
+ # resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
630
+ # resp.campaign_response.schedule.is_local_time #=> Boolean
631
+ # resp.campaign_response.schedule.quiet_time.end #=> String
632
+ # resp.campaign_response.schedule.quiet_time.start #=> String
633
+ # resp.campaign_response.schedule.start_time #=> String
634
+ # resp.campaign_response.schedule.timezone #=> String
635
+ # resp.campaign_response.segment_id #=> String
636
+ # resp.campaign_response.segment_version #=> Integer
637
+ # resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
638
+ # resp.campaign_response.treatment_description #=> String
639
+ # resp.campaign_response.treatment_name #=> String
640
+ # resp.campaign_response.version #=> Integer
641
+ # @overload delete_campaign(params = {})
642
+ # @param [Hash] params ({})
643
+ def delete_campaign(params = {}, options = {})
644
+ req = build_request(:delete_campaign, params)
645
+ req.send_request(options)
646
+ end
647
+
648
+ # Deletes the GCM channel for an app.
649
+ # @option params [required, String] :application_id
650
+ # @return [Types::DeleteGcmChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
651
+ #
652
+ # * {Types::DeleteGcmChannelResponse#gcm_channel_response #GCMChannelResponse} => Types::GCMChannelResponse
653
+ #
654
+ # @example Request syntax with placeholder values
655
+ # resp = client.delete_gcm_channel({
656
+ # application_id: "__string", # required
657
+ # })
658
+ #
659
+ # @example Response structure
660
+ # resp.gcm_channel_response.application_id #=> String
661
+ # resp.gcm_channel_response.creation_date #=> String
662
+ # resp.gcm_channel_response.credential #=> String
663
+ # resp.gcm_channel_response.id #=> String
664
+ # resp.gcm_channel_response.is_archived #=> Boolean
665
+ # resp.gcm_channel_response.last_modified_by #=> String
666
+ # resp.gcm_channel_response.last_modified_date #=> String
667
+ # resp.gcm_channel_response.platform #=> String
668
+ # resp.gcm_channel_response.version #=> Integer
669
+ # @overload delete_gcm_channel(params = {})
670
+ # @param [Hash] params ({})
671
+ def delete_gcm_channel(params = {}, options = {})
672
+ req = build_request(:delete_gcm_channel, params)
673
+ req.send_request(options)
674
+ end
675
+
676
+ # Deletes a segment.
677
+ # @option params [required, String] :application_id
678
+ # @option params [required, String] :segment_id
679
+ # @return [Types::DeleteSegmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
680
+ #
681
+ # * {Types::DeleteSegmentResponse#segment_response #SegmentResponse} => Types::SegmentResponse
682
+ #
683
+ # @example Request syntax with placeholder values
684
+ # resp = client.delete_segment({
685
+ # application_id: "__string", # required
686
+ # segment_id: "__string", # required
687
+ # })
688
+ #
689
+ # @example Response structure
690
+ # resp.segment_response.application_id #=> String
691
+ # resp.segment_response.creation_date #=> String
692
+ # resp.segment_response.dimensions.attributes #=> Hash
693
+ # resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
694
+ # resp.segment_response.dimensions.attributes["__string"].values #=> Array
695
+ # resp.segment_response.dimensions.attributes["__string"].values[0] #=> String
696
+ # resp.segment_response.dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
697
+ # resp.segment_response.dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
698
+ # resp.segment_response.dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
699
+ # resp.segment_response.dimensions.demographic.app_version.values #=> Array
700
+ # resp.segment_response.dimensions.demographic.app_version.values[0] #=> String
701
+ # resp.segment_response.dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
702
+ # resp.segment_response.dimensions.demographic.device_type.values #=> Array
703
+ # resp.segment_response.dimensions.demographic.device_type.values[0] #=> String
704
+ # resp.segment_response.dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
705
+ # resp.segment_response.dimensions.demographic.make.values #=> Array
706
+ # resp.segment_response.dimensions.demographic.make.values[0] #=> String
707
+ # resp.segment_response.dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
708
+ # resp.segment_response.dimensions.demographic.model.values #=> Array
709
+ # resp.segment_response.dimensions.demographic.model.values[0] #=> String
710
+ # resp.segment_response.dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
711
+ # resp.segment_response.dimensions.demographic.platform.values #=> Array
712
+ # resp.segment_response.dimensions.demographic.platform.values[0] #=> String
713
+ # resp.segment_response.dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
714
+ # resp.segment_response.dimensions.location.country.values #=> Array
715
+ # resp.segment_response.dimensions.location.country.values[0] #=> String
716
+ # resp.segment_response.id #=> String
717
+ # resp.segment_response.import_definition.external_id #=> String
718
+ # resp.segment_response.import_definition.format #=> String, one of "CSV", "JSON"
719
+ # resp.segment_response.import_definition.role_arn #=> String
720
+ # resp.segment_response.import_definition.s3_url #=> String
721
+ # resp.segment_response.import_definition.size #=> Integer
722
+ # resp.segment_response.last_modified_date #=> String
723
+ # resp.segment_response.name #=> String
724
+ # resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
725
+ # resp.segment_response.version #=> Integer
726
+ # @overload delete_segment(params = {})
727
+ # @param [Hash] params ({})
728
+ def delete_segment(params = {}, options = {})
729
+ req = build_request(:delete_segment, params)
730
+ req.send_request(options)
731
+ end
732
+
733
+ # Returns information about the APNs channel for an app.
734
+ # @option params [required, String] :application_id
735
+ # @return [Types::GetApnsChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
736
+ #
737
+ # * {Types::GetApnsChannelResponse#apns_channel_response #APNSChannelResponse} => Types::APNSChannelResponse
738
+ #
739
+ # @example Request syntax with placeholder values
740
+ # resp = client.get_apns_channel({
741
+ # application_id: "__string", # required
742
+ # })
743
+ #
744
+ # @example Response structure
745
+ # resp.apns_channel_response.application_id #=> String
746
+ # resp.apns_channel_response.creation_date #=> String
747
+ # resp.apns_channel_response.id #=> String
748
+ # resp.apns_channel_response.is_archived #=> Boolean
749
+ # resp.apns_channel_response.last_modified_by #=> String
750
+ # resp.apns_channel_response.last_modified_date #=> String
751
+ # resp.apns_channel_response.platform #=> String
752
+ # resp.apns_channel_response.version #=> Integer
753
+ # @overload get_apns_channel(params = {})
754
+ # @param [Hash] params ({})
755
+ def get_apns_channel(params = {}, options = {})
756
+ req = build_request(:get_apns_channel, params)
757
+ req.send_request(options)
758
+ end
759
+
760
+ # Used to request the settings for an app.
761
+ # @option params [required, String] :application_id
762
+ # @return [Types::GetApplicationSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
763
+ #
764
+ # * {Types::GetApplicationSettingsResponse#application_settings_resource #ApplicationSettingsResource} => Types::ApplicationSettingsResource
765
+ #
766
+ # @example Request syntax with placeholder values
767
+ # resp = client.get_application_settings({
768
+ # application_id: "__string", # required
769
+ # })
770
+ #
771
+ # @example Response structure
772
+ # resp.application_settings_resource.application_id #=> String
773
+ # resp.application_settings_resource.last_modified_date #=> String
774
+ # resp.application_settings_resource.limits.daily #=> Integer
775
+ # resp.application_settings_resource.limits.total #=> Integer
776
+ # resp.application_settings_resource.quiet_time.end #=> String
777
+ # resp.application_settings_resource.quiet_time.start #=> String
778
+ # @overload get_application_settings(params = {})
779
+ # @param [Hash] params ({})
780
+ def get_application_settings(params = {}, options = {})
781
+ req = build_request(:get_application_settings, params)
782
+ req.send_request(options)
783
+ end
784
+
785
+ # Returns information about a campaign.
786
+ # @option params [required, String] :application_id
787
+ # @option params [required, String] :campaign_id
788
+ # @return [Types::GetCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
789
+ #
790
+ # * {Types::GetCampaignResponse#campaign_response #CampaignResponse} => Types::CampaignResponse
791
+ #
792
+ # @example Request syntax with placeholder values
793
+ # resp = client.get_campaign({
794
+ # application_id: "__string", # required
795
+ # campaign_id: "__string", # required
796
+ # })
797
+ #
798
+ # @example Response structure
799
+ # resp.campaign_response.additional_treatments #=> Array
800
+ # resp.campaign_response.additional_treatments[0].id #=> String
801
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
802
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
803
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
804
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
805
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
806
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
807
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
808
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
809
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
810
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
811
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
812
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
813
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
814
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
815
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
816
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
817
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
818
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
819
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
820
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
821
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
822
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
823
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
824
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
825
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
826
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
827
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
828
+ # resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
829
+ # resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
830
+ # resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> Boolean
831
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
832
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
833
+ # resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
834
+ # resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
835
+ # resp.campaign_response.additional_treatments[0].size_percent #=> Integer
836
+ # resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
837
+ # resp.campaign_response.additional_treatments[0].treatment_description #=> String
838
+ # resp.campaign_response.additional_treatments[0].treatment_name #=> String
839
+ # resp.campaign_response.application_id #=> String
840
+ # resp.campaign_response.creation_date #=> String
841
+ # resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
842
+ # resp.campaign_response.description #=> String
843
+ # resp.campaign_response.holdout_percent #=> Integer
844
+ # resp.campaign_response.id #=> String
845
+ # resp.campaign_response.is_paused #=> Boolean
846
+ # resp.campaign_response.last_modified_date #=> String
847
+ # resp.campaign_response.limits.daily #=> Integer
848
+ # resp.campaign_response.limits.total #=> Integer
849
+ # resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
850
+ # resp.campaign_response.message_configuration.apns_message.body #=> String
851
+ # resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
852
+ # resp.campaign_response.message_configuration.apns_message.image_url #=> String
853
+ # resp.campaign_response.message_configuration.apns_message.json_body #=> String
854
+ # resp.campaign_response.message_configuration.apns_message.media_url #=> String
855
+ # resp.campaign_response.message_configuration.apns_message.silent_push #=> Boolean
856
+ # resp.campaign_response.message_configuration.apns_message.title #=> String
857
+ # resp.campaign_response.message_configuration.apns_message.url #=> String
858
+ # resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
859
+ # resp.campaign_response.message_configuration.default_message.body #=> String
860
+ # resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
861
+ # resp.campaign_response.message_configuration.default_message.image_url #=> String
862
+ # resp.campaign_response.message_configuration.default_message.json_body #=> String
863
+ # resp.campaign_response.message_configuration.default_message.media_url #=> String
864
+ # resp.campaign_response.message_configuration.default_message.silent_push #=> Boolean
865
+ # resp.campaign_response.message_configuration.default_message.title #=> String
866
+ # resp.campaign_response.message_configuration.default_message.url #=> String
867
+ # resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
868
+ # resp.campaign_response.message_configuration.gcm_message.body #=> String
869
+ # resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
870
+ # resp.campaign_response.message_configuration.gcm_message.image_url #=> String
871
+ # resp.campaign_response.message_configuration.gcm_message.json_body #=> String
872
+ # resp.campaign_response.message_configuration.gcm_message.media_url #=> String
873
+ # resp.campaign_response.message_configuration.gcm_message.silent_push #=> Boolean
874
+ # resp.campaign_response.message_configuration.gcm_message.title #=> String
875
+ # resp.campaign_response.message_configuration.gcm_message.url #=> String
876
+ # resp.campaign_response.name #=> String
877
+ # resp.campaign_response.schedule.end_time #=> String
878
+ # resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
879
+ # resp.campaign_response.schedule.is_local_time #=> Boolean
880
+ # resp.campaign_response.schedule.quiet_time.end #=> String
881
+ # resp.campaign_response.schedule.quiet_time.start #=> String
882
+ # resp.campaign_response.schedule.start_time #=> String
883
+ # resp.campaign_response.schedule.timezone #=> String
884
+ # resp.campaign_response.segment_id #=> String
885
+ # resp.campaign_response.segment_version #=> Integer
886
+ # resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
887
+ # resp.campaign_response.treatment_description #=> String
888
+ # resp.campaign_response.treatment_name #=> String
889
+ # resp.campaign_response.version #=> Integer
890
+ # @overload get_campaign(params = {})
891
+ # @param [Hash] params ({})
892
+ def get_campaign(params = {}, options = {})
893
+ req = build_request(:get_campaign, params)
894
+ req.send_request(options)
895
+ end
896
+
897
+ # Returns information about the activity performed by a campaign.
898
+ # @option params [required, String] :application_id
899
+ # @option params [required, String] :campaign_id
900
+ # @option params [String] :page_size
901
+ # @option params [String] :token
902
+ # @return [Types::GetCampaignActivitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
903
+ #
904
+ # * {Types::GetCampaignActivitiesResponse#activities_response #ActivitiesResponse} => Types::ActivitiesResponse
905
+ #
906
+ # @example Request syntax with placeholder values
907
+ # resp = client.get_campaign_activities({
908
+ # application_id: "__string", # required
909
+ # campaign_id: "__string", # required
910
+ # page_size: "__string",
911
+ # token: "__string",
912
+ # })
913
+ #
914
+ # @example Response structure
915
+ # resp.activities_response.item #=> Array
916
+ # resp.activities_response.item[0].application_id #=> String
917
+ # resp.activities_response.item[0].campaign_id #=> String
918
+ # resp.activities_response.item[0].end #=> String
919
+ # resp.activities_response.item[0].id #=> String
920
+ # resp.activities_response.item[0].result #=> String
921
+ # resp.activities_response.item[0].scheduled_start #=> String
922
+ # resp.activities_response.item[0].start #=> String
923
+ # resp.activities_response.item[0].state #=> String
924
+ # resp.activities_response.item[0].successful_endpoint_count #=> Integer
925
+ # resp.activities_response.item[0].total_endpoint_count #=> Integer
926
+ # resp.activities_response.item[0].treatment_id #=> String
927
+ # @overload get_campaign_activities(params = {})
928
+ # @param [Hash] params ({})
929
+ def get_campaign_activities(params = {}, options = {})
930
+ req = build_request(:get_campaign_activities, params)
931
+ req.send_request(options)
932
+ end
933
+
934
+ # Returns information about your campaign versions.
935
+ # @option params [required, String] :application_id
936
+ # @option params [required, String] :campaign_id
937
+ # @option params [required, String] :version
938
+ # @return [Types::GetCampaignVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
939
+ #
940
+ # * {Types::GetCampaignVersionResponse#campaign_response #CampaignResponse} => Types::CampaignResponse
941
+ #
942
+ # @example Request syntax with placeholder values
943
+ # resp = client.get_campaign_version({
944
+ # application_id: "__string", # required
945
+ # campaign_id: "__string", # required
946
+ # version: "__string", # required
947
+ # })
948
+ #
949
+ # @example Response structure
950
+ # resp.campaign_response.additional_treatments #=> Array
951
+ # resp.campaign_response.additional_treatments[0].id #=> String
952
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
953
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
954
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
955
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
956
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
957
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
958
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
959
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
960
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
961
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
962
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
963
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
964
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
965
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
966
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
967
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
968
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
969
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
970
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
971
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
972
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
973
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
974
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
975
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
976
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
977
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
978
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
979
+ # resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
980
+ # resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
981
+ # resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> Boolean
982
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
983
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
984
+ # resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
985
+ # resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
986
+ # resp.campaign_response.additional_treatments[0].size_percent #=> Integer
987
+ # resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
988
+ # resp.campaign_response.additional_treatments[0].treatment_description #=> String
989
+ # resp.campaign_response.additional_treatments[0].treatment_name #=> String
990
+ # resp.campaign_response.application_id #=> String
991
+ # resp.campaign_response.creation_date #=> String
992
+ # resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
993
+ # resp.campaign_response.description #=> String
994
+ # resp.campaign_response.holdout_percent #=> Integer
995
+ # resp.campaign_response.id #=> String
996
+ # resp.campaign_response.is_paused #=> Boolean
997
+ # resp.campaign_response.last_modified_date #=> String
998
+ # resp.campaign_response.limits.daily #=> Integer
999
+ # resp.campaign_response.limits.total #=> Integer
1000
+ # resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1001
+ # resp.campaign_response.message_configuration.apns_message.body #=> String
1002
+ # resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
1003
+ # resp.campaign_response.message_configuration.apns_message.image_url #=> String
1004
+ # resp.campaign_response.message_configuration.apns_message.json_body #=> String
1005
+ # resp.campaign_response.message_configuration.apns_message.media_url #=> String
1006
+ # resp.campaign_response.message_configuration.apns_message.silent_push #=> Boolean
1007
+ # resp.campaign_response.message_configuration.apns_message.title #=> String
1008
+ # resp.campaign_response.message_configuration.apns_message.url #=> String
1009
+ # resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1010
+ # resp.campaign_response.message_configuration.default_message.body #=> String
1011
+ # resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
1012
+ # resp.campaign_response.message_configuration.default_message.image_url #=> String
1013
+ # resp.campaign_response.message_configuration.default_message.json_body #=> String
1014
+ # resp.campaign_response.message_configuration.default_message.media_url #=> String
1015
+ # resp.campaign_response.message_configuration.default_message.silent_push #=> Boolean
1016
+ # resp.campaign_response.message_configuration.default_message.title #=> String
1017
+ # resp.campaign_response.message_configuration.default_message.url #=> String
1018
+ # resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1019
+ # resp.campaign_response.message_configuration.gcm_message.body #=> String
1020
+ # resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
1021
+ # resp.campaign_response.message_configuration.gcm_message.image_url #=> String
1022
+ # resp.campaign_response.message_configuration.gcm_message.json_body #=> String
1023
+ # resp.campaign_response.message_configuration.gcm_message.media_url #=> String
1024
+ # resp.campaign_response.message_configuration.gcm_message.silent_push #=> Boolean
1025
+ # resp.campaign_response.message_configuration.gcm_message.title #=> String
1026
+ # resp.campaign_response.message_configuration.gcm_message.url #=> String
1027
+ # resp.campaign_response.name #=> String
1028
+ # resp.campaign_response.schedule.end_time #=> String
1029
+ # resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
1030
+ # resp.campaign_response.schedule.is_local_time #=> Boolean
1031
+ # resp.campaign_response.schedule.quiet_time.end #=> String
1032
+ # resp.campaign_response.schedule.quiet_time.start #=> String
1033
+ # resp.campaign_response.schedule.start_time #=> String
1034
+ # resp.campaign_response.schedule.timezone #=> String
1035
+ # resp.campaign_response.segment_id #=> String
1036
+ # resp.campaign_response.segment_version #=> Integer
1037
+ # resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1038
+ # resp.campaign_response.treatment_description #=> String
1039
+ # resp.campaign_response.treatment_name #=> String
1040
+ # resp.campaign_response.version #=> Integer
1041
+ # @overload get_campaign_version(params = {})
1042
+ # @param [Hash] params ({})
1043
+ def get_campaign_version(params = {}, options = {})
1044
+ req = build_request(:get_campaign_version, params)
1045
+ req.send_request(options)
1046
+ end
1047
+
1048
+ # Returns information about your campaign versions.
1049
+ # @option params [required, String] :application_id
1050
+ # @option params [required, String] :campaign_id
1051
+ # @option params [String] :page_size
1052
+ # @option params [String] :token
1053
+ # @return [Types::GetCampaignVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1054
+ #
1055
+ # * {Types::GetCampaignVersionsResponse#campaigns_response #CampaignsResponse} => Types::CampaignsResponse
1056
+ #
1057
+ # @example Request syntax with placeholder values
1058
+ # resp = client.get_campaign_versions({
1059
+ # application_id: "__string", # required
1060
+ # campaign_id: "__string", # required
1061
+ # page_size: "__string",
1062
+ # token: "__string",
1063
+ # })
1064
+ #
1065
+ # @example Response structure
1066
+ # resp.campaigns_response.item #=> Array
1067
+ # resp.campaigns_response.item[0].additional_treatments #=> Array
1068
+ # resp.campaigns_response.item[0].additional_treatments[0].id #=> String
1069
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1070
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.body #=> String
1071
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
1072
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_url #=> String
1073
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.json_body #=> String
1074
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.media_url #=> String
1075
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
1076
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.title #=> String
1077
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.url #=> String
1078
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1079
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.body #=> String
1080
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
1081
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_url #=> String
1082
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.json_body #=> String
1083
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.media_url #=> String
1084
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
1085
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.title #=> String
1086
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.url #=> String
1087
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1088
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.body #=> String
1089
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
1090
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_url #=> String
1091
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.json_body #=> String
1092
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.media_url #=> String
1093
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
1094
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.title #=> String
1095
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.url #=> String
1096
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.end_time #=> String
1097
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
1098
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.is_local_time #=> Boolean
1099
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.end #=> String
1100
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.start #=> String
1101
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.start_time #=> String
1102
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.timezone #=> String
1103
+ # resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
1104
+ # resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1105
+ # resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
1106
+ # resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
1107
+ # resp.campaigns_response.item[0].application_id #=> String
1108
+ # resp.campaigns_response.item[0].creation_date #=> String
1109
+ # resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1110
+ # resp.campaigns_response.item[0].description #=> String
1111
+ # resp.campaigns_response.item[0].holdout_percent #=> Integer
1112
+ # resp.campaigns_response.item[0].id #=> String
1113
+ # resp.campaigns_response.item[0].is_paused #=> Boolean
1114
+ # resp.campaigns_response.item[0].last_modified_date #=> String
1115
+ # resp.campaigns_response.item[0].limits.daily #=> Integer
1116
+ # resp.campaigns_response.item[0].limits.total #=> Integer
1117
+ # resp.campaigns_response.item[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1118
+ # resp.campaigns_response.item[0].message_configuration.apns_message.body #=> String
1119
+ # resp.campaigns_response.item[0].message_configuration.apns_message.image_icon_url #=> String
1120
+ # resp.campaigns_response.item[0].message_configuration.apns_message.image_url #=> String
1121
+ # resp.campaigns_response.item[0].message_configuration.apns_message.json_body #=> String
1122
+ # resp.campaigns_response.item[0].message_configuration.apns_message.media_url #=> String
1123
+ # resp.campaigns_response.item[0].message_configuration.apns_message.silent_push #=> Boolean
1124
+ # resp.campaigns_response.item[0].message_configuration.apns_message.title #=> String
1125
+ # resp.campaigns_response.item[0].message_configuration.apns_message.url #=> String
1126
+ # resp.campaigns_response.item[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1127
+ # resp.campaigns_response.item[0].message_configuration.default_message.body #=> String
1128
+ # resp.campaigns_response.item[0].message_configuration.default_message.image_icon_url #=> String
1129
+ # resp.campaigns_response.item[0].message_configuration.default_message.image_url #=> String
1130
+ # resp.campaigns_response.item[0].message_configuration.default_message.json_body #=> String
1131
+ # resp.campaigns_response.item[0].message_configuration.default_message.media_url #=> String
1132
+ # resp.campaigns_response.item[0].message_configuration.default_message.silent_push #=> Boolean
1133
+ # resp.campaigns_response.item[0].message_configuration.default_message.title #=> String
1134
+ # resp.campaigns_response.item[0].message_configuration.default_message.url #=> String
1135
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1136
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.body #=> String
1137
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.image_icon_url #=> String
1138
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.image_url #=> String
1139
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.json_body #=> String
1140
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.media_url #=> String
1141
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.silent_push #=> Boolean
1142
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.title #=> String
1143
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.url #=> String
1144
+ # resp.campaigns_response.item[0].name #=> String
1145
+ # resp.campaigns_response.item[0].schedule.end_time #=> String
1146
+ # resp.campaigns_response.item[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
1147
+ # resp.campaigns_response.item[0].schedule.is_local_time #=> Boolean
1148
+ # resp.campaigns_response.item[0].schedule.quiet_time.end #=> String
1149
+ # resp.campaigns_response.item[0].schedule.quiet_time.start #=> String
1150
+ # resp.campaigns_response.item[0].schedule.start_time #=> String
1151
+ # resp.campaigns_response.item[0].schedule.timezone #=> String
1152
+ # resp.campaigns_response.item[0].segment_id #=> String
1153
+ # resp.campaigns_response.item[0].segment_version #=> Integer
1154
+ # resp.campaigns_response.item[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1155
+ # resp.campaigns_response.item[0].treatment_description #=> String
1156
+ # resp.campaigns_response.item[0].treatment_name #=> String
1157
+ # resp.campaigns_response.item[0].version #=> Integer
1158
+ # resp.campaigns_response.next_token #=> String
1159
+ # @overload get_campaign_versions(params = {})
1160
+ # @param [Hash] params ({})
1161
+ def get_campaign_versions(params = {}, options = {})
1162
+ req = build_request(:get_campaign_versions, params)
1163
+ req.send_request(options)
1164
+ end
1165
+
1166
+ # Returns information about your campaigns.
1167
+ # @option params [required, String] :application_id
1168
+ # @option params [String] :page_size
1169
+ # @option params [String] :token
1170
+ # @return [Types::GetCampaignsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1171
+ #
1172
+ # * {Types::GetCampaignsResponse#campaigns_response #CampaignsResponse} => Types::CampaignsResponse
1173
+ #
1174
+ # @example Request syntax with placeholder values
1175
+ # resp = client.get_campaigns({
1176
+ # application_id: "__string", # required
1177
+ # page_size: "__string",
1178
+ # token: "__string",
1179
+ # })
1180
+ #
1181
+ # @example Response structure
1182
+ # resp.campaigns_response.item #=> Array
1183
+ # resp.campaigns_response.item[0].additional_treatments #=> Array
1184
+ # resp.campaigns_response.item[0].additional_treatments[0].id #=> String
1185
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1186
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.body #=> String
1187
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
1188
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.image_url #=> String
1189
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.json_body #=> String
1190
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.media_url #=> String
1191
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
1192
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.title #=> String
1193
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.apns_message.url #=> String
1194
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1195
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.body #=> String
1196
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
1197
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.image_url #=> String
1198
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.json_body #=> String
1199
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.media_url #=> String
1200
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
1201
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.title #=> String
1202
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.default_message.url #=> String
1203
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1204
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.body #=> String
1205
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
1206
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.image_url #=> String
1207
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.json_body #=> String
1208
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.media_url #=> String
1209
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
1210
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.title #=> String
1211
+ # resp.campaigns_response.item[0].additional_treatments[0].message_configuration.gcm_message.url #=> String
1212
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.end_time #=> String
1213
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
1214
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.is_local_time #=> Boolean
1215
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.end #=> String
1216
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.quiet_time.start #=> String
1217
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.start_time #=> String
1218
+ # resp.campaigns_response.item[0].additional_treatments[0].schedule.timezone #=> String
1219
+ # resp.campaigns_response.item[0].additional_treatments[0].size_percent #=> Integer
1220
+ # resp.campaigns_response.item[0].additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1221
+ # resp.campaigns_response.item[0].additional_treatments[0].treatment_description #=> String
1222
+ # resp.campaigns_response.item[0].additional_treatments[0].treatment_name #=> String
1223
+ # resp.campaigns_response.item[0].application_id #=> String
1224
+ # resp.campaigns_response.item[0].creation_date #=> String
1225
+ # resp.campaigns_response.item[0].default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1226
+ # resp.campaigns_response.item[0].description #=> String
1227
+ # resp.campaigns_response.item[0].holdout_percent #=> Integer
1228
+ # resp.campaigns_response.item[0].id #=> String
1229
+ # resp.campaigns_response.item[0].is_paused #=> Boolean
1230
+ # resp.campaigns_response.item[0].last_modified_date #=> String
1231
+ # resp.campaigns_response.item[0].limits.daily #=> Integer
1232
+ # resp.campaigns_response.item[0].limits.total #=> Integer
1233
+ # resp.campaigns_response.item[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1234
+ # resp.campaigns_response.item[0].message_configuration.apns_message.body #=> String
1235
+ # resp.campaigns_response.item[0].message_configuration.apns_message.image_icon_url #=> String
1236
+ # resp.campaigns_response.item[0].message_configuration.apns_message.image_url #=> String
1237
+ # resp.campaigns_response.item[0].message_configuration.apns_message.json_body #=> String
1238
+ # resp.campaigns_response.item[0].message_configuration.apns_message.media_url #=> String
1239
+ # resp.campaigns_response.item[0].message_configuration.apns_message.silent_push #=> Boolean
1240
+ # resp.campaigns_response.item[0].message_configuration.apns_message.title #=> String
1241
+ # resp.campaigns_response.item[0].message_configuration.apns_message.url #=> String
1242
+ # resp.campaigns_response.item[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1243
+ # resp.campaigns_response.item[0].message_configuration.default_message.body #=> String
1244
+ # resp.campaigns_response.item[0].message_configuration.default_message.image_icon_url #=> String
1245
+ # resp.campaigns_response.item[0].message_configuration.default_message.image_url #=> String
1246
+ # resp.campaigns_response.item[0].message_configuration.default_message.json_body #=> String
1247
+ # resp.campaigns_response.item[0].message_configuration.default_message.media_url #=> String
1248
+ # resp.campaigns_response.item[0].message_configuration.default_message.silent_push #=> Boolean
1249
+ # resp.campaigns_response.item[0].message_configuration.default_message.title #=> String
1250
+ # resp.campaigns_response.item[0].message_configuration.default_message.url #=> String
1251
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1252
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.body #=> String
1253
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.image_icon_url #=> String
1254
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.image_url #=> String
1255
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.json_body #=> String
1256
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.media_url #=> String
1257
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.silent_push #=> Boolean
1258
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.title #=> String
1259
+ # resp.campaigns_response.item[0].message_configuration.gcm_message.url #=> String
1260
+ # resp.campaigns_response.item[0].name #=> String
1261
+ # resp.campaigns_response.item[0].schedule.end_time #=> String
1262
+ # resp.campaigns_response.item[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
1263
+ # resp.campaigns_response.item[0].schedule.is_local_time #=> Boolean
1264
+ # resp.campaigns_response.item[0].schedule.quiet_time.end #=> String
1265
+ # resp.campaigns_response.item[0].schedule.quiet_time.start #=> String
1266
+ # resp.campaigns_response.item[0].schedule.start_time #=> String
1267
+ # resp.campaigns_response.item[0].schedule.timezone #=> String
1268
+ # resp.campaigns_response.item[0].segment_id #=> String
1269
+ # resp.campaigns_response.item[0].segment_version #=> Integer
1270
+ # resp.campaigns_response.item[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1271
+ # resp.campaigns_response.item[0].treatment_description #=> String
1272
+ # resp.campaigns_response.item[0].treatment_name #=> String
1273
+ # resp.campaigns_response.item[0].version #=> Integer
1274
+ # resp.campaigns_response.next_token #=> String
1275
+ # @overload get_campaigns(params = {})
1276
+ # @param [Hash] params ({})
1277
+ def get_campaigns(params = {}, options = {})
1278
+ req = build_request(:get_campaigns, params)
1279
+ req.send_request(options)
1280
+ end
1281
+
1282
+ # Returns information about an endpoint.
1283
+ # @option params [required, String] :application_id
1284
+ # @option params [required, String] :endpoint_id
1285
+ # @return [Types::GetEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1286
+ #
1287
+ # * {Types::GetEndpointResponse#endpoint_response #EndpointResponse} => Types::EndpointResponse
1288
+ #
1289
+ # @example Request syntax with placeholder values
1290
+ # resp = client.get_endpoint({
1291
+ # application_id: "__string", # required
1292
+ # endpoint_id: "__string", # required
1293
+ # })
1294
+ #
1295
+ # @example Response structure
1296
+ # resp.endpoint_response.address #=> String
1297
+ # resp.endpoint_response.application_id #=> String
1298
+ # resp.endpoint_response.attributes #=> Hash
1299
+ # resp.endpoint_response.attributes["__string"] #=> Array
1300
+ # resp.endpoint_response.attributes["__string"][0] #=> String
1301
+ # resp.endpoint_response.channel_type #=> String, one of "APNS", "GCM"
1302
+ # resp.endpoint_response.cohort_id #=> String
1303
+ # resp.endpoint_response.creation_date #=> String
1304
+ # resp.endpoint_response.demographic.app_version #=> String
1305
+ # resp.endpoint_response.demographic.locale #=> String
1306
+ # resp.endpoint_response.demographic.make #=> String
1307
+ # resp.endpoint_response.demographic.model #=> String
1308
+ # resp.endpoint_response.demographic.model_version #=> String
1309
+ # resp.endpoint_response.demographic.platform #=> String
1310
+ # resp.endpoint_response.demographic.platform_version #=> String
1311
+ # resp.endpoint_response.demographic.timezone #=> String
1312
+ # resp.endpoint_response.effective_date #=> String
1313
+ # resp.endpoint_response.endpoint_status #=> String
1314
+ # resp.endpoint_response.id #=> String
1315
+ # resp.endpoint_response.location.city #=> String
1316
+ # resp.endpoint_response.location.country #=> String
1317
+ # resp.endpoint_response.location.latitude #=> Float
1318
+ # resp.endpoint_response.location.longitude #=> Float
1319
+ # resp.endpoint_response.location.postal_code #=> String
1320
+ # resp.endpoint_response.location.region #=> String
1321
+ # resp.endpoint_response.metrics #=> Hash
1322
+ # resp.endpoint_response.metrics["__string"] #=> Float
1323
+ # resp.endpoint_response.opt_out #=> String
1324
+ # resp.endpoint_response.request_id #=> String
1325
+ # resp.endpoint_response.shard_id #=> String
1326
+ # resp.endpoint_response.user.user_attributes #=> Hash
1327
+ # resp.endpoint_response.user.user_attributes["__string"] #=> Array
1328
+ # resp.endpoint_response.user.user_attributes["__string"][0] #=> String
1329
+ # resp.endpoint_response.user.user_id #=> String
1330
+ # @overload get_endpoint(params = {})
1331
+ # @param [Hash] params ({})
1332
+ def get_endpoint(params = {}, options = {})
1333
+ req = build_request(:get_endpoint, params)
1334
+ req.send_request(options)
1335
+ end
1336
+
1337
+ # Returns information about the GCM channel for an app.
1338
+ # @option params [required, String] :application_id
1339
+ # @return [Types::GetGcmChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1340
+ #
1341
+ # * {Types::GetGcmChannelResponse#gcm_channel_response #GCMChannelResponse} => Types::GCMChannelResponse
1342
+ #
1343
+ # @example Request syntax with placeholder values
1344
+ # resp = client.get_gcm_channel({
1345
+ # application_id: "__string", # required
1346
+ # })
1347
+ #
1348
+ # @example Response structure
1349
+ # resp.gcm_channel_response.application_id #=> String
1350
+ # resp.gcm_channel_response.creation_date #=> String
1351
+ # resp.gcm_channel_response.credential #=> String
1352
+ # resp.gcm_channel_response.id #=> String
1353
+ # resp.gcm_channel_response.is_archived #=> Boolean
1354
+ # resp.gcm_channel_response.last_modified_by #=> String
1355
+ # resp.gcm_channel_response.last_modified_date #=> String
1356
+ # resp.gcm_channel_response.platform #=> String
1357
+ # resp.gcm_channel_response.version #=> Integer
1358
+ # @overload get_gcm_channel(params = {})
1359
+ # @param [Hash] params ({})
1360
+ def get_gcm_channel(params = {}, options = {})
1361
+ req = build_request(:get_gcm_channel, params)
1362
+ req.send_request(options)
1363
+ end
1364
+
1365
+ # Returns information about an import job.
1366
+ # @option params [required, String] :application_id
1367
+ # @option params [required, String] :job_id
1368
+ # @return [Types::GetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1369
+ #
1370
+ # * {Types::GetImportJobResponse#import_job_response #ImportJobResponse} => Types::ImportJobResponse
1371
+ #
1372
+ # @example Request syntax with placeholder values
1373
+ # resp = client.get_import_job({
1374
+ # application_id: "__string", # required
1375
+ # job_id: "__string", # required
1376
+ # })
1377
+ #
1378
+ # @example Response structure
1379
+ # resp.import_job_response.application_id #=> String
1380
+ # resp.import_job_response.completed_pieces #=> Integer
1381
+ # resp.import_job_response.completion_date #=> String
1382
+ # resp.import_job_response.creation_date #=> String
1383
+ # resp.import_job_response.definition.define_segment #=> Boolean
1384
+ # resp.import_job_response.definition.external_id #=> String
1385
+ # resp.import_job_response.definition.format #=> String, one of "CSV", "JSON"
1386
+ # resp.import_job_response.definition.register_endpoints #=> Boolean
1387
+ # resp.import_job_response.definition.role_arn #=> String
1388
+ # resp.import_job_response.definition.s3_url #=> String
1389
+ # resp.import_job_response.definition.segment_id #=> String
1390
+ # resp.import_job_response.definition.segment_name #=> String
1391
+ # resp.import_job_response.failed_pieces #=> Integer
1392
+ # resp.import_job_response.failures #=> Array
1393
+ # resp.import_job_response.failures[0] #=> String
1394
+ # resp.import_job_response.id #=> String
1395
+ # resp.import_job_response.job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
1396
+ # resp.import_job_response.total_failures #=> Integer
1397
+ # resp.import_job_response.total_pieces #=> Integer
1398
+ # resp.import_job_response.total_processed #=> Integer
1399
+ # resp.import_job_response.type #=> String
1400
+ # @overload get_import_job(params = {})
1401
+ # @param [Hash] params ({})
1402
+ def get_import_job(params = {}, options = {})
1403
+ req = build_request(:get_import_job, params)
1404
+ req.send_request(options)
1405
+ end
1406
+
1407
+ # Returns information about your import jobs.
1408
+ # @option params [required, String] :application_id
1409
+ # @option params [String] :page_size
1410
+ # @option params [String] :token
1411
+ # @return [Types::GetImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1412
+ #
1413
+ # * {Types::GetImportJobsResponse#import_jobs_response #ImportJobsResponse} => Types::ImportJobsResponse
1414
+ #
1415
+ # @example Request syntax with placeholder values
1416
+ # resp = client.get_import_jobs({
1417
+ # application_id: "__string", # required
1418
+ # page_size: "__string",
1419
+ # token: "__string",
1420
+ # })
1421
+ #
1422
+ # @example Response structure
1423
+ # resp.import_jobs_response.item #=> Array
1424
+ # resp.import_jobs_response.item[0].application_id #=> String
1425
+ # resp.import_jobs_response.item[0].completed_pieces #=> Integer
1426
+ # resp.import_jobs_response.item[0].completion_date #=> String
1427
+ # resp.import_jobs_response.item[0].creation_date #=> String
1428
+ # resp.import_jobs_response.item[0].definition.define_segment #=> Boolean
1429
+ # resp.import_jobs_response.item[0].definition.external_id #=> String
1430
+ # resp.import_jobs_response.item[0].definition.format #=> String, one of "CSV", "JSON"
1431
+ # resp.import_jobs_response.item[0].definition.register_endpoints #=> Boolean
1432
+ # resp.import_jobs_response.item[0].definition.role_arn #=> String
1433
+ # resp.import_jobs_response.item[0].definition.s3_url #=> String
1434
+ # resp.import_jobs_response.item[0].definition.segment_id #=> String
1435
+ # resp.import_jobs_response.item[0].definition.segment_name #=> String
1436
+ # resp.import_jobs_response.item[0].failed_pieces #=> Integer
1437
+ # resp.import_jobs_response.item[0].failures #=> Array
1438
+ # resp.import_jobs_response.item[0].failures[0] #=> String
1439
+ # resp.import_jobs_response.item[0].id #=> String
1440
+ # resp.import_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
1441
+ # resp.import_jobs_response.item[0].total_failures #=> Integer
1442
+ # resp.import_jobs_response.item[0].total_pieces #=> Integer
1443
+ # resp.import_jobs_response.item[0].total_processed #=> Integer
1444
+ # resp.import_jobs_response.item[0].type #=> String
1445
+ # resp.import_jobs_response.next_token #=> String
1446
+ # @overload get_import_jobs(params = {})
1447
+ # @param [Hash] params ({})
1448
+ def get_import_jobs(params = {}, options = {})
1449
+ req = build_request(:get_import_jobs, params)
1450
+ req.send_request(options)
1451
+ end
1452
+
1453
+ # Returns information about a segment.
1454
+ # @option params [required, String] :application_id
1455
+ # @option params [required, String] :segment_id
1456
+ # @return [Types::GetSegmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1457
+ #
1458
+ # * {Types::GetSegmentResponse#segment_response #SegmentResponse} => Types::SegmentResponse
1459
+ #
1460
+ # @example Request syntax with placeholder values
1461
+ # resp = client.get_segment({
1462
+ # application_id: "__string", # required
1463
+ # segment_id: "__string", # required
1464
+ # })
1465
+ #
1466
+ # @example Response structure
1467
+ # resp.segment_response.application_id #=> String
1468
+ # resp.segment_response.creation_date #=> String
1469
+ # resp.segment_response.dimensions.attributes #=> Hash
1470
+ # resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1471
+ # resp.segment_response.dimensions.attributes["__string"].values #=> Array
1472
+ # resp.segment_response.dimensions.attributes["__string"].values[0] #=> String
1473
+ # resp.segment_response.dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
1474
+ # resp.segment_response.dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
1475
+ # resp.segment_response.dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1476
+ # resp.segment_response.dimensions.demographic.app_version.values #=> Array
1477
+ # resp.segment_response.dimensions.demographic.app_version.values[0] #=> String
1478
+ # resp.segment_response.dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1479
+ # resp.segment_response.dimensions.demographic.device_type.values #=> Array
1480
+ # resp.segment_response.dimensions.demographic.device_type.values[0] #=> String
1481
+ # resp.segment_response.dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1482
+ # resp.segment_response.dimensions.demographic.make.values #=> Array
1483
+ # resp.segment_response.dimensions.demographic.make.values[0] #=> String
1484
+ # resp.segment_response.dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1485
+ # resp.segment_response.dimensions.demographic.model.values #=> Array
1486
+ # resp.segment_response.dimensions.demographic.model.values[0] #=> String
1487
+ # resp.segment_response.dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1488
+ # resp.segment_response.dimensions.demographic.platform.values #=> Array
1489
+ # resp.segment_response.dimensions.demographic.platform.values[0] #=> String
1490
+ # resp.segment_response.dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1491
+ # resp.segment_response.dimensions.location.country.values #=> Array
1492
+ # resp.segment_response.dimensions.location.country.values[0] #=> String
1493
+ # resp.segment_response.id #=> String
1494
+ # resp.segment_response.import_definition.external_id #=> String
1495
+ # resp.segment_response.import_definition.format #=> String, one of "CSV", "JSON"
1496
+ # resp.segment_response.import_definition.role_arn #=> String
1497
+ # resp.segment_response.import_definition.s3_url #=> String
1498
+ # resp.segment_response.import_definition.size #=> Integer
1499
+ # resp.segment_response.last_modified_date #=> String
1500
+ # resp.segment_response.name #=> String
1501
+ # resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
1502
+ # resp.segment_response.version #=> Integer
1503
+ # @overload get_segment(params = {})
1504
+ # @param [Hash] params ({})
1505
+ def get_segment(params = {}, options = {})
1506
+ req = build_request(:get_segment, params)
1507
+ req.send_request(options)
1508
+ end
1509
+
1510
+ # Returns a list of import jobs for a specific segment.
1511
+ # @option params [required, String] :application_id
1512
+ # @option params [String] :page_size
1513
+ # @option params [required, String] :segment_id
1514
+ # @option params [String] :token
1515
+ # @return [Types::GetSegmentImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1516
+ #
1517
+ # * {Types::GetSegmentImportJobsResponse#import_jobs_response #ImportJobsResponse} => Types::ImportJobsResponse
1518
+ #
1519
+ # @example Request syntax with placeholder values
1520
+ # resp = client.get_segment_import_jobs({
1521
+ # application_id: "__string", # required
1522
+ # page_size: "__string",
1523
+ # segment_id: "__string", # required
1524
+ # token: "__string",
1525
+ # })
1526
+ #
1527
+ # @example Response structure
1528
+ # resp.import_jobs_response.item #=> Array
1529
+ # resp.import_jobs_response.item[0].application_id #=> String
1530
+ # resp.import_jobs_response.item[0].completed_pieces #=> Integer
1531
+ # resp.import_jobs_response.item[0].completion_date #=> String
1532
+ # resp.import_jobs_response.item[0].creation_date #=> String
1533
+ # resp.import_jobs_response.item[0].definition.define_segment #=> Boolean
1534
+ # resp.import_jobs_response.item[0].definition.external_id #=> String
1535
+ # resp.import_jobs_response.item[0].definition.format #=> String, one of "CSV", "JSON"
1536
+ # resp.import_jobs_response.item[0].definition.register_endpoints #=> Boolean
1537
+ # resp.import_jobs_response.item[0].definition.role_arn #=> String
1538
+ # resp.import_jobs_response.item[0].definition.s3_url #=> String
1539
+ # resp.import_jobs_response.item[0].definition.segment_id #=> String
1540
+ # resp.import_jobs_response.item[0].definition.segment_name #=> String
1541
+ # resp.import_jobs_response.item[0].failed_pieces #=> Integer
1542
+ # resp.import_jobs_response.item[0].failures #=> Array
1543
+ # resp.import_jobs_response.item[0].failures[0] #=> String
1544
+ # resp.import_jobs_response.item[0].id #=> String
1545
+ # resp.import_jobs_response.item[0].job_status #=> String, one of "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED"
1546
+ # resp.import_jobs_response.item[0].total_failures #=> Integer
1547
+ # resp.import_jobs_response.item[0].total_pieces #=> Integer
1548
+ # resp.import_jobs_response.item[0].total_processed #=> Integer
1549
+ # resp.import_jobs_response.item[0].type #=> String
1550
+ # resp.import_jobs_response.next_token #=> String
1551
+ # @overload get_segment_import_jobs(params = {})
1552
+ # @param [Hash] params ({})
1553
+ def get_segment_import_jobs(params = {}, options = {})
1554
+ req = build_request(:get_segment_import_jobs, params)
1555
+ req.send_request(options)
1556
+ end
1557
+
1558
+ # Returns information about a segment version.
1559
+ # @option params [required, String] :application_id
1560
+ # @option params [required, String] :segment_id
1561
+ # @option params [required, String] :version
1562
+ # @return [Types::GetSegmentVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1563
+ #
1564
+ # * {Types::GetSegmentVersionResponse#segment_response #SegmentResponse} => Types::SegmentResponse
1565
+ #
1566
+ # @example Request syntax with placeholder values
1567
+ # resp = client.get_segment_version({
1568
+ # application_id: "__string", # required
1569
+ # segment_id: "__string", # required
1570
+ # version: "__string", # required
1571
+ # })
1572
+ #
1573
+ # @example Response structure
1574
+ # resp.segment_response.application_id #=> String
1575
+ # resp.segment_response.creation_date #=> String
1576
+ # resp.segment_response.dimensions.attributes #=> Hash
1577
+ # resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1578
+ # resp.segment_response.dimensions.attributes["__string"].values #=> Array
1579
+ # resp.segment_response.dimensions.attributes["__string"].values[0] #=> String
1580
+ # resp.segment_response.dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
1581
+ # resp.segment_response.dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
1582
+ # resp.segment_response.dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1583
+ # resp.segment_response.dimensions.demographic.app_version.values #=> Array
1584
+ # resp.segment_response.dimensions.demographic.app_version.values[0] #=> String
1585
+ # resp.segment_response.dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1586
+ # resp.segment_response.dimensions.demographic.device_type.values #=> Array
1587
+ # resp.segment_response.dimensions.demographic.device_type.values[0] #=> String
1588
+ # resp.segment_response.dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1589
+ # resp.segment_response.dimensions.demographic.make.values #=> Array
1590
+ # resp.segment_response.dimensions.demographic.make.values[0] #=> String
1591
+ # resp.segment_response.dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1592
+ # resp.segment_response.dimensions.demographic.model.values #=> Array
1593
+ # resp.segment_response.dimensions.demographic.model.values[0] #=> String
1594
+ # resp.segment_response.dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1595
+ # resp.segment_response.dimensions.demographic.platform.values #=> Array
1596
+ # resp.segment_response.dimensions.demographic.platform.values[0] #=> String
1597
+ # resp.segment_response.dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1598
+ # resp.segment_response.dimensions.location.country.values #=> Array
1599
+ # resp.segment_response.dimensions.location.country.values[0] #=> String
1600
+ # resp.segment_response.id #=> String
1601
+ # resp.segment_response.import_definition.external_id #=> String
1602
+ # resp.segment_response.import_definition.format #=> String, one of "CSV", "JSON"
1603
+ # resp.segment_response.import_definition.role_arn #=> String
1604
+ # resp.segment_response.import_definition.s3_url #=> String
1605
+ # resp.segment_response.import_definition.size #=> Integer
1606
+ # resp.segment_response.last_modified_date #=> String
1607
+ # resp.segment_response.name #=> String
1608
+ # resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
1609
+ # resp.segment_response.version #=> Integer
1610
+ # @overload get_segment_version(params = {})
1611
+ # @param [Hash] params ({})
1612
+ def get_segment_version(params = {}, options = {})
1613
+ req = build_request(:get_segment_version, params)
1614
+ req.send_request(options)
1615
+ end
1616
+
1617
+ # Returns information about your segment versions.
1618
+ # @option params [required, String] :application_id
1619
+ # @option params [String] :page_size
1620
+ # @option params [required, String] :segment_id
1621
+ # @option params [String] :token
1622
+ # @return [Types::GetSegmentVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1623
+ #
1624
+ # * {Types::GetSegmentVersionsResponse#segments_response #SegmentsResponse} => Types::SegmentsResponse
1625
+ #
1626
+ # @example Request syntax with placeholder values
1627
+ # resp = client.get_segment_versions({
1628
+ # application_id: "__string", # required
1629
+ # page_size: "__string",
1630
+ # segment_id: "__string", # required
1631
+ # token: "__string",
1632
+ # })
1633
+ #
1634
+ # @example Response structure
1635
+ # resp.segments_response.item #=> Array
1636
+ # resp.segments_response.item[0].application_id #=> String
1637
+ # resp.segments_response.item[0].creation_date #=> String
1638
+ # resp.segments_response.item[0].dimensions.attributes #=> Hash
1639
+ # resp.segments_response.item[0].dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1640
+ # resp.segments_response.item[0].dimensions.attributes["__string"].values #=> Array
1641
+ # resp.segments_response.item[0].dimensions.attributes["__string"].values[0] #=> String
1642
+ # resp.segments_response.item[0].dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
1643
+ # resp.segments_response.item[0].dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
1644
+ # resp.segments_response.item[0].dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1645
+ # resp.segments_response.item[0].dimensions.demographic.app_version.values #=> Array
1646
+ # resp.segments_response.item[0].dimensions.demographic.app_version.values[0] #=> String
1647
+ # resp.segments_response.item[0].dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1648
+ # resp.segments_response.item[0].dimensions.demographic.device_type.values #=> Array
1649
+ # resp.segments_response.item[0].dimensions.demographic.device_type.values[0] #=> String
1650
+ # resp.segments_response.item[0].dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1651
+ # resp.segments_response.item[0].dimensions.demographic.make.values #=> Array
1652
+ # resp.segments_response.item[0].dimensions.demographic.make.values[0] #=> String
1653
+ # resp.segments_response.item[0].dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1654
+ # resp.segments_response.item[0].dimensions.demographic.model.values #=> Array
1655
+ # resp.segments_response.item[0].dimensions.demographic.model.values[0] #=> String
1656
+ # resp.segments_response.item[0].dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1657
+ # resp.segments_response.item[0].dimensions.demographic.platform.values #=> Array
1658
+ # resp.segments_response.item[0].dimensions.demographic.platform.values[0] #=> String
1659
+ # resp.segments_response.item[0].dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1660
+ # resp.segments_response.item[0].dimensions.location.country.values #=> Array
1661
+ # resp.segments_response.item[0].dimensions.location.country.values[0] #=> String
1662
+ # resp.segments_response.item[0].id #=> String
1663
+ # resp.segments_response.item[0].import_definition.external_id #=> String
1664
+ # resp.segments_response.item[0].import_definition.format #=> String, one of "CSV", "JSON"
1665
+ # resp.segments_response.item[0].import_definition.role_arn #=> String
1666
+ # resp.segments_response.item[0].import_definition.s3_url #=> String
1667
+ # resp.segments_response.item[0].import_definition.size #=> Integer
1668
+ # resp.segments_response.item[0].last_modified_date #=> String
1669
+ # resp.segments_response.item[0].name #=> String
1670
+ # resp.segments_response.item[0].segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
1671
+ # resp.segments_response.item[0].version #=> Integer
1672
+ # resp.segments_response.next_token #=> String
1673
+ # @overload get_segment_versions(params = {})
1674
+ # @param [Hash] params ({})
1675
+ def get_segment_versions(params = {}, options = {})
1676
+ req = build_request(:get_segment_versions, params)
1677
+ req.send_request(options)
1678
+ end
1679
+
1680
+ # Used to get information about your segments.
1681
+ # @option params [required, String] :application_id
1682
+ # @option params [String] :page_size
1683
+ # @option params [String] :token
1684
+ # @return [Types::GetSegmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1685
+ #
1686
+ # * {Types::GetSegmentsResponse#segments_response #SegmentsResponse} => Types::SegmentsResponse
1687
+ #
1688
+ # @example Request syntax with placeholder values
1689
+ # resp = client.get_segments({
1690
+ # application_id: "__string", # required
1691
+ # page_size: "__string",
1692
+ # token: "__string",
1693
+ # })
1694
+ #
1695
+ # @example Response structure
1696
+ # resp.segments_response.item #=> Array
1697
+ # resp.segments_response.item[0].application_id #=> String
1698
+ # resp.segments_response.item[0].creation_date #=> String
1699
+ # resp.segments_response.item[0].dimensions.attributes #=> Hash
1700
+ # resp.segments_response.item[0].dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1701
+ # resp.segments_response.item[0].dimensions.attributes["__string"].values #=> Array
1702
+ # resp.segments_response.item[0].dimensions.attributes["__string"].values[0] #=> String
1703
+ # resp.segments_response.item[0].dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
1704
+ # resp.segments_response.item[0].dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
1705
+ # resp.segments_response.item[0].dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1706
+ # resp.segments_response.item[0].dimensions.demographic.app_version.values #=> Array
1707
+ # resp.segments_response.item[0].dimensions.demographic.app_version.values[0] #=> String
1708
+ # resp.segments_response.item[0].dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1709
+ # resp.segments_response.item[0].dimensions.demographic.device_type.values #=> Array
1710
+ # resp.segments_response.item[0].dimensions.demographic.device_type.values[0] #=> String
1711
+ # resp.segments_response.item[0].dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1712
+ # resp.segments_response.item[0].dimensions.demographic.make.values #=> Array
1713
+ # resp.segments_response.item[0].dimensions.demographic.make.values[0] #=> String
1714
+ # resp.segments_response.item[0].dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1715
+ # resp.segments_response.item[0].dimensions.demographic.model.values #=> Array
1716
+ # resp.segments_response.item[0].dimensions.demographic.model.values[0] #=> String
1717
+ # resp.segments_response.item[0].dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1718
+ # resp.segments_response.item[0].dimensions.demographic.platform.values #=> Array
1719
+ # resp.segments_response.item[0].dimensions.demographic.platform.values[0] #=> String
1720
+ # resp.segments_response.item[0].dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
1721
+ # resp.segments_response.item[0].dimensions.location.country.values #=> Array
1722
+ # resp.segments_response.item[0].dimensions.location.country.values[0] #=> String
1723
+ # resp.segments_response.item[0].id #=> String
1724
+ # resp.segments_response.item[0].import_definition.external_id #=> String
1725
+ # resp.segments_response.item[0].import_definition.format #=> String, one of "CSV", "JSON"
1726
+ # resp.segments_response.item[0].import_definition.role_arn #=> String
1727
+ # resp.segments_response.item[0].import_definition.s3_url #=> String
1728
+ # resp.segments_response.item[0].import_definition.size #=> Integer
1729
+ # resp.segments_response.item[0].last_modified_date #=> String
1730
+ # resp.segments_response.item[0].name #=> String
1731
+ # resp.segments_response.item[0].segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
1732
+ # resp.segments_response.item[0].version #=> Integer
1733
+ # resp.segments_response.next_token #=> String
1734
+ # @overload get_segments(params = {})
1735
+ # @param [Hash] params ({})
1736
+ def get_segments(params = {}, options = {})
1737
+ req = build_request(:get_segments, params)
1738
+ req.send_request(options)
1739
+ end
1740
+
1741
+ # Use to update the APNs channel for an app.
1742
+ # @option params [required, Types::APNSChannelRequest] :apns_channel_request
1743
+ # @option params [required, String] :application_id
1744
+ # @return [Types::UpdateApnsChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1745
+ #
1746
+ # * {Types::UpdateApnsChannelResponse#apns_channel_response #APNSChannelResponse} => Types::APNSChannelResponse
1747
+ #
1748
+ # @example Request syntax with placeholder values
1749
+ # resp = client.update_apns_channel({
1750
+ # apns_channel_request: { # required
1751
+ # certificate: "__string",
1752
+ # private_key: "__string",
1753
+ # },
1754
+ # application_id: "__string", # required
1755
+ # })
1756
+ #
1757
+ # @example Response structure
1758
+ # resp.apns_channel_response.application_id #=> String
1759
+ # resp.apns_channel_response.creation_date #=> String
1760
+ # resp.apns_channel_response.id #=> String
1761
+ # resp.apns_channel_response.is_archived #=> Boolean
1762
+ # resp.apns_channel_response.last_modified_by #=> String
1763
+ # resp.apns_channel_response.last_modified_date #=> String
1764
+ # resp.apns_channel_response.platform #=> String
1765
+ # resp.apns_channel_response.version #=> Integer
1766
+ # @overload update_apns_channel(params = {})
1767
+ # @param [Hash] params ({})
1768
+ def update_apns_channel(params = {}, options = {})
1769
+ req = build_request(:update_apns_channel, params)
1770
+ req.send_request(options)
1771
+ end
1772
+
1773
+ # Used to update the settings for an app.
1774
+ # @option params [required, String] :application_id
1775
+ # @option params [required, Types::WriteApplicationSettingsRequest] :write_application_settings_request
1776
+ # @return [Types::UpdateApplicationSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1777
+ #
1778
+ # * {Types::UpdateApplicationSettingsResponse#application_settings_resource #ApplicationSettingsResource} => Types::ApplicationSettingsResource
1779
+ #
1780
+ # @example Request syntax with placeholder values
1781
+ # resp = client.update_application_settings({
1782
+ # application_id: "__string", # required
1783
+ # write_application_settings_request: { # required
1784
+ # limits: {
1785
+ # daily: 1,
1786
+ # total: 1,
1787
+ # },
1788
+ # quiet_time: {
1789
+ # end: "__string",
1790
+ # start: "__string",
1791
+ # },
1792
+ # },
1793
+ # })
1794
+ #
1795
+ # @example Response structure
1796
+ # resp.application_settings_resource.application_id #=> String
1797
+ # resp.application_settings_resource.last_modified_date #=> String
1798
+ # resp.application_settings_resource.limits.daily #=> Integer
1799
+ # resp.application_settings_resource.limits.total #=> Integer
1800
+ # resp.application_settings_resource.quiet_time.end #=> String
1801
+ # resp.application_settings_resource.quiet_time.start #=> String
1802
+ # @overload update_application_settings(params = {})
1803
+ # @param [Hash] params ({})
1804
+ def update_application_settings(params = {}, options = {})
1805
+ req = build_request(:update_application_settings, params)
1806
+ req.send_request(options)
1807
+ end
1808
+
1809
+ # Use to update a campaign.
1810
+ # @option params [required, String] :application_id
1811
+ # @option params [required, String] :campaign_id
1812
+ # @option params [required, Types::WriteCampaignRequest] :write_campaign_request
1813
+ # @return [Types::UpdateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1814
+ #
1815
+ # * {Types::UpdateCampaignResponse#campaign_response #CampaignResponse} => Types::CampaignResponse
1816
+ #
1817
+ # @example Request syntax with placeholder values
1818
+ # resp = client.update_campaign({
1819
+ # application_id: "__string", # required
1820
+ # campaign_id: "__string", # required
1821
+ # write_campaign_request: { # required
1822
+ # additional_treatments: [
1823
+ # {
1824
+ # message_configuration: {
1825
+ # apns_message: {
1826
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1827
+ # body: "__string",
1828
+ # image_icon_url: "__string",
1829
+ # image_url: "__string",
1830
+ # json_body: "__string",
1831
+ # media_url: "__string",
1832
+ # silent_push: false,
1833
+ # title: "__string",
1834
+ # url: "__string",
1835
+ # },
1836
+ # default_message: {
1837
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1838
+ # body: "__string",
1839
+ # image_icon_url: "__string",
1840
+ # image_url: "__string",
1841
+ # json_body: "__string",
1842
+ # media_url: "__string",
1843
+ # silent_push: false,
1844
+ # title: "__string",
1845
+ # url: "__string",
1846
+ # },
1847
+ # gcm_message: {
1848
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1849
+ # body: "__string",
1850
+ # image_icon_url: "__string",
1851
+ # image_url: "__string",
1852
+ # json_body: "__string",
1853
+ # media_url: "__string",
1854
+ # silent_push: false,
1855
+ # title: "__string",
1856
+ # url: "__string",
1857
+ # },
1858
+ # },
1859
+ # schedule: {
1860
+ # end_time: "__string",
1861
+ # frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
1862
+ # is_local_time: false,
1863
+ # quiet_time: {
1864
+ # end: "__string",
1865
+ # start: "__string",
1866
+ # },
1867
+ # start_time: "__string",
1868
+ # timezone: "__string",
1869
+ # },
1870
+ # size_percent: 1,
1871
+ # treatment_description: "__string",
1872
+ # treatment_name: "__string",
1873
+ # },
1874
+ # ],
1875
+ # description: "__string",
1876
+ # holdout_percent: 1,
1877
+ # is_paused: false,
1878
+ # limits: {
1879
+ # daily: 1,
1880
+ # total: 1,
1881
+ # },
1882
+ # message_configuration: {
1883
+ # apns_message: {
1884
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1885
+ # body: "__string",
1886
+ # image_icon_url: "__string",
1887
+ # image_url: "__string",
1888
+ # json_body: "__string",
1889
+ # media_url: "__string",
1890
+ # silent_push: false,
1891
+ # title: "__string",
1892
+ # url: "__string",
1893
+ # },
1894
+ # default_message: {
1895
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1896
+ # body: "__string",
1897
+ # image_icon_url: "__string",
1898
+ # image_url: "__string",
1899
+ # json_body: "__string",
1900
+ # media_url: "__string",
1901
+ # silent_push: false,
1902
+ # title: "__string",
1903
+ # url: "__string",
1904
+ # },
1905
+ # gcm_message: {
1906
+ # action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
1907
+ # body: "__string",
1908
+ # image_icon_url: "__string",
1909
+ # image_url: "__string",
1910
+ # json_body: "__string",
1911
+ # media_url: "__string",
1912
+ # silent_push: false,
1913
+ # title: "__string",
1914
+ # url: "__string",
1915
+ # },
1916
+ # },
1917
+ # name: "__string",
1918
+ # schedule: {
1919
+ # end_time: "__string",
1920
+ # frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
1921
+ # is_local_time: false,
1922
+ # quiet_time: {
1923
+ # end: "__string",
1924
+ # start: "__string",
1925
+ # },
1926
+ # start_time: "__string",
1927
+ # timezone: "__string",
1928
+ # },
1929
+ # segment_id: "__string",
1930
+ # segment_version: 1,
1931
+ # treatment_description: "__string",
1932
+ # treatment_name: "__string",
1933
+ # },
1934
+ # })
1935
+ #
1936
+ # @example Response structure
1937
+ # resp.campaign_response.additional_treatments #=> Array
1938
+ # resp.campaign_response.additional_treatments[0].id #=> String
1939
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1940
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.body #=> String
1941
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_icon_url #=> String
1942
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.image_url #=> String
1943
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.json_body #=> String
1944
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.media_url #=> String
1945
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.silent_push #=> Boolean
1946
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.title #=> String
1947
+ # resp.campaign_response.additional_treatments[0].message_configuration.apns_message.url #=> String
1948
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1949
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.body #=> String
1950
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_icon_url #=> String
1951
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.image_url #=> String
1952
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.json_body #=> String
1953
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.media_url #=> String
1954
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.silent_push #=> Boolean
1955
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.title #=> String
1956
+ # resp.campaign_response.additional_treatments[0].message_configuration.default_message.url #=> String
1957
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1958
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.body #=> String
1959
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_icon_url #=> String
1960
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.image_url #=> String
1961
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.json_body #=> String
1962
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.media_url #=> String
1963
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.silent_push #=> Boolean
1964
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.title #=> String
1965
+ # resp.campaign_response.additional_treatments[0].message_configuration.gcm_message.url #=> String
1966
+ # resp.campaign_response.additional_treatments[0].schedule.end_time #=> String
1967
+ # resp.campaign_response.additional_treatments[0].schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
1968
+ # resp.campaign_response.additional_treatments[0].schedule.is_local_time #=> Boolean
1969
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.end #=> String
1970
+ # resp.campaign_response.additional_treatments[0].schedule.quiet_time.start #=> String
1971
+ # resp.campaign_response.additional_treatments[0].schedule.start_time #=> String
1972
+ # resp.campaign_response.additional_treatments[0].schedule.timezone #=> String
1973
+ # resp.campaign_response.additional_treatments[0].size_percent #=> Integer
1974
+ # resp.campaign_response.additional_treatments[0].state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1975
+ # resp.campaign_response.additional_treatments[0].treatment_description #=> String
1976
+ # resp.campaign_response.additional_treatments[0].treatment_name #=> String
1977
+ # resp.campaign_response.application_id #=> String
1978
+ # resp.campaign_response.creation_date #=> String
1979
+ # resp.campaign_response.default_state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
1980
+ # resp.campaign_response.description #=> String
1981
+ # resp.campaign_response.holdout_percent #=> Integer
1982
+ # resp.campaign_response.id #=> String
1983
+ # resp.campaign_response.is_paused #=> Boolean
1984
+ # resp.campaign_response.last_modified_date #=> String
1985
+ # resp.campaign_response.limits.daily #=> Integer
1986
+ # resp.campaign_response.limits.total #=> Integer
1987
+ # resp.campaign_response.message_configuration.apns_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1988
+ # resp.campaign_response.message_configuration.apns_message.body #=> String
1989
+ # resp.campaign_response.message_configuration.apns_message.image_icon_url #=> String
1990
+ # resp.campaign_response.message_configuration.apns_message.image_url #=> String
1991
+ # resp.campaign_response.message_configuration.apns_message.json_body #=> String
1992
+ # resp.campaign_response.message_configuration.apns_message.media_url #=> String
1993
+ # resp.campaign_response.message_configuration.apns_message.silent_push #=> Boolean
1994
+ # resp.campaign_response.message_configuration.apns_message.title #=> String
1995
+ # resp.campaign_response.message_configuration.apns_message.url #=> String
1996
+ # resp.campaign_response.message_configuration.default_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
1997
+ # resp.campaign_response.message_configuration.default_message.body #=> String
1998
+ # resp.campaign_response.message_configuration.default_message.image_icon_url #=> String
1999
+ # resp.campaign_response.message_configuration.default_message.image_url #=> String
2000
+ # resp.campaign_response.message_configuration.default_message.json_body #=> String
2001
+ # resp.campaign_response.message_configuration.default_message.media_url #=> String
2002
+ # resp.campaign_response.message_configuration.default_message.silent_push #=> Boolean
2003
+ # resp.campaign_response.message_configuration.default_message.title #=> String
2004
+ # resp.campaign_response.message_configuration.default_message.url #=> String
2005
+ # resp.campaign_response.message_configuration.gcm_message.action #=> String, one of "OPEN_APP", "DEEP_LINK", "URL"
2006
+ # resp.campaign_response.message_configuration.gcm_message.body #=> String
2007
+ # resp.campaign_response.message_configuration.gcm_message.image_icon_url #=> String
2008
+ # resp.campaign_response.message_configuration.gcm_message.image_url #=> String
2009
+ # resp.campaign_response.message_configuration.gcm_message.json_body #=> String
2010
+ # resp.campaign_response.message_configuration.gcm_message.media_url #=> String
2011
+ # resp.campaign_response.message_configuration.gcm_message.silent_push #=> Boolean
2012
+ # resp.campaign_response.message_configuration.gcm_message.title #=> String
2013
+ # resp.campaign_response.message_configuration.gcm_message.url #=> String
2014
+ # resp.campaign_response.name #=> String
2015
+ # resp.campaign_response.schedule.end_time #=> String
2016
+ # resp.campaign_response.schedule.frequency #=> String, one of "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY"
2017
+ # resp.campaign_response.schedule.is_local_time #=> Boolean
2018
+ # resp.campaign_response.schedule.quiet_time.end #=> String
2019
+ # resp.campaign_response.schedule.quiet_time.start #=> String
2020
+ # resp.campaign_response.schedule.start_time #=> String
2021
+ # resp.campaign_response.schedule.timezone #=> String
2022
+ # resp.campaign_response.segment_id #=> String
2023
+ # resp.campaign_response.segment_version #=> Integer
2024
+ # resp.campaign_response.state.campaign_status #=> String, one of "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED"
2025
+ # resp.campaign_response.treatment_description #=> String
2026
+ # resp.campaign_response.treatment_name #=> String
2027
+ # resp.campaign_response.version #=> Integer
2028
+ # @overload update_campaign(params = {})
2029
+ # @param [Hash] params ({})
2030
+ def update_campaign(params = {}, options = {})
2031
+ req = build_request(:update_campaign, params)
2032
+ req.send_request(options)
2033
+ end
2034
+
2035
+ # Use to update an endpoint.
2036
+ # @option params [required, String] :application_id
2037
+ # @option params [required, String] :endpoint_id
2038
+ # @option params [required, Types::EndpointRequest] :endpoint_request
2039
+ # @return [Types::UpdateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2040
+ #
2041
+ # * {Types::UpdateEndpointResponse#message_body #MessageBody} => Types::MessageBody
2042
+ #
2043
+ # @example Request syntax with placeholder values
2044
+ # resp = client.update_endpoint({
2045
+ # application_id: "__string", # required
2046
+ # endpoint_id: "__string", # required
2047
+ # endpoint_request: { # required
2048
+ # address: "__string",
2049
+ # attributes: {
2050
+ # "__string" => ["__string"],
2051
+ # },
2052
+ # channel_type: "APNS", # accepts APNS, GCM
2053
+ # demographic: {
2054
+ # app_version: "__string",
2055
+ # locale: "__string",
2056
+ # make: "__string",
2057
+ # model: "__string",
2058
+ # model_version: "__string",
2059
+ # platform: "__string",
2060
+ # platform_version: "__string",
2061
+ # timezone: "__string",
2062
+ # },
2063
+ # effective_date: "__string",
2064
+ # endpoint_status: "__string",
2065
+ # location: {
2066
+ # city: "__string",
2067
+ # country: "__string",
2068
+ # latitude: 1.0,
2069
+ # longitude: 1.0,
2070
+ # postal_code: "__string",
2071
+ # region: "__string",
2072
+ # },
2073
+ # metrics: {
2074
+ # "__string" => 1.0,
2075
+ # },
2076
+ # opt_out: "__string",
2077
+ # request_id: "__string",
2078
+ # user: {
2079
+ # user_attributes: {
2080
+ # "__string" => ["__string"],
2081
+ # },
2082
+ # user_id: "__string",
2083
+ # },
2084
+ # },
2085
+ # })
2086
+ #
2087
+ # @example Response structure
2088
+ # resp.message_body.message #=> String
2089
+ # resp.message_body.request_id #=> String
2090
+ # @overload update_endpoint(params = {})
2091
+ # @param [Hash] params ({})
2092
+ def update_endpoint(params = {}, options = {})
2093
+ req = build_request(:update_endpoint, params)
2094
+ req.send_request(options)
2095
+ end
2096
+
2097
+ # Use to update your endpoints.
2098
+ # @option params [required, String] :application_id
2099
+ # @option params [required, Types::EndpointBatchRequest] :endpoint_batch_request
2100
+ # @return [Types::UpdateEndpointsBatchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2101
+ #
2102
+ # * {Types::UpdateEndpointsBatchResponse#message_body #MessageBody} => Types::MessageBody
2103
+ #
2104
+ # @example Request syntax with placeholder values
2105
+ # resp = client.update_endpoints_batch({
2106
+ # application_id: "__string", # required
2107
+ # endpoint_batch_request: { # required
2108
+ # item: [
2109
+ # {
2110
+ # address: "__string",
2111
+ # attributes: {
2112
+ # "__string" => ["__string"],
2113
+ # },
2114
+ # channel_type: "APNS", # accepts APNS, GCM
2115
+ # demographic: {
2116
+ # app_version: "__string",
2117
+ # locale: "__string",
2118
+ # make: "__string",
2119
+ # model: "__string",
2120
+ # model_version: "__string",
2121
+ # platform: "__string",
2122
+ # platform_version: "__string",
2123
+ # timezone: "__string",
2124
+ # },
2125
+ # effective_date: "__string",
2126
+ # endpoint_status: "__string",
2127
+ # id: "__string",
2128
+ # location: {
2129
+ # city: "__string",
2130
+ # country: "__string",
2131
+ # latitude: 1.0,
2132
+ # longitude: 1.0,
2133
+ # postal_code: "__string",
2134
+ # region: "__string",
2135
+ # },
2136
+ # metrics: {
2137
+ # "__string" => 1.0,
2138
+ # },
2139
+ # opt_out: "__string",
2140
+ # request_id: "__string",
2141
+ # user: {
2142
+ # user_attributes: {
2143
+ # "__string" => ["__string"],
2144
+ # },
2145
+ # user_id: "__string",
2146
+ # },
2147
+ # },
2148
+ # ],
2149
+ # },
2150
+ # })
2151
+ #
2152
+ # @example Response structure
2153
+ # resp.message_body.message #=> String
2154
+ # resp.message_body.request_id #=> String
2155
+ # @overload update_endpoints_batch(params = {})
2156
+ # @param [Hash] params ({})
2157
+ def update_endpoints_batch(params = {}, options = {})
2158
+ req = build_request(:update_endpoints_batch, params)
2159
+ req.send_request(options)
2160
+ end
2161
+
2162
+ # Use to update the GCM channel for an app.
2163
+ # @option params [required, String] :application_id
2164
+ # @option params [required, Types::GCMChannelRequest] :gcm_channel_request
2165
+ # @return [Types::UpdateGcmChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2166
+ #
2167
+ # * {Types::UpdateGcmChannelResponse#gcm_channel_response #GCMChannelResponse} => Types::GCMChannelResponse
2168
+ #
2169
+ # @example Request syntax with placeholder values
2170
+ # resp = client.update_gcm_channel({
2171
+ # application_id: "__string", # required
2172
+ # gcm_channel_request: { # required
2173
+ # api_key: "__string",
2174
+ # },
2175
+ # })
2176
+ #
2177
+ # @example Response structure
2178
+ # resp.gcm_channel_response.application_id #=> String
2179
+ # resp.gcm_channel_response.creation_date #=> String
2180
+ # resp.gcm_channel_response.credential #=> String
2181
+ # resp.gcm_channel_response.id #=> String
2182
+ # resp.gcm_channel_response.is_archived #=> Boolean
2183
+ # resp.gcm_channel_response.last_modified_by #=> String
2184
+ # resp.gcm_channel_response.last_modified_date #=> String
2185
+ # resp.gcm_channel_response.platform #=> String
2186
+ # resp.gcm_channel_response.version #=> Integer
2187
+ # @overload update_gcm_channel(params = {})
2188
+ # @param [Hash] params ({})
2189
+ def update_gcm_channel(params = {}, options = {})
2190
+ req = build_request(:update_gcm_channel, params)
2191
+ req.send_request(options)
2192
+ end
2193
+
2194
+ # Use to update a segment.
2195
+ # @option params [required, String] :application_id
2196
+ # @option params [required, String] :segment_id
2197
+ # @option params [required, Types::WriteSegmentRequest] :write_segment_request
2198
+ # @return [Types::UpdateSegmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2199
+ #
2200
+ # * {Types::UpdateSegmentResponse#segment_response #SegmentResponse} => Types::SegmentResponse
2201
+ #
2202
+ # @example Request syntax with placeholder values
2203
+ # resp = client.update_segment({
2204
+ # application_id: "__string", # required
2205
+ # segment_id: "__string", # required
2206
+ # write_segment_request: { # required
2207
+ # dimensions: {
2208
+ # attributes: {
2209
+ # "__string" => {
2210
+ # attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2211
+ # values: ["__string"],
2212
+ # },
2213
+ # },
2214
+ # behavior: {
2215
+ # recency: {
2216
+ # duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
2217
+ # recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
2218
+ # },
2219
+ # },
2220
+ # demographic: {
2221
+ # app_version: {
2222
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2223
+ # values: ["__string"],
2224
+ # },
2225
+ # device_type: {
2226
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2227
+ # values: ["__string"],
2228
+ # },
2229
+ # make: {
2230
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2231
+ # values: ["__string"],
2232
+ # },
2233
+ # model: {
2234
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2235
+ # values: ["__string"],
2236
+ # },
2237
+ # platform: {
2238
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2239
+ # values: ["__string"],
2240
+ # },
2241
+ # },
2242
+ # location: {
2243
+ # country: {
2244
+ # dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
2245
+ # values: ["__string"],
2246
+ # },
2247
+ # },
2248
+ # },
2249
+ # name: "__string",
2250
+ # },
2251
+ # })
2252
+ #
2253
+ # @example Response structure
2254
+ # resp.segment_response.application_id #=> String
2255
+ # resp.segment_response.creation_date #=> String
2256
+ # resp.segment_response.dimensions.attributes #=> Hash
2257
+ # resp.segment_response.dimensions.attributes["__string"].attribute_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2258
+ # resp.segment_response.dimensions.attributes["__string"].values #=> Array
2259
+ # resp.segment_response.dimensions.attributes["__string"].values[0] #=> String
2260
+ # resp.segment_response.dimensions.behavior.recency.duration #=> String, one of "HR_24", "DAY_7", "DAY_14", "DAY_30"
2261
+ # resp.segment_response.dimensions.behavior.recency.recency_type #=> String, one of "ACTIVE", "INACTIVE"
2262
+ # resp.segment_response.dimensions.demographic.app_version.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2263
+ # resp.segment_response.dimensions.demographic.app_version.values #=> Array
2264
+ # resp.segment_response.dimensions.demographic.app_version.values[0] #=> String
2265
+ # resp.segment_response.dimensions.demographic.device_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2266
+ # resp.segment_response.dimensions.demographic.device_type.values #=> Array
2267
+ # resp.segment_response.dimensions.demographic.device_type.values[0] #=> String
2268
+ # resp.segment_response.dimensions.demographic.make.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2269
+ # resp.segment_response.dimensions.demographic.make.values #=> Array
2270
+ # resp.segment_response.dimensions.demographic.make.values[0] #=> String
2271
+ # resp.segment_response.dimensions.demographic.model.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2272
+ # resp.segment_response.dimensions.demographic.model.values #=> Array
2273
+ # resp.segment_response.dimensions.demographic.model.values[0] #=> String
2274
+ # resp.segment_response.dimensions.demographic.platform.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2275
+ # resp.segment_response.dimensions.demographic.platform.values #=> Array
2276
+ # resp.segment_response.dimensions.demographic.platform.values[0] #=> String
2277
+ # resp.segment_response.dimensions.location.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
2278
+ # resp.segment_response.dimensions.location.country.values #=> Array
2279
+ # resp.segment_response.dimensions.location.country.values[0] #=> String
2280
+ # resp.segment_response.id #=> String
2281
+ # resp.segment_response.import_definition.external_id #=> String
2282
+ # resp.segment_response.import_definition.format #=> String, one of "CSV", "JSON"
2283
+ # resp.segment_response.import_definition.role_arn #=> String
2284
+ # resp.segment_response.import_definition.s3_url #=> String
2285
+ # resp.segment_response.import_definition.size #=> Integer
2286
+ # resp.segment_response.last_modified_date #=> String
2287
+ # resp.segment_response.name #=> String
2288
+ # resp.segment_response.segment_type #=> String, one of "DIMENSIONAL", "IMPORT"
2289
+ # resp.segment_response.version #=> Integer
2290
+ # @overload update_segment(params = {})
2291
+ # @param [Hash] params ({})
2292
+ def update_segment(params = {}, options = {})
2293
+ req = build_request(:update_segment, params)
2294
+ req.send_request(options)
2295
+ end
2296
+
2297
+ # @!endgroup
2298
+
2299
+ # @param params ({})
2300
+ # @api private
2301
+ def build_request(operation_name, params = {})
2302
+ handlers = @handlers.for(operation_name)
2303
+ context = Seahorse::Client::RequestContext.new(
2304
+ operation_name: operation_name,
2305
+ operation: config.api.operation(operation_name),
2306
+ client: self,
2307
+ params: params,
2308
+ config: config)
2309
+ context[:gem_name] = 'aws-sdk-pinpoint'
2310
+ context[:gem_version] = '1.0.0.rc2'
2311
+ Seahorse::Client::Request.new(handlers, context)
2312
+ end
2313
+
2314
+ # @api private
2315
+ # @deprecated
2316
+ def waiter_names
2317
+ []
2318
+ end
2319
+
2320
+ class << self
2321
+
2322
+ # @api private
2323
+ attr_reader :identifier
2324
+
2325
+ # @api private
2326
+ def errors_module
2327
+ Errors
2328
+ end
2329
+
2330
+ end
2331
+ end
2332
+ end
2333
+ end