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