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 +4 -4
- data/lib/aws-sdk-cognitosync.rb +2 -2
- data/lib/aws-sdk-cognitosync/client.rb +979 -816
- data/lib/aws-sdk-cognitosync/client_api.rb +545 -837
- data/lib/aws-sdk-cognitosync/errors.rb +4 -13
- data/lib/aws-sdk-cognitosync/resource.rb +12 -14
- data/lib/aws-sdk-cognitosync/types.rb +1163 -987
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4228828341f9f5f51cb09be406a26fdc9e0e9691
|
4
|
+
data.tar.gz: e770fdf25526a7f7a6d5c4fa3fe835545824531d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1e6064c939ad061991da333200c8a738439173e011d5c3d2f58a3046908c39781493c30409f6a680efb9d671f62e5c1c4ca6a94a7133c2424e5d1d6158449b2b
|
7
|
+
data.tar.gz: f47b277fe4f3d5cecd7b824bf2b3394457623eee82b4a6730e6ebec67475550b40ba9b756231e8c87f7ca770aed2c9c88744cebe59fd8c264f17d440c53034d7
|
data/lib/aws-sdk-cognitosync.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
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.
|
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
|
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
|
-
|
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
|
-
|
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
|
-
|
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
|
-
|
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
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
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
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
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
|
-
|
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
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
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
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
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
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
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
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
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
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
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
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
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
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
|
642
|
-
|
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<String,String>
|
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
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
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
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
699
|
-
|
700
|
-
|
701
|
-
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
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<Types::Dataset>
|
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
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
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<Types::IdentityPoolUsage>
|
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
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
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<Types::Record>
|
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<String>
|
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
|
-
|
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
|
-
|
835
|
-
|
836
|
-
|
837
|
-
|
838
|
-
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
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
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
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
|
-
|
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
|
-
|
858
|
-
|
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<Types::Record>
|
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
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
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
|