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.
@@ -1,23 +1,14 @@
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
7
7
 
8
- module Aws
9
- module CognitoSync
10
- module Errors
8
+ module Aws::CognitoSync
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
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
7
7
 
8
- module Aws
9
- module CognitoSync
10
- class Resource
8
+ module Aws::CognitoSync
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,1036 +1,1212 @@
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
7
7
 
8
- module Aws
9
- module CognitoSync
10
- module Types
8
+ module Aws::CognitoSync
9
+ module Types
11
10
 
12
- # The input for the BulkPublish operation.
13
- # @note When making an API call, pass BulkPublishRequest
14
- # data as a hash:
15
- #
16
- # {
17
- # identity_pool_id: "IdentityPoolId", # required
18
- # }
19
- # @!attribute [rw] identity_pool_id
20
- # A name-spaced GUID (for example,
21
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
22
- # Cognito. GUID generation is unique within a region.
23
- # @return [String]
24
- class BulkPublishRequest < Struct.new(
25
- :identity_pool_id)
26
- include Aws::Structure
27
- end
28
-
29
- # The output for the BulkPublish operation.
30
- # @!attribute [rw] identity_pool_id
31
- # A name-spaced GUID (for example,
32
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
33
- # Cognito. GUID generation is unique within a region.
34
- # @return [String]
35
- class BulkPublishResponse < Struct.new(
36
- :identity_pool_id)
37
- include Aws::Structure
38
- end
11
+ # The input for the BulkPublish operation.
12
+ #
13
+ # @note When making an API call, you may pass BulkPublishRequest
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # identity_pool_id: "IdentityPoolId", # required
18
+ # }
19
+ #
20
+ # @!attribute [rw] identity_pool_id
21
+ # A name-spaced GUID (for example,
22
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
23
+ # Cognito. GUID generation is unique within a region.
24
+ # @return [String]
25
+ #
26
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/BulkPublishRequest AWS API Documentation
27
+ #
28
+ class BulkPublishRequest < Struct.new(
29
+ :identity_pool_id)
30
+ include Aws::Structure
31
+ end
39
32
 
40
- # Configuration options for configure Cognito streams.
41
- # @note When making an API call, pass CognitoStreams
42
- # data as a hash:
43
- #
44
- # {
45
- # stream_name: "StreamName",
46
- # role_arn: "AssumeRoleArn",
47
- # streaming_status: "ENABLED", # accepts ENABLED, DISABLED
48
- # }
49
- # @!attribute [rw] stream_name
50
- # The name of the Cognito stream to receive updates. This stream must
51
- # be in the developers account and in the same region as the identity
52
- # pool.
53
- # @return [String]
54
- #
55
- # @!attribute [rw] role_arn
56
- # The ARN of the role Amazon Cognito can assume in order to publish to
57
- # the stream. This role must grant access to Amazon Cognito
58
- # (cognito-sync) to invoke PutRecord on your Cognito stream.
59
- # @return [String]
60
- #
61
- # @!attribute [rw] streaming_status
62
- # Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled.
63
- #
64
- # DISABLED - Streaming of updates to identity pool is disabled. Bulk
65
- # publish will also fail if StreamingStatus is DISABLED.
66
- # @return [String]
67
- class CognitoStreams < Struct.new(
68
- :stream_name,
69
- :role_arn,
70
- :streaming_status)
71
- include Aws::Structure
72
- end
33
+ # The output for the BulkPublish operation.
34
+ #
35
+ # @!attribute [rw] identity_pool_id
36
+ # A name-spaced GUID (for example,
37
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
38
+ # Cognito. GUID generation is unique within a region.
39
+ # @return [String]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/BulkPublishResponse AWS API Documentation
42
+ #
43
+ class BulkPublishResponse < Struct.new(
44
+ :identity_pool_id)
45
+ include Aws::Structure
46
+ end
73
47
 
74
- # A collection of data for an identity pool. An identity pool can have
75
- # multiple datasets. A dataset is per identity and can be general or
76
- # associated with a particular entity in an application (like a saved
77
- # game). Datasets are automatically created if they don't exist. Data
78
- # is synced by dataset, and a dataset can hold up to 1MB of key-value
79
- # pairs.
80
- # @!attribute [rw] identity_id
81
- # A name-spaced GUID (for example,
82
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
83
- # Cognito. GUID generation is unique within a region.
84
- # @return [String]
85
- #
86
- # @!attribute [rw] dataset_name
87
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
88
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
89
- # @return [String]
90
- #
91
- # @!attribute [rw] creation_date
92
- # Date on which the dataset was created.
93
- # @return [Time]
94
- #
95
- # @!attribute [rw] last_modified_date
96
- # Date when the dataset was last modified.
97
- # @return [Time]
98
- #
99
- # @!attribute [rw] last_modified_by
100
- # The device that made the last change to this dataset.
101
- # @return [String]
102
- #
103
- # @!attribute [rw] data_storage
104
- # Total size in bytes of the records in this dataset.
105
- # @return [Integer]
106
- #
107
- # @!attribute [rw] num_records
108
- # Number of records in this dataset.
109
- # @return [Integer]
110
- class Dataset < Struct.new(
111
- :identity_id,
112
- :dataset_name,
113
- :creation_date,
114
- :last_modified_date,
115
- :last_modified_by,
116
- :data_storage,
117
- :num_records)
118
- include Aws::Structure
119
- end
48
+ # Configuration options for configure Cognito streams.
49
+ #
50
+ # @note When making an API call, you may pass CognitoStreams
51
+ # data as a hash:
52
+ #
53
+ # {
54
+ # stream_name: "StreamName",
55
+ # role_arn: "AssumeRoleArn",
56
+ # streaming_status: "ENABLED", # accepts ENABLED, DISABLED
57
+ # }
58
+ #
59
+ # @!attribute [rw] stream_name
60
+ # The name of the Cognito stream to receive updates. This stream must
61
+ # be in the developers account and in the same region as the identity
62
+ # pool.
63
+ # @return [String]
64
+ #
65
+ # @!attribute [rw] role_arn
66
+ # The ARN of the role Amazon Cognito can assume in order to publish to
67
+ # the stream. This role must grant access to Amazon Cognito
68
+ # (cognito-sync) to invoke PutRecord on your Cognito stream.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] streaming_status
72
+ # Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled.
73
+ #
74
+ # DISABLED - Streaming of updates to identity pool is disabled. Bulk
75
+ # publish will also fail if StreamingStatus is DISABLED.
76
+ # @return [String]
77
+ #
78
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/CognitoStreams AWS API Documentation
79
+ #
80
+ class CognitoStreams < Struct.new(
81
+ :stream_name,
82
+ :role_arn,
83
+ :streaming_status)
84
+ include Aws::Structure
85
+ end
120
86
 
121
- # A request to delete the specific dataset.
122
- # @note When making an API call, pass DeleteDatasetRequest
123
- # data as a hash:
124
- #
125
- # {
126
- # identity_pool_id: "IdentityPoolId", # required
127
- # identity_id: "IdentityId", # required
128
- # dataset_name: "DatasetName", # required
129
- # }
130
- # @!attribute [rw] identity_pool_id
131
- # A name-spaced GUID (for example,
132
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
133
- # Cognito. GUID generation is unique within a region.
134
- # @return [String]
135
- #
136
- # @!attribute [rw] identity_id
137
- # A name-spaced GUID (for example,
138
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
139
- # Cognito. GUID generation is unique within a region.
140
- # @return [String]
141
- #
142
- # @!attribute [rw] dataset_name
143
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
144
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
145
- # @return [String]
146
- class DeleteDatasetRequest < Struct.new(
147
- :identity_pool_id,
148
- :identity_id,
149
- :dataset_name)
150
- include Aws::Structure
151
- end
87
+ # A collection of data for an identity pool. An identity pool can have
88
+ # multiple datasets. A dataset is per identity and can be general or
89
+ # associated with a particular entity in an application (like a saved
90
+ # game). Datasets are automatically created if they don't exist. Data
91
+ # is synced by dataset, and a dataset can hold up to 1MB of key-value
92
+ # pairs.
93
+ #
94
+ # @!attribute [rw] identity_id
95
+ # A name-spaced GUID (for example,
96
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
97
+ # Cognito. GUID generation is unique within a region.
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] dataset_name
101
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
102
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
103
+ # @return [String]
104
+ #
105
+ # @!attribute [rw] creation_date
106
+ # Date on which the dataset was created.
107
+ # @return [Time]
108
+ #
109
+ # @!attribute [rw] last_modified_date
110
+ # Date when the dataset was last modified.
111
+ # @return [Time]
112
+ #
113
+ # @!attribute [rw] last_modified_by
114
+ # The device that made the last change to this dataset.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] data_storage
118
+ # Total size in bytes of the records in this dataset.
119
+ # @return [Integer]
120
+ #
121
+ # @!attribute [rw] num_records
122
+ # Number of records in this dataset.
123
+ # @return [Integer]
124
+ #
125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/Dataset AWS API Documentation
126
+ #
127
+ class Dataset < Struct.new(
128
+ :identity_id,
129
+ :dataset_name,
130
+ :creation_date,
131
+ :last_modified_date,
132
+ :last_modified_by,
133
+ :data_storage,
134
+ :num_records)
135
+ include Aws::Structure
136
+ end
152
137
 
153
- # Response to a successful DeleteDataset request.
154
- # @!attribute [rw] dataset
155
- # A collection of data for an identity pool. An identity pool can have
156
- # multiple datasets. A dataset is per identity and can be general or
157
- # associated with a particular entity in an application (like a saved
158
- # game). Datasets are automatically created if they don't exist. Data
159
- # is synced by dataset, and a dataset can hold up to 1MB of key-value
160
- # pairs.
161
- # @return [Types::Dataset]
162
- class DeleteDatasetResponse < Struct.new(
163
- :dataset)
164
- include Aws::Structure
165
- end
138
+ # A request to delete the specific dataset.
139
+ #
140
+ # @note When making an API call, you may pass DeleteDatasetRequest
141
+ # data as a hash:
142
+ #
143
+ # {
144
+ # identity_pool_id: "IdentityPoolId", # required
145
+ # identity_id: "IdentityId", # required
146
+ # dataset_name: "DatasetName", # required
147
+ # }
148
+ #
149
+ # @!attribute [rw] identity_pool_id
150
+ # A name-spaced GUID (for example,
151
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
152
+ # Cognito. GUID generation is unique within a region.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] identity_id
156
+ # A name-spaced GUID (for example,
157
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
158
+ # Cognito. GUID generation is unique within a region.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] dataset_name
162
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
163
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
164
+ # @return [String]
165
+ #
166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DeleteDatasetRequest AWS API Documentation
167
+ #
168
+ class DeleteDatasetRequest < Struct.new(
169
+ :identity_pool_id,
170
+ :identity_id,
171
+ :dataset_name)
172
+ include Aws::Structure
173
+ end
166
174
 
167
- # A request for meta data about a dataset (creation date, number of
168
- # records, size) by owner and dataset name.
169
- # @note When making an API call, pass DescribeDatasetRequest
170
- # data as a hash:
171
- #
172
- # {
173
- # identity_pool_id: "IdentityPoolId", # required
174
- # identity_id: "IdentityId", # required
175
- # dataset_name: "DatasetName", # required
176
- # }
177
- # @!attribute [rw] identity_pool_id
178
- # A name-spaced GUID (for example,
179
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
180
- # Cognito. GUID generation is unique within a region.
181
- # @return [String]
182
- #
183
- # @!attribute [rw] identity_id
184
- # A name-spaced GUID (for example,
185
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
186
- # Cognito. GUID generation is unique within a region.
187
- # @return [String]
188
- #
189
- # @!attribute [rw] dataset_name
190
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
191
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
192
- # @return [String]
193
- class DescribeDatasetRequest < Struct.new(
194
- :identity_pool_id,
195
- :identity_id,
196
- :dataset_name)
197
- include Aws::Structure
198
- end
175
+ # Response to a successful DeleteDataset request.
176
+ #
177
+ # @!attribute [rw] dataset
178
+ # A collection of data for an identity pool. An identity pool can have
179
+ # multiple datasets. A dataset is per identity and can be general or
180
+ # associated with a particular entity in an application (like a saved
181
+ # game). Datasets are automatically created if they don't exist. Data
182
+ # is synced by dataset, and a dataset can hold up to 1MB of key-value
183
+ # pairs.
184
+ # @return [Types::Dataset]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DeleteDatasetResponse AWS API Documentation
187
+ #
188
+ class DeleteDatasetResponse < Struct.new(
189
+ :dataset)
190
+ include Aws::Structure
191
+ end
199
192
 
200
- # Response to a successful DescribeDataset request.
201
- # @!attribute [rw] dataset
202
- # Meta data for a collection of data for an identity. An identity can
203
- # have multiple datasets. A dataset can be general or associated with
204
- # a particular entity in an application (like a saved game). Datasets
205
- # are automatically created if they don't exist. Data is synced by
206
- # dataset, and a dataset can hold up to 1MB of key-value pairs.
207
- # @return [Types::Dataset]
208
- class DescribeDatasetResponse < Struct.new(
209
- :dataset)
210
- include Aws::Structure
211
- end
193
+ # A request for meta data about a dataset (creation date, number of
194
+ # records, size) by owner and dataset name.
195
+ #
196
+ # @note When making an API call, you may pass DescribeDatasetRequest
197
+ # data as a hash:
198
+ #
199
+ # {
200
+ # identity_pool_id: "IdentityPoolId", # required
201
+ # identity_id: "IdentityId", # required
202
+ # dataset_name: "DatasetName", # required
203
+ # }
204
+ #
205
+ # @!attribute [rw] identity_pool_id
206
+ # A name-spaced GUID (for example,
207
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
208
+ # Cognito. GUID generation is unique within a region.
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] identity_id
212
+ # A name-spaced GUID (for example,
213
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
214
+ # Cognito. GUID generation is unique within a region.
215
+ # @return [String]
216
+ #
217
+ # @!attribute [rw] dataset_name
218
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
219
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
220
+ # @return [String]
221
+ #
222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeDatasetRequest AWS API Documentation
223
+ #
224
+ class DescribeDatasetRequest < Struct.new(
225
+ :identity_pool_id,
226
+ :identity_id,
227
+ :dataset_name)
228
+ include Aws::Structure
229
+ end
212
230
 
213
- # A request for usage information about the identity pool.
214
- # @note When making an API call, pass DescribeIdentityPoolUsageRequest
215
- # data as a hash:
216
- #
217
- # {
218
- # identity_pool_id: "IdentityPoolId", # required
219
- # }
220
- # @!attribute [rw] identity_pool_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
- # @return [String]
225
- class DescribeIdentityPoolUsageRequest < Struct.new(
226
- :identity_pool_id)
227
- include Aws::Structure
228
- end
231
+ # Response to a successful DescribeDataset request.
232
+ #
233
+ # @!attribute [rw] dataset
234
+ # Meta data for a collection of data for an identity. An identity can
235
+ # have multiple datasets. A dataset can be general or associated with
236
+ # a particular entity in an application (like a saved game). Datasets
237
+ # are automatically created if they don't exist. Data is synced by
238
+ # dataset, and a dataset can hold up to 1MB of key-value pairs.
239
+ # @return [Types::Dataset]
240
+ #
241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeDatasetResponse AWS API Documentation
242
+ #
243
+ class DescribeDatasetResponse < Struct.new(
244
+ :dataset)
245
+ include Aws::Structure
246
+ end
229
247
 
230
- # Response to a successful DescribeIdentityPoolUsage request.
231
- # @!attribute [rw] identity_pool_usage
232
- # Information about the usage of the identity pool.
233
- # @return [Types::IdentityPoolUsage]
234
- class DescribeIdentityPoolUsageResponse < Struct.new(
235
- :identity_pool_usage)
236
- include Aws::Structure
237
- end
248
+ # A request for usage information about the identity pool.
249
+ #
250
+ # @note When making an API call, you may pass DescribeIdentityPoolUsageRequest
251
+ # data as a hash:
252
+ #
253
+ # {
254
+ # identity_pool_id: "IdentityPoolId", # required
255
+ # }
256
+ #
257
+ # @!attribute [rw] identity_pool_id
258
+ # A name-spaced GUID (for example,
259
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
260
+ # Cognito. GUID generation is unique within a region.
261
+ # @return [String]
262
+ #
263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityPoolUsageRequest AWS API Documentation
264
+ #
265
+ class DescribeIdentityPoolUsageRequest < Struct.new(
266
+ :identity_pool_id)
267
+ include Aws::Structure
268
+ end
238
269
 
239
- # A request for information about the usage of an identity pool.
240
- # @note When making an API call, pass DescribeIdentityUsageRequest
241
- # data as a hash:
242
- #
243
- # {
244
- # identity_pool_id: "IdentityPoolId", # required
245
- # identity_id: "IdentityId", # required
246
- # }
247
- # @!attribute [rw] identity_pool_id
248
- # A name-spaced GUID (for example,
249
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
250
- # Cognito. GUID generation is unique within a region.
251
- # @return [String]
252
- #
253
- # @!attribute [rw] 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
- # @return [String]
258
- class DescribeIdentityUsageRequest < Struct.new(
259
- :identity_pool_id,
260
- :identity_id)
261
- include Aws::Structure
262
- end
270
+ # Response to a successful DescribeIdentityPoolUsage request.
271
+ #
272
+ # @!attribute [rw] identity_pool_usage
273
+ # Information about the usage of the identity pool.
274
+ # @return [Types::IdentityPoolUsage]
275
+ #
276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityPoolUsageResponse AWS API Documentation
277
+ #
278
+ class DescribeIdentityPoolUsageResponse < Struct.new(
279
+ :identity_pool_usage)
280
+ include Aws::Structure
281
+ end
263
282
 
264
- # The response to a successful DescribeIdentityUsage request.
265
- # @!attribute [rw] identity_usage
266
- # Usage information for the identity.
267
- # @return [Types::IdentityUsage]
268
- class DescribeIdentityUsageResponse < Struct.new(
269
- :identity_usage)
270
- include Aws::Structure
271
- end
283
+ # A request for information about the usage of an identity pool.
284
+ #
285
+ # @note When making an API call, you may pass DescribeIdentityUsageRequest
286
+ # data as a hash:
287
+ #
288
+ # {
289
+ # identity_pool_id: "IdentityPoolId", # required
290
+ # identity_id: "IdentityId", # required
291
+ # }
292
+ #
293
+ # @!attribute [rw] identity_pool_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 [String]
298
+ #
299
+ # @!attribute [rw] identity_id
300
+ # A name-spaced GUID (for example,
301
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
302
+ # Cognito. GUID generation is unique within a region.
303
+ # @return [String]
304
+ #
305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityUsageRequest AWS API Documentation
306
+ #
307
+ class DescribeIdentityUsageRequest < Struct.new(
308
+ :identity_pool_id,
309
+ :identity_id)
310
+ include Aws::Structure
311
+ end
272
312
 
273
- # The input for the GetBulkPublishDetails operation.
274
- # @note When making an API call, pass GetBulkPublishDetailsRequest
275
- # data as a hash:
276
- #
277
- # {
278
- # identity_pool_id: "IdentityPoolId", # required
279
- # }
280
- # @!attribute [rw] identity_pool_id
281
- # A name-spaced GUID (for example,
282
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
283
- # Cognito. GUID generation is unique within a region.
284
- # @return [String]
285
- class GetBulkPublishDetailsRequest < Struct.new(
286
- :identity_pool_id)
287
- include Aws::Structure
288
- end
313
+ # The response to a successful DescribeIdentityUsage request.
314
+ #
315
+ # @!attribute [rw] identity_usage
316
+ # Usage information for the identity.
317
+ # @return [Types::IdentityUsage]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/DescribeIdentityUsageResponse AWS API Documentation
320
+ #
321
+ class DescribeIdentityUsageResponse < Struct.new(
322
+ :identity_usage)
323
+ include Aws::Structure
324
+ end
289
325
 
290
- # The output for the GetBulkPublishDetails operation.
291
- # @!attribute [rw] identity_pool_id
292
- # A name-spaced GUID (for example,
293
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
294
- # Cognito. GUID generation is unique within a region.
295
- # @return [String]
296
- #
297
- # @!attribute [rw] bulk_publish_start_time
298
- # The date/time at which the last bulk publish was initiated.
299
- # @return [Time]
300
- #
301
- # @!attribute [rw] bulk_publish_complete_time
302
- # If BulkPublishStatus is SUCCEEDED, the time the last bulk publish
303
- # operation completed.
304
- # @return [Time]
305
- #
306
- # @!attribute [rw] bulk_publish_status
307
- # Status of the last bulk publish operation, valid values are: NOT\_STARTED - No bulk publish has been requested for this identity
308
- # pool
309
- #
310
- # IN\_PROGRESS - Data is being published to the configured stream
311
- #
312
- # SUCCEEDED - All data for the identity pool has been published to the
313
- # configured stream
314
- #
315
- # FAILED - Some portion of the data has failed to publish, check
316
- # FailureMessage for the cause.
317
- # @return [String]
318
- #
319
- # @!attribute [rw] failure_message
320
- # If BulkPublishStatus is FAILED this field will contain the error
321
- # message that caused the bulk publish to fail.
322
- # @return [String]
323
- class GetBulkPublishDetailsResponse < Struct.new(
324
- :identity_pool_id,
325
- :bulk_publish_start_time,
326
- :bulk_publish_complete_time,
327
- :bulk_publish_status,
328
- :failure_message)
329
- include Aws::Structure
330
- end
326
+ # The input for the GetBulkPublishDetails operation.
327
+ #
328
+ # @note When making an API call, you may pass GetBulkPublishDetailsRequest
329
+ # data as a hash:
330
+ #
331
+ # {
332
+ # identity_pool_id: "IdentityPoolId", # required
333
+ # }
334
+ #
335
+ # @!attribute [rw] identity_pool_id
336
+ # A name-spaced GUID (for example,
337
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
338
+ # Cognito. GUID generation is unique within a region.
339
+ # @return [String]
340
+ #
341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetBulkPublishDetailsRequest AWS API Documentation
342
+ #
343
+ class GetBulkPublishDetailsRequest < Struct.new(
344
+ :identity_pool_id)
345
+ include Aws::Structure
346
+ end
331
347
 
332
- # A request for a list of the configured Cognito Events
333
- # @note When making an API call, pass GetCognitoEventsRequest
334
- # data as a hash:
335
- #
336
- # {
337
- # identity_pool_id: "IdentityPoolId", # required
338
- # }
339
- # @!attribute [rw] identity_pool_id
340
- # The Cognito Identity Pool ID for the request
341
- # @return [String]
342
- class GetCognitoEventsRequest < Struct.new(
343
- :identity_pool_id)
344
- include Aws::Structure
345
- end
348
+ # The output for the GetBulkPublishDetails operation.
349
+ #
350
+ # @!attribute [rw] identity_pool_id
351
+ # A name-spaced GUID (for example,
352
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
353
+ # Cognito. GUID generation is unique within a region.
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] bulk_publish_start_time
357
+ # The date/time at which the last bulk publish was initiated.
358
+ # @return [Time]
359
+ #
360
+ # @!attribute [rw] bulk_publish_complete_time
361
+ # If BulkPublishStatus is SUCCEEDED, the time the last bulk publish
362
+ # operation completed.
363
+ # @return [Time]
364
+ #
365
+ # @!attribute [rw] bulk_publish_status
366
+ # Status of the last bulk publish operation, valid values are: NOT\_STARTED - No bulk publish has been requested for this identity
367
+ # pool
368
+ #
369
+ # IN\_PROGRESS - Data is being published to the configured stream
370
+ #
371
+ # SUCCEEDED - All data for the identity pool has been published to the
372
+ # configured stream
373
+ #
374
+ # FAILED - Some portion of the data has failed to publish, check
375
+ # FailureMessage for the cause.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] failure_message
379
+ # If BulkPublishStatus is FAILED this field will contain the error
380
+ # message that caused the bulk publish to fail.
381
+ # @return [String]
382
+ #
383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetBulkPublishDetailsResponse AWS API Documentation
384
+ #
385
+ class GetBulkPublishDetailsResponse < Struct.new(
386
+ :identity_pool_id,
387
+ :bulk_publish_start_time,
388
+ :bulk_publish_complete_time,
389
+ :bulk_publish_status,
390
+ :failure_message)
391
+ include Aws::Structure
392
+ end
346
393
 
347
- # The response from the GetCognitoEvents request
348
- # @!attribute [rw] events
349
- # The Cognito Events returned from the GetCognitoEvents request
350
- # @return [Hash<String,String>]
351
- class GetCognitoEventsResponse < Struct.new(
352
- :events)
353
- include Aws::Structure
354
- end
394
+ # A request for a list of the configured Cognito Events
395
+ #
396
+ # @note When making an API call, you may pass GetCognitoEventsRequest
397
+ # data as a hash:
398
+ #
399
+ # {
400
+ # identity_pool_id: "IdentityPoolId", # required
401
+ # }
402
+ #
403
+ # @!attribute [rw] identity_pool_id
404
+ # The Cognito Identity Pool ID for the request
405
+ # @return [String]
406
+ #
407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetCognitoEventsRequest AWS API Documentation
408
+ #
409
+ class GetCognitoEventsRequest < Struct.new(
410
+ :identity_pool_id)
411
+ include Aws::Structure
412
+ end
355
413
 
356
- # The input for the GetIdentityPoolConfiguration operation.
357
- # @note When making an API call, pass GetIdentityPoolConfigurationRequest
358
- # data as a hash:
359
- #
360
- # {
361
- # identity_pool_id: "IdentityPoolId", # required
362
- # }
363
- # @!attribute [rw] identity_pool_id
364
- # A name-spaced GUID (for example,
365
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
366
- # Cognito. This is the ID of the pool for which to return a
367
- # configuration.
368
- # @return [String]
369
- class GetIdentityPoolConfigurationRequest < Struct.new(
370
- :identity_pool_id)
371
- include Aws::Structure
372
- end
414
+ # The response from the GetCognitoEvents request
415
+ #
416
+ # @!attribute [rw] events
417
+ # The Cognito Events returned from the GetCognitoEvents request
418
+ # @return [Hash<String,String>]
419
+ #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetCognitoEventsResponse AWS API Documentation
421
+ #
422
+ class GetCognitoEventsResponse < Struct.new(
423
+ :events)
424
+ include Aws::Structure
425
+ end
373
426
 
374
- # The output for the GetIdentityPoolConfiguration operation.
375
- # @!attribute [rw] identity_pool_id
376
- # A name-spaced GUID (for example,
377
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
378
- # Cognito.
379
- # @return [String]
380
- #
381
- # @!attribute [rw] push_sync
382
- # Options to apply to this identity pool for push synchronization.
383
- # @return [Types::PushSync]
384
- #
385
- # @!attribute [rw] cognito_streams
386
- # Options to apply to this identity pool for Amazon Cognito streams.
387
- # @return [Types::CognitoStreams]
388
- class GetIdentityPoolConfigurationResponse < Struct.new(
389
- :identity_pool_id,
390
- :push_sync,
391
- :cognito_streams)
392
- include Aws::Structure
393
- end
427
+ # The input for the GetIdentityPoolConfiguration operation.
428
+ #
429
+ # @note When making an API call, you may pass GetIdentityPoolConfigurationRequest
430
+ # data as a hash:
431
+ #
432
+ # {
433
+ # identity_pool_id: "IdentityPoolId", # required
434
+ # }
435
+ #
436
+ # @!attribute [rw] identity_pool_id
437
+ # A name-spaced GUID (for example,
438
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
439
+ # Cognito. This is the ID of the pool for which to return a
440
+ # configuration.
441
+ # @return [String]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetIdentityPoolConfigurationRequest AWS API Documentation
444
+ #
445
+ class GetIdentityPoolConfigurationRequest < Struct.new(
446
+ :identity_pool_id)
447
+ include Aws::Structure
448
+ end
394
449
 
395
- # Usage information for the identity pool.
396
- # @!attribute [rw] identity_pool_id
397
- # A name-spaced GUID (for example,
398
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
399
- # Cognito. GUID generation is unique within a region.
400
- # @return [String]
401
- #
402
- # @!attribute [rw] sync_sessions_count
403
- # Number of sync sessions for the identity pool.
404
- # @return [Integer]
405
- #
406
- # @!attribute [rw] data_storage
407
- # Data storage information for the identity pool.
408
- # @return [Integer]
409
- #
410
- # @!attribute [rw] last_modified_date
411
- # Date on which the identity pool was last modified.
412
- # @return [Time]
413
- class IdentityPoolUsage < Struct.new(
414
- :identity_pool_id,
415
- :sync_sessions_count,
416
- :data_storage,
417
- :last_modified_date)
418
- include Aws::Structure
419
- end
450
+ # The output for the GetIdentityPoolConfiguration operation.
451
+ #
452
+ # @!attribute [rw] identity_pool_id
453
+ # A name-spaced GUID (for example,
454
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
455
+ # Cognito.
456
+ # @return [String]
457
+ #
458
+ # @!attribute [rw] push_sync
459
+ # Options to apply to this identity pool for push synchronization.
460
+ # @return [Types::PushSync]
461
+ #
462
+ # @!attribute [rw] cognito_streams
463
+ # Options to apply to this identity pool for Amazon Cognito streams.
464
+ # @return [Types::CognitoStreams]
465
+ #
466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/GetIdentityPoolConfigurationResponse AWS API Documentation
467
+ #
468
+ class GetIdentityPoolConfigurationResponse < Struct.new(
469
+ :identity_pool_id,
470
+ :push_sync,
471
+ :cognito_streams)
472
+ include Aws::Structure
473
+ end
420
474
 
421
- # Usage information for the identity.
422
- # @!attribute [rw] identity_id
423
- # A name-spaced GUID (for example,
424
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
425
- # Cognito. GUID generation is unique within a region.
426
- # @return [String]
427
- #
428
- # @!attribute [rw] identity_pool_id
429
- # A name-spaced GUID (for example,
430
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
431
- # Cognito. GUID generation is unique within a region.
432
- # @return [String]
433
- #
434
- # @!attribute [rw] last_modified_date
435
- # Date on which the identity was last modified.
436
- # @return [Time]
437
- #
438
- # @!attribute [rw] dataset_count
439
- # Number of datasets for the identity.
440
- # @return [Integer]
441
- #
442
- # @!attribute [rw] data_storage
443
- # Total data storage for this identity.
444
- # @return [Integer]
445
- class IdentityUsage < Struct.new(
446
- :identity_id,
447
- :identity_pool_id,
448
- :last_modified_date,
449
- :dataset_count,
450
- :data_storage)
451
- include Aws::Structure
452
- end
475
+ # Usage information for the identity pool.
476
+ #
477
+ # @!attribute [rw] identity_pool_id
478
+ # A name-spaced GUID (for example,
479
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
480
+ # Cognito. GUID generation is unique within a region.
481
+ # @return [String]
482
+ #
483
+ # @!attribute [rw] sync_sessions_count
484
+ # Number of sync sessions for the identity pool.
485
+ # @return [Integer]
486
+ #
487
+ # @!attribute [rw] data_storage
488
+ # Data storage information for the identity pool.
489
+ # @return [Integer]
490
+ #
491
+ # @!attribute [rw] last_modified_date
492
+ # Date on which the identity pool was last modified.
493
+ # @return [Time]
494
+ #
495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/IdentityPoolUsage AWS API Documentation
496
+ #
497
+ class IdentityPoolUsage < Struct.new(
498
+ :identity_pool_id,
499
+ :sync_sessions_count,
500
+ :data_storage,
501
+ :last_modified_date)
502
+ include Aws::Structure
503
+ end
453
504
 
454
- # Request for a list of datasets for an identity.
455
- # @note When making an API call, pass ListDatasetsRequest
456
- # data as a hash:
457
- #
458
- # {
459
- # identity_pool_id: "IdentityPoolId", # required
460
- # identity_id: "IdentityId", # required
461
- # next_token: "String",
462
- # max_results: 1,
463
- # }
464
- # @!attribute [rw] identity_pool_id
465
- # A name-spaced GUID (for example,
466
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
467
- # Cognito. GUID generation is unique within a region.
468
- # @return [String]
469
- #
470
- # @!attribute [rw] identity_id
471
- # A name-spaced GUID (for example,
472
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
473
- # Cognito. GUID generation is unique within a region.
474
- # @return [String]
475
- #
476
- # @!attribute [rw] next_token
477
- # A pagination token for obtaining the next page of results.
478
- # @return [String]
479
- #
480
- # @!attribute [rw] max_results
481
- # The maximum number of results to be returned.
482
- # @return [Integer]
483
- class ListDatasetsRequest < Struct.new(
484
- :identity_pool_id,
485
- :identity_id,
486
- :next_token,
487
- :max_results)
488
- include Aws::Structure
489
- end
505
+ # Usage information for the identity.
506
+ #
507
+ # @!attribute [rw] 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
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] identity_pool_id
514
+ # A name-spaced GUID (for example,
515
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
516
+ # Cognito. GUID generation is unique within a region.
517
+ # @return [String]
518
+ #
519
+ # @!attribute [rw] last_modified_date
520
+ # Date on which the identity was last modified.
521
+ # @return [Time]
522
+ #
523
+ # @!attribute [rw] dataset_count
524
+ # Number of datasets for the identity.
525
+ # @return [Integer]
526
+ #
527
+ # @!attribute [rw] data_storage
528
+ # Total data storage for this identity.
529
+ # @return [Integer]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/IdentityUsage AWS API Documentation
532
+ #
533
+ class IdentityUsage < Struct.new(
534
+ :identity_id,
535
+ :identity_pool_id,
536
+ :last_modified_date,
537
+ :dataset_count,
538
+ :data_storage)
539
+ include Aws::Structure
540
+ end
490
541
 
491
- # Returned for a successful ListDatasets request.
492
- # @!attribute [rw] datasets
493
- # A set of datasets.
494
- # @return [Array<Types::Dataset>]
495
- #
496
- # @!attribute [rw] count
497
- # Number of datasets returned.
498
- # @return [Integer]
499
- #
500
- # @!attribute [rw] next_token
501
- # A pagination token for obtaining the next page of results.
502
- # @return [String]
503
- class ListDatasetsResponse < Struct.new(
504
- :datasets,
505
- :count,
506
- :next_token)
507
- include Aws::Structure
508
- end
542
+ # Request for a list of datasets for an identity.
543
+ #
544
+ # @note When making an API call, you may pass ListDatasetsRequest
545
+ # data as a hash:
546
+ #
547
+ # {
548
+ # identity_pool_id: "IdentityPoolId", # required
549
+ # identity_id: "IdentityId", # required
550
+ # next_token: "String",
551
+ # max_results: 1,
552
+ # }
553
+ #
554
+ # @!attribute [rw] identity_pool_id
555
+ # A name-spaced GUID (for example,
556
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
557
+ # Cognito. GUID generation is unique within a region.
558
+ # @return [String]
559
+ #
560
+ # @!attribute [rw] identity_id
561
+ # A name-spaced GUID (for example,
562
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
563
+ # Cognito. GUID generation is unique within a region.
564
+ # @return [String]
565
+ #
566
+ # @!attribute [rw] next_token
567
+ # A pagination token for obtaining the next page of results.
568
+ # @return [String]
569
+ #
570
+ # @!attribute [rw] max_results
571
+ # The maximum number of results to be returned.
572
+ # @return [Integer]
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListDatasetsRequest AWS API Documentation
575
+ #
576
+ class ListDatasetsRequest < Struct.new(
577
+ :identity_pool_id,
578
+ :identity_id,
579
+ :next_token,
580
+ :max_results)
581
+ include Aws::Structure
582
+ end
509
583
 
510
- # A request for usage information on an identity pool.
511
- # @note When making an API call, pass ListIdentityPoolUsageRequest
512
- # data as a hash:
513
- #
514
- # {
515
- # next_token: "String",
516
- # max_results: 1,
517
- # }
518
- # @!attribute [rw] next_token
519
- # A pagination token for obtaining the next page of results.
520
- # @return [String]
521
- #
522
- # @!attribute [rw] max_results
523
- # The maximum number of results to be returned.
524
- # @return [Integer]
525
- class ListIdentityPoolUsageRequest < Struct.new(
526
- :next_token,
527
- :max_results)
528
- include Aws::Structure
529
- end
584
+ # Returned for a successful ListDatasets request.
585
+ #
586
+ # @!attribute [rw] datasets
587
+ # A set of datasets.
588
+ # @return [Array<Types::Dataset>]
589
+ #
590
+ # @!attribute [rw] count
591
+ # Number of datasets returned.
592
+ # @return [Integer]
593
+ #
594
+ # @!attribute [rw] next_token
595
+ # A pagination token for obtaining the next page of results.
596
+ # @return [String]
597
+ #
598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListDatasetsResponse AWS API Documentation
599
+ #
600
+ class ListDatasetsResponse < Struct.new(
601
+ :datasets,
602
+ :count,
603
+ :next_token)
604
+ include Aws::Structure
605
+ end
530
606
 
531
- # Returned for a successful ListIdentityPoolUsage request.
532
- # @!attribute [rw] identity_pool_usages
533
- # Usage information for the identity pools.
534
- # @return [Array<Types::IdentityPoolUsage>]
535
- #
536
- # @!attribute [rw] max_results
537
- # The maximum number of results to be returned.
538
- # @return [Integer]
539
- #
540
- # @!attribute [rw] count
541
- # Total number of identities for the identity pool.
542
- # @return [Integer]
543
- #
544
- # @!attribute [rw] next_token
545
- # A pagination token for obtaining the next page of results.
546
- # @return [String]
547
- class ListIdentityPoolUsageResponse < Struct.new(
548
- :identity_pool_usages,
549
- :max_results,
550
- :count,
551
- :next_token)
552
- include Aws::Structure
553
- end
607
+ # A request for usage information on an identity pool.
608
+ #
609
+ # @note When making an API call, you may pass ListIdentityPoolUsageRequest
610
+ # data as a hash:
611
+ #
612
+ # {
613
+ # next_token: "String",
614
+ # max_results: 1,
615
+ # }
616
+ #
617
+ # @!attribute [rw] next_token
618
+ # A pagination token for obtaining the next page of results.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] max_results
622
+ # The maximum number of results to be returned.
623
+ # @return [Integer]
624
+ #
625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListIdentityPoolUsageRequest AWS API Documentation
626
+ #
627
+ class ListIdentityPoolUsageRequest < Struct.new(
628
+ :next_token,
629
+ :max_results)
630
+ include Aws::Structure
631
+ end
554
632
 
555
- # A request for a list of records.
556
- # @note When making an API call, pass ListRecordsRequest
557
- # data as a hash:
558
- #
559
- # {
560
- # identity_pool_id: "IdentityPoolId", # required
561
- # identity_id: "IdentityId", # required
562
- # dataset_name: "DatasetName", # required
563
- # last_sync_count: 1,
564
- # next_token: "String",
565
- # max_results: 1,
566
- # sync_session_token: "SyncSessionToken",
567
- # }
568
- # @!attribute [rw] identity_pool_id
569
- # A name-spaced GUID (for example,
570
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
571
- # Cognito. GUID generation is unique within a region.
572
- # @return [String]
573
- #
574
- # @!attribute [rw] identity_id
575
- # A name-spaced GUID (for example,
576
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
577
- # Cognito. GUID generation is unique within a region.
578
- # @return [String]
579
- #
580
- # @!attribute [rw] dataset_name
581
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
582
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
583
- # @return [String]
584
- #
585
- # @!attribute [rw] last_sync_count
586
- # The last server sync count for this record.
587
- # @return [Integer]
588
- #
589
- # @!attribute [rw] next_token
590
- # A pagination token for obtaining the next page of results.
591
- # @return [String]
592
- #
593
- # @!attribute [rw] max_results
594
- # The maximum number of results to be returned.
595
- # @return [Integer]
596
- #
597
- # @!attribute [rw] sync_session_token
598
- # A token containing a session ID, identity ID, and expiration.
599
- # @return [String]
600
- class ListRecordsRequest < Struct.new(
601
- :identity_pool_id,
602
- :identity_id,
603
- :dataset_name,
604
- :last_sync_count,
605
- :next_token,
606
- :max_results,
607
- :sync_session_token)
608
- include Aws::Structure
609
- end
633
+ # Returned for a successful ListIdentityPoolUsage request.
634
+ #
635
+ # @!attribute [rw] identity_pool_usages
636
+ # Usage information for the identity pools.
637
+ # @return [Array<Types::IdentityPoolUsage>]
638
+ #
639
+ # @!attribute [rw] max_results
640
+ # The maximum number of results to be returned.
641
+ # @return [Integer]
642
+ #
643
+ # @!attribute [rw] count
644
+ # Total number of identities for the identity pool.
645
+ # @return [Integer]
646
+ #
647
+ # @!attribute [rw] next_token
648
+ # A pagination token for obtaining the next page of results.
649
+ # @return [String]
650
+ #
651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListIdentityPoolUsageResponse AWS API Documentation
652
+ #
653
+ class ListIdentityPoolUsageResponse < Struct.new(
654
+ :identity_pool_usages,
655
+ :max_results,
656
+ :count,
657
+ :next_token)
658
+ include Aws::Structure
659
+ end
610
660
 
611
- # Returned for a successful ListRecordsRequest.
612
- # @!attribute [rw] records
613
- # A list of all records.
614
- # @return [Array<Types::Record>]
615
- #
616
- # @!attribute [rw] next_token
617
- # A pagination token for obtaining the next page of results.
618
- # @return [String]
619
- #
620
- # @!attribute [rw] count
621
- # Total number of records.
622
- # @return [Integer]
623
- #
624
- # @!attribute [rw] dataset_sync_count
625
- # Server sync count for this dataset.
626
- # @return [Integer]
627
- #
628
- # @!attribute [rw] last_modified_by
629
- # The user/device that made the last change to this record.
630
- # @return [String]
631
- #
632
- # @!attribute [rw] merged_dataset_names
633
- # Names of merged datasets.
634
- # @return [Array<String>]
635
- #
636
- # @!attribute [rw] dataset_exists
637
- # Indicates whether the dataset exists.
638
- # @return [Boolean]
639
- #
640
- # @!attribute [rw] dataset_deleted_after_requested_sync_count
641
- # A boolean value specifying whether to delete the dataset locally.
642
- # @return [Boolean]
643
- #
644
- # @!attribute [rw] sync_session_token
645
- # A token containing a session ID, identity ID, and expiration.
646
- # @return [String]
647
- class ListRecordsResponse < Struct.new(
648
- :records,
649
- :next_token,
650
- :count,
651
- :dataset_sync_count,
652
- :last_modified_by,
653
- :merged_dataset_names,
654
- :dataset_exists,
655
- :dataset_deleted_after_requested_sync_count,
656
- :sync_session_token)
657
- include Aws::Structure
658
- end
661
+ # A request for a list of records.
662
+ #
663
+ # @note When making an API call, you may pass ListRecordsRequest
664
+ # data as a hash:
665
+ #
666
+ # {
667
+ # identity_pool_id: "IdentityPoolId", # required
668
+ # identity_id: "IdentityId", # required
669
+ # dataset_name: "DatasetName", # required
670
+ # last_sync_count: 1,
671
+ # next_token: "String",
672
+ # max_results: 1,
673
+ # sync_session_token: "SyncSessionToken",
674
+ # }
675
+ #
676
+ # @!attribute [rw] identity_pool_id
677
+ # A name-spaced GUID (for example,
678
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
679
+ # Cognito. GUID generation is unique within a region.
680
+ # @return [String]
681
+ #
682
+ # @!attribute [rw] identity_id
683
+ # A name-spaced GUID (for example,
684
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
685
+ # Cognito. GUID generation is unique within a region.
686
+ # @return [String]
687
+ #
688
+ # @!attribute [rw] dataset_name
689
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
690
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
691
+ # @return [String]
692
+ #
693
+ # @!attribute [rw] last_sync_count
694
+ # The last server sync count for this record.
695
+ # @return [Integer]
696
+ #
697
+ # @!attribute [rw] next_token
698
+ # A pagination token for obtaining the next page of results.
699
+ # @return [String]
700
+ #
701
+ # @!attribute [rw] max_results
702
+ # The maximum number of results to be returned.
703
+ # @return [Integer]
704
+ #
705
+ # @!attribute [rw] sync_session_token
706
+ # A token containing a session ID, identity ID, and expiration.
707
+ # @return [String]
708
+ #
709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListRecordsRequest AWS API Documentation
710
+ #
711
+ class ListRecordsRequest < Struct.new(
712
+ :identity_pool_id,
713
+ :identity_id,
714
+ :dataset_name,
715
+ :last_sync_count,
716
+ :next_token,
717
+ :max_results,
718
+ :sync_session_token)
719
+ include Aws::Structure
720
+ end
659
721
 
660
- # Configuration options to be applied to the identity pool.
661
- # @note When making an API call, pass PushSync
662
- # data as a hash:
663
- #
664
- # {
665
- # application_arns: ["ApplicationArn"],
666
- # role_arn: "AssumeRoleArn",
667
- # }
668
- # @!attribute [rw] application_arns
669
- # List of SNS platform application ARNs that could be used by clients.
670
- # @return [Array<String>]
671
- #
672
- # @!attribute [rw] role_arn
673
- # A role configured to allow Cognito to call SNS on behalf of the
674
- # developer.
675
- # @return [String]
676
- class PushSync < Struct.new(
677
- :application_arns,
678
- :role_arn)
679
- include Aws::Structure
680
- end
722
+ # Returned for a successful ListRecordsRequest.
723
+ #
724
+ # @!attribute [rw] records
725
+ # A list of all records.
726
+ # @return [Array<Types::Record>]
727
+ #
728
+ # @!attribute [rw] next_token
729
+ # A pagination token for obtaining the next page of results.
730
+ # @return [String]
731
+ #
732
+ # @!attribute [rw] count
733
+ # Total number of records.
734
+ # @return [Integer]
735
+ #
736
+ # @!attribute [rw] dataset_sync_count
737
+ # Server sync count for this dataset.
738
+ # @return [Integer]
739
+ #
740
+ # @!attribute [rw] last_modified_by
741
+ # The user/device that made the last change to this record.
742
+ # @return [String]
743
+ #
744
+ # @!attribute [rw] merged_dataset_names
745
+ # Names of merged datasets.
746
+ # @return [Array<String>]
747
+ #
748
+ # @!attribute [rw] dataset_exists
749
+ # Indicates whether the dataset exists.
750
+ # @return [Boolean]
751
+ #
752
+ # @!attribute [rw] dataset_deleted_after_requested_sync_count
753
+ # A boolean value specifying whether to delete the dataset locally.
754
+ # @return [Boolean]
755
+ #
756
+ # @!attribute [rw] sync_session_token
757
+ # A token containing a session ID, identity ID, and expiration.
758
+ # @return [String]
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/ListRecordsResponse AWS API Documentation
761
+ #
762
+ class ListRecordsResponse < Struct.new(
763
+ :records,
764
+ :next_token,
765
+ :count,
766
+ :dataset_sync_count,
767
+ :last_modified_by,
768
+ :merged_dataset_names,
769
+ :dataset_exists,
770
+ :dataset_deleted_after_requested_sync_count,
771
+ :sync_session_token)
772
+ include Aws::Structure
773
+ end
681
774
 
682
- # The basic data structure of a dataset.
683
- # @!attribute [rw] key
684
- # The key for the record.
685
- # @return [String]
686
- #
687
- # @!attribute [rw] value
688
- # The value for the record.
689
- # @return [String]
690
- #
691
- # @!attribute [rw] sync_count
692
- # The server sync count for this record.
693
- # @return [Integer]
694
- #
695
- # @!attribute [rw] last_modified_date
696
- # The date on which the record was last modified.
697
- # @return [Time]
698
- #
699
- # @!attribute [rw] last_modified_by
700
- # The user/device that made the last change to this record.
701
- # @return [String]
702
- #
703
- # @!attribute [rw] device_last_modified_date
704
- # The last modified date of the client device.
705
- # @return [Time]
706
- class Record < Struct.new(
707
- :key,
708
- :value,
709
- :sync_count,
710
- :last_modified_date,
711
- :last_modified_by,
712
- :device_last_modified_date)
713
- include Aws::Structure
714
- end
775
+ # Configuration options to be applied to the identity pool.
776
+ #
777
+ # @note When making an API call, you may pass PushSync
778
+ # data as a hash:
779
+ #
780
+ # {
781
+ # application_arns: ["ApplicationArn"],
782
+ # role_arn: "AssumeRoleArn",
783
+ # }
784
+ #
785
+ # @!attribute [rw] application_arns
786
+ # List of SNS platform application ARNs that could be used by clients.
787
+ # @return [Array<String>]
788
+ #
789
+ # @!attribute [rw] role_arn
790
+ # A role configured to allow Cognito to call SNS on behalf of the
791
+ # developer.
792
+ # @return [String]
793
+ #
794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/PushSync AWS API Documentation
795
+ #
796
+ class PushSync < Struct.new(
797
+ :application_arns,
798
+ :role_arn)
799
+ include Aws::Structure
800
+ end
715
801
 
716
- # An update operation for a record.
717
- # @note When making an API call, pass RecordPatch
718
- # data as a hash:
719
- #
720
- # {
721
- # op: "replace", # required, accepts replace, remove
722
- # key: "RecordKey", # required
723
- # value: "RecordValue",
724
- # sync_count: 1, # required
725
- # device_last_modified_date: Time.now,
726
- # }
727
- # @!attribute [rw] op
728
- # An operation, either replace or remove.
729
- # @return [String]
730
- #
731
- # @!attribute [rw] key
732
- # The key associated with the record patch.
733
- # @return [String]
734
- #
735
- # @!attribute [rw] value
736
- # The value associated with the record patch.
737
- # @return [String]
738
- #
739
- # @!attribute [rw] sync_count
740
- # Last known server sync count for this record. Set to 0 if unknown.
741
- # @return [Integer]
742
- #
743
- # @!attribute [rw] device_last_modified_date
744
- # The last modified date of the client device.
745
- # @return [Time]
746
- class RecordPatch < Struct.new(
747
- :op,
748
- :key,
749
- :value,
750
- :sync_count,
751
- :device_last_modified_date)
752
- include Aws::Structure
753
- end
802
+ # The basic data structure of a dataset.
803
+ #
804
+ # @!attribute [rw] key
805
+ # The key for the record.
806
+ # @return [String]
807
+ #
808
+ # @!attribute [rw] value
809
+ # The value for the record.
810
+ # @return [String]
811
+ #
812
+ # @!attribute [rw] sync_count
813
+ # The server sync count for this record.
814
+ # @return [Integer]
815
+ #
816
+ # @!attribute [rw] last_modified_date
817
+ # The date on which the record was last modified.
818
+ # @return [Time]
819
+ #
820
+ # @!attribute [rw] last_modified_by
821
+ # The user/device that made the last change to this record.
822
+ # @return [String]
823
+ #
824
+ # @!attribute [rw] device_last_modified_date
825
+ # The last modified date of the client device.
826
+ # @return [Time]
827
+ #
828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/Record AWS API Documentation
829
+ #
830
+ class Record < Struct.new(
831
+ :key,
832
+ :value,
833
+ :sync_count,
834
+ :last_modified_date,
835
+ :last_modified_by,
836
+ :device_last_modified_date)
837
+ include Aws::Structure
838
+ end
754
839
 
755
- # A request to RegisterDevice.
756
- # @note When making an API call, pass RegisterDeviceRequest
757
- # data as a hash:
758
- #
759
- # {
760
- # identity_pool_id: "IdentityPoolId", # required
761
- # identity_id: "IdentityId", # required
762
- # platform: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM, ADM
763
- # token: "PushToken", # required
764
- # }
765
- # @!attribute [rw] identity_pool_id
766
- # A name-spaced GUID (for example,
767
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
768
- # Cognito. Here, the ID of the pool that the identity belongs to.
769
- # @return [String]
770
- #
771
- # @!attribute [rw] identity_id
772
- # The unique ID for this identity.
773
- # @return [String]
774
- #
775
- # @!attribute [rw] platform
776
- # The SNS platform type (e.g. GCM, SDM, APNS, APNS\_SANDBOX).
777
- # @return [String]
778
- #
779
- # @!attribute [rw] token
780
- # The push token.
781
- # @return [String]
782
- class RegisterDeviceRequest < Struct.new(
783
- :identity_pool_id,
784
- :identity_id,
785
- :platform,
786
- :token)
787
- include Aws::Structure
788
- end
840
+ # An update operation for a record.
841
+ #
842
+ # @note When making an API call, you may pass RecordPatch
843
+ # data as a hash:
844
+ #
845
+ # {
846
+ # op: "replace", # required, accepts replace, remove
847
+ # key: "RecordKey", # required
848
+ # value: "RecordValue",
849
+ # sync_count: 1, # required
850
+ # device_last_modified_date: Time.now,
851
+ # }
852
+ #
853
+ # @!attribute [rw] op
854
+ # An operation, either replace or remove.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] key
858
+ # The key associated with the record patch.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] value
862
+ # The value associated with the record patch.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] sync_count
866
+ # Last known server sync count for this record. Set to 0 if unknown.
867
+ # @return [Integer]
868
+ #
869
+ # @!attribute [rw] device_last_modified_date
870
+ # The last modified date of the client device.
871
+ # @return [Time]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RecordPatch AWS API Documentation
874
+ #
875
+ class RecordPatch < Struct.new(
876
+ :op,
877
+ :key,
878
+ :value,
879
+ :sync_count,
880
+ :device_last_modified_date)
881
+ include Aws::Structure
882
+ end
789
883
 
790
- # Response to a RegisterDevice request.
791
- # @!attribute [rw] device_id
792
- # The unique ID generated for this device by Cognito.
793
- # @return [String]
794
- class RegisterDeviceResponse < Struct.new(
795
- :device_id)
796
- include Aws::Structure
797
- end
884
+ # A request to RegisterDevice.
885
+ #
886
+ # @note When making an API call, you may pass RegisterDeviceRequest
887
+ # data as a hash:
888
+ #
889
+ # {
890
+ # identity_pool_id: "IdentityPoolId", # required
891
+ # identity_id: "IdentityId", # required
892
+ # platform: "APNS", # required, accepts APNS, APNS_SANDBOX, GCM, ADM
893
+ # token: "PushToken", # required
894
+ # }
895
+ #
896
+ # @!attribute [rw] identity_pool_id
897
+ # A name-spaced GUID (for example,
898
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
899
+ # Cognito. Here, the ID of the pool that the identity belongs to.
900
+ # @return [String]
901
+ #
902
+ # @!attribute [rw] identity_id
903
+ # The unique ID for this identity.
904
+ # @return [String]
905
+ #
906
+ # @!attribute [rw] platform
907
+ # The SNS platform type (e.g. GCM, SDM, APNS, APNS\_SANDBOX).
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] token
911
+ # The push token.
912
+ # @return [String]
913
+ #
914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RegisterDeviceRequest AWS API Documentation
915
+ #
916
+ class RegisterDeviceRequest < Struct.new(
917
+ :identity_pool_id,
918
+ :identity_id,
919
+ :platform,
920
+ :token)
921
+ include Aws::Structure
922
+ end
798
923
 
799
- # A request to configure Cognito Events"
800
- #
801
- # "
802
- # @note When making an API call, pass SetCognitoEventsRequest
803
- # data as a hash:
804
- #
805
- # {
806
- # identity_pool_id: "IdentityPoolId", # required
807
- # events: { # required
808
- # "CognitoEventType" => "LambdaFunctionArn",
809
- # },
810
- # }
811
- # @!attribute [rw] identity_pool_id
812
- # The Cognito Identity Pool to use when configuring Cognito Events
813
- # @return [String]
814
- #
815
- # @!attribute [rw] events
816
- # The events to configure
817
- # @return [Hash<String,String>]
818
- class SetCognitoEventsRequest < Struct.new(
819
- :identity_pool_id,
820
- :events)
821
- include Aws::Structure
822
- end
924
+ # Response to a RegisterDevice request.
925
+ #
926
+ # @!attribute [rw] device_id
927
+ # The unique ID generated for this device by Cognito.
928
+ # @return [String]
929
+ #
930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/RegisterDeviceResponse AWS API Documentation
931
+ #
932
+ class RegisterDeviceResponse < Struct.new(
933
+ :device_id)
934
+ include Aws::Structure
935
+ end
823
936
 
824
- # The input for the SetIdentityPoolConfiguration operation.
825
- # @note When making an API call, pass SetIdentityPoolConfigurationRequest
826
- # data as a hash:
827
- #
828
- # {
829
- # identity_pool_id: "IdentityPoolId", # required
830
- # push_sync: {
831
- # application_arns: ["ApplicationArn"],
832
- # role_arn: "AssumeRoleArn",
833
- # },
834
- # cognito_streams: {
835
- # stream_name: "StreamName",
836
- # role_arn: "AssumeRoleArn",
837
- # streaming_status: "ENABLED", # accepts ENABLED, DISABLED
838
- # },
839
- # }
840
- # @!attribute [rw] identity_pool_id
841
- # A name-spaced GUID (for example,
842
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
843
- # Cognito. This is the ID of the pool to modify.
844
- # @return [String]
845
- #
846
- # @!attribute [rw] push_sync
847
- # Options to apply to this identity pool for push synchronization.
848
- # @return [Types::PushSync]
849
- #
850
- # @!attribute [rw] cognito_streams
851
- # Options to apply to this identity pool for Amazon Cognito streams.
852
- # @return [Types::CognitoStreams]
853
- class SetIdentityPoolConfigurationRequest < Struct.new(
854
- :identity_pool_id,
855
- :push_sync,
856
- :cognito_streams)
857
- include Aws::Structure
858
- end
937
+ # A request to configure Cognito Events"
938
+ #
939
+ # "
940
+ #
941
+ # @note When making an API call, you may pass SetCognitoEventsRequest
942
+ # data as a hash:
943
+ #
944
+ # {
945
+ # identity_pool_id: "IdentityPoolId", # required
946
+ # events: { # required
947
+ # "CognitoEventType" => "LambdaFunctionArn",
948
+ # },
949
+ # }
950
+ #
951
+ # @!attribute [rw] identity_pool_id
952
+ # The Cognito Identity Pool to use when configuring Cognito Events
953
+ # @return [String]
954
+ #
955
+ # @!attribute [rw] events
956
+ # The events to configure
957
+ # @return [Hash<String,String>]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetCognitoEventsRequest AWS API Documentation
960
+ #
961
+ class SetCognitoEventsRequest < Struct.new(
962
+ :identity_pool_id,
963
+ :events)
964
+ include Aws::Structure
965
+ end
859
966
 
860
- # The output for the SetIdentityPoolConfiguration operation
861
- # @!attribute [rw] identity_pool_id
862
- # A name-spaced GUID (for example,
863
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
864
- # Cognito.
865
- # @return [String]
866
- #
867
- # @!attribute [rw] push_sync
868
- # Options to apply to this identity pool for push synchronization.
869
- # @return [Types::PushSync]
870
- #
871
- # @!attribute [rw] cognito_streams
872
- # Options to apply to this identity pool for Amazon Cognito streams.
873
- # @return [Types::CognitoStreams]
874
- class SetIdentityPoolConfigurationResponse < Struct.new(
875
- :identity_pool_id,
876
- :push_sync,
877
- :cognito_streams)
878
- include Aws::Structure
879
- end
967
+ # The input for the SetIdentityPoolConfiguration operation.
968
+ #
969
+ # @note When making an API call, you may pass SetIdentityPoolConfigurationRequest
970
+ # data as a hash:
971
+ #
972
+ # {
973
+ # identity_pool_id: "IdentityPoolId", # required
974
+ # push_sync: {
975
+ # application_arns: ["ApplicationArn"],
976
+ # role_arn: "AssumeRoleArn",
977
+ # },
978
+ # cognito_streams: {
979
+ # stream_name: "StreamName",
980
+ # role_arn: "AssumeRoleArn",
981
+ # streaming_status: "ENABLED", # accepts ENABLED, DISABLED
982
+ # },
983
+ # }
984
+ #
985
+ # @!attribute [rw] identity_pool_id
986
+ # A name-spaced GUID (for example,
987
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
988
+ # Cognito. This is the ID of the pool to modify.
989
+ # @return [String]
990
+ #
991
+ # @!attribute [rw] push_sync
992
+ # Options to apply to this identity pool for push synchronization.
993
+ # @return [Types::PushSync]
994
+ #
995
+ # @!attribute [rw] cognito_streams
996
+ # Options to apply to this identity pool for Amazon Cognito streams.
997
+ # @return [Types::CognitoStreams]
998
+ #
999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetIdentityPoolConfigurationRequest AWS API Documentation
1000
+ #
1001
+ class SetIdentityPoolConfigurationRequest < Struct.new(
1002
+ :identity_pool_id,
1003
+ :push_sync,
1004
+ :cognito_streams)
1005
+ include Aws::Structure
1006
+ end
880
1007
 
881
- # A request to SubscribeToDatasetRequest.
882
- # @note When making an API call, pass SubscribeToDatasetRequest
883
- # data as a hash:
884
- #
885
- # {
886
- # identity_pool_id: "IdentityPoolId", # required
887
- # identity_id: "IdentityId", # required
888
- # dataset_name: "DatasetName", # required
889
- # device_id: "DeviceId", # required
890
- # }
891
- # @!attribute [rw] identity_pool_id
892
- # A name-spaced GUID (for example,
893
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
894
- # Cognito. The ID of the pool to which the identity belongs.
895
- # @return [String]
896
- #
897
- # @!attribute [rw] identity_id
898
- # Unique ID for this identity.
899
- # @return [String]
900
- #
901
- # @!attribute [rw] dataset_name
902
- # The name of the dataset to subcribe to.
903
- # @return [String]
904
- #
905
- # @!attribute [rw] device_id
906
- # The unique ID generated for this device by Cognito.
907
- # @return [String]
908
- class SubscribeToDatasetRequest < Struct.new(
909
- :identity_pool_id,
910
- :identity_id,
911
- :dataset_name,
912
- :device_id)
913
- include Aws::Structure
914
- end
1008
+ # The output for the SetIdentityPoolConfiguration operation
1009
+ #
1010
+ # @!attribute [rw] identity_pool_id
1011
+ # A name-spaced GUID (for example,
1012
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
1013
+ # Cognito.
1014
+ # @return [String]
1015
+ #
1016
+ # @!attribute [rw] push_sync
1017
+ # Options to apply to this identity pool for push synchronization.
1018
+ # @return [Types::PushSync]
1019
+ #
1020
+ # @!attribute [rw] cognito_streams
1021
+ # Options to apply to this identity pool for Amazon Cognito streams.
1022
+ # @return [Types::CognitoStreams]
1023
+ #
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SetIdentityPoolConfigurationResponse AWS API Documentation
1025
+ #
1026
+ class SetIdentityPoolConfigurationResponse < Struct.new(
1027
+ :identity_pool_id,
1028
+ :push_sync,
1029
+ :cognito_streams)
1030
+ include Aws::Structure
1031
+ end
915
1032
 
916
- # Response to a SubscribeToDataset request.
917
- class SubscribeToDatasetResponse < Aws::EmptyStructure; end
1033
+ # A request to SubscribeToDatasetRequest.
1034
+ #
1035
+ # @note When making an API call, you may pass SubscribeToDatasetRequest
1036
+ # data as a hash:
1037
+ #
1038
+ # {
1039
+ # identity_pool_id: "IdentityPoolId", # required
1040
+ # identity_id: "IdentityId", # required
1041
+ # dataset_name: "DatasetName", # required
1042
+ # device_id: "DeviceId", # required
1043
+ # }
1044
+ #
1045
+ # @!attribute [rw] identity_pool_id
1046
+ # A name-spaced GUID (for example,
1047
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
1048
+ # Cognito. The ID of the pool to which the identity belongs.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] identity_id
1052
+ # Unique ID for this identity.
1053
+ # @return [String]
1054
+ #
1055
+ # @!attribute [rw] dataset_name
1056
+ # The name of the dataset to subcribe to.
1057
+ # @return [String]
1058
+ #
1059
+ # @!attribute [rw] device_id
1060
+ # The unique ID generated for this device by Cognito.
1061
+ # @return [String]
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SubscribeToDatasetRequest AWS API Documentation
1064
+ #
1065
+ class SubscribeToDatasetRequest < Struct.new(
1066
+ :identity_pool_id,
1067
+ :identity_id,
1068
+ :dataset_name,
1069
+ :device_id)
1070
+ include Aws::Structure
1071
+ end
918
1072
 
919
- # A request to UnsubscribeFromDataset.
920
- # @note When making an API call, pass UnsubscribeFromDatasetRequest
921
- # data as a hash:
922
- #
923
- # {
924
- # identity_pool_id: "IdentityPoolId", # required
925
- # identity_id: "IdentityId", # required
926
- # dataset_name: "DatasetName", # required
927
- # device_id: "DeviceId", # required
928
- # }
929
- # @!attribute [rw] identity_pool_id
930
- # A name-spaced GUID (for example,
931
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
932
- # Cognito. The ID of the pool to which this identity belongs.
933
- # @return [String]
934
- #
935
- # @!attribute [rw] identity_id
936
- # Unique ID for this identity.
937
- # @return [String]
938
- #
939
- # @!attribute [rw] dataset_name
940
- # The name of the dataset from which to unsubcribe.
941
- # @return [String]
942
- #
943
- # @!attribute [rw] device_id
944
- # The unique ID generated for this device by Cognito.
945
- # @return [String]
946
- class UnsubscribeFromDatasetRequest < Struct.new(
947
- :identity_pool_id,
948
- :identity_id,
949
- :dataset_name,
950
- :device_id)
951
- include Aws::Structure
952
- end
1073
+ # Response to a SubscribeToDataset request.
1074
+ #
1075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/SubscribeToDatasetResponse AWS API Documentation
1076
+ #
1077
+ class SubscribeToDatasetResponse < Aws::EmptyStructure; end
953
1078
 
954
- # Response to an UnsubscribeFromDataset request.
955
- class UnsubscribeFromDatasetResponse < Aws::EmptyStructure; end
1079
+ # A request to UnsubscribeFromDataset.
1080
+ #
1081
+ # @note When making an API call, you may pass UnsubscribeFromDatasetRequest
1082
+ # data as a hash:
1083
+ #
1084
+ # {
1085
+ # identity_pool_id: "IdentityPoolId", # required
1086
+ # identity_id: "IdentityId", # required
1087
+ # dataset_name: "DatasetName", # required
1088
+ # device_id: "DeviceId", # required
1089
+ # }
1090
+ #
1091
+ # @!attribute [rw] identity_pool_id
1092
+ # A name-spaced GUID (for example,
1093
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
1094
+ # Cognito. The ID of the pool to which this identity belongs.
1095
+ # @return [String]
1096
+ #
1097
+ # @!attribute [rw] identity_id
1098
+ # Unique ID for this identity.
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] dataset_name
1102
+ # The name of the dataset from which to unsubcribe.
1103
+ # @return [String]
1104
+ #
1105
+ # @!attribute [rw] device_id
1106
+ # The unique ID generated for this device by Cognito.
1107
+ # @return [String]
1108
+ #
1109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDatasetRequest AWS API Documentation
1110
+ #
1111
+ class UnsubscribeFromDatasetRequest < Struct.new(
1112
+ :identity_pool_id,
1113
+ :identity_id,
1114
+ :dataset_name,
1115
+ :device_id)
1116
+ include Aws::Structure
1117
+ end
956
1118
 
957
- # A request to post updates to records or add and delete records for a
958
- # dataset and user.
959
- # @note When making an API call, pass UpdateRecordsRequest
960
- # data as a hash:
961
- #
962
- # {
963
- # identity_pool_id: "IdentityPoolId", # required
964
- # identity_id: "IdentityId", # required
965
- # dataset_name: "DatasetName", # required
966
- # device_id: "DeviceId",
967
- # record_patches: [
968
- # {
969
- # op: "replace", # required, accepts replace, remove
970
- # key: "RecordKey", # required
971
- # value: "RecordValue",
972
- # sync_count: 1, # required
973
- # device_last_modified_date: Time.now,
974
- # },
975
- # ],
976
- # sync_session_token: "SyncSessionToken", # required
977
- # client_context: "ClientContext",
978
- # }
979
- # @!attribute [rw] identity_pool_id
980
- # A name-spaced GUID (for example,
981
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
982
- # Cognito. GUID generation is unique within a region.
983
- # @return [String]
984
- #
985
- # @!attribute [rw] identity_id
986
- # A name-spaced GUID (for example,
987
- # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
988
- # Cognito. GUID generation is unique within a region.
989
- # @return [String]
990
- #
991
- # @!attribute [rw] dataset_name
992
- # A string of up to 128 characters. Allowed characters are a-z, A-Z,
993
- # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
994
- # @return [String]
995
- #
996
- # @!attribute [rw] device_id
997
- # The unique ID generated for this device by Cognito.
998
- # @return [String]
999
- #
1000
- # @!attribute [rw] record_patches
1001
- # A list of patch operations.
1002
- # @return [Array<Types::RecordPatch>]
1003
- #
1004
- # @!attribute [rw] sync_session_token
1005
- # The SyncSessionToken returned by a previous call to ListRecords for
1006
- # this dataset and identity.
1007
- # @return [String]
1008
- #
1009
- # @!attribute [rw] client_context
1010
- # Intended to supply a device ID that will populate the lastModifiedBy
1011
- # field referenced in other methods. The ClientContext field is not
1012
- # yet implemented.
1013
- # @return [String]
1014
- class UpdateRecordsRequest < Struct.new(
1015
- :identity_pool_id,
1016
- :identity_id,
1017
- :dataset_name,
1018
- :device_id,
1019
- :record_patches,
1020
- :sync_session_token,
1021
- :client_context)
1022
- include Aws::Structure
1023
- end
1119
+ # Response to an UnsubscribeFromDataset request.
1120
+ #
1121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UnsubscribeFromDatasetResponse AWS API Documentation
1122
+ #
1123
+ class UnsubscribeFromDatasetResponse < Aws::EmptyStructure; end
1024
1124
 
1025
- # Returned for a successful UpdateRecordsRequest.
1026
- # @!attribute [rw] records
1027
- # A list of records that have been updated.
1028
- # @return [Array<Types::Record>]
1029
- class UpdateRecordsResponse < Struct.new(
1030
- :records)
1031
- include Aws::Structure
1032
- end
1125
+ # A request to post updates to records or add and delete records for a
1126
+ # dataset and user.
1127
+ #
1128
+ # @note When making an API call, you may pass UpdateRecordsRequest
1129
+ # data as a hash:
1130
+ #
1131
+ # {
1132
+ # identity_pool_id: "IdentityPoolId", # required
1133
+ # identity_id: "IdentityId", # required
1134
+ # dataset_name: "DatasetName", # required
1135
+ # device_id: "DeviceId",
1136
+ # record_patches: [
1137
+ # {
1138
+ # op: "replace", # required, accepts replace, remove
1139
+ # key: "RecordKey", # required
1140
+ # value: "RecordValue",
1141
+ # sync_count: 1, # required
1142
+ # device_last_modified_date: Time.now,
1143
+ # },
1144
+ # ],
1145
+ # sync_session_token: "SyncSessionToken", # required
1146
+ # client_context: "ClientContext",
1147
+ # }
1148
+ #
1149
+ # @!attribute [rw] identity_pool_id
1150
+ # A name-spaced GUID (for example,
1151
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
1152
+ # Cognito. GUID generation is unique within a region.
1153
+ # @return [String]
1154
+ #
1155
+ # @!attribute [rw] identity_id
1156
+ # A name-spaced GUID (for example,
1157
+ # us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
1158
+ # Cognito. GUID generation is unique within a region.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] dataset_name
1162
+ # A string of up to 128 characters. Allowed characters are a-z, A-Z,
1163
+ # 0-9, '\_' (underscore), '-' (dash), and '.' (dot).
1164
+ # @return [String]
1165
+ #
1166
+ # @!attribute [rw] device_id
1167
+ # The unique ID generated for this device by Cognito.
1168
+ # @return [String]
1169
+ #
1170
+ # @!attribute [rw] record_patches
1171
+ # A list of patch operations.
1172
+ # @return [Array<Types::RecordPatch>]
1173
+ #
1174
+ # @!attribute [rw] sync_session_token
1175
+ # The SyncSessionToken returned by a previous call to ListRecords for
1176
+ # this dataset and identity.
1177
+ # @return [String]
1178
+ #
1179
+ # @!attribute [rw] client_context
1180
+ # Intended to supply a device ID that will populate the lastModifiedBy
1181
+ # field referenced in other methods. The ClientContext field is not
1182
+ # yet implemented.
1183
+ # @return [String]
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UpdateRecordsRequest AWS API Documentation
1186
+ #
1187
+ class UpdateRecordsRequest < Struct.new(
1188
+ :identity_pool_id,
1189
+ :identity_id,
1190
+ :dataset_name,
1191
+ :device_id,
1192
+ :record_patches,
1193
+ :sync_session_token,
1194
+ :client_context)
1195
+ include Aws::Structure
1196
+ end
1033
1197
 
1198
+ # Returned for a successful UpdateRecordsRequest.
1199
+ #
1200
+ # @!attribute [rw] records
1201
+ # A list of records that have been updated.
1202
+ # @return [Array<Types::Record>]
1203
+ #
1204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/UpdateRecordsResponse AWS API Documentation
1205
+ #
1206
+ class UpdateRecordsResponse < Struct.new(
1207
+ :records)
1208
+ include Aws::Structure
1034
1209
  end
1210
+
1035
1211
  end
1036
1212
  end