qldb-2019-01-02.min.json 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2019-01-02",
  5. "endpointPrefix": "qldb",
  6. "jsonVersion": "1.0",
  7. "protocol": "rest-json",
  8. "serviceAbbreviation": "QLDB",
  9. "serviceFullName": "Amazon QLDB",
  10. "serviceId": "QLDB",
  11. "signatureVersion": "v4",
  12. "signingName": "qldb",
  13. "uid": "qldb-2019-01-02"
  14. },
  15. "operations": {
  16. "CancelJournalKinesisStream": {
  17. "http": {
  18. "method": "DELETE",
  19. "requestUri": "/ledgers/{name}/journal-kinesis-streams/{streamId}"
  20. },
  21. "input": {
  22. "type": "structure",
  23. "required": [
  24. "LedgerName",
  25. "StreamId"
  26. ],
  27. "members": {
  28. "LedgerName": {
  29. "location": "uri",
  30. "locationName": "name"
  31. },
  32. "StreamId": {
  33. "location": "uri",
  34. "locationName": "streamId"
  35. }
  36. }
  37. },
  38. "output": {
  39. "type": "structure",
  40. "members": {
  41. "StreamId": {}
  42. }
  43. }
  44. },
  45. "CreateLedger": {
  46. "http": {
  47. "requestUri": "/ledgers"
  48. },
  49. "input": {
  50. "type": "structure",
  51. "required": [
  52. "Name",
  53. "PermissionsMode"
  54. ],
  55. "members": {
  56. "Name": {},
  57. "Tags": {
  58. "shape": "S6"
  59. },
  60. "PermissionsMode": {},
  61. "DeletionProtection": {
  62. "type": "boolean"
  63. },
  64. "KmsKey": {}
  65. }
  66. },
  67. "output": {
  68. "type": "structure",
  69. "members": {
  70. "Name": {},
  71. "Arn": {},
  72. "State": {},
  73. "CreationDateTime": {
  74. "type": "timestamp"
  75. },
  76. "PermissionsMode": {},
  77. "DeletionProtection": {
  78. "type": "boolean"
  79. },
  80. "KmsKeyArn": {}
  81. }
  82. }
  83. },
  84. "DeleteLedger": {
  85. "http": {
  86. "method": "DELETE",
  87. "requestUri": "/ledgers/{name}"
  88. },
  89. "input": {
  90. "type": "structure",
  91. "required": [
  92. "Name"
  93. ],
  94. "members": {
  95. "Name": {
  96. "location": "uri",
  97. "locationName": "name"
  98. }
  99. }
  100. }
  101. },
  102. "DescribeJournalKinesisStream": {
  103. "http": {
  104. "method": "GET",
  105. "requestUri": "/ledgers/{name}/journal-kinesis-streams/{streamId}"
  106. },
  107. "input": {
  108. "type": "structure",
  109. "required": [
  110. "LedgerName",
  111. "StreamId"
  112. ],
  113. "members": {
  114. "LedgerName": {
  115. "location": "uri",
  116. "locationName": "name"
  117. },
  118. "StreamId": {
  119. "location": "uri",
  120. "locationName": "streamId"
  121. }
  122. }
  123. },
  124. "output": {
  125. "type": "structure",
  126. "members": {
  127. "Stream": {
  128. "shape": "Sj"
  129. }
  130. }
  131. }
  132. },
  133. "DescribeJournalS3Export": {
  134. "http": {
  135. "method": "GET",
  136. "requestUri": "/ledgers/{name}/journal-s3-exports/{exportId}"
  137. },
  138. "input": {
  139. "type": "structure",
  140. "required": [
  141. "Name",
  142. "ExportId"
  143. ],
  144. "members": {
  145. "Name": {
  146. "location": "uri",
  147. "locationName": "name"
  148. },
  149. "ExportId": {
  150. "location": "uri",
  151. "locationName": "exportId"
  152. }
  153. }
  154. },
  155. "output": {
  156. "type": "structure",
  157. "required": [
  158. "ExportDescription"
  159. ],
  160. "members": {
  161. "ExportDescription": {
  162. "shape": "Sr"
  163. }
  164. }
  165. }
  166. },
  167. "DescribeLedger": {
  168. "http": {
  169. "method": "GET",
  170. "requestUri": "/ledgers/{name}"
  171. },
  172. "input": {
  173. "type": "structure",
  174. "required": [
  175. "Name"
  176. ],
  177. "members": {
  178. "Name": {
  179. "location": "uri",
  180. "locationName": "name"
  181. }
  182. }
  183. },
  184. "output": {
  185. "type": "structure",
  186. "members": {
  187. "Name": {},
  188. "Arn": {},
  189. "State": {},
  190. "CreationDateTime": {
  191. "type": "timestamp"
  192. },
  193. "PermissionsMode": {},
  194. "DeletionProtection": {
  195. "type": "boolean"
  196. },
  197. "EncryptionDescription": {
  198. "shape": "S11"
  199. }
  200. }
  201. }
  202. },
  203. "ExportJournalToS3": {
  204. "http": {
  205. "requestUri": "/ledgers/{name}/journal-s3-exports"
  206. },
  207. "input": {
  208. "type": "structure",
  209. "required": [
  210. "Name",
  211. "InclusiveStartTime",
  212. "ExclusiveEndTime",
  213. "S3ExportConfiguration",
  214. "RoleArn"
  215. ],
  216. "members": {
  217. "Name": {
  218. "location": "uri",
  219. "locationName": "name"
  220. },
  221. "InclusiveStartTime": {
  222. "type": "timestamp"
  223. },
  224. "ExclusiveEndTime": {
  225. "type": "timestamp"
  226. },
  227. "S3ExportConfiguration": {
  228. "shape": "St"
  229. },
  230. "RoleArn": {},
  231. "OutputFormat": {}
  232. }
  233. },
  234. "output": {
  235. "type": "structure",
  236. "required": [
  237. "ExportId"
  238. ],
  239. "members": {
  240. "ExportId": {}
  241. }
  242. }
  243. },
  244. "GetBlock": {
  245. "http": {
  246. "requestUri": "/ledgers/{name}/block"
  247. },
  248. "input": {
  249. "type": "structure",
  250. "required": [
  251. "Name",
  252. "BlockAddress"
  253. ],
  254. "members": {
  255. "Name": {
  256. "location": "uri",
  257. "locationName": "name"
  258. },
  259. "BlockAddress": {
  260. "shape": "S16"
  261. },
  262. "DigestTipAddress": {
  263. "shape": "S16"
  264. }
  265. }
  266. },
  267. "output": {
  268. "type": "structure",
  269. "required": [
  270. "Block"
  271. ],
  272. "members": {
  273. "Block": {
  274. "shape": "S16"
  275. },
  276. "Proof": {
  277. "shape": "S16"
  278. }
  279. }
  280. }
  281. },
  282. "GetDigest": {
  283. "http": {
  284. "requestUri": "/ledgers/{name}/digest"
  285. },
  286. "input": {
  287. "type": "structure",
  288. "required": [
  289. "Name"
  290. ],
  291. "members": {
  292. "Name": {
  293. "location": "uri",
  294. "locationName": "name"
  295. }
  296. }
  297. },
  298. "output": {
  299. "type": "structure",
  300. "required": [
  301. "Digest",
  302. "DigestTipAddress"
  303. ],
  304. "members": {
  305. "Digest": {
  306. "type": "blob"
  307. },
  308. "DigestTipAddress": {
  309. "shape": "S16"
  310. }
  311. }
  312. }
  313. },
  314. "GetRevision": {
  315. "http": {
  316. "requestUri": "/ledgers/{name}/revision"
  317. },
  318. "input": {
  319. "type": "structure",
  320. "required": [
  321. "Name",
  322. "BlockAddress",
  323. "DocumentId"
  324. ],
  325. "members": {
  326. "Name": {
  327. "location": "uri",
  328. "locationName": "name"
  329. },
  330. "BlockAddress": {
  331. "shape": "S16"
  332. },
  333. "DocumentId": {},
  334. "DigestTipAddress": {
  335. "shape": "S16"
  336. }
  337. }
  338. },
  339. "output": {
  340. "type": "structure",
  341. "required": [
  342. "Revision"
  343. ],
  344. "members": {
  345. "Proof": {
  346. "shape": "S16"
  347. },
  348. "Revision": {
  349. "shape": "S16"
  350. }
  351. }
  352. }
  353. },
  354. "ListJournalKinesisStreamsForLedger": {
  355. "http": {
  356. "method": "GET",
  357. "requestUri": "/ledgers/{name}/journal-kinesis-streams"
  358. },
  359. "input": {
  360. "type": "structure",
  361. "required": [
  362. "LedgerName"
  363. ],
  364. "members": {
  365. "LedgerName": {
  366. "location": "uri",
  367. "locationName": "name"
  368. },
  369. "MaxResults": {
  370. "location": "querystring",
  371. "locationName": "max_results",
  372. "type": "integer"
  373. },
  374. "NextToken": {
  375. "location": "querystring",
  376. "locationName": "next_token"
  377. }
  378. }
  379. },
  380. "output": {
  381. "type": "structure",
  382. "members": {
  383. "Streams": {
  384. "type": "list",
  385. "member": {
  386. "shape": "Sj"
  387. }
  388. },
  389. "NextToken": {}
  390. }
  391. }
  392. },
  393. "ListJournalS3Exports": {
  394. "http": {
  395. "method": "GET",
  396. "requestUri": "/journal-s3-exports"
  397. },
  398. "input": {
  399. "type": "structure",
  400. "members": {
  401. "MaxResults": {
  402. "location": "querystring",
  403. "locationName": "max_results",
  404. "type": "integer"
  405. },
  406. "NextToken": {
  407. "location": "querystring",
  408. "locationName": "next_token"
  409. }
  410. }
  411. },
  412. "output": {
  413. "type": "structure",
  414. "members": {
  415. "JournalS3Exports": {
  416. "shape": "S1l"
  417. },
  418. "NextToken": {}
  419. }
  420. }
  421. },
  422. "ListJournalS3ExportsForLedger": {
  423. "http": {
  424. "method": "GET",
  425. "requestUri": "/ledgers/{name}/journal-s3-exports"
  426. },
  427. "input": {
  428. "type": "structure",
  429. "required": [
  430. "Name"
  431. ],
  432. "members": {
  433. "Name": {
  434. "location": "uri",
  435. "locationName": "name"
  436. },
  437. "MaxResults": {
  438. "location": "querystring",
  439. "locationName": "max_results",
  440. "type": "integer"
  441. },
  442. "NextToken": {
  443. "location": "querystring",
  444. "locationName": "next_token"
  445. }
  446. }
  447. },
  448. "output": {
  449. "type": "structure",
  450. "members": {
  451. "JournalS3Exports": {
  452. "shape": "S1l"
  453. },
  454. "NextToken": {}
  455. }
  456. }
  457. },
  458. "ListLedgers": {
  459. "http": {
  460. "method": "GET",
  461. "requestUri": "/ledgers"
  462. },
  463. "input": {
  464. "type": "structure",
  465. "members": {
  466. "MaxResults": {
  467. "location": "querystring",
  468. "locationName": "max_results",
  469. "type": "integer"
  470. },
  471. "NextToken": {
  472. "location": "querystring",
  473. "locationName": "next_token"
  474. }
  475. }
  476. },
  477. "output": {
  478. "type": "structure",
  479. "members": {
  480. "Ledgers": {
  481. "type": "list",
  482. "member": {
  483. "type": "structure",
  484. "members": {
  485. "Name": {},
  486. "State": {},
  487. "CreationDateTime": {
  488. "type": "timestamp"
  489. }
  490. }
  491. }
  492. },
  493. "NextToken": {}
  494. }
  495. }
  496. },
  497. "ListTagsForResource": {
  498. "http": {
  499. "method": "GET",
  500. "requestUri": "/tags/{resourceArn}"
  501. },
  502. "input": {
  503. "type": "structure",
  504. "required": [
  505. "ResourceArn"
  506. ],
  507. "members": {
  508. "ResourceArn": {
  509. "location": "uri",
  510. "locationName": "resourceArn"
  511. }
  512. }
  513. },
  514. "output": {
  515. "type": "structure",
  516. "members": {
  517. "Tags": {
  518. "shape": "S6"
  519. }
  520. }
  521. }
  522. },
  523. "StreamJournalToKinesis": {
  524. "http": {
  525. "requestUri": "/ledgers/{name}/journal-kinesis-streams"
  526. },
  527. "input": {
  528. "type": "structure",
  529. "required": [
  530. "LedgerName",
  531. "RoleArn",
  532. "InclusiveStartTime",
  533. "KinesisConfiguration",
  534. "StreamName"
  535. ],
  536. "members": {
  537. "LedgerName": {
  538. "location": "uri",
  539. "locationName": "name"
  540. },
  541. "RoleArn": {},
  542. "Tags": {
  543. "shape": "S6"
  544. },
  545. "InclusiveStartTime": {
  546. "type": "timestamp"
  547. },
  548. "ExclusiveEndTime": {
  549. "type": "timestamp"
  550. },
  551. "KinesisConfiguration": {
  552. "shape": "Sl"
  553. },
  554. "StreamName": {}
  555. }
  556. },
  557. "output": {
  558. "type": "structure",
  559. "members": {
  560. "StreamId": {}
  561. }
  562. }
  563. },
  564. "TagResource": {
  565. "http": {
  566. "requestUri": "/tags/{resourceArn}"
  567. },
  568. "input": {
  569. "type": "structure",
  570. "required": [
  571. "ResourceArn",
  572. "Tags"
  573. ],
  574. "members": {
  575. "ResourceArn": {
  576. "location": "uri",
  577. "locationName": "resourceArn"
  578. },
  579. "Tags": {
  580. "shape": "S6"
  581. }
  582. }
  583. },
  584. "output": {
  585. "type": "structure",
  586. "members": {}
  587. }
  588. },
  589. "UntagResource": {
  590. "http": {
  591. "method": "DELETE",
  592. "requestUri": "/tags/{resourceArn}"
  593. },
  594. "input": {
  595. "type": "structure",
  596. "required": [
  597. "ResourceArn",
  598. "TagKeys"
  599. ],
  600. "members": {
  601. "ResourceArn": {
  602. "location": "uri",
  603. "locationName": "resourceArn"
  604. },
  605. "TagKeys": {
  606. "location": "querystring",
  607. "locationName": "tagKeys",
  608. "type": "list",
  609. "member": {}
  610. }
  611. }
  612. },
  613. "output": {
  614. "type": "structure",
  615. "members": {}
  616. }
  617. },
  618. "UpdateLedger": {
  619. "http": {
  620. "method": "PATCH",
  621. "requestUri": "/ledgers/{name}"
  622. },
  623. "input": {
  624. "type": "structure",
  625. "required": [
  626. "Name"
  627. ],
  628. "members": {
  629. "Name": {
  630. "location": "uri",
  631. "locationName": "name"
  632. },
  633. "DeletionProtection": {
  634. "type": "boolean"
  635. },
  636. "KmsKey": {}
  637. }
  638. },
  639. "output": {
  640. "type": "structure",
  641. "members": {
  642. "Name": {},
  643. "Arn": {},
  644. "State": {},
  645. "CreationDateTime": {
  646. "type": "timestamp"
  647. },
  648. "DeletionProtection": {
  649. "type": "boolean"
  650. },
  651. "EncryptionDescription": {
  652. "shape": "S11"
  653. }
  654. }
  655. }
  656. },
  657. "UpdateLedgerPermissionsMode": {
  658. "http": {
  659. "method": "PATCH",
  660. "requestUri": "/ledgers/{name}/permissions-mode"
  661. },
  662. "input": {
  663. "type": "structure",
  664. "required": [
  665. "Name",
  666. "PermissionsMode"
  667. ],
  668. "members": {
  669. "Name": {
  670. "location": "uri",
  671. "locationName": "name"
  672. },
  673. "PermissionsMode": {}
  674. }
  675. },
  676. "output": {
  677. "type": "structure",
  678. "members": {
  679. "Name": {},
  680. "Arn": {},
  681. "PermissionsMode": {}
  682. }
  683. }
  684. }
  685. },
  686. "shapes": {
  687. "S6": {
  688. "type": "map",
  689. "key": {},
  690. "value": {}
  691. },
  692. "Sj": {
  693. "type": "structure",
  694. "required": [
  695. "LedgerName",
  696. "RoleArn",
  697. "StreamId",
  698. "Status",
  699. "KinesisConfiguration",
  700. "StreamName"
  701. ],
  702. "members": {
  703. "LedgerName": {},
  704. "CreationTime": {
  705. "type": "timestamp"
  706. },
  707. "InclusiveStartTime": {
  708. "type": "timestamp"
  709. },
  710. "ExclusiveEndTime": {
  711. "type": "timestamp"
  712. },
  713. "RoleArn": {},
  714. "StreamId": {},
  715. "Arn": {},
  716. "Status": {},
  717. "KinesisConfiguration": {
  718. "shape": "Sl"
  719. },
  720. "ErrorCause": {},
  721. "StreamName": {}
  722. }
  723. },
  724. "Sl": {
  725. "type": "structure",
  726. "required": [
  727. "StreamArn"
  728. ],
  729. "members": {
  730. "StreamArn": {},
  731. "AggregationEnabled": {
  732. "type": "boolean"
  733. }
  734. }
  735. },
  736. "Sr": {
  737. "type": "structure",
  738. "required": [
  739. "LedgerName",
  740. "ExportId",
  741. "ExportCreationTime",
  742. "Status",
  743. "InclusiveStartTime",
  744. "ExclusiveEndTime",
  745. "S3ExportConfiguration",
  746. "RoleArn"
  747. ],
  748. "members": {
  749. "LedgerName": {},
  750. "ExportId": {},
  751. "ExportCreationTime": {
  752. "type": "timestamp"
  753. },
  754. "Status": {},
  755. "InclusiveStartTime": {
  756. "type": "timestamp"
  757. },
  758. "ExclusiveEndTime": {
  759. "type": "timestamp"
  760. },
  761. "S3ExportConfiguration": {
  762. "shape": "St"
  763. },
  764. "RoleArn": {},
  765. "OutputFormat": {}
  766. }
  767. },
  768. "St": {
  769. "type": "structure",
  770. "required": [
  771. "Bucket",
  772. "Prefix",
  773. "EncryptionConfiguration"
  774. ],
  775. "members": {
  776. "Bucket": {},
  777. "Prefix": {},
  778. "EncryptionConfiguration": {
  779. "type": "structure",
  780. "required": [
  781. "ObjectEncryptionType"
  782. ],
  783. "members": {
  784. "ObjectEncryptionType": {},
  785. "KmsKeyArn": {}
  786. }
  787. }
  788. }
  789. },
  790. "S11": {
  791. "type": "structure",
  792. "required": [
  793. "KmsKeyArn",
  794. "EncryptionStatus"
  795. ],
  796. "members": {
  797. "KmsKeyArn": {},
  798. "EncryptionStatus": {},
  799. "InaccessibleKmsKeyDateTime": {
  800. "type": "timestamp"
  801. }
  802. }
  803. },
  804. "S16": {
  805. "type": "structure",
  806. "members": {
  807. "IonText": {
  808. "type": "string",
  809. "sensitive": true
  810. }
  811. },
  812. "sensitive": true
  813. },
  814. "S1l": {
  815. "type": "list",
  816. "member": {
  817. "shape": "Sr"
  818. }
  819. }
  820. }
  821. }