1 | {
|
2 | "version": "2.0",
|
3 | "metadata": {
|
4 | "apiVersion": "2014-06-30",
|
5 | "endpointPrefix": "cognito-sync",
|
6 | "jsonVersion": "1.1",
|
7 | "serviceFullName": "Amazon Cognito Sync",
|
8 | "signatureVersion": "v4",
|
9 | "protocol": "rest-json",
|
10 | "uid": "cognito-sync-2014-06-30"
|
11 | },
|
12 | "operations": {
|
13 | "BulkPublish": {
|
14 | "http": {
|
15 | "requestUri": "/identitypools/{IdentityPoolId}/bulkpublish",
|
16 | "responseCode": 200
|
17 | },
|
18 | "input": {
|
19 | "type": "structure",
|
20 | "required": [
|
21 | "IdentityPoolId"
|
22 | ],
|
23 | "members": {
|
24 | "IdentityPoolId": {
|
25 | "location": "uri",
|
26 | "locationName": "IdentityPoolId"
|
27 | }
|
28 | }
|
29 | },
|
30 | "output": {
|
31 | "type": "structure",
|
32 | "members": {
|
33 | "IdentityPoolId": {}
|
34 | }
|
35 | }
|
36 | },
|
37 | "DeleteDataset": {
|
38 | "http": {
|
39 | "method": "DELETE",
|
40 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
41 | "responseCode": 200
|
42 | },
|
43 | "input": {
|
44 | "type": "structure",
|
45 | "required": [
|
46 | "IdentityPoolId",
|
47 | "IdentityId",
|
48 | "DatasetName"
|
49 | ],
|
50 | "members": {
|
51 | "IdentityPoolId": {
|
52 | "location": "uri",
|
53 | "locationName": "IdentityPoolId"
|
54 | },
|
55 | "IdentityId": {
|
56 | "location": "uri",
|
57 | "locationName": "IdentityId"
|
58 | },
|
59 | "DatasetName": {
|
60 | "location": "uri",
|
61 | "locationName": "DatasetName"
|
62 | }
|
63 | }
|
64 | },
|
65 | "output": {
|
66 | "type": "structure",
|
67 | "members": {
|
68 | "Dataset": {
|
69 | "shape": "S8"
|
70 | }
|
71 | }
|
72 | }
|
73 | },
|
74 | "DescribeDataset": {
|
75 | "http": {
|
76 | "method": "GET",
|
77 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
78 | "responseCode": 200
|
79 | },
|
80 | "input": {
|
81 | "type": "structure",
|
82 | "required": [
|
83 | "IdentityPoolId",
|
84 | "IdentityId",
|
85 | "DatasetName"
|
86 | ],
|
87 | "members": {
|
88 | "IdentityPoolId": {
|
89 | "location": "uri",
|
90 | "locationName": "IdentityPoolId"
|
91 | },
|
92 | "IdentityId": {
|
93 | "location": "uri",
|
94 | "locationName": "IdentityId"
|
95 | },
|
96 | "DatasetName": {
|
97 | "location": "uri",
|
98 | "locationName": "DatasetName"
|
99 | }
|
100 | }
|
101 | },
|
102 | "output": {
|
103 | "type": "structure",
|
104 | "members": {
|
105 | "Dataset": {
|
106 | "shape": "S8"
|
107 | }
|
108 | }
|
109 | }
|
110 | },
|
111 | "DescribeIdentityPoolUsage": {
|
112 | "http": {
|
113 | "method": "GET",
|
114 | "requestUri": "/identitypools/{IdentityPoolId}",
|
115 | "responseCode": 200
|
116 | },
|
117 | "input": {
|
118 | "type": "structure",
|
119 | "required": [
|
120 | "IdentityPoolId"
|
121 | ],
|
122 | "members": {
|
123 | "IdentityPoolId": {
|
124 | "location": "uri",
|
125 | "locationName": "IdentityPoolId"
|
126 | }
|
127 | }
|
128 | },
|
129 | "output": {
|
130 | "type": "structure",
|
131 | "members": {
|
132 | "IdentityPoolUsage": {
|
133 | "shape": "Sg"
|
134 | }
|
135 | }
|
136 | }
|
137 | },
|
138 | "DescribeIdentityUsage": {
|
139 | "http": {
|
140 | "method": "GET",
|
141 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}",
|
142 | "responseCode": 200
|
143 | },
|
144 | "input": {
|
145 | "type": "structure",
|
146 | "required": [
|
147 | "IdentityPoolId",
|
148 | "IdentityId"
|
149 | ],
|
150 | "members": {
|
151 | "IdentityPoolId": {
|
152 | "location": "uri",
|
153 | "locationName": "IdentityPoolId"
|
154 | },
|
155 | "IdentityId": {
|
156 | "location": "uri",
|
157 | "locationName": "IdentityId"
|
158 | }
|
159 | }
|
160 | },
|
161 | "output": {
|
162 | "type": "structure",
|
163 | "members": {
|
164 | "IdentityUsage": {
|
165 | "type": "structure",
|
166 | "members": {
|
167 | "IdentityId": {},
|
168 | "IdentityPoolId": {},
|
169 | "LastModifiedDate": {
|
170 | "type": "timestamp"
|
171 | },
|
172 | "DatasetCount": {
|
173 | "type": "integer"
|
174 | },
|
175 | "DataStorage": {
|
176 | "type": "long"
|
177 | }
|
178 | }
|
179 | }
|
180 | }
|
181 | }
|
182 | },
|
183 | "GetBulkPublishDetails": {
|
184 | "http": {
|
185 | "requestUri": "/identitypools/{IdentityPoolId}/getBulkPublishDetails",
|
186 | "responseCode": 200
|
187 | },
|
188 | "input": {
|
189 | "type": "structure",
|
190 | "required": [
|
191 | "IdentityPoolId"
|
192 | ],
|
193 | "members": {
|
194 | "IdentityPoolId": {
|
195 | "location": "uri",
|
196 | "locationName": "IdentityPoolId"
|
197 | }
|
198 | }
|
199 | },
|
200 | "output": {
|
201 | "type": "structure",
|
202 | "members": {
|
203 | "IdentityPoolId": {},
|
204 | "BulkPublishStartTime": {
|
205 | "type": "timestamp"
|
206 | },
|
207 | "BulkPublishCompleteTime": {
|
208 | "type": "timestamp"
|
209 | },
|
210 | "BulkPublishStatus": {},
|
211 | "FailureMessage": {}
|
212 | }
|
213 | }
|
214 | },
|
215 | "GetCognitoEvents": {
|
216 | "http": {
|
217 | "method": "GET",
|
218 | "requestUri": "/identitypools/{IdentityPoolId}/events",
|
219 | "responseCode": 200
|
220 | },
|
221 | "input": {
|
222 | "type": "structure",
|
223 | "required": [
|
224 | "IdentityPoolId"
|
225 | ],
|
226 | "members": {
|
227 | "IdentityPoolId": {
|
228 | "location": "uri",
|
229 | "locationName": "IdentityPoolId"
|
230 | }
|
231 | }
|
232 | },
|
233 | "output": {
|
234 | "type": "structure",
|
235 | "members": {
|
236 | "Events": {
|
237 | "shape": "Sq"
|
238 | }
|
239 | }
|
240 | }
|
241 | },
|
242 | "GetIdentityPoolConfiguration": {
|
243 | "http": {
|
244 | "method": "GET",
|
245 | "requestUri": "/identitypools/{IdentityPoolId}/configuration",
|
246 | "responseCode": 200
|
247 | },
|
248 | "input": {
|
249 | "type": "structure",
|
250 | "required": [
|
251 | "IdentityPoolId"
|
252 | ],
|
253 | "members": {
|
254 | "IdentityPoolId": {
|
255 | "location": "uri",
|
256 | "locationName": "IdentityPoolId"
|
257 | }
|
258 | }
|
259 | },
|
260 | "output": {
|
261 | "type": "structure",
|
262 | "members": {
|
263 | "IdentityPoolId": {},
|
264 | "PushSync": {
|
265 | "shape": "Sv"
|
266 | },
|
267 | "CognitoStreams": {
|
268 | "shape": "Sz"
|
269 | }
|
270 | }
|
271 | }
|
272 | },
|
273 | "ListDatasets": {
|
274 | "http": {
|
275 | "method": "GET",
|
276 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets",
|
277 | "responseCode": 200
|
278 | },
|
279 | "input": {
|
280 | "type": "structure",
|
281 | "required": [
|
282 | "IdentityId",
|
283 | "IdentityPoolId"
|
284 | ],
|
285 | "members": {
|
286 | "IdentityPoolId": {
|
287 | "location": "uri",
|
288 | "locationName": "IdentityPoolId"
|
289 | },
|
290 | "IdentityId": {
|
291 | "location": "uri",
|
292 | "locationName": "IdentityId"
|
293 | },
|
294 | "NextToken": {
|
295 | "location": "querystring",
|
296 | "locationName": "nextToken"
|
297 | },
|
298 | "MaxResults": {
|
299 | "location": "querystring",
|
300 | "locationName": "maxResults",
|
301 | "type": "integer"
|
302 | }
|
303 | }
|
304 | },
|
305 | "output": {
|
306 | "type": "structure",
|
307 | "members": {
|
308 | "Datasets": {
|
309 | "type": "list",
|
310 | "member": {
|
311 | "shape": "S8"
|
312 | }
|
313 | },
|
314 | "Count": {
|
315 | "type": "integer"
|
316 | },
|
317 | "NextToken": {}
|
318 | }
|
319 | }
|
320 | },
|
321 | "ListIdentityPoolUsage": {
|
322 | "http": {
|
323 | "method": "GET",
|
324 | "requestUri": "/identitypools",
|
325 | "responseCode": 200
|
326 | },
|
327 | "input": {
|
328 | "type": "structure",
|
329 | "members": {
|
330 | "NextToken": {
|
331 | "location": "querystring",
|
332 | "locationName": "nextToken"
|
333 | },
|
334 | "MaxResults": {
|
335 | "location": "querystring",
|
336 | "locationName": "maxResults",
|
337 | "type": "integer"
|
338 | }
|
339 | }
|
340 | },
|
341 | "output": {
|
342 | "type": "structure",
|
343 | "members": {
|
344 | "IdentityPoolUsages": {
|
345 | "type": "list",
|
346 | "member": {
|
347 | "shape": "Sg"
|
348 | }
|
349 | },
|
350 | "MaxResults": {
|
351 | "type": "integer"
|
352 | },
|
353 | "Count": {
|
354 | "type": "integer"
|
355 | },
|
356 | "NextToken": {}
|
357 | }
|
358 | }
|
359 | },
|
360 | "ListRecords": {
|
361 | "http": {
|
362 | "method": "GET",
|
363 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records",
|
364 | "responseCode": 200
|
365 | },
|
366 | "input": {
|
367 | "type": "structure",
|
368 | "required": [
|
369 | "IdentityPoolId",
|
370 | "IdentityId",
|
371 | "DatasetName"
|
372 | ],
|
373 | "members": {
|
374 | "IdentityPoolId": {
|
375 | "location": "uri",
|
376 | "locationName": "IdentityPoolId"
|
377 | },
|
378 | "IdentityId": {
|
379 | "location": "uri",
|
380 | "locationName": "IdentityId"
|
381 | },
|
382 | "DatasetName": {
|
383 | "location": "uri",
|
384 | "locationName": "DatasetName"
|
385 | },
|
386 | "LastSyncCount": {
|
387 | "location": "querystring",
|
388 | "locationName": "lastSyncCount",
|
389 | "type": "long"
|
390 | },
|
391 | "NextToken": {
|
392 | "location": "querystring",
|
393 | "locationName": "nextToken"
|
394 | },
|
395 | "MaxResults": {
|
396 | "location": "querystring",
|
397 | "locationName": "maxResults",
|
398 | "type": "integer"
|
399 | },
|
400 | "SyncSessionToken": {
|
401 | "location": "querystring",
|
402 | "locationName": "syncSessionToken"
|
403 | }
|
404 | }
|
405 | },
|
406 | "output": {
|
407 | "type": "structure",
|
408 | "members": {
|
409 | "Records": {
|
410 | "shape": "S1c"
|
411 | },
|
412 | "NextToken": {},
|
413 | "Count": {
|
414 | "type": "integer"
|
415 | },
|
416 | "DatasetSyncCount": {
|
417 | "type": "long"
|
418 | },
|
419 | "LastModifiedBy": {},
|
420 | "MergedDatasetNames": {
|
421 | "type": "list",
|
422 | "member": {}
|
423 | },
|
424 | "DatasetExists": {
|
425 | "type": "boolean"
|
426 | },
|
427 | "DatasetDeletedAfterRequestedSyncCount": {
|
428 | "type": "boolean"
|
429 | },
|
430 | "SyncSessionToken": {}
|
431 | }
|
432 | }
|
433 | },
|
434 | "RegisterDevice": {
|
435 | "http": {
|
436 | "requestUri": "/identitypools/{IdentityPoolId}/identity/{IdentityId}/device",
|
437 | "responseCode": 200
|
438 | },
|
439 | "input": {
|
440 | "type": "structure",
|
441 | "required": [
|
442 | "IdentityPoolId",
|
443 | "IdentityId",
|
444 | "Platform",
|
445 | "Token"
|
446 | ],
|
447 | "members": {
|
448 | "IdentityPoolId": {
|
449 | "location": "uri",
|
450 | "locationName": "IdentityPoolId"
|
451 | },
|
452 | "IdentityId": {
|
453 | "location": "uri",
|
454 | "locationName": "IdentityId"
|
455 | },
|
456 | "Platform": {},
|
457 | "Token": {}
|
458 | }
|
459 | },
|
460 | "output": {
|
461 | "type": "structure",
|
462 | "members": {
|
463 | "DeviceId": {}
|
464 | }
|
465 | }
|
466 | },
|
467 | "SetCognitoEvents": {
|
468 | "http": {
|
469 | "requestUri": "/identitypools/{IdentityPoolId}/events",
|
470 | "responseCode": 200
|
471 | },
|
472 | "input": {
|
473 | "type": "structure",
|
474 | "required": [
|
475 | "IdentityPoolId",
|
476 | "Events"
|
477 | ],
|
478 | "members": {
|
479 | "IdentityPoolId": {
|
480 | "location": "uri",
|
481 | "locationName": "IdentityPoolId"
|
482 | },
|
483 | "Events": {
|
484 | "shape": "Sq"
|
485 | }
|
486 | }
|
487 | }
|
488 | },
|
489 | "SetIdentityPoolConfiguration": {
|
490 | "http": {
|
491 | "requestUri": "/identitypools/{IdentityPoolId}/configuration",
|
492 | "responseCode": 200
|
493 | },
|
494 | "input": {
|
495 | "type": "structure",
|
496 | "required": [
|
497 | "IdentityPoolId"
|
498 | ],
|
499 | "members": {
|
500 | "IdentityPoolId": {
|
501 | "location": "uri",
|
502 | "locationName": "IdentityPoolId"
|
503 | },
|
504 | "PushSync": {
|
505 | "shape": "Sv"
|
506 | },
|
507 | "CognitoStreams": {
|
508 | "shape": "Sz"
|
509 | }
|
510 | }
|
511 | },
|
512 | "output": {
|
513 | "type": "structure",
|
514 | "members": {
|
515 | "IdentityPoolId": {},
|
516 | "PushSync": {
|
517 | "shape": "Sv"
|
518 | },
|
519 | "CognitoStreams": {
|
520 | "shape": "Sz"
|
521 | }
|
522 | }
|
523 | }
|
524 | },
|
525 | "SubscribeToDataset": {
|
526 | "http": {
|
527 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}",
|
528 | "responseCode": 200
|
529 | },
|
530 | "input": {
|
531 | "type": "structure",
|
532 | "required": [
|
533 | "IdentityPoolId",
|
534 | "IdentityId",
|
535 | "DatasetName",
|
536 | "DeviceId"
|
537 | ],
|
538 | "members": {
|
539 | "IdentityPoolId": {
|
540 | "location": "uri",
|
541 | "locationName": "IdentityPoolId"
|
542 | },
|
543 | "IdentityId": {
|
544 | "location": "uri",
|
545 | "locationName": "IdentityId"
|
546 | },
|
547 | "DatasetName": {
|
548 | "location": "uri",
|
549 | "locationName": "DatasetName"
|
550 | },
|
551 | "DeviceId": {
|
552 | "location": "uri",
|
553 | "locationName": "DeviceId"
|
554 | }
|
555 | }
|
556 | },
|
557 | "output": {
|
558 | "type": "structure",
|
559 | "members": {}
|
560 | }
|
561 | },
|
562 | "UnsubscribeFromDataset": {
|
563 | "http": {
|
564 | "method": "DELETE",
|
565 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}",
|
566 | "responseCode": 200
|
567 | },
|
568 | "input": {
|
569 | "type": "structure",
|
570 | "required": [
|
571 | "IdentityPoolId",
|
572 | "IdentityId",
|
573 | "DatasetName",
|
574 | "DeviceId"
|
575 | ],
|
576 | "members": {
|
577 | "IdentityPoolId": {
|
578 | "location": "uri",
|
579 | "locationName": "IdentityPoolId"
|
580 | },
|
581 | "IdentityId": {
|
582 | "location": "uri",
|
583 | "locationName": "IdentityId"
|
584 | },
|
585 | "DatasetName": {
|
586 | "location": "uri",
|
587 | "locationName": "DatasetName"
|
588 | },
|
589 | "DeviceId": {
|
590 | "location": "uri",
|
591 | "locationName": "DeviceId"
|
592 | }
|
593 | }
|
594 | },
|
595 | "output": {
|
596 | "type": "structure",
|
597 | "members": {}
|
598 | }
|
599 | },
|
600 | "UpdateRecords": {
|
601 | "http": {
|
602 | "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
603 | "responseCode": 200
|
604 | },
|
605 | "input": {
|
606 | "type": "structure",
|
607 | "required": [
|
608 | "IdentityPoolId",
|
609 | "IdentityId",
|
610 | "DatasetName",
|
611 | "SyncSessionToken"
|
612 | ],
|
613 | "members": {
|
614 | "IdentityPoolId": {
|
615 | "location": "uri",
|
616 | "locationName": "IdentityPoolId"
|
617 | },
|
618 | "IdentityId": {
|
619 | "location": "uri",
|
620 | "locationName": "IdentityId"
|
621 | },
|
622 | "DatasetName": {
|
623 | "location": "uri",
|
624 | "locationName": "DatasetName"
|
625 | },
|
626 | "DeviceId": {},
|
627 | "RecordPatches": {
|
628 | "type": "list",
|
629 | "member": {
|
630 | "type": "structure",
|
631 | "required": [
|
632 | "Op",
|
633 | "Key",
|
634 | "SyncCount"
|
635 | ],
|
636 | "members": {
|
637 | "Op": {},
|
638 | "Key": {},
|
639 | "Value": {},
|
640 | "SyncCount": {
|
641 | "type": "long"
|
642 | },
|
643 | "DeviceLastModifiedDate": {
|
644 | "type": "timestamp"
|
645 | }
|
646 | }
|
647 | }
|
648 | },
|
649 | "SyncSessionToken": {},
|
650 | "ClientContext": {
|
651 | "location": "header",
|
652 | "locationName": "x-amz-Client-Context"
|
653 | }
|
654 | }
|
655 | },
|
656 | "output": {
|
657 | "type": "structure",
|
658 | "members": {
|
659 | "Records": {
|
660 | "shape": "S1c"
|
661 | }
|
662 | }
|
663 | }
|
664 | }
|
665 | },
|
666 | "shapes": {
|
667 | "S8": {
|
668 | "type": "structure",
|
669 | "members": {
|
670 | "IdentityId": {},
|
671 | "DatasetName": {},
|
672 | "CreationDate": {
|
673 | "type": "timestamp"
|
674 | },
|
675 | "LastModifiedDate": {
|
676 | "type": "timestamp"
|
677 | },
|
678 | "LastModifiedBy": {},
|
679 | "DataStorage": {
|
680 | "type": "long"
|
681 | },
|
682 | "NumRecords": {
|
683 | "type": "long"
|
684 | }
|
685 | }
|
686 | },
|
687 | "Sg": {
|
688 | "type": "structure",
|
689 | "members": {
|
690 | "IdentityPoolId": {},
|
691 | "SyncSessionsCount": {
|
692 | "type": "long"
|
693 | },
|
694 | "DataStorage": {
|
695 | "type": "long"
|
696 | },
|
697 | "LastModifiedDate": {
|
698 | "type": "timestamp"
|
699 | }
|
700 | }
|
701 | },
|
702 | "Sq": {
|
703 | "type": "map",
|
704 | "key": {},
|
705 | "value": {}
|
706 | },
|
707 | "Sv": {
|
708 | "type": "structure",
|
709 | "members": {
|
710 | "ApplicationArns": {
|
711 | "type": "list",
|
712 | "member": {}
|
713 | },
|
714 | "RoleArn": {}
|
715 | }
|
716 | },
|
717 | "Sz": {
|
718 | "type": "structure",
|
719 | "members": {
|
720 | "StreamName": {},
|
721 | "RoleArn": {},
|
722 | "StreamingStatus": {}
|
723 | }
|
724 | },
|
725 | "S1c": {
|
726 | "type": "list",
|
727 | "member": {
|
728 | "type": "structure",
|
729 | "members": {
|
730 | "Key": {},
|
731 | "Value": {},
|
732 | "SyncCount": {
|
733 | "type": "long"
|
734 | },
|
735 | "LastModifiedDate": {
|
736 | "type": "timestamp"
|
737 | },
|
738 | "LastModifiedBy": {},
|
739 | "DeviceLastModifiedDate": {
|
740 | "type": "timestamp"
|
741 | }
|
742 | }
|
743 | }
|
744 | }
|
745 | },
|
746 | "examples": {}
|
747 | } |
\ | No newline at end of file |