blib/lib/Paws/CognitoSync.pm untested

filter: Statementstmt 0.0% 0 / 64 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 23 Podpod 0.0% 0 / 22 totaltotal 0.0% 0 / 109 CC 1 SCAR 6.9
CC
1
Cov
0%
service
2.0
signing_name
2.0
version
2.0
CRAP 2.0
1 package Paws::CognitoSync;
2 use Moose;
3 sub service { 'cognito-sync' }
4 sub signing_name { 'cognito-sync' }
5 sub version { '2014-06-30' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub BulkPublish {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::CognitoSync::BulkPublish', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub DeleteDataset {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::CognitoSync::DeleteDataset', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub DescribeDataset {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::CognitoSync::DescribeDataset', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub DescribeIdentityPoolUsage {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::CognitoSync::DescribeIdentityPoolUsage', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub DescribeIdentityUsage {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::CognitoSync::DescribeIdentityUsage', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub GetBulkPublishDetails {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::CognitoSync::GetBulkPublishDetails', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub GetCognitoEvents {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::CognitoSync::GetCognitoEvents', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub GetIdentityPoolConfiguration {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::CognitoSync::GetIdentityPoolConfiguration', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub ListDatasets {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::CognitoSync::ListDatasets', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub ListIdentityPoolUsage {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::CognitoSync::ListIdentityPoolUsage', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub ListRecords {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::CognitoSync::ListRecords', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub RegisterDevice {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::CognitoSync::RegisterDevice', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub SetCognitoEvents {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::CognitoSync::SetCognitoEvents', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82 sub SetIdentityPoolConfiguration {
83 my $self = shift;
84 my $call_object = $self->new_with_coercions('Paws::CognitoSync::SetIdentityPoolConfiguration', @_);
85 return $self->caller->do_call($self, $call_object);
86 }
87 sub SubscribeToDataset {
88 my $self = shift;
89 my $call_object = $self->new_with_coercions('Paws::CognitoSync::SubscribeToDataset', @_);
90 return $self->caller->do_call($self, $call_object);
91 }
92 sub UnsubscribeFromDataset {
93 my $self = shift;
94 my $call_object = $self->new_with_coercions('Paws::CognitoSync::UnsubscribeFromDataset', @_);
95 return $self->caller->do_call($self, $call_object);
96 }
97 sub UpdateRecords {
98 my $self = shift;
99 my $call_object = $self->new_with_coercions('Paws::CognitoSync::UpdateRecords', @_);
100 return $self->caller->do_call($self, $call_object);
101 }
102
103  
104  
105 sub operations { qw/BulkPublish DeleteDataset DescribeDataset DescribeIdentityPoolUsage DescribeIdentityUsage GetBulkPublishDetails GetCognitoEvents GetIdentityPoolConfiguration ListDatasets ListIdentityPoolUsage ListRecords RegisterDevice SetCognitoEvents SetIdentityPoolConfiguration SubscribeToDataset UnsubscribeFromDataset UpdateRecords / }
106  
107 1;
108  
109 ### main pod documentation begin ###
110  
111 =head1 NAME
112  
113 Paws::CognitoSync - Perl Interface to AWS Amazon Cognito Sync
114  
115 =head1 SYNOPSIS
116  
117 use Paws;
118  
119 my $obj = Paws->service('CognitoSync');
120 my $res = $obj->Method(
121 Arg1 => $val1,
122 Arg2 => [ 'V1', 'V2' ],
123 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
124 # of the arguments type
125 Arg3 => { Att1 => 'Val1' },
126 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
127 # the constructor of the arguments type
128 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
129 );
130  
131 =head1 DESCRIPTION
132  
133 Amazon Cognito Sync
134  
135 Amazon Cognito Sync provides an AWS service and client library that
136 enable cross-device syncing of application-related user data.
137 High-level client libraries are available for both iOS and Android. You
138 can use these libraries to persist data locally so that it's available
139 even if the device is offline. Developer credentials don't need to be
140 stored on the mobile device to access the service. You can use Amazon
141 Cognito to obtain a normalized user ID and credentials. User data is
142 persisted in a dataset that can store up to 1 MB of key-value pairs,
143 and you can have up to 20 datasets per user identity.
144  
145 With Amazon Cognito Sync, the data stored for each identity is
146 accessible only to credentials assigned to that identity. In order to
147 use the Cognito Sync service, you need to make API calls using
148 credentials retrieved with Amazon Cognito Identity service
149 (http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html).
150  
151 If you want to use Cognito Sync in an Android or iOS application, you
152 will probably want to make API calls via the AWS Mobile SDK. To learn
153 more, see the Developer Guide for Android
154 (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html)
155 and the Developer Guide for iOS
156 (http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html).
157  
158 For the AWS API documentation, see L<https://docs.aws.amazon.com/cognito/>
159  
160  
161 =head1 METHODS
162  
163 =head2 BulkPublish
164  
165 =over
166  
167 =item IdentityPoolId => Str
168  
169  
170 =back
171  
172 Each argument is described in detail in: L<Paws::CognitoSync::BulkPublish>
173  
174 Returns: a L<Paws::CognitoSync::BulkPublishResponse> instance
175  
176 Initiates a bulk publish of all existing datasets for an Identity Pool
177 to the configured stream. Customers are limited to one successful bulk
178 publish per 24 hours. Bulk publish is an asynchronous request,
179 customers can see the status of the request via the
180 GetBulkPublishDetails operation.
181  
182 This API can only be called with developer credentials. You cannot call
183 this API with the temporary user credentials provided by Cognito
184 Identity.
185  
186  
187 =head2 DeleteDataset
188  
189 =over
190  
191 =item DatasetName => Str
192  
193 =item IdentityId => Str
194  
195 =item IdentityPoolId => Str
196  
197  
198 =back
199  
200 Each argument is described in detail in: L<Paws::CognitoSync::DeleteDataset>
201  
202 Returns: a L<Paws::CognitoSync::DeleteDatasetResponse> instance
203  
204 Deletes the specific dataset. The dataset will be deleted permanently,
205 and the action can't be undone. Datasets that this dataset was merged
206 with will no longer report the merge. Any subsequent operation on this
207 dataset will result in a ResourceNotFoundException.
208  
209 This API can be called with temporary user credentials provided by
210 Cognito Identity or with developer credentials.
211  
212  
213 =head2 DescribeDataset
214  
215 =over
216  
217 =item DatasetName => Str
218  
219 =item IdentityId => Str
220  
221 =item IdentityPoolId => Str
222  
223  
224 =back
225  
226 Each argument is described in detail in: L<Paws::CognitoSync::DescribeDataset>
227  
228 Returns: a L<Paws::CognitoSync::DescribeDatasetResponse> instance
229  
230 Gets meta data about a dataset by identity and dataset name. With
231 Amazon Cognito Sync, each identity has access only to its own data.
232 Thus, the credentials used to make this API call need to have access to
233 the identity data.
234  
235 This API can be called with temporary user credentials provided by
236 Cognito Identity or with developer credentials. You should use Cognito
237 Identity credentials to make this API call.
238  
239  
240 =head2 DescribeIdentityPoolUsage
241  
242 =over
243  
244 =item IdentityPoolId => Str
245  
246  
247 =back
248  
249 Each argument is described in detail in: L<Paws::CognitoSync::DescribeIdentityPoolUsage>
250  
251 Returns: a L<Paws::CognitoSync::DescribeIdentityPoolUsageResponse> instance
252  
253 Gets usage details (for example, data storage) about a particular
254 identity pool.
255  
256 This API can only be called with developer credentials. You cannot call
257 this API with the temporary user credentials provided by Cognito
258 Identity.
259  
260  
261 =head2 DescribeIdentityUsage
262  
263 =over
264  
265 =item IdentityId => Str
266  
267 =item IdentityPoolId => Str
268  
269  
270 =back
271  
272 Each argument is described in detail in: L<Paws::CognitoSync::DescribeIdentityUsage>
273  
274 Returns: a L<Paws::CognitoSync::DescribeIdentityUsageResponse> instance
275  
276 Gets usage information for an identity, including number of datasets
277 and data usage.
278  
279 This API can be called with temporary user credentials provided by
280 Cognito Identity or with developer credentials.
281  
282  
283 =head2 GetBulkPublishDetails
284  
285 =over
286  
287 =item IdentityPoolId => Str
288  
289  
290 =back
291  
292 Each argument is described in detail in: L<Paws::CognitoSync::GetBulkPublishDetails>
293  
294 Returns: a L<Paws::CognitoSync::GetBulkPublishDetailsResponse> instance
295  
296 Get the status of the last BulkPublish operation for an identity pool.
297  
298 This API can only be called with developer credentials. You cannot call
299 this API with the temporary user credentials provided by Cognito
300 Identity.
301  
302  
303 =head2 GetCognitoEvents
304  
305 =over
306  
307 =item IdentityPoolId => Str
308  
309  
310 =back
311  
312 Each argument is described in detail in: L<Paws::CognitoSync::GetCognitoEvents>
313  
314 Returns: a L<Paws::CognitoSync::GetCognitoEventsResponse> instance
315  
316 Gets the events and the corresponding Lambda functions associated with
317 an identity pool.
318  
319 This API can only be called with developer credentials. You cannot call
320 this API with the temporary user credentials provided by Cognito
321 Identity.
322  
323  
324 =head2 GetIdentityPoolConfiguration
325  
326 =over
327  
328 =item IdentityPoolId => Str
329  
330  
331 =back
332  
333 Each argument is described in detail in: L<Paws::CognitoSync::GetIdentityPoolConfiguration>
334  
335 Returns: a L<Paws::CognitoSync::GetIdentityPoolConfigurationResponse> instance
336  
337 Gets the configuration settings of an identity pool.
338  
339 This API can only be called with developer credentials. You cannot call
340 this API with the temporary user credentials provided by Cognito
341 Identity.
342  
343  
344 =head2 ListDatasets
345  
346 =over
347  
348 =item IdentityId => Str
349  
350 =item IdentityPoolId => Str
351  
352 =item [MaxResults => Int]
353  
354 =item [NextToken => Str]
355  
356  
357 =back
358  
359 Each argument is described in detail in: L<Paws::CognitoSync::ListDatasets>
360  
361 Returns: a L<Paws::CognitoSync::ListDatasetsResponse> instance
362  
363 Lists datasets for an identity. With Amazon Cognito Sync, each identity
364 has access only to its own data. Thus, the credentials used to make
365 this API call need to have access to the identity data.
366  
367 ListDatasets can be called with temporary user credentials provided by
368 Cognito Identity or with developer credentials. You should use the
369 Cognito Identity credentials to make this API call.
370  
371  
372 =head2 ListIdentityPoolUsage
373  
374 =over
375  
376 =item [MaxResults => Int]
377  
378 =item [NextToken => Str]
379  
380  
381 =back
382  
383 Each argument is described in detail in: L<Paws::CognitoSync::ListIdentityPoolUsage>
384  
385 Returns: a L<Paws::CognitoSync::ListIdentityPoolUsageResponse> instance
386  
387 Gets a list of identity pools registered with Cognito.
388  
389 ListIdentityPoolUsage can only be called with developer credentials.
390 You cannot make this API call with the temporary user credentials
391 provided by Cognito Identity.
392  
393  
394 =head2 ListRecords
395  
396 =over
397  
398 =item DatasetName => Str
399  
400 =item IdentityId => Str
401  
402 =item IdentityPoolId => Str
403  
404 =item [LastSyncCount => Int]
405  
406 =item [MaxResults => Int]
407  
408 =item [NextToken => Str]
409  
410 =item [SyncSessionToken => Str]
411  
412  
413 =back
414  
415 Each argument is described in detail in: L<Paws::CognitoSync::ListRecords>
416  
417 Returns: a L<Paws::CognitoSync::ListRecordsResponse> instance
418  
419 Gets paginated records, optionally changed after a particular sync
420 count for a dataset and identity. With Amazon Cognito Sync, each
421 identity has access only to its own data. Thus, the credentials used to
422 make this API call need to have access to the identity data.
423  
424 ListRecords can be called with temporary user credentials provided by
425 Cognito Identity or with developer credentials. You should use Cognito
426 Identity credentials to make this API call.
427  
428  
429 =head2 RegisterDevice
430  
431 =over
432  
433 =item IdentityId => Str
434  
435 =item IdentityPoolId => Str
436  
437 =item Platform => Str
438  
439 =item Token => Str
440  
441  
442 =back
443  
444 Each argument is described in detail in: L<Paws::CognitoSync::RegisterDevice>
445  
446 Returns: a L<Paws::CognitoSync::RegisterDeviceResponse> instance
447  
448 Registers a device to receive push sync notifications.
449  
450 This API can only be called with temporary credentials provided by
451 Cognito Identity. You cannot call this API with developer credentials.
452  
453  
454 =head2 SetCognitoEvents
455  
456 =over
457  
458 =item Events => L<Paws::CognitoSync::Events>
459  
460 =item IdentityPoolId => Str
461  
462  
463 =back
464  
465 Each argument is described in detail in: L<Paws::CognitoSync::SetCognitoEvents>
466  
467 Returns: nothing
468  
469 Sets the AWS Lambda function for a given event type for an identity
470 pool. This request only updates the key/value pair specified. Other
471 key/values pairs are not updated. To remove a key value pair, pass a
472 empty value for the particular key.
473  
474 This API can only be called with developer credentials. You cannot call
475 this API with the temporary user credentials provided by Cognito
476 Identity.
477  
478  
479 =head2 SetIdentityPoolConfiguration
480  
481 =over
482  
483 =item IdentityPoolId => Str
484  
485 =item [CognitoStreams => L<Paws::CognitoSync::CognitoStreams>]
486  
487 =item [PushSync => L<Paws::CognitoSync::PushSync>]
488  
489  
490 =back
491  
492 Each argument is described in detail in: L<Paws::CognitoSync::SetIdentityPoolConfiguration>
493  
494 Returns: a L<Paws::CognitoSync::SetIdentityPoolConfigurationResponse> instance
495  
496 Sets the necessary configuration for push sync.
497  
498 This API can only be called with developer credentials. You cannot call
499 this API with the temporary user credentials provided by Cognito
500 Identity.
501  
502  
503 =head2 SubscribeToDataset
504  
505 =over
506  
507 =item DatasetName => Str
508  
509 =item DeviceId => Str
510  
511 =item IdentityId => Str
512  
513 =item IdentityPoolId => Str
514  
515  
516 =back
517  
518 Each argument is described in detail in: L<Paws::CognitoSync::SubscribeToDataset>
519  
520 Returns: a L<Paws::CognitoSync::SubscribeToDatasetResponse> instance
521  
522 Subscribes to receive notifications when a dataset is modified by
523 another device.
524  
525 This API can only be called with temporary credentials provided by
526 Cognito Identity. You cannot call this API with developer credentials.
527  
528  
529 =head2 UnsubscribeFromDataset
530  
531 =over
532  
533 =item DatasetName => Str
534  
535 =item DeviceId => Str
536  
537 =item IdentityId => Str
538  
539 =item IdentityPoolId => Str
540  
541  
542 =back
543  
544 Each argument is described in detail in: L<Paws::CognitoSync::UnsubscribeFromDataset>
545  
546 Returns: a L<Paws::CognitoSync::UnsubscribeFromDatasetResponse> instance
547  
548 Unsubscribes from receiving notifications when a dataset is modified by
549 another device.
550  
551 This API can only be called with temporary credentials provided by
552 Cognito Identity. You cannot call this API with developer credentials.
553  
554  
555 =head2 UpdateRecords
556  
557 =over
558  
559 =item DatasetName => Str
560  
561 =item IdentityId => Str
562  
563 =item IdentityPoolId => Str
564  
565 =item SyncSessionToken => Str
566  
567 =item [ClientContext => Str]
568  
569 =item [DeviceId => Str]
570  
571 =item [RecordPatches => ArrayRef[L<Paws::CognitoSync::RecordPatch>]]
572  
573  
574 =back
575  
576 Each argument is described in detail in: L<Paws::CognitoSync::UpdateRecords>
577  
578 Returns: a L<Paws::CognitoSync::UpdateRecordsResponse> instance
579  
580 Posts updates to records and adds and deletes records for a dataset and
581 user.
582  
583 The sync count in the record patch is your last known sync count for
584 that record. The server will reject an UpdateRecords request with a
585 ResourceConflictException if you try to patch a record with a new value
586 but a stale sync count.
587  
588 For example, if the sync count on the server is 5 for a key called
589 highScore and you try and submit a new highScore with sync count of 4,
590 the request will be rejected. To obtain the current sync count for a
591 record, call ListRecords. On a successful update of the record, the
592 response returns the new sync count for that record. You should present
593 that sync count the next time you try to update that same record. When
594 the record does not exist, specify the sync count as 0.
595  
596 This API can be called with temporary user credentials provided by
597 Cognito Identity or with developer credentials.
598  
599  
600  
601  
602 =head1 PAGINATORS
603  
604 Paginator methods are helpers that repetively call methods that return partial results
605  
606  
607  
608  
609 =head1 SEE ALSO
610  
611 This service class forms part of L<Paws>
612  
613 =head1 BUGS and CONTRIBUTIONS
614  
615 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
616  
617 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
618  
619 =cut
620