forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcognito-sync-2014-06-30.normal.json
2440 lines (2440 loc) · 85.9 KB
/
cognito-sync-2014-06-30.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2014-06-30",
"endpointPrefix":"cognito-sync",
"jsonVersion":"1.1",
"serviceFullName":"Amazon Cognito Sync",
"signatureVersion":"v4",
"protocol":"rest-json",
"uid":"cognito-sync-2014-06-30"
},
"documentation":"<fullname>Amazon Cognito Sync</fullname> <p>Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.</p> <p>With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with <a href=\"http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html\">Amazon Cognito Identity service</a>.</p> <p>If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href=\"http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html\">Developer Guide for Android</a> and the <a href=\"http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html\">Developer Guide for iOS</a>.</p>",
"operations":{
"BulkPublish":{
"name":"BulkPublish",
"http":{
"method":"POST",
"requestUri":"/identitypools/{IdentityPoolId}/bulkpublish",
"responseCode":200
},
"input":{
"shape":"BulkPublishRequest",
"documentation":"The input for the BulkPublish operation."
},
"output":{
"shape":"BulkPublishResponse",
"documentation":"The output for the BulkPublish operation."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"DuplicateRequestException",
"error":{
"code":"DuplicateRequest",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool."
},
{
"shape":"AlreadyStreamedException",
"error":{
"code":"AlreadyStreamed",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully."
}
],
"documentation":"<p>Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"DeleteDataset":{
"name":"DeleteDataset",
"http":{
"method":"DELETE",
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
"responseCode":200
},
"input":{
"shape":"DeleteDatasetRequest",
"documentation":"A request to delete the specific dataset."
},
"output":{
"shape":"DeleteDatasetResponse",
"documentation":"Response to a successful DeleteDataset request."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
},
{
"shape":"ResourceConflictException",
"error":{
"code":"ResourceConflict",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict."
}
],
"documentation":"<p>Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.</p> <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.</p>"
},
"DescribeDataset":{
"name":"DescribeDataset",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
"responseCode":200
},
"input":{
"shape":"DescribeDatasetRequest",
"documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name."
},
"output":{
"shape":"DescribeDatasetResponse",
"documentation":"Response to a successful DescribeDataset request."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.</p> <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.</p>"
},
"DescribeIdentityPoolUsage":{
"name":"DescribeIdentityPoolUsage",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}",
"responseCode":200
},
"input":{
"shape":"DescribeIdentityPoolUsageRequest",
"documentation":"A request for usage information about the identity pool."
},
"output":{
"shape":"DescribeIdentityPoolUsageResponse",
"documentation":"Response to a successful DescribeIdentityPoolUsage request."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Gets usage details (for example, data storage) about a particular identity pool.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"DescribeIdentityUsage":{
"name":"DescribeIdentityUsage",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}",
"responseCode":200
},
"input":{
"shape":"DescribeIdentityUsageRequest",
"documentation":"A request for information about the usage of an identity pool."
},
"output":{
"shape":"DescribeIdentityUsageResponse",
"documentation":"The response to a successful DescribeIdentityUsage request."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Gets usage information for an identity, including number of datasets and data usage.</p> <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.</p>"
},
"GetBulkPublishDetails":{
"name":"GetBulkPublishDetails",
"http":{
"method":"POST",
"requestUri":"/identitypools/{IdentityPoolId}/getBulkPublishDetails",
"responseCode":200
},
"input":{
"shape":"GetBulkPublishDetailsRequest",
"documentation":"The input for the GetBulkPublishDetails operation."
},
"output":{
"shape":"GetBulkPublishDetailsResponse",
"documentation":"The output for the GetBulkPublishDetails operation."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
}
],
"documentation":"<p>Get the status of the last BulkPublish operation for an identity pool.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"GetCognitoEvents":{
"name":"GetCognitoEvents",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}/events",
"responseCode":200
},
"input":{
"shape":"GetCognitoEventsRequest",
"documentation":"<p>A request for a list of the configured Cognito Events</p>"
},
"output":{
"shape":"GetCognitoEventsResponse",
"documentation":"<p>The response from the GetCognitoEvents request</p>"
},
"errors":[
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Gets the events and the corresponding Lambda functions associated with an identity pool.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"GetIdentityPoolConfiguration":{
"name":"GetIdentityPoolConfiguration",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}/configuration",
"responseCode":200
},
"input":{
"shape":"GetIdentityPoolConfigurationRequest",
"documentation":"<p>The input for the GetIdentityPoolConfiguration operation.</p>"
},
"output":{
"shape":"GetIdentityPoolConfigurationResponse",
"documentation":"<p>The output for the GetIdentityPoolConfiguration operation.</p>"
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Gets the configuration settings of an identity pool.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"ListDatasets":{
"name":"ListDatasets",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets",
"responseCode":200
},
"input":{
"shape":"ListDatasetsRequest",
"documentation":"Request for a list of datasets for an identity."
},
"output":{
"shape":"ListDatasetsResponse",
"documentation":"Returned for a successful ListDatasets request."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.</p> <p>ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.</p>"
},
"ListIdentityPoolUsage":{
"name":"ListIdentityPoolUsage",
"http":{
"method":"GET",
"requestUri":"/identitypools",
"responseCode":200
},
"input":{
"shape":"ListIdentityPoolUsageRequest",
"documentation":"A request for usage information on an identity pool."
},
"output":{
"shape":"ListIdentityPoolUsageResponse",
"documentation":"Returned for a successful ListIdentityPoolUsage request."
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Gets a list of identity pools registered with Cognito.</p> <p>ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.</p>"
},
"ListRecords":{
"name":"ListRecords",
"http":{
"method":"GET",
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records",
"responseCode":200
},
"input":{
"shape":"ListRecordsRequest",
"documentation":"A request for a list of records."
},
"output":{
"shape":"ListRecordsResponse",
"documentation":"Returned for a successful ListRecordsRequest."
},
"errors":[
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
}
],
"documentation":"<p>Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.</p> <p>ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.</p>"
},
"RegisterDevice":{
"name":"RegisterDevice",
"http":{
"method":"POST",
"requestUri":"/identitypools/{IdentityPoolId}/identity/{IdentityId}/device",
"responseCode":200
},
"input":{
"shape":"RegisterDeviceRequest",
"documentation":"<p>A request to RegisterDevice.</p>"
},
"output":{
"shape":"RegisterDeviceResponse",
"documentation":"<p>Response to a RegisterDevice request.</p>"
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"InvalidConfigurationException",
"error":{
"code":"InvalidConfiguration",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Registers a device to receive push sync notifications.</p> <p>This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.</p>"
},
"SetCognitoEvents":{
"name":"SetCognitoEvents",
"http":{
"method":"POST",
"requestUri":"/identitypools/{IdentityPoolId}/events",
"responseCode":200
},
"input":{
"shape":"SetCognitoEventsRequest",
"documentation":"<p>A request to configure Cognito Events\"</p>\""
},
"errors":[
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
}
],
"documentation":"<p>Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"SetIdentityPoolConfiguration":{
"name":"SetIdentityPoolConfiguration",
"http":{
"method":"POST",
"requestUri":"/identitypools/{IdentityPoolId}/configuration",
"responseCode":200
},
"input":{
"shape":"SetIdentityPoolConfigurationRequest",
"documentation":"<p>The input for the SetIdentityPoolConfiguration operation.</p>"
},
"output":{
"shape":"SetIdentityPoolConfigurationResponse",
"documentation":"<p>The output for the SetIdentityPoolConfiguration operation</p>"
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},
{
"shape":"InvalidParameterException",
"error":{
"code":"InvalidParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
},
{
"shape":"ResourceNotFoundException",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the resource doesn't exist."
},
{
"shape":"InternalErrorException",
"error":{
"code":"InternalError",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"Indicates an internal service error."
},
{
"shape":"TooManyRequestsException",
"error":{
"code":"TooManyRequests",
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"documentation":"Thrown if the request is throttled."
},
{
"shape":"ConcurrentModificationException",
"error":{
"code":"ConcurrentModification",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>Thrown if there are parallel requests to modify a resource.</p>"
}
],
"documentation":"<p>Sets the necessary configuration for push sync.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
},
"SubscribeToDataset":{
"name":"SubscribeToDataset",
"http":{
"method":"POST",
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}",
"responseCode":200
},
"input":{
"shape":"SubscribeToDatasetRequest",
"documentation":"<p>A request to SubscribeToDatasetRequest.</p>"
},
"output":{
"shape":"SubscribeToDatasetResponse",
"documentation":"<p>Response to a SubscribeToDataset request.</p>"
},
"errors":[
{
"shape":"NotAuthorizedException",
"error":{
"code":"NotAuthorizedError",
"httpStatusCode":403,
"senderFault":true
},
"exception":true,
"documentation":"Thrown when a user is not authorized to access the requested resource."
},