UNPKG

12.3 kBJSONView Raw
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 "CreateLedger": {
17 "http": {
18 "requestUri": "/ledgers"
19 },
20 "input": {
21 "type": "structure",
22 "required": [
23 "Name",
24 "PermissionsMode"
25 ],
26 "members": {
27 "Name": {},
28 "Tags": {
29 "shape": "S3"
30 },
31 "PermissionsMode": {},
32 "DeletionProtection": {
33 "type": "boolean"
34 }
35 }
36 },
37 "output": {
38 "type": "structure",
39 "members": {
40 "Name": {},
41 "Arn": {},
42 "State": {},
43 "CreationDateTime": {
44 "type": "timestamp"
45 },
46 "DeletionProtection": {
47 "type": "boolean"
48 }
49 }
50 }
51 },
52 "DeleteLedger": {
53 "http": {
54 "method": "DELETE",
55 "requestUri": "/ledgers/{name}"
56 },
57 "input": {
58 "type": "structure",
59 "required": [
60 "Name"
61 ],
62 "members": {
63 "Name": {
64 "location": "uri",
65 "locationName": "name"
66 }
67 }
68 }
69 },
70 "DescribeJournalS3Export": {
71 "http": {
72 "method": "GET",
73 "requestUri": "/ledgers/{name}/journal-s3-exports/{exportId}"
74 },
75 "input": {
76 "type": "structure",
77 "required": [
78 "Name",
79 "ExportId"
80 ],
81 "members": {
82 "Name": {
83 "location": "uri",
84 "locationName": "name"
85 },
86 "ExportId": {
87 "location": "uri",
88 "locationName": "exportId"
89 }
90 }
91 },
92 "output": {
93 "type": "structure",
94 "required": [
95 "ExportDescription"
96 ],
97 "members": {
98 "ExportDescription": {
99 "shape": "Sg"
100 }
101 }
102 }
103 },
104 "DescribeLedger": {
105 "http": {
106 "method": "GET",
107 "requestUri": "/ledgers/{name}"
108 },
109 "input": {
110 "type": "structure",
111 "required": [
112 "Name"
113 ],
114 "members": {
115 "Name": {
116 "location": "uri",
117 "locationName": "name"
118 }
119 }
120 },
121 "output": {
122 "type": "structure",
123 "members": {
124 "Name": {},
125 "Arn": {},
126 "State": {},
127 "CreationDateTime": {
128 "type": "timestamp"
129 },
130 "DeletionProtection": {
131 "type": "boolean"
132 }
133 }
134 }
135 },
136 "ExportJournalToS3": {
137 "http": {
138 "requestUri": "/ledgers/{name}/journal-s3-exports"
139 },
140 "input": {
141 "type": "structure",
142 "required": [
143 "Name",
144 "InclusiveStartTime",
145 "ExclusiveEndTime",
146 "S3ExportConfiguration",
147 "RoleArn"
148 ],
149 "members": {
150 "Name": {
151 "location": "uri",
152 "locationName": "name"
153 },
154 "InclusiveStartTime": {
155 "type": "timestamp"
156 },
157 "ExclusiveEndTime": {
158 "type": "timestamp"
159 },
160 "S3ExportConfiguration": {
161 "shape": "Si"
162 },
163 "RoleArn": {}
164 }
165 },
166 "output": {
167 "type": "structure",
168 "required": [
169 "ExportId"
170 ],
171 "members": {
172 "ExportId": {}
173 }
174 }
175 },
176 "GetBlock": {
177 "http": {
178 "requestUri": "/ledgers/{name}/block"
179 },
180 "input": {
181 "type": "structure",
182 "required": [
183 "Name",
184 "BlockAddress"
185 ],
186 "members": {
187 "Name": {
188 "location": "uri",
189 "locationName": "name"
190 },
191 "BlockAddress": {
192 "shape": "Ss"
193 },
194 "DigestTipAddress": {
195 "shape": "Ss"
196 }
197 }
198 },
199 "output": {
200 "type": "structure",
201 "required": [
202 "Block"
203 ],
204 "members": {
205 "Block": {
206 "shape": "Ss"
207 },
208 "Proof": {
209 "shape": "Ss"
210 }
211 }
212 }
213 },
214 "GetDigest": {
215 "http": {
216 "requestUri": "/ledgers/{name}/digest"
217 },
218 "input": {
219 "type": "structure",
220 "required": [
221 "Name"
222 ],
223 "members": {
224 "Name": {
225 "location": "uri",
226 "locationName": "name"
227 }
228 }
229 },
230 "output": {
231 "type": "structure",
232 "required": [
233 "Digest",
234 "DigestTipAddress"
235 ],
236 "members": {
237 "Digest": {
238 "type": "blob"
239 },
240 "DigestTipAddress": {
241 "shape": "Ss"
242 }
243 }
244 }
245 },
246 "GetRevision": {
247 "http": {
248 "requestUri": "/ledgers/{name}/revision"
249 },
250 "input": {
251 "type": "structure",
252 "required": [
253 "Name",
254 "BlockAddress",
255 "DocumentId"
256 ],
257 "members": {
258 "Name": {
259 "location": "uri",
260 "locationName": "name"
261 },
262 "BlockAddress": {
263 "shape": "Ss"
264 },
265 "DocumentId": {},
266 "DigestTipAddress": {
267 "shape": "Ss"
268 }
269 }
270 },
271 "output": {
272 "type": "structure",
273 "required": [
274 "Revision"
275 ],
276 "members": {
277 "Proof": {
278 "shape": "Ss"
279 },
280 "Revision": {
281 "shape": "Ss"
282 }
283 }
284 }
285 },
286 "ListJournalS3Exports": {
287 "http": {
288 "method": "GET",
289 "requestUri": "/journal-s3-exports"
290 },
291 "input": {
292 "type": "structure",
293 "members": {
294 "MaxResults": {
295 "location": "querystring",
296 "locationName": "max_results",
297 "type": "integer"
298 },
299 "NextToken": {
300 "location": "querystring",
301 "locationName": "next_token"
302 }
303 }
304 },
305 "output": {
306 "type": "structure",
307 "members": {
308 "JournalS3Exports": {
309 "shape": "S14"
310 },
311 "NextToken": {}
312 }
313 }
314 },
315 "ListJournalS3ExportsForLedger": {
316 "http": {
317 "method": "GET",
318 "requestUri": "/ledgers/{name}/journal-s3-exports"
319 },
320 "input": {
321 "type": "structure",
322 "required": [
323 "Name"
324 ],
325 "members": {
326 "Name": {
327 "location": "uri",
328 "locationName": "name"
329 },
330 "MaxResults": {
331 "location": "querystring",
332 "locationName": "max_results",
333 "type": "integer"
334 },
335 "NextToken": {
336 "location": "querystring",
337 "locationName": "next_token"
338 }
339 }
340 },
341 "output": {
342 "type": "structure",
343 "members": {
344 "JournalS3Exports": {
345 "shape": "S14"
346 },
347 "NextToken": {}
348 }
349 }
350 },
351 "ListLedgers": {
352 "http": {
353 "method": "GET",
354 "requestUri": "/ledgers"
355 },
356 "input": {
357 "type": "structure",
358 "members": {
359 "MaxResults": {
360 "location": "querystring",
361 "locationName": "max_results",
362 "type": "integer"
363 },
364 "NextToken": {
365 "location": "querystring",
366 "locationName": "next_token"
367 }
368 }
369 },
370 "output": {
371 "type": "structure",
372 "members": {
373 "Ledgers": {
374 "type": "list",
375 "member": {
376 "type": "structure",
377 "members": {
378 "Name": {},
379 "State": {},
380 "CreationDateTime": {
381 "type": "timestamp"
382 }
383 }
384 }
385 },
386 "NextToken": {}
387 }
388 }
389 },
390 "ListTagsForResource": {
391 "http": {
392 "method": "GET",
393 "requestUri": "/tags/{resourceArn}"
394 },
395 "input": {
396 "type": "structure",
397 "required": [
398 "ResourceArn"
399 ],
400 "members": {
401 "ResourceArn": {
402 "location": "uri",
403 "locationName": "resourceArn"
404 }
405 }
406 },
407 "output": {
408 "type": "structure",
409 "members": {
410 "Tags": {
411 "shape": "S3"
412 }
413 }
414 }
415 },
416 "TagResource": {
417 "http": {
418 "requestUri": "/tags/{resourceArn}"
419 },
420 "input": {
421 "type": "structure",
422 "required": [
423 "ResourceArn",
424 "Tags"
425 ],
426 "members": {
427 "ResourceArn": {
428 "location": "uri",
429 "locationName": "resourceArn"
430 },
431 "Tags": {
432 "shape": "S3"
433 }
434 }
435 },
436 "output": {
437 "type": "structure",
438 "members": {}
439 }
440 },
441 "UntagResource": {
442 "http": {
443 "method": "DELETE",
444 "requestUri": "/tags/{resourceArn}"
445 },
446 "input": {
447 "type": "structure",
448 "required": [
449 "ResourceArn",
450 "TagKeys"
451 ],
452 "members": {
453 "ResourceArn": {
454 "location": "uri",
455 "locationName": "resourceArn"
456 },
457 "TagKeys": {
458 "location": "querystring",
459 "locationName": "tagKeys",
460 "type": "list",
461 "member": {}
462 }
463 }
464 },
465 "output": {
466 "type": "structure",
467 "members": {}
468 }
469 },
470 "UpdateLedger": {
471 "http": {
472 "method": "PATCH",
473 "requestUri": "/ledgers/{name}"
474 },
475 "input": {
476 "type": "structure",
477 "required": [
478 "Name"
479 ],
480 "members": {
481 "Name": {
482 "location": "uri",
483 "locationName": "name"
484 },
485 "DeletionProtection": {
486 "type": "boolean"
487 }
488 }
489 },
490 "output": {
491 "type": "structure",
492 "members": {
493 "Name": {},
494 "Arn": {},
495 "State": {},
496 "CreationDateTime": {
497 "type": "timestamp"
498 },
499 "DeletionProtection": {
500 "type": "boolean"
501 }
502 }
503 }
504 }
505 },
506 "shapes": {
507 "S3": {
508 "type": "map",
509 "key": {},
510 "value": {}
511 },
512 "Sg": {
513 "type": "structure",
514 "required": [
515 "LedgerName",
516 "ExportId",
517 "ExportCreationTime",
518 "Status",
519 "InclusiveStartTime",
520 "ExclusiveEndTime",
521 "S3ExportConfiguration",
522 "RoleArn"
523 ],
524 "members": {
525 "LedgerName": {},
526 "ExportId": {},
527 "ExportCreationTime": {
528 "type": "timestamp"
529 },
530 "Status": {},
531 "InclusiveStartTime": {
532 "type": "timestamp"
533 },
534 "ExclusiveEndTime": {
535 "type": "timestamp"
536 },
537 "S3ExportConfiguration": {
538 "shape": "Si"
539 },
540 "RoleArn": {}
541 }
542 },
543 "Si": {
544 "type": "structure",
545 "required": [
546 "Bucket",
547 "Prefix",
548 "EncryptionConfiguration"
549 ],
550 "members": {
551 "Bucket": {},
552 "Prefix": {},
553 "EncryptionConfiguration": {
554 "type": "structure",
555 "required": [
556 "ObjectEncryptionType"
557 ],
558 "members": {
559 "ObjectEncryptionType": {},
560 "KmsKeyArn": {}
561 }
562 }
563 }
564 },
565 "Ss": {
566 "type": "structure",
567 "members": {
568 "IonText": {
569 "type": "string",
570 "sensitive": true
571 }
572 },
573 "sensitive": true
574 },
575 "S14": {
576 "type": "list",
577 "member": {
578 "shape": "Sg"
579 }
580 }
581 }
582}
\No newline at end of file