aws-sdk-cognitosync 1.0.0.rc1 → 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 73ae5581e7a3608f344b943cbf5138044476eff4
4
- data.tar.gz: 41f7452be7ebb6a4c5141ac413f9bfd2549eddb8
3
+ metadata.gz: 4228828341f9f5f51cb09be406a26fdc9e0e9691
4
+ data.tar.gz: e770fdf25526a7f7a6d5c4fa3fe835545824531d
5
5
  SHA512:
6
- metadata.gz: 093d1e8a4320193620abb07b5619fced9eaaac17a0916b8d758e3b77c595a7a1bc0bdf8296a591a30fcf600714640b10dbad4305a95f3079846e7fc29386e66b
7
- data.tar.gz: 4a33bb09d5b0b3617ff651d4f752f110074c6ece0a53f183a1e36936b2b4250460bcbdeaedc2ae64f3277ff919706c236fdd15f9f8a3d82554e80d03d9d93f95
6
+ metadata.gz: 1e6064c939ad061991da333200c8a738439173e011d5c3d2f58a3046908c39781493c30409f6a680efb9d671f62e5c1c4ca6a94a7133c2424e5d1d6158449b2b
7
+ data.tar.gz: f47b277fe4f3d5cecd7b824bf2b3394457623eee82b4a6730e6ebec67475550b40ba9b756231e8c87f7ca770aed2c9c88744cebe59fd8c264f17d440c53034d7
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cognitosync/customizations'
42
42
  # @service
43
43
  module Aws::CognitoSync
44
44
 
45
- GEM_VERSION = '1.0.0.rc1'
45
+ GEM_VERSION = '1.0.0.rc2'
46
46
 
47
47
  end
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -18,851 +18,1014 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
18
  require 'aws-sdk-core/plugins/response_paging.rb'
19
19
  require 'aws-sdk-core/plugins/stub_responses.rb'
20
20
  require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
21
22
  require 'aws-sdk-core/plugins/signature_v4.rb'
22
23
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
23
24
 
24
25
  Aws::Plugins::GlobalConfiguration.add_identifier(:cognitosync)
25
26
 
26
- module Aws
27
- module CognitoSync
28
- class Client < Seahorse::Client::Base
29
-
30
- include Aws::ClientStubs
31
-
32
- @identifier = :cognitosync
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
27
+ module Aws::CognitoSync
28
+ class Client < Seahorse::Client::Base
130
29
 
131
- # @!group API Operations
132
-
133
- # Initiates a bulk publish of all existing datasets for an Identity Pool
134
- # to the configured stream. Customers are limited to one successful bulk
135
- # publish per 24 hours. Bulk publish is an asynchronous request,
136
- # customers can see the status of the request via the
137
- # GetBulkPublishDetails operation.
138
- #
139
- # This API can only be called with developer credentials. You cannot
140
- # call this API with the temporary user credentials provided by Cognito
141
- # Identity.
142
- # @option params [required, String] :identity_pool_id
143
- # A name-spaced GUID (for example,
144
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
145
- # Cognito. GUID generation is unique within a region.
146
- # @return [Types::BulkPublishResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
147
- #
148
- # * {Types::BulkPublishResponse#identity_pool_id #IdentityPoolId} => String
149
- #
150
- # @example Request syntax with placeholder values
151
- # resp = client.bulk_publish({
152
- # identity_pool_id: "IdentityPoolId", # required
153
- # })
154
- #
155
- # @example Response structure
156
- # resp.identity_pool_id #=> String
157
- # @overload bulk_publish(params = {})
158
- # @param [Hash] params ({})
159
- def bulk_publish(params = {}, options = {})
160
- req = build_request(:bulk_publish, params)
161
- req.send_request(options)
162
- end
30
+ include Aws::ClientStubs
163
31
 
164
- # Deletes the specific dataset. The dataset will be deleted permanently,
165
- # and the action can't be undone. Datasets that this dataset was merged
166
- # with will no longer report the merge. Any subsequent operation on this
167
- # dataset will result in a ResourceNotFoundException.
168
- #
169
- # This API can be called with temporary user credentials provided by
170
- # Cognito Identity or with developer credentials.
171
- # @option params [required, String] :identity_pool_id
172
- # A name-spaced GUID (for example,
173
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
174
- # Cognito. GUID generation is unique within a region.
175
- # @option params [required, String] :identity_id
176
- # A name-spaced GUID (for example,
177
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
178
- # Cognito. GUID generation is unique within a region.
179
- # @option params [required, String] :dataset_name
180
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
181
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
182
- # @return [Types::DeleteDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
183
- #
184
- # * {Types::DeleteDatasetResponse#dataset #Dataset} => Types::Dataset
185
- #
186
- # @example Request syntax with placeholder values
187
- # resp = client.delete_dataset({
188
- # identity_pool_id: "IdentityPoolId", # required
189
- # identity_id: "IdentityId", # required
190
- # dataset_name: "DatasetName", # required
191
- # })
192
- #
193
- # @example Response structure
194
- # resp.dataset.identity_id #=> String
195
- # resp.dataset.dataset_name #=> String
196
- # resp.dataset.creation_date #=> Time
197
- # resp.dataset.last_modified_date #=> Time
198
- # resp.dataset.last_modified_by #=> String
199
- # resp.dataset.data_storage #=> Integer
200
- # resp.dataset.num_records #=> Integer
201
- # @overload delete_dataset(params = {})
202
- # @param [Hash] params ({})
203
- def delete_dataset(params = {}, options = {})
204
- req = build_request(:delete_dataset, params)
205
- req.send_request(options)
206
- end
32
+ @identifier = :cognitosync
207
33
 
208
- # Gets meta data about a dataset by identity and dataset name. With
209
- # Amazon Cognito Sync, each identity has access only to its own data.
210
- # Thus, the credentials used to make this API call need to have access
211
- # to the identity data.
212
- #
213
- # This API can be called with temporary user credentials provided by
214
- # Cognito Identity or with developer credentials. You should use Cognito
215
- # Identity credentials to make this API call.
216
- # @option params [required, String] :identity_pool_id
217
- # A name-spaced GUID (for example,
218
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
219
- # Cognito. GUID generation is unique within a region.
220
- # @option params [required, String] :identity_id
221
- # A name-spaced GUID (for example,
222
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
223
- # Cognito. GUID generation is unique within a region.
224
- # @option params [required, String] :dataset_name
225
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
226
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
227
- # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
228
- #
229
- # * {Types::DescribeDatasetResponse#dataset #Dataset} => Types::Dataset
230
- #
231
- # @example Request syntax with placeholder values
232
- # resp = client.describe_dataset({
233
- # identity_pool_id: "IdentityPoolId", # required
234
- # identity_id: "IdentityId", # required
235
- # dataset_name: "DatasetName", # required
236
- # })
237
- #
238
- # @example Response structure
239
- # resp.dataset.identity_id #=> String
240
- # resp.dataset.dataset_name #=> String
241
- # resp.dataset.creation_date #=> Time
242
- # resp.dataset.last_modified_date #=> Time
243
- # resp.dataset.last_modified_by #=> String
244
- # resp.dataset.data_storage #=> Integer
245
- # resp.dataset.num_records #=> Integer
246
- # @overload describe_dataset(params = {})
247
- # @param [Hash] params ({})
248
- def describe_dataset(params = {}, options = {})
249
- req = build_request(:describe_dataset, params)
250
- req.send_request(options)
251
- end
34
+ set_api(ClientApi::API)
252
35
 
253
- # Gets usage details (for example, data storage) about a particular
254
- # identity pool.
255
- #
256
- # This API can only be called with developer credentials. You cannot
257
- # call this API with the temporary user credentials provided by Cognito
258
- # Identity.
259
- # @option params [required, String] :identity_pool_id
260
- # A name-spaced GUID (for example,
261
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
262
- # Cognito. GUID generation is unique within a region.
263
- # @return [Types::DescribeIdentityPoolUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
264
- #
265
- # * {Types::DescribeIdentityPoolUsageResponse#identity_pool_usage #IdentityPoolUsage} => Types::IdentityPoolUsage
266
- #
267
- # @example Request syntax with placeholder values
268
- # resp = client.describe_identity_pool_usage({
269
- # identity_pool_id: "IdentityPoolId", # required
270
- # })
271
- #
272
- # @example Response structure
273
- # resp.identity_pool_usage.identity_pool_id #=> String
274
- # resp.identity_pool_usage.sync_sessions_count #=> Integer
275
- # resp.identity_pool_usage.data_storage #=> Integer
276
- # resp.identity_pool_usage.last_modified_date #=> Time
277
- # @overload describe_identity_pool_usage(params = {})
278
- # @param [Hash] params ({})
279
- def describe_identity_pool_usage(params = {}, options = {})
280
- req = build_request(:describe_identity_pool_usage, params)
281
- req.send_request(options)
282
- end
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::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::RestJson)
283
52
 
284
- # Gets usage information for an identity, including number of datasets
285
- # and data usage.
286
- #
287
- # This API can be called with temporary user credentials provided by
288
- # Cognito Identity or with developer credentials.
289
- # @option params [required, String] :identity_pool_id
290
- # A name-spaced GUID (for example,
291
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
292
- # Cognito. GUID generation is unique within a region.
293
- # @option params [required, String] :identity_id
294
- # A name-spaced GUID (for example,
295
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
296
- # Cognito. GUID generation is unique within a region.
297
- # @return [Types::DescribeIdentityUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
298
- #
299
- # * {Types::DescribeIdentityUsageResponse#identity_usage #IdentityUsage} => Types::IdentityUsage
300
- #
301
- # @example Request syntax with placeholder values
302
- # resp = client.describe_identity_usage({
303
- # identity_pool_id: "IdentityPoolId", # required
304
- # identity_id: "IdentityId", # required
305
- # })
306
- #
307
- # @example Response structure
308
- # resp.identity_usage.identity_id #=> String
309
- # resp.identity_usage.identity_pool_id #=> String
310
- # resp.identity_usage.last_modified_date #=> Time
311
- # resp.identity_usage.dataset_count #=> Integer
312
- # resp.identity_usage.data_storage #=> Integer
313
- # @overload describe_identity_usage(params = {})
314
- # @param [Hash] params ({})
315
- def describe_identity_usage(params = {}, options = {})
316
- req = build_request(:describe_identity_usage, params)
317
- req.send_request(options)
318
- end
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
319
145
 
320
- # Get the status of the last BulkPublish operation for an identity pool.
321
- #
322
- # This API can only be called with developer credentials. You cannot
323
- # call this API with the temporary user credentials provided by Cognito
324
- # Identity.
325
- # @option params [required, String] :identity_pool_id
326
- # A name-spaced GUID (for example,
327
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
328
- # Cognito. GUID generation is unique within a region.
329
- # @return [Types::GetBulkPublishDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
330
- #
331
- # * {Types::GetBulkPublishDetailsResponse#identity_pool_id #IdentityPoolId} => String
332
- # * {Types::GetBulkPublishDetailsResponse#bulk_publish_start_time #BulkPublishStartTime} => Time
333
- # * {Types::GetBulkPublishDetailsResponse#bulk_publish_complete_time #BulkPublishCompleteTime} => Time
334
- # * {Types::GetBulkPublishDetailsResponse#bulk_publish_status #BulkPublishStatus} => String
335
- # * {Types::GetBulkPublishDetailsResponse#failure_message #FailureMessage} => String
336
- #
337
- # @example Request syntax with placeholder values
338
- # resp = client.get_bulk_publish_details({
339
- # identity_pool_id: "IdentityPoolId", # required
340
- # })
341
- #
342
- # @example Response structure
343
- # resp.identity_pool_id #=> String
344
- # resp.bulk_publish_start_time #=> Time
345
- # resp.bulk_publish_complete_time #=> Time
346
- # resp.bulk_publish_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "SUCCEEDED"
347
- # resp.failure_message #=> String
348
- # @overload get_bulk_publish_details(params = {})
349
- # @param [Hash] params ({})
350
- def get_bulk_publish_details(params = {}, options = {})
351
- req = build_request(:get_bulk_publish_details, params)
352
- req.send_request(options)
353
- end
146
+ # @!group API Operations
354
147
 
355
- # Gets the events and the corresponding Lambda functions associated with
356
- # an identity pool.
357
- #
358
- # This API can only be called with developer credentials. You cannot
359
- # call this API with the temporary user credentials provided by Cognito
360
- # Identity.
361
- # @option params [required, String] :identity_pool_id
362
- # The Cognito Identity Pool ID for the request
363
- # @return [Types::GetCognitoEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
364
- #
365
- # * {Types::GetCognitoEventsResponse#events #Events} => Hash&lt;String,String&gt;
366
- #
367
- # @example Request syntax with placeholder values
368
- # resp = client.get_cognito_events({
369
- # identity_pool_id: "IdentityPoolId", # required
370
- # })
371
- #
372
- # @example Response structure
373
- # resp.events #=> Hash
374
- # resp.events["CognitoEventType"] #=> String
375
- # @overload get_cognito_events(params = {})
376
- # @param [Hash] params ({})
377
- def get_cognito_events(params = {}, options = {})
378
- req = build_request(:get_cognito_events, params)
379
- req.send_request(options)
380
- end
148
+ # Initiates a bulk publish of all existing datasets for an Identity Pool
149
+ # to the configured stream. Customers are limited to one successful bulk
150
+ # publish per 24 hours. Bulk publish is an asynchronous request,
151
+ # customers can see the status of the request via the
152
+ # GetBulkPublishDetails operation.
153
+ #
154
+ # This API can only be called with developer credentials. You cannot
155
+ # call this API with the temporary user credentials provided by Cognito
156
+ # Identity.
157
+ #
158
+ # @option params [required, String] :identity_pool_id
159
+ # A name-spaced GUID (for example,
160
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
161
+ # Cognito. GUID generation is unique within a region.
162
+ #
163
+ # @return [Types::BulkPublishResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
164
+ #
165
+ # * {Types::BulkPublishResponse#identity_pool_id #identity_pool_id} => String
166
+ #
167
+ # @example Request syntax with placeholder values
168
+ #
169
+ # resp = client.bulk_publish({
170
+ # identity_pool_id: "IdentityPoolId", # required
171
+ # })
172
+ #
173
+ # @example Response structure
174
+ #
175
+ # resp.identity_pool_id #=> String
176
+ #
177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/BulkPublish AWS API Documentation
178
+ #
179
+ # @overload bulk_publish(params = {})
180
+ # @param [Hash] params ({})
181
+ def bulk_publish(params = {}, options = {})
182
+ req = build_request(:bulk_publish, params)
183
+ req.send_request(options)
184
+ end
381
185
 
382
- # Gets the configuration settings of an identity pool.
383
- #
384
- # This API can only be called with developer credentials. You cannot
385
- # call this API with the temporary user credentials provided by Cognito
386
- # Identity.
387
- # @option params [required, String] :identity_pool_id
388
- # A name-spaced GUID (for example,
389
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
390
- # Cognito. This is the ID of the pool for which to return a
391
- # configuration.
392
- # @return [Types::GetIdentityPoolConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
393
- #
394
- # * {Types::GetIdentityPoolConfigurationResponse#identity_pool_id #IdentityPoolId} => String
395
- # * {Types::GetIdentityPoolConfigurationResponse#push_sync #PushSync} => Types::PushSync
396
- # * {Types::GetIdentityPoolConfigurationResponse#cognito_streams #CognitoStreams} => Types::CognitoStreams
397
- #
398
- # @example Request syntax with placeholder values
399
- # resp = client.get_identity_pool_configuration({
400
- # identity_pool_id: "IdentityPoolId", # required
401
- # })
402
- #
403
- # @example Response structure
404
- # resp.identity_pool_id #=> String
405
- # resp.push_sync.application_arns #=> Array
406
- # resp.push_sync.application_arns[0] #=> String
407
- # resp.push_sync.role_arn #=> String
408
- # resp.cognito_streams.stream_name #=> String
409
- # resp.cognito_streams.role_arn #=> String
410
- # resp.cognito_streams.streaming_status #=> String, one of "ENABLED", "DISABLED"
411
- # @overload get_identity_pool_configuration(params = {})
412
- # @param [Hash] params ({})
413
- def get_identity_pool_configuration(params = {}, options = {})
414
- req = build_request(:get_identity_pool_configuration, params)
415
- req.send_request(options)
416
- end
186
+ # Deletes the specific dataset. The dataset will be deleted permanently,
187
+ # and the action can't be undone. Datasets that this dataset was merged
188
+ # with will no longer report the merge. Any subsequent operation on this
189
+ # dataset will result in a ResourceNotFoundException.
190
+ #
191
+ # This API can be called with temporary user credentials provided by
192
+ # Cognito Identity or with developer credentials.
193
+ #
194
+ # @option params [required, String] :identity_pool_id
195
+ # A name-spaced GUID (for example,
196
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
197
+ # Cognito. GUID generation is unique within a region.
198
+ #
199
+ # @option params [required, String] :identity_id
200
+ # A name-spaced GUID (for example,
201
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
202
+ # Cognito. GUID generation is unique within a region.
203
+ #
204
+ # @option params [required, String] :dataset_name
205
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
206
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
207
+ #
208
+ # @return [Types::DeleteDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
209
+ #
210
+ # * {Types::DeleteDatasetResponse#dataset #dataset} => Types::Dataset
211
+ #
212
+ # @example Request syntax with placeholder values
213
+ #
214
+ # resp = client.delete_dataset({
215
+ # identity_pool_id: "IdentityPoolId", # required
216
+ # identity_id: "IdentityId", # required
217
+ # dataset_name: "DatasetName", # required
218
+ # })
219
+ #
220
+ # @example Response structure
221
+ #
222
+ # resp.dataset.identity_id #=> String
223
+ # resp.dataset.dataset_name #=> String
224
+ # resp.dataset.creation_date #=> Time
225
+ # resp.dataset.last_modified_date #=> Time
226
+ # resp.dataset.last_modified_by #=> String
227
+ # resp.dataset.data_storage #=> Integer
228
+ # resp.dataset.num_records #=> Integer
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DeleteDataset AWS API Documentation
231
+ #
232
+ # @overload delete_dataset(params = {})
233
+ # @param [Hash] params ({})
234
+ def delete_dataset(params = {}, options = {})
235
+ req = build_request(:delete_dataset, params)
236
+ req.send_request(options)
237
+ end
417
238
 
418
- # Lists datasets for an identity. With Amazon Cognito Sync, each
419
- # identity has access only to its own data. Thus, the credentials used
420
- # to make this API call need to have access to the identity data.
421
- #
422
- # ListDatasets can be called with temporary user credentials provided by
423
- # Cognito Identity or with developer credentials. You should use the
424
- # Cognito Identity credentials to make this API call.
425
- # @option params [required, String] :identity_pool_id
426
- # A name-spaced GUID (for example,
427
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
428
- # Cognito. GUID generation is unique within a region.
429
- # @option params [required, String] :identity_id
430
- # A name-spaced GUID (for example,
431
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
432
- # Cognito. GUID generation is unique within a region.
433
- # @option params [String] :next_token
434
- # A pagination token for obtaining the next page of results.
435
- # @option params [Integer] :max_results
436
- # The maximum number of results to be returned.
437
- # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
438
- #
439
- # * {Types::ListDatasetsResponse#datasets #Datasets} => Array&lt;Types::Dataset&gt;
440
- # * {Types::ListDatasetsResponse#count #Count} => Integer
441
- # * {Types::ListDatasetsResponse#next_token #NextToken} => String
442
- #
443
- # @example Request syntax with placeholder values
444
- # resp = client.list_datasets({
445
- # identity_pool_id: "IdentityPoolId", # required
446
- # identity_id: "IdentityId", # required
447
- # next_token: "String",
448
- # max_results: 1,
449
- # })
450
- #
451
- # @example Response structure
452
- # resp.datasets #=> Array
453
- # resp.datasets[0].identity_id #=> String
454
- # resp.datasets[0].dataset_name #=> String
455
- # resp.datasets[0].creation_date #=> Time
456
- # resp.datasets[0].last_modified_date #=> Time
457
- # resp.datasets[0].last_modified_by #=> String
458
- # resp.datasets[0].data_storage #=> Integer
459
- # resp.datasets[0].num_records #=> Integer
460
- # resp.count #=> Integer
461
- # resp.next_token #=> String
462
- # @overload list_datasets(params = {})
463
- # @param [Hash] params ({})
464
- def list_datasets(params = {}, options = {})
465
- req = build_request(:list_datasets, params)
466
- req.send_request(options)
467
- end
239
+ # Gets meta data about a dataset by identity and dataset name. With
240
+ # Amazon Cognito Sync, each identity has access only to its own data.
241
+ # Thus, the credentials used to make this API call need to have access
242
+ # to the identity data.
243
+ #
244
+ # This API can be called with temporary user credentials provided by
245
+ # Cognito Identity or with developer credentials. You should use Cognito
246
+ # Identity credentials to make this API call.
247
+ #
248
+ # @option params [required, String] :identity_pool_id
249
+ # A name-spaced GUID (for example,
250
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
251
+ # Cognito. GUID generation is unique within a region.
252
+ #
253
+ # @option params [required, String] :identity_id
254
+ # A name-spaced GUID (for example,
255
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
256
+ # Cognito. GUID generation is unique within a region.
257
+ #
258
+ # @option params [required, String] :dataset_name
259
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
260
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
261
+ #
262
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
263
+ #
264
+ # * {Types::DescribeDatasetResponse#dataset #dataset} => Types::Dataset
265
+ #
266
+ # @example Request syntax with placeholder values
267
+ #
268
+ # resp = client.describe_dataset({
269
+ # identity_pool_id: "IdentityPoolId", # required
270
+ # identity_id: "IdentityId", # required
271
+ # dataset_name: "DatasetName", # required
272
+ # })
273
+ #
274
+ # @example Response structure
275
+ #
276
+ # resp.dataset.identity_id #=> String
277
+ # resp.dataset.dataset_name #=> String
278
+ # resp.dataset.creation_date #=> Time
279
+ # resp.dataset.last_modified_date #=> Time
280
+ # resp.dataset.last_modified_by #=> String
281
+ # resp.dataset.data_storage #=> Integer
282
+ # resp.dataset.num_records #=> Integer
283
+ #
284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeDataset AWS API Documentation
285
+ #
286
+ # @overload describe_dataset(params = {})
287
+ # @param [Hash] params ({})
288
+ def describe_dataset(params = {}, options = {})
289
+ req = build_request(:describe_dataset, params)
290
+ req.send_request(options)
291
+ end
468
292
 
469
- # Gets a list of identity pools registered with Cognito.
470
- #
471
- # ListIdentityPoolUsage can only be called with developer credentials.
472
- # You cannot make this API call with the temporary user credentials
473
- # provided by Cognito Identity.
474
- # @option params [String] :next_token
475
- # A pagination token for obtaining the next page of results.
476
- # @option params [Integer] :max_results
477
- # The maximum number of results to be returned.
478
- # @return [Types::ListIdentityPoolUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
479
- #
480
- # * {Types::ListIdentityPoolUsageResponse#identity_pool_usages #IdentityPoolUsages} => Array&lt;Types::IdentityPoolUsage&gt;
481
- # * {Types::ListIdentityPoolUsageResponse#max_results #MaxResults} => Integer
482
- # * {Types::ListIdentityPoolUsageResponse#count #Count} => Integer
483
- # * {Types::ListIdentityPoolUsageResponse#next_token #NextToken} => String
484
- #
485
- # @example Request syntax with placeholder values
486
- # resp = client.list_identity_pool_usage({
487
- # next_token: "String",
488
- # max_results: 1,
489
- # })
490
- #
491
- # @example Response structure
492
- # resp.identity_pool_usages #=> Array
493
- # resp.identity_pool_usages[0].identity_pool_id #=> String
494
- # resp.identity_pool_usages[0].sync_sessions_count #=> Integer
495
- # resp.identity_pool_usages[0].data_storage #=> Integer
496
- # resp.identity_pool_usages[0].last_modified_date #=> Time
497
- # resp.max_results #=> Integer
498
- # resp.count #=> Integer
499
- # resp.next_token #=> String
500
- # @overload list_identity_pool_usage(params = {})
501
- # @param [Hash] params ({})
502
- def list_identity_pool_usage(params = {}, options = {})
503
- req = build_request(:list_identity_pool_usage, params)
504
- req.send_request(options)
505
- end
293
+ # Gets usage details (for example, data storage) about a particular
294
+ # identity pool.
295
+ #
296
+ # This API can only be called with developer credentials. You cannot
297
+ # call this API with the temporary user credentials provided by Cognito
298
+ # Identity.
299
+ #
300
+ # @option params [required, String] :identity_pool_id
301
+ # A name-spaced GUID (for example,
302
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
303
+ # Cognito. GUID generation is unique within a region.
304
+ #
305
+ # @return [Types::DescribeIdentityPoolUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
306
+ #
307
+ # * {Types::DescribeIdentityPoolUsageResponse#identity_pool_usage #identity_pool_usage} => Types::IdentityPoolUsage
308
+ #
309
+ # @example Request syntax with placeholder values
310
+ #
311
+ # resp = client.describe_identity_pool_usage({
312
+ # identity_pool_id: "IdentityPoolId", # required
313
+ # })
314
+ #
315
+ # @example Response structure
316
+ #
317
+ # resp.identity_pool_usage.identity_pool_id #=> String
318
+ # resp.identity_pool_usage.sync_sessions_count #=> Integer
319
+ # resp.identity_pool_usage.data_storage #=> Integer
320
+ # resp.identity_pool_usage.last_modified_date #=> Time
321
+ #
322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityPoolUsage AWS API Documentation
323
+ #
324
+ # @overload describe_identity_pool_usage(params = {})
325
+ # @param [Hash] params ({})
326
+ def describe_identity_pool_usage(params = {}, options = {})
327
+ req = build_request(:describe_identity_pool_usage, params)
328
+ req.send_request(options)
329
+ end
506
330
 
507
- # Gets paginated records, optionally changed after a particular sync
508
- # count for a dataset and identity. With Amazon Cognito Sync, each
509
- # identity has access only to its own data. Thus, the credentials used
510
- # to make this API call need to have access to the identity data.
511
- #
512
- # ListRecords can be called with temporary user credentials provided by
513
- # Cognito Identity or with developer credentials. You should use Cognito
514
- # Identity credentials to make this API call.
515
- # @option params [required, String] :identity_pool_id
516
- # A name-spaced GUID (for example,
517
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
518
- # Cognito. GUID generation is unique within a region.
519
- # @option params [required, String] :identity_id
520
- # A name-spaced GUID (for example,
521
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
522
- # Cognito. GUID generation is unique within a region.
523
- # @option params [required, String] :dataset_name
524
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
525
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
526
- # @option params [Integer] :last_sync_count
527
- # The last server sync count for this record.
528
- # @option params [String] :next_token
529
- # A pagination token for obtaining the next page of results.
530
- # @option params [Integer] :max_results
531
- # The maximum number of results to be returned.
532
- # @option params [String] :sync_session_token
533
- # A token containing a session ID, identity ID, and expiration.
534
- # @return [Types::ListRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
535
- #
536
- # * {Types::ListRecordsResponse#records #Records} => Array&lt;Types::Record&gt;
537
- # * {Types::ListRecordsResponse#next_token #NextToken} => String
538
- # * {Types::ListRecordsResponse#count #Count} => Integer
539
- # * {Types::ListRecordsResponse#dataset_sync_count #DatasetSyncCount} => Integer
540
- # * {Types::ListRecordsResponse#last_modified_by #LastModifiedBy} => String
541
- # * {Types::ListRecordsResponse#merged_dataset_names #MergedDatasetNames} => Array&lt;String&gt;
542
- # * {Types::ListRecordsResponse#dataset_exists #DatasetExists} => Boolean
543
- # * {Types::ListRecordsResponse#dataset_deleted_after_requested_sync_count #DatasetDeletedAfterRequestedSyncCount} => Boolean
544
- # * {Types::ListRecordsResponse#sync_session_token #SyncSessionToken} => String
545
- #
546
- # @example Request syntax with placeholder values
547
- # resp = client.list_records({
548
- # identity_pool_id: "IdentityPoolId", # required
549
- # identity_id: "IdentityId", # required
550
- # dataset_name: "DatasetName", # required
551
- # last_sync_count: 1,
552
- # next_token: "String",
553
- # max_results: 1,
554
- # sync_session_token: "SyncSessionToken",
555
- # })
556
- #
557
- # @example Response structure
558
- # resp.records #=> Array
559
- # resp.records[0].key #=> String
560
- # resp.records[0].value #=> String
561
- # resp.records[0].sync_count #=> Integer
562
- # resp.records[0].last_modified_date #=> Time
563
- # resp.records[0].last_modified_by #=> String
564
- # resp.records[0].device_last_modified_date #=> Time
565
- # resp.next_token #=> String
566
- # resp.count #=> Integer
567
- # resp.dataset_sync_count #=> Integer
568
- # resp.last_modified_by #=> String
569
- # resp.merged_dataset_names #=> Array
570
- # resp.merged_dataset_names[0] #=> String
571
- # resp.dataset_exists #=> Boolean
572
- # resp.dataset_deleted_after_requested_sync_count #=> Boolean
573
- # resp.sync_session_token #=> String
574
- # @overload list_records(params = {})
575
- # @param [Hash] params ({})
576
- def list_records(params = {}, options = {})
577
- req = build_request(:list_records, params)
578
- req.send_request(options)
579
- end
331
+ # Gets usage information for an identity, including number of datasets
332
+ # and data usage.
333
+ #
334
+ # This API can be called with temporary user credentials provided by
335
+ # Cognito Identity or with developer credentials.
336
+ #
337
+ # @option params [required, String] :identity_pool_id
338
+ # A name-spaced GUID (for example,
339
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
340
+ # Cognito. GUID generation is unique within a region.
341
+ #
342
+ # @option params [required, String] :identity_id
343
+ # A name-spaced GUID (for example,
344
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
345
+ # Cognito. GUID generation is unique within a region.
346
+ #
347
+ # @return [Types::DescribeIdentityUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
348
+ #
349
+ # * {Types::DescribeIdentityUsageResponse#identity_usage #identity_usage} => Types::IdentityUsage
350
+ #
351
+ # @example Request syntax with placeholder values
352
+ #
353
+ # resp = client.describe_identity_usage({
354
+ # identity_pool_id: "IdentityPoolId", # required
355
+ # identity_id: "IdentityId", # required
356
+ # })
357
+ #
358
+ # @example Response structure
359
+ #
360
+ # resp.identity_usage.identity_id #=> String
361
+ # resp.identity_usage.identity_pool_id #=> String
362
+ # resp.identity_usage.last_modified_date #=> Time
363
+ # resp.identity_usage.dataset_count #=> Integer
364
+ # resp.identity_usage.data_storage #=> Integer
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityUsage AWS API Documentation
367
+ #
368
+ # @overload describe_identity_usage(params = {})
369
+ # @param [Hash] params ({})
370
+ def describe_identity_usage(params = {}, options = {})
371
+ req = build_request(:describe_identity_usage, params)
372
+ req.send_request(options)
373
+ end
580
374
 
581
- # Registers a device to receive push sync notifications.
582
- #
583
- # This API can only be called with temporary credentials provided by
584
- # Cognito Identity. You cannot call this API with developer credentials.
585
- # @option params [required, String] :identity_pool_id
586
- # A name-spaced GUID (for example,
587
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
588
- # Cognito. Here, the ID of the pool that the identity belongs to.
589
- # @option params [required, String] :identity_id
590
- # The unique ID for this identity.
591
- # @option params [required, String] :platform
592
- # The SNS platform type (e.g. GCM, SDM, APNS, APNS\_SANDBOX).
593
- # @option params [required, String] :token
594
- # The push token.
595
- # @return [Types::RegisterDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
596
- #
597
- # * {Types::RegisterDeviceResponse#device_id #DeviceId} => String
598
- #
599
- # @example Request syntax with placeholder values
600
- # resp = client.register_device({
601
- # identity_pool_id: "IdentityPoolId", # required
602
- # identity_id: "IdentityId", # required
603
- # platform: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM, ADM
604
- # token: "PushToken", # required
605
- # })
606
- #
607
- # @example Response structure
608
- # resp.device_id #=> String
609
- # @overload register_device(params = {})
610
- # @param [Hash] params ({})
611
- def register_device(params = {}, options = {})
612
- req = build_request(:register_device, params)
613
- req.send_request(options)
614
- end
375
+ # Get the status of the last BulkPublish operation for an identity pool.
376
+ #
377
+ # This API can only be called with developer credentials. You cannot
378
+ # call this API with the temporary user credentials provided by Cognito
379
+ # Identity.
380
+ #
381
+ # @option params [required, String] :identity_pool_id
382
+ # A name-spaced GUID (for example,
383
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
384
+ # Cognito. GUID generation is unique within a region.
385
+ #
386
+ # @return [Types::GetBulkPublishDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
387
+ #
388
+ # * {Types::GetBulkPublishDetailsResponse#identity_pool_id #identity_pool_id} => String
389
+ # * {Types::GetBulkPublishDetailsResponse#bulk_publish_start_time #bulk_publish_start_time} => Time
390
+ # * {Types::GetBulkPublishDetailsResponse#bulk_publish_complete_time #bulk_publish_complete_time} => Time
391
+ # * {Types::GetBulkPublishDetailsResponse#bulk_publish_status #bulk_publish_status} => String
392
+ # * {Types::GetBulkPublishDetailsResponse#failure_message #failure_message} => String
393
+ #
394
+ # @example Request syntax with placeholder values
395
+ #
396
+ # resp = client.get_bulk_publish_details({
397
+ # identity_pool_id: "IdentityPoolId", # required
398
+ # })
399
+ #
400
+ # @example Response structure
401
+ #
402
+ # resp.identity_pool_id #=> String
403
+ # resp.bulk_publish_start_time #=> Time
404
+ # resp.bulk_publish_complete_time #=> Time
405
+ # resp.bulk_publish_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "SUCCEEDED"
406
+ # resp.failure_message #=> String
407
+ #
408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetBulkPublishDetails AWS API Documentation
409
+ #
410
+ # @overload get_bulk_publish_details(params = {})
411
+ # @param [Hash] params ({})
412
+ def get_bulk_publish_details(params = {}, options = {})
413
+ req = build_request(:get_bulk_publish_details, params)
414
+ req.send_request(options)
415
+ end
615
416
 
616
- # Sets the AWS Lambda function for a given event type for an identity
617
- # pool. This request only updates the key/value pair specified. Other
618
- # key/values pairs are not updated. To remove a key value pair, pass a
619
- # empty value for the particular key.
620
- #
621
- # This API can only be called with developer credentials. You cannot
622
- # call this API with the temporary user credentials provided by Cognito
623
- # Identity.
624
- # @option params [required, String] :identity_pool_id
625
- # The Cognito Identity Pool to use when configuring Cognito Events
626
- # @option params [required, Hash<String,String>] :events
627
- # The events to configure
628
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
629
- #
630
- # @example Request syntax with placeholder values
631
- # resp = client.set_cognito_events({
632
- # identity_pool_id: "IdentityPoolId", # required
633
- # events: { # required
634
- # "CognitoEventType" => "LambdaFunctionArn",
635
- # },
636
- # })
637
- # @overload set_cognito_events(params = {})
638
- # @param [Hash] params ({})
639
- def set_cognito_events(params = {}, options = {})
640
- req = build_request(:set_cognito_events, params)
641
- req.send_request(options)
642
- end
417
+ # Gets the events and the corresponding Lambda functions associated with
418
+ # an identity pool.
419
+ #
420
+ # This API can only be called with developer credentials. You cannot
421
+ # call this API with the temporary user credentials provided by Cognito
422
+ # Identity.
423
+ #
424
+ # @option params [required, String] :identity_pool_id
425
+ # The Cognito Identity Pool ID for the request
426
+ #
427
+ # @return [Types::GetCognitoEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
428
+ #
429
+ # * {Types::GetCognitoEventsResponse#events #events} => Hash&lt;String,String&gt;
430
+ #
431
+ # @example Request syntax with placeholder values
432
+ #
433
+ # resp = client.get_cognito_events({
434
+ # identity_pool_id: "IdentityPoolId", # required
435
+ # })
436
+ #
437
+ # @example Response structure
438
+ #
439
+ # resp.events #=> Hash
440
+ # resp.events["CognitoEventType"] #=> String
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetCognitoEvents AWS API Documentation
443
+ #
444
+ # @overload get_cognito_events(params = {})
445
+ # @param [Hash] params ({})
446
+ def get_cognito_events(params = {}, options = {})
447
+ req = build_request(:get_cognito_events, params)
448
+ req.send_request(options)
449
+ end
643
450
 
644
- # Sets the necessary configuration for push sync.
645
- #
646
- # This API can only be called with developer credentials. You cannot
647
- # call this API with the temporary user credentials provided by Cognito
648
- # Identity.
649
- # @option params [required, String] :identity_pool_id
650
- # A name-spaced GUID (for example,
651
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
652
- # Cognito. This is the ID of the pool to modify.
653
- # @option params [Types::PushSync] :push_sync
654
- # Options to apply to this identity pool for push synchronization.
655
- # @option params [Types::CognitoStreams] :cognito_streams
656
- # Options to apply to this identity pool for Amazon Cognito streams.
657
- # @return [Types::SetIdentityPoolConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
658
- #
659
- # * {Types::SetIdentityPoolConfigurationResponse#identity_pool_id #IdentityPoolId} => String
660
- # * {Types::SetIdentityPoolConfigurationResponse#push_sync #PushSync} => Types::PushSync
661
- # * {Types::SetIdentityPoolConfigurationResponse#cognito_streams #CognitoStreams} => Types::CognitoStreams
662
- #
663
- # @example Request syntax with placeholder values
664
- # resp = client.set_identity_pool_configuration({
665
- # identity_pool_id: "IdentityPoolId", # required
666
- # push_sync: {
667
- # application_arns: ["ApplicationArn"],
668
- # role_arn: "AssumeRoleArn",
669
- # },
670
- # cognito_streams: {
671
- # stream_name: "StreamName",
672
- # role_arn: "AssumeRoleArn",
673
- # streaming_status: "ENABLED", # accepts ENABLED, DISABLED
674
- # },
675
- # })
676
- #
677
- # @example Response structure
678
- # resp.identity_pool_id #=> String
679
- # resp.push_sync.application_arns #=> Array
680
- # resp.push_sync.application_arns[0] #=> String
681
- # resp.push_sync.role_arn #=> String
682
- # resp.cognito_streams.stream_name #=> String
683
- # resp.cognito_streams.role_arn #=> String
684
- # resp.cognito_streams.streaming_status #=> String, one of "ENABLED", "DISABLED"
685
- # @overload set_identity_pool_configuration(params = {})
686
- # @param [Hash] params ({})
687
- def set_identity_pool_configuration(params = {}, options = {})
688
- req = build_request(:set_identity_pool_configuration, params)
689
- req.send_request(options)
690
- end
451
+ # Gets the configuration settings of an identity pool.
452
+ #
453
+ # This API can only be called with developer credentials. You cannot
454
+ # call this API with the temporary user credentials provided by Cognito
455
+ # Identity.
456
+ #
457
+ # @option params [required, String] :identity_pool_id
458
+ # A name-spaced GUID (for example,
459
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
460
+ # Cognito. This is the ID of the pool for which to return a
461
+ # configuration.
462
+ #
463
+ # @return [Types::GetIdentityPoolConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
464
+ #
465
+ # * {Types::GetIdentityPoolConfigurationResponse#identity_pool_id #identity_pool_id} => String
466
+ # * {Types::GetIdentityPoolConfigurationResponse#push_sync #push_sync} => Types::PushSync
467
+ # * {Types::GetIdentityPoolConfigurationResponse#cognito_streams #cognito_streams} => Types::CognitoStreams
468
+ #
469
+ # @example Request syntax with placeholder values
470
+ #
471
+ # resp = client.get_identity_pool_configuration({
472
+ # identity_pool_id: "IdentityPoolId", # required
473
+ # })
474
+ #
475
+ # @example Response structure
476
+ #
477
+ # resp.identity_pool_id #=> String
478
+ # resp.push_sync.application_arns #=> Array
479
+ # resp.push_sync.application_arns[0] #=> String
480
+ # resp.push_sync.role_arn #=> String
481
+ # resp.cognito_streams.stream_name #=> String
482
+ # resp.cognito_streams.role_arn #=> String
483
+ # resp.cognito_streams.streaming_status #=> String, one of "ENABLED", "DISABLED"
484
+ #
485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetIdentityPoolConfiguration AWS API Documentation
486
+ #
487
+ # @overload get_identity_pool_configuration(params = {})
488
+ # @param [Hash] params ({})
489
+ def get_identity_pool_configuration(params = {}, options = {})
490
+ req = build_request(:get_identity_pool_configuration, params)
491
+ req.send_request(options)
492
+ end
691
493
 
692
- # Subscribes to receive notifications when a dataset is modified by
693
- # another device.
694
- #
695
- # This API can only be called with temporary credentials provided by
696
- # Cognito Identity. You cannot call this API with developer credentials.
697
- # @option params [required, String] :identity_pool_id
698
- # A name-spaced GUID (for example,
699
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
700
- # Cognito. The ID of the pool to which the identity belongs.
701
- # @option params [required, String] :identity_id
702
- # Unique ID for this identity.
703
- # @option params [required, String] :dataset_name
704
- # The name of the dataset to subcribe to.
705
- # @option params [required, String] :device_id
706
- # The unique ID generated for this device by Cognito.
707
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
708
- #
709
- # @example Request syntax with placeholder values
710
- # resp = client.subscribe_to_dataset({
711
- # identity_pool_id: "IdentityPoolId", # required
712
- # identity_id: "IdentityId", # required
713
- # dataset_name: "DatasetName", # required
714
- # device_id: "DeviceId", # required
715
- # })
716
- # @overload subscribe_to_dataset(params = {})
717
- # @param [Hash] params ({})
718
- def subscribe_to_dataset(params = {}, options = {})
719
- req = build_request(:subscribe_to_dataset, params)
720
- req.send_request(options)
721
- end
494
+ # Lists datasets for an identity. With Amazon Cognito Sync, each
495
+ # identity has access only to its own data. Thus, the credentials used
496
+ # to make this API call need to have access to the identity data.
497
+ #
498
+ # ListDatasets can be called with temporary user credentials provided by
499
+ # Cognito Identity or with developer credentials. You should use the
500
+ # Cognito Identity credentials to make this API call.
501
+ #
502
+ # @option params [required, String] :identity_pool_id
503
+ # A name-spaced GUID (for example,
504
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
505
+ # Cognito. GUID generation is unique within a region.
506
+ #
507
+ # @option params [required, String] :identity_id
508
+ # A name-spaced GUID (for example,
509
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
510
+ # Cognito. GUID generation is unique within a region.
511
+ #
512
+ # @option params [String] :next_token
513
+ # A pagination token for obtaining the next page of results.
514
+ #
515
+ # @option params [Integer] :max_results
516
+ # The maximum number of results to be returned.
517
+ #
518
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
519
+ #
520
+ # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::Dataset&gt;
521
+ # * {Types::ListDatasetsResponse#count #count} => Integer
522
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
523
+ #
524
+ # @example Request syntax with placeholder values
525
+ #
526
+ # resp = client.list_datasets({
527
+ # identity_pool_id: "IdentityPoolId", # required
528
+ # identity_id: "IdentityId", # required
529
+ # next_token: "String",
530
+ # max_results: 1,
531
+ # })
532
+ #
533
+ # @example Response structure
534
+ #
535
+ # resp.datasets #=> Array
536
+ # resp.datasets[0].identity_id #=> String
537
+ # resp.datasets[0].dataset_name #=> String
538
+ # resp.datasets[0].creation_date #=> Time
539
+ # resp.datasets[0].last_modified_date #=> Time
540
+ # resp.datasets[0].last_modified_by #=> String
541
+ # resp.datasets[0].data_storage #=> Integer
542
+ # resp.datasets[0].num_records #=> Integer
543
+ # resp.count #=> Integer
544
+ # resp.next_token #=> String
545
+ #
546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListDatasets AWS API Documentation
547
+ #
548
+ # @overload list_datasets(params = {})
549
+ # @param [Hash] params ({})
550
+ def list_datasets(params = {}, options = {})
551
+ req = build_request(:list_datasets, params)
552
+ req.send_request(options)
553
+ end
722
554
 
723
- # Unsubscribes from receiving notifications when a dataset is modified
724
- # by another device.
725
- #
726
- # This API can only be called with temporary credentials provided by
727
- # Cognito Identity. You cannot call this API with developer credentials.
728
- # @option params [required, String] :identity_pool_id
729
- # A name-spaced GUID (for example,
730
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
731
- # Cognito. The ID of the pool to which this identity belongs.
732
- # @option params [required, String] :identity_id
733
- # Unique ID for this identity.
734
- # @option params [required, String] :dataset_name
735
- # The name of the dataset from which to unsubcribe.
736
- # @option params [required, String] :device_id
737
- # The unique ID generated for this device by Cognito.
738
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
739
- #
740
- # @example Request syntax with placeholder values
741
- # resp = client.unsubscribe_from_dataset({
742
- # identity_pool_id: "IdentityPoolId", # required
743
- # identity_id: "IdentityId", # required
744
- # dataset_name: "DatasetName", # required
745
- # device_id: "DeviceId", # required
746
- # })
747
- # @overload unsubscribe_from_dataset(params = {})
748
- # @param [Hash] params ({})
749
- def unsubscribe_from_dataset(params = {}, options = {})
750
- req = build_request(:unsubscribe_from_dataset, params)
751
- req.send_request(options)
752
- end
555
+ # Gets a list of identity pools registered with Cognito.
556
+ #
557
+ # ListIdentityPoolUsage can only be called with developer credentials.
558
+ # You cannot make this API call with the temporary user credentials
559
+ # provided by Cognito Identity.
560
+ #
561
+ # @option params [String] :next_token
562
+ # A pagination token for obtaining the next page of results.
563
+ #
564
+ # @option params [Integer] :max_results
565
+ # The maximum number of results to be returned.
566
+ #
567
+ # @return [Types::ListIdentityPoolUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
568
+ #
569
+ # * {Types::ListIdentityPoolUsageResponse#identity_pool_usages #identity_pool_usages} => Array&lt;Types::IdentityPoolUsage&gt;
570
+ # * {Types::ListIdentityPoolUsageResponse#max_results #max_results} => Integer
571
+ # * {Types::ListIdentityPoolUsageResponse#count #count} => Integer
572
+ # * {Types::ListIdentityPoolUsageResponse#next_token #next_token} => String
573
+ #
574
+ # @example Request syntax with placeholder values
575
+ #
576
+ # resp = client.list_identity_pool_usage({
577
+ # next_token: "String",
578
+ # max_results: 1,
579
+ # })
580
+ #
581
+ # @example Response structure
582
+ #
583
+ # resp.identity_pool_usages #=> Array
584
+ # resp.identity_pool_usages[0].identity_pool_id #=> String
585
+ # resp.identity_pool_usages[0].sync_sessions_count #=> Integer
586
+ # resp.identity_pool_usages[0].data_storage #=> Integer
587
+ # resp.identity_pool_usages[0].last_modified_date #=> Time
588
+ # resp.max_results #=> Integer
589
+ # resp.count #=> Integer
590
+ # resp.next_token #=> String
591
+ #
592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListIdentityPoolUsage AWS API Documentation
593
+ #
594
+ # @overload list_identity_pool_usage(params = {})
595
+ # @param [Hash] params ({})
596
+ def list_identity_pool_usage(params = {}, options = {})
597
+ req = build_request(:list_identity_pool_usage, params)
598
+ req.send_request(options)
599
+ end
753
600
 
754
- # Posts updates to records and adds and deletes records for a dataset
755
- # and user.
756
- #
757
- # The sync count in the record patch is your last known sync count for
758
- # that record. The server will reject an UpdateRecords request with a
759
- # ResourceConflictException if you try to patch a record with a new
760
- # value but a stale sync count.
761
- #
762
- # For example, if the sync count on the server is 5 for a key called
763
- # highScore and you try and submit a new highScore with sync count of 4,
764
- # the request will be rejected. To obtain the current sync count for a
765
- # record, call ListRecords. On a successful update of the record, the
766
- # response returns the new sync count for that record. You should
767
- # present that sync count the next time you try to update that same
768
- # record. When the record does not exist, specify the sync count as 0.
769
- #
770
- # This API can be called with temporary user credentials provided by
771
- # Cognito Identity or with developer credentials.
772
- # @option params [required, String] :identity_pool_id
773
- # A name-spaced GUID (for example,
774
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
775
- # Cognito. GUID generation is unique within a region.
776
- # @option params [required, String] :identity_id
777
- # A name-spaced GUID (for example,
778
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
779
- # Cognito. GUID generation is unique within a region.
780
- # @option params [required, String] :dataset_name
781
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
782
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
783
- # @option params [String] :device_id
784
- # The unique ID generated for this device by Cognito.
785
- # @option params [Array<Types::RecordPatch>] :record_patches
786
- # A list of patch operations.
787
- # @option params [required, String] :sync_session_token
788
- # The SyncSessionToken returned by a previous call to ListRecords for
789
- # this dataset and identity.
790
- # @option params [String] :client_context
791
- # Intended to supply a device ID that will populate the lastModifiedBy
792
- # field referenced in other methods. The ClientContext field is not yet
793
- # implemented.
794
- # @return [Types::UpdateRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
795
- #
796
- # * {Types::UpdateRecordsResponse#records #Records} => Array&lt;Types::Record&gt;
797
- #
798
- # @example Request syntax with placeholder values
799
- # resp = client.update_records({
800
- # identity_pool_id: "IdentityPoolId", # required
801
- # identity_id: "IdentityId", # required
802
- # dataset_name: "DatasetName", # required
803
- # device_id: "DeviceId",
804
- # record_patches: [
805
- # {
806
- # op: "replace", # required, accepts replace, remove
807
- # key: "RecordKey", # required
808
- # value: "RecordValue",
809
- # sync_count: 1, # required
810
- # device_last_modified_date: Time.now,
811
- # },
812
- # ],
813
- # sync_session_token: "SyncSessionToken", # required
814
- # client_context: "ClientContext",
815
- # })
816
- #
817
- # @example Response structure
818
- # resp.records #=> Array
819
- # resp.records[0].key #=> String
820
- # resp.records[0].value #=> String
821
- # resp.records[0].sync_count #=> Integer
822
- # resp.records[0].last_modified_date #=> Time
823
- # resp.records[0].last_modified_by #=> String
824
- # resp.records[0].device_last_modified_date #=> Time
825
- # @overload update_records(params = {})
826
- # @param [Hash] params ({})
827
- def update_records(params = {}, options = {})
828
- req = build_request(:update_records, params)
829
- req.send_request(options)
830
- end
601
+ # Gets paginated records, optionally changed after a particular sync
602
+ # count for a dataset and identity. With Amazon Cognito Sync, each
603
+ # identity has access only to its own data. Thus, the credentials used
604
+ # to make this API call need to have access to the identity data.
605
+ #
606
+ # ListRecords can be called with temporary user credentials provided by
607
+ # Cognito Identity or with developer credentials. You should use Cognito
608
+ # Identity credentials to make this API call.
609
+ #
610
+ # @option params [required, String] :identity_pool_id
611
+ # A name-spaced GUID (for example,
612
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
613
+ # Cognito. GUID generation is unique within a region.
614
+ #
615
+ # @option params [required, String] :identity_id
616
+ # A name-spaced GUID (for example,
617
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
618
+ # Cognito. GUID generation is unique within a region.
619
+ #
620
+ # @option params [required, String] :dataset_name
621
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
622
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
623
+ #
624
+ # @option params [Integer] :last_sync_count
625
+ # The last server sync count for this record.
626
+ #
627
+ # @option params [String] :next_token
628
+ # A pagination token for obtaining the next page of results.
629
+ #
630
+ # @option params [Integer] :max_results
631
+ # The maximum number of results to be returned.
632
+ #
633
+ # @option params [String] :sync_session_token
634
+ # A token containing a session ID, identity ID, and expiration.
635
+ #
636
+ # @return [Types::ListRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
637
+ #
638
+ # * {Types::ListRecordsResponse#records #records} => Array&lt;Types::Record&gt;
639
+ # * {Types::ListRecordsResponse#next_token #next_token} => String
640
+ # * {Types::ListRecordsResponse#count #count} => Integer
641
+ # * {Types::ListRecordsResponse#dataset_sync_count #dataset_sync_count} => Integer
642
+ # * {Types::ListRecordsResponse#last_modified_by #last_modified_by} => String
643
+ # * {Types::ListRecordsResponse#merged_dataset_names #merged_dataset_names} => Array&lt;String&gt;
644
+ # * {Types::ListRecordsResponse#dataset_exists #dataset_exists} => Boolean
645
+ # * {Types::ListRecordsResponse#dataset_deleted_after_requested_sync_count #dataset_deleted_after_requested_sync_count} => Boolean
646
+ # * {Types::ListRecordsResponse#sync_session_token #sync_session_token} => String
647
+ #
648
+ # @example Request syntax with placeholder values
649
+ #
650
+ # resp = client.list_records({
651
+ # identity_pool_id: "IdentityPoolId", # required
652
+ # identity_id: "IdentityId", # required
653
+ # dataset_name: "DatasetName", # required
654
+ # last_sync_count: 1,
655
+ # next_token: "String",
656
+ # max_results: 1,
657
+ # sync_session_token: "SyncSessionToken",
658
+ # })
659
+ #
660
+ # @example Response structure
661
+ #
662
+ # resp.records #=> Array
663
+ # resp.records[0].key #=> String
664
+ # resp.records[0].value #=> String
665
+ # resp.records[0].sync_count #=> Integer
666
+ # resp.records[0].last_modified_date #=> Time
667
+ # resp.records[0].last_modified_by #=> String
668
+ # resp.records[0].device_last_modified_date #=> Time
669
+ # resp.next_token #=> String
670
+ # resp.count #=> Integer
671
+ # resp.dataset_sync_count #=> Integer
672
+ # resp.last_modified_by #=> String
673
+ # resp.merged_dataset_names #=> Array
674
+ # resp.merged_dataset_names[0] #=> String
675
+ # resp.dataset_exists #=> Boolean
676
+ # resp.dataset_deleted_after_requested_sync_count #=> Boolean
677
+ # resp.sync_session_token #=> String
678
+ #
679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListRecords AWS API Documentation
680
+ #
681
+ # @overload list_records(params = {})
682
+ # @param [Hash] params ({})
683
+ def list_records(params = {}, options = {})
684
+ req = build_request(:list_records, params)
685
+ req.send_request(options)
686
+ end
831
687
 
832
- # @!endgroup
688
+ # Registers a device to receive push sync notifications.
689
+ #
690
+ # This API can only be called with temporary credentials provided by
691
+ # Cognito Identity. You cannot call this API with developer credentials.
692
+ #
693
+ # @option params [required, String] :identity_pool_id
694
+ # A name-spaced GUID (for example,
695
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
696
+ # Cognito. Here, the ID of the pool that the identity belongs to.
697
+ #
698
+ # @option params [required, String] :identity_id
699
+ # The unique ID for this identity.
700
+ #
701
+ # @option params [required, String] :platform
702
+ # The SNS platform type (e.g. GCM, SDM, APNS, APNS\_SANDBOX).
703
+ #
704
+ # @option params [required, String] :token
705
+ # The push token.
706
+ #
707
+ # @return [Types::RegisterDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
708
+ #
709
+ # * {Types::RegisterDeviceResponse#device_id #device_id} => String
710
+ #
711
+ # @example Request syntax with placeholder values
712
+ #
713
+ # resp = client.register_device({
714
+ # identity_pool_id: "IdentityPoolId", # required
715
+ # identity_id: "IdentityId", # required
716
+ # platform: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM, ADM
717
+ # token: "PushToken", # required
718
+ # })
719
+ #
720
+ # @example Response structure
721
+ #
722
+ # resp.device_id #=> String
723
+ #
724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RegisterDevice AWS API Documentation
725
+ #
726
+ # @overload register_device(params = {})
727
+ # @param [Hash] params ({})
728
+ def register_device(params = {}, options = {})
729
+ req = build_request(:register_device, params)
730
+ req.send_request(options)
731
+ end
833
732
 
834
- # @param params ({})
835
- # @api private
836
- def build_request(operation_name, params = {})
837
- handlers = @handlers.for(operation_name)
838
- context = Seahorse::Client::RequestContext.new(
839
- operation_name: operation_name,
840
- operation: config.api.operation(operation_name),
841
- client: self,
842
- params: params,
843
- config: config)
844
- context[:gem_name] = 'aws-sdk-cognitosync'
845
- context[:gem_version] = '1.0.0.rc1'
846
- Seahorse::Client::Request.new(handlers, context)
847
- end
733
+ # Sets the AWS Lambda function for a given event type for an identity
734
+ # pool. This request only updates the key/value pair specified. Other
735
+ # key/values pairs are not updated. To remove a key value pair, pass a
736
+ # empty value for the particular key.
737
+ #
738
+ # This API can only be called with developer credentials. You cannot
739
+ # call this API with the temporary user credentials provided by Cognito
740
+ # Identity.
741
+ #
742
+ # @option params [required, String] :identity_pool_id
743
+ # The Cognito Identity Pool to use when configuring Cognito Events
744
+ #
745
+ # @option params [required, Hash<String,String>] :events
746
+ # The events to configure
747
+ #
748
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
749
+ #
750
+ # @example Request syntax with placeholder values
751
+ #
752
+ # resp = client.set_cognito_events({
753
+ # identity_pool_id: "IdentityPoolId", # required
754
+ # events: { # required
755
+ # "CognitoEventType" => "LambdaFunctionArn",
756
+ # },
757
+ # })
758
+ #
759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetCognitoEvents AWS API Documentation
760
+ #
761
+ # @overload set_cognito_events(params = {})
762
+ # @param [Hash] params ({})
763
+ def set_cognito_events(params = {}, options = {})
764
+ req = build_request(:set_cognito_events, params)
765
+ req.send_request(options)
766
+ end
848
767
 
849
- # @api private
850
- # @deprecated
851
- def waiter_names
852
- []
853
- end
768
+ # Sets the necessary configuration for push sync.
769
+ #
770
+ # This API can only be called with developer credentials. You cannot
771
+ # call this API with the temporary user credentials provided by Cognito
772
+ # Identity.
773
+ #
774
+ # @option params [required, String] :identity_pool_id
775
+ # A name-spaced GUID (for example,
776
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
777
+ # Cognito. This is the ID of the pool to modify.
778
+ #
779
+ # @option params [Types::PushSync] :push_sync
780
+ # Options to apply to this identity pool for push synchronization.
781
+ #
782
+ # @option params [Types::CognitoStreams] :cognito_streams
783
+ # Options to apply to this identity pool for Amazon Cognito streams.
784
+ #
785
+ # @return [Types::SetIdentityPoolConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
786
+ #
787
+ # * {Types::SetIdentityPoolConfigurationResponse#identity_pool_id #identity_pool_id} => String
788
+ # * {Types::SetIdentityPoolConfigurationResponse#push_sync #push_sync} => Types::PushSync
789
+ # * {Types::SetIdentityPoolConfigurationResponse#cognito_streams #cognito_streams} => Types::CognitoStreams
790
+ #
791
+ # @example Request syntax with placeholder values
792
+ #
793
+ # resp = client.set_identity_pool_configuration({
794
+ # identity_pool_id: "IdentityPoolId", # required
795
+ # push_sync: {
796
+ # application_arns: ["ApplicationArn"],
797
+ # role_arn: "AssumeRoleArn",
798
+ # },
799
+ # cognito_streams: {
800
+ # stream_name: "StreamName",
801
+ # role_arn: "AssumeRoleArn",
802
+ # streaming_status: "ENABLED", # accepts ENABLED, DISABLED
803
+ # },
804
+ # })
805
+ #
806
+ # @example Response structure
807
+ #
808
+ # resp.identity_pool_id #=> String
809
+ # resp.push_sync.application_arns #=> Array
810
+ # resp.push_sync.application_arns[0] #=> String
811
+ # resp.push_sync.role_arn #=> String
812
+ # resp.cognito_streams.stream_name #=> String
813
+ # resp.cognito_streams.role_arn #=> String
814
+ # resp.cognito_streams.streaming_status #=> String, one of "ENABLED", "DISABLED"
815
+ #
816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetIdentityPoolConfiguration AWS API Documentation
817
+ #
818
+ # @overload set_identity_pool_configuration(params = {})
819
+ # @param [Hash] params ({})
820
+ def set_identity_pool_configuration(params = {}, options = {})
821
+ req = build_request(:set_identity_pool_configuration, params)
822
+ req.send_request(options)
823
+ end
854
824
 
855
- class << self
825
+ # Subscribes to receive notifications when a dataset is modified by
826
+ # another device.
827
+ #
828
+ # This API can only be called with temporary credentials provided by
829
+ # Cognito Identity. You cannot call this API with developer credentials.
830
+ #
831
+ # @option params [required, String] :identity_pool_id
832
+ # A name-spaced GUID (for example,
833
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
834
+ # Cognito. The ID of the pool to which the identity belongs.
835
+ #
836
+ # @option params [required, String] :identity_id
837
+ # Unique ID for this identity.
838
+ #
839
+ # @option params [required, String] :dataset_name
840
+ # The name of the dataset to subcribe to.
841
+ #
842
+ # @option params [required, String] :device_id
843
+ # The unique ID generated for this device by Cognito.
844
+ #
845
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
846
+ #
847
+ # @example Request syntax with placeholder values
848
+ #
849
+ # resp = client.subscribe_to_dataset({
850
+ # identity_pool_id: "IdentityPoolId", # required
851
+ # identity_id: "IdentityId", # required
852
+ # dataset_name: "DatasetName", # required
853
+ # device_id: "DeviceId", # required
854
+ # })
855
+ #
856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SubscribeToDataset AWS API Documentation
857
+ #
858
+ # @overload subscribe_to_dataset(params = {})
859
+ # @param [Hash] params ({})
860
+ def subscribe_to_dataset(params = {}, options = {})
861
+ req = build_request(:subscribe_to_dataset, params)
862
+ req.send_request(options)
863
+ end
856
864
 
857
- # @api private
858
- attr_reader :identifier
865
+ # Unsubscribes from receiving notifications when a dataset is modified
866
+ # by another device.
867
+ #
868
+ # This API can only be called with temporary credentials provided by
869
+ # Cognito Identity. You cannot call this API with developer credentials.
870
+ #
871
+ # @option params [required, String] :identity_pool_id
872
+ # A name-spaced GUID (for example,
873
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
874
+ # Cognito. The ID of the pool to which this identity belongs.
875
+ #
876
+ # @option params [required, String] :identity_id
877
+ # Unique ID for this identity.
878
+ #
879
+ # @option params [required, String] :dataset_name
880
+ # The name of the dataset from which to unsubcribe.
881
+ #
882
+ # @option params [required, String] :device_id
883
+ # The unique ID generated for this device by Cognito.
884
+ #
885
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
886
+ #
887
+ # @example Request syntax with placeholder values
888
+ #
889
+ # resp = client.unsubscribe_from_dataset({
890
+ # identity_pool_id: "IdentityPoolId", # required
891
+ # identity_id: "IdentityId", # required
892
+ # dataset_name: "DatasetName", # required
893
+ # device_id: "DeviceId", # required
894
+ # })
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDataset AWS API Documentation
897
+ #
898
+ # @overload unsubscribe_from_dataset(params = {})
899
+ # @param [Hash] params ({})
900
+ def unsubscribe_from_dataset(params = {}, options = {})
901
+ req = build_request(:unsubscribe_from_dataset, params)
902
+ req.send_request(options)
903
+ end
904
+
905
+ # Posts updates to records and adds and deletes records for a dataset
906
+ # and user.
907
+ #
908
+ # The sync count in the record patch is your last known sync count for
909
+ # that record. The server will reject an UpdateRecords request with a
910
+ # ResourceConflictException if you try to patch a record with a new
911
+ # value but a stale sync count.
912
+ #
913
+ # For example, if the sync count on the server is 5 for a key called
914
+ # highScore and you try and submit a new highScore with sync count of 4,
915
+ # the request will be rejected. To obtain the current sync count for a
916
+ # record, call ListRecords. On a successful update of the record, the
917
+ # response returns the new sync count for that record. You should
918
+ # present that sync count the next time you try to update that same
919
+ # record. When the record does not exist, specify the sync count as 0.
920
+ #
921
+ # This API can be called with temporary user credentials provided by
922
+ # Cognito Identity or with developer credentials.
923
+ #
924
+ # @option params [required, String] :identity_pool_id
925
+ # A name-spaced GUID (for example,
926
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
927
+ # Cognito. GUID generation is unique within a region.
928
+ #
929
+ # @option params [required, String] :identity_id
930
+ # A name-spaced GUID (for example,
931
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
932
+ # Cognito. GUID generation is unique within a region.
933
+ #
934
+ # @option params [required, String] :dataset_name
935
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
936
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
937
+ #
938
+ # @option params [String] :device_id
939
+ # The unique ID generated for this device by Cognito.
940
+ #
941
+ # @option params [Array<Types::RecordPatch>] :record_patches
942
+ # A list of patch operations.
943
+ #
944
+ # @option params [required, String] :sync_session_token
945
+ # The SyncSessionToken returned by a previous call to ListRecords for
946
+ # this dataset and identity.
947
+ #
948
+ # @option params [String] :client_context
949
+ # Intended to supply a device ID that will populate the lastModifiedBy
950
+ # field referenced in other methods. The ClientContext field is not yet
951
+ # implemented.
952
+ #
953
+ # @return [Types::UpdateRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
954
+ #
955
+ # * {Types::UpdateRecordsResponse#records #records} => Array&lt;Types::Record&gt;
956
+ #
957
+ # @example Request syntax with placeholder values
958
+ #
959
+ # resp = client.update_records({
960
+ # identity_pool_id: "IdentityPoolId", # required
961
+ # identity_id: "IdentityId", # required
962
+ # dataset_name: "DatasetName", # required
963
+ # device_id: "DeviceId",
964
+ # record_patches: [
965
+ # {
966
+ # op: "replace", # required, accepts replace, remove
967
+ # key: "RecordKey", # required
968
+ # value: "RecordValue",
969
+ # sync_count: 1, # required
970
+ # device_last_modified_date: Time.now,
971
+ # },
972
+ # ],
973
+ # sync_session_token: "SyncSessionToken", # required
974
+ # client_context: "ClientContext",
975
+ # })
976
+ #
977
+ # @example Response structure
978
+ #
979
+ # resp.records #=> Array
980
+ # resp.records[0].key #=> String
981
+ # resp.records[0].value #=> String
982
+ # resp.records[0].sync_count #=> Integer
983
+ # resp.records[0].last_modified_date #=> Time
984
+ # resp.records[0].last_modified_by #=> String
985
+ # resp.records[0].device_last_modified_date #=> Time
986
+ #
987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UpdateRecords AWS API Documentation
988
+ #
989
+ # @overload update_records(params = {})
990
+ # @param [Hash] params ({})
991
+ def update_records(params = {}, options = {})
992
+ req = build_request(:update_records, params)
993
+ req.send_request(options)
994
+ end
995
+
996
+ # @!endgroup
997
+
998
+ # @param params ({})
999
+ # @api private
1000
+ def build_request(operation_name, params = {})
1001
+ handlers = @handlers.for(operation_name)
1002
+ context = Seahorse::Client::RequestContext.new(
1003
+ operation_name: operation_name,
1004
+ operation: config.api.operation(operation_name),
1005
+ client: self,
1006
+ params: params,
1007
+ config: config)
1008
+ context[:gem_name] = 'aws-sdk-cognitosync'
1009
+ context[:gem_version] = '1.0.0.rc2'
1010
+ Seahorse::Client::Request.new(handlers, context)
1011
+ end
859
1012
 
860
- # @api private
861
- def errors_module
862
- Errors
863
- end
1013
+ # @api private
1014
+ # @deprecated
1015
+ def waiter_names
1016
+ []
1017
+ end
1018
+
1019
+ class << self
1020
+
1021
+ # @api private
1022
+ attr_reader :identifier
864
1023
 
1024
+ # @api private
1025
+ def errors_module
1026
+ Errors
865
1027
  end
1028
+
866
1029
  end
867
1030
  end
868
1031
  end