cognito-sync-2014-06-30.min.json 17 KB

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