api-2.json 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  1. {
  2. "version":"2.0",
  3. "metadata":{
  4. "apiVersion":"2012-08-10",
  5. "endpointPrefix":"streams.dynamodb",
  6. "jsonVersion":"1.0",
  7. "serviceFullName":"Amazon DynamoDB Streams",
  8. "signatureVersion":"v4",
  9. "signingName":"dynamodb",
  10. "targetPrefix":"DynamoDBStreams_20120810",
  11. "protocol":"json"
  12. },
  13. "operations":{
  14. "DescribeStream":{
  15. "name":"DescribeStream",
  16. "http":{
  17. "method":"POST",
  18. "requestUri":"/"
  19. },
  20. "input":{"shape":"DescribeStreamInput"},
  21. "output":{"shape":"DescribeStreamOutput"},
  22. "errors":[
  23. {
  24. "shape":"ResourceNotFoundException",
  25. "exception":true
  26. },
  27. {
  28. "shape":"InternalServerError",
  29. "exception":true,
  30. "fault":true
  31. }
  32. ]
  33. },
  34. "GetRecords":{
  35. "name":"GetRecords",
  36. "http":{
  37. "method":"POST",
  38. "requestUri":"/"
  39. },
  40. "input":{"shape":"GetRecordsInput"},
  41. "output":{"shape":"GetRecordsOutput"},
  42. "errors":[
  43. {
  44. "shape":"ResourceNotFoundException",
  45. "exception":true
  46. },
  47. {
  48. "shape":"LimitExceededException",
  49. "exception":true
  50. },
  51. {
  52. "shape":"InternalServerError",
  53. "exception":true,
  54. "fault":true
  55. },
  56. {
  57. "shape":"ExpiredIteratorException",
  58. "exception":true
  59. },
  60. {
  61. "shape":"TrimmedDataAccessException",
  62. "exception":true
  63. }
  64. ]
  65. },
  66. "GetShardIterator":{
  67. "name":"GetShardIterator",
  68. "http":{
  69. "method":"POST",
  70. "requestUri":"/"
  71. },
  72. "input":{"shape":"GetShardIteratorInput"},
  73. "output":{"shape":"GetShardIteratorOutput"},
  74. "errors":[
  75. {
  76. "shape":"ResourceNotFoundException",
  77. "exception":true
  78. },
  79. {
  80. "shape":"InternalServerError",
  81. "exception":true,
  82. "fault":true
  83. },
  84. {
  85. "shape":"TrimmedDataAccessException",
  86. "exception":true
  87. }
  88. ]
  89. },
  90. "ListStreams":{
  91. "name":"ListStreams",
  92. "http":{
  93. "method":"POST",
  94. "requestUri":"/"
  95. },
  96. "input":{"shape":"ListStreamsInput"},
  97. "output":{"shape":"ListStreamsOutput"},
  98. "errors":[
  99. {
  100. "shape":"ResourceNotFoundException",
  101. "exception":true
  102. },
  103. {
  104. "shape":"InternalServerError",
  105. "exception":true,
  106. "fault":true
  107. }
  108. ]
  109. }
  110. },
  111. "shapes":{
  112. "AttributeMap":{
  113. "type":"map",
  114. "key":{"shape":"AttributeName"},
  115. "value":{"shape":"AttributeValue"}
  116. },
  117. "AttributeName":{
  118. "type":"string",
  119. "max":65535
  120. },
  121. "AttributeValue":{
  122. "type":"structure",
  123. "members":{
  124. "S":{"shape":"StringAttributeValue"},
  125. "N":{"shape":"NumberAttributeValue"},
  126. "B":{"shape":"BinaryAttributeValue"},
  127. "SS":{"shape":"StringSetAttributeValue"},
  128. "NS":{"shape":"NumberSetAttributeValue"},
  129. "BS":{"shape":"BinarySetAttributeValue"},
  130. "M":{"shape":"MapAttributeValue"},
  131. "L":{"shape":"ListAttributeValue"},
  132. "NULL":{"shape":"NullAttributeValue"},
  133. "BOOL":{"shape":"BooleanAttributeValue"}
  134. }
  135. },
  136. "BinaryAttributeValue":{"type":"blob"},
  137. "BinarySetAttributeValue":{
  138. "type":"list",
  139. "member":{"shape":"BinaryAttributeValue"}
  140. },
  141. "BooleanAttributeValue":{"type":"boolean"},
  142. "Date":{"type":"timestamp"},
  143. "DescribeStreamInput":{
  144. "type":"structure",
  145. "required":["StreamArn"],
  146. "members":{
  147. "StreamArn":{"shape":"StreamArn"},
  148. "Limit":{"shape":"PositiveIntegerObject"},
  149. "ExclusiveStartShardId":{"shape":"ShardId"}
  150. }
  151. },
  152. "DescribeStreamOutput":{
  153. "type":"structure",
  154. "members":{
  155. "StreamDescription":{"shape":"StreamDescription"}
  156. }
  157. },
  158. "ErrorMessage":{"type":"string"},
  159. "ExpiredIteratorException":{
  160. "type":"structure",
  161. "members":{
  162. "message":{"shape":"ErrorMessage"}
  163. },
  164. "exception":true
  165. },
  166. "GetRecordsInput":{
  167. "type":"structure",
  168. "required":["ShardIterator"],
  169. "members":{
  170. "ShardIterator":{"shape":"ShardIterator"},
  171. "Limit":{"shape":"PositiveIntegerObject"}
  172. }
  173. },
  174. "GetRecordsOutput":{
  175. "type":"structure",
  176. "members":{
  177. "Records":{"shape":"RecordList"},
  178. "NextShardIterator":{"shape":"ShardIterator"}
  179. }
  180. },
  181. "GetShardIteratorInput":{
  182. "type":"structure",
  183. "required":[
  184. "StreamArn",
  185. "ShardId",
  186. "ShardIteratorType"
  187. ],
  188. "members":{
  189. "StreamArn":{"shape":"StreamArn"},
  190. "ShardId":{"shape":"ShardId"},
  191. "ShardIteratorType":{"shape":"ShardIteratorType"},
  192. "SequenceNumber":{"shape":"SequenceNumber"}
  193. }
  194. },
  195. "GetShardIteratorOutput":{
  196. "type":"structure",
  197. "members":{
  198. "ShardIterator":{"shape":"ShardIterator"}
  199. }
  200. },
  201. "InternalServerError":{
  202. "type":"structure",
  203. "members":{
  204. "message":{"shape":"ErrorMessage"}
  205. },
  206. "exception":true,
  207. "fault":true
  208. },
  209. "KeySchema":{
  210. "type":"list",
  211. "member":{"shape":"KeySchemaElement"},
  212. "min":1,
  213. "max":2
  214. },
  215. "KeySchemaAttributeName":{
  216. "type":"string",
  217. "min":1,
  218. "max":255
  219. },
  220. "KeySchemaElement":{
  221. "type":"structure",
  222. "required":[
  223. "AttributeName",
  224. "KeyType"
  225. ],
  226. "members":{
  227. "AttributeName":{"shape":"KeySchemaAttributeName"},
  228. "KeyType":{"shape":"KeyType"}
  229. }
  230. },
  231. "KeyType":{
  232. "type":"string",
  233. "enum":[
  234. "HASH",
  235. "RANGE"
  236. ]
  237. },
  238. "LimitExceededException":{
  239. "type":"structure",
  240. "members":{
  241. "message":{"shape":"ErrorMessage"}
  242. },
  243. "exception":true
  244. },
  245. "ListAttributeValue":{
  246. "type":"list",
  247. "member":{"shape":"AttributeValue"}
  248. },
  249. "ListStreamsInput":{
  250. "type":"structure",
  251. "members":{
  252. "TableName":{"shape":"TableName"},
  253. "Limit":{"shape":"PositiveIntegerObject"},
  254. "ExclusiveStartStreamArn":{"shape":"StreamArn"}
  255. }
  256. },
  257. "ListStreamsOutput":{
  258. "type":"structure",
  259. "members":{
  260. "Streams":{"shape":"StreamList"},
  261. "LastEvaluatedStreamArn":{"shape":"StreamArn"}
  262. }
  263. },
  264. "MapAttributeValue":{
  265. "type":"map",
  266. "key":{"shape":"AttributeName"},
  267. "value":{"shape":"AttributeValue"}
  268. },
  269. "NullAttributeValue":{"type":"boolean"},
  270. "NumberAttributeValue":{"type":"string"},
  271. "NumberSetAttributeValue":{
  272. "type":"list",
  273. "member":{"shape":"NumberAttributeValue"}
  274. },
  275. "OperationType":{
  276. "type":"string",
  277. "enum":[
  278. "INSERT",
  279. "MODIFY",
  280. "REMOVE"
  281. ]
  282. },
  283. "PositiveIntegerObject":{
  284. "type":"integer",
  285. "min":1
  286. },
  287. "PositiveLongObject":{
  288. "type":"long",
  289. "min":1
  290. },
  291. "Record":{
  292. "type":"structure",
  293. "members":{
  294. "eventID":{"shape":"String"},
  295. "eventName":{"shape":"OperationType"},
  296. "eventVersion":{"shape":"String"},
  297. "eventSource":{"shape":"String"},
  298. "awsRegion":{"shape":"String"},
  299. "dynamodb":{"shape":"StreamRecord"}
  300. }
  301. },
  302. "RecordList":{
  303. "type":"list",
  304. "member":{"shape":"Record"}
  305. },
  306. "ResourceNotFoundException":{
  307. "type":"structure",
  308. "members":{
  309. "message":{"shape":"ErrorMessage"}
  310. },
  311. "exception":true
  312. },
  313. "SequenceNumber":{
  314. "type":"string",
  315. "min":21,
  316. "max":40
  317. },
  318. "SequenceNumberRange":{
  319. "type":"structure",
  320. "members":{
  321. "StartingSequenceNumber":{"shape":"SequenceNumber"},
  322. "EndingSequenceNumber":{"shape":"SequenceNumber"}
  323. }
  324. },
  325. "Shard":{
  326. "type":"structure",
  327. "members":{
  328. "ShardId":{"shape":"ShardId"},
  329. "SequenceNumberRange":{"shape":"SequenceNumberRange"},
  330. "ParentShardId":{"shape":"ShardId"}
  331. }
  332. },
  333. "ShardDescriptionList":{
  334. "type":"list",
  335. "member":{"shape":"Shard"}
  336. },
  337. "ShardId":{
  338. "type":"string",
  339. "min":28,
  340. "max":65
  341. },
  342. "ShardIterator":{
  343. "type":"string",
  344. "min":1,
  345. "max":2048
  346. },
  347. "ShardIteratorType":{
  348. "type":"string",
  349. "enum":[
  350. "TRIM_HORIZON",
  351. "LATEST",
  352. "AT_SEQUENCE_NUMBER",
  353. "AFTER_SEQUENCE_NUMBER"
  354. ]
  355. },
  356. "Stream":{
  357. "type":"structure",
  358. "members":{
  359. "StreamArn":{"shape":"StreamArn"},
  360. "TableName":{"shape":"TableName"},
  361. "StreamLabel":{"shape":"String"}
  362. }
  363. },
  364. "StreamArn":{
  365. "type":"string",
  366. "min":37,
  367. "max":1024
  368. },
  369. "StreamDescription":{
  370. "type":"structure",
  371. "members":{
  372. "StreamArn":{"shape":"StreamArn"},
  373. "StreamLabel":{"shape":"String"},
  374. "StreamStatus":{"shape":"StreamStatus"},
  375. "StreamViewType":{"shape":"StreamViewType"},
  376. "CreationRequestDateTime":{"shape":"Date"},
  377. "TableName":{"shape":"TableName"},
  378. "KeySchema":{"shape":"KeySchema"},
  379. "Shards":{"shape":"ShardDescriptionList"},
  380. "LastEvaluatedShardId":{"shape":"ShardId"}
  381. }
  382. },
  383. "StreamList":{
  384. "type":"list",
  385. "member":{"shape":"Stream"}
  386. },
  387. "StreamRecord":{
  388. "type":"structure",
  389. "members":{
  390. "Keys":{"shape":"AttributeMap"},
  391. "NewImage":{"shape":"AttributeMap"},
  392. "OldImage":{"shape":"AttributeMap"},
  393. "SequenceNumber":{"shape":"SequenceNumber"},
  394. "SizeBytes":{"shape":"PositiveLongObject"},
  395. "StreamViewType":{"shape":"StreamViewType"}
  396. }
  397. },
  398. "StreamStatus":{
  399. "type":"string",
  400. "enum":[
  401. "ENABLING",
  402. "ENABLED",
  403. "DISABLING",
  404. "DISABLED"
  405. ]
  406. },
  407. "StreamViewType":{
  408. "type":"string",
  409. "enum":[
  410. "NEW_IMAGE",
  411. "OLD_IMAGE",
  412. "NEW_AND_OLD_IMAGES",
  413. "KEYS_ONLY"
  414. ]
  415. },
  416. "String":{"type":"string"},
  417. "StringAttributeValue":{"type":"string"},
  418. "StringSetAttributeValue":{
  419. "type":"list",
  420. "member":{"shape":"StringAttributeValue"}
  421. },
  422. "TableName":{
  423. "type":"string",
  424. "min":3,
  425. "max":255,
  426. "pattern":"[a-zA-Z0-9_.-]+"
  427. },
  428. "TrimmedDataAccessException":{
  429. "type":"structure",
  430. "members":{
  431. "message":{"shape":"ErrorMessage"}
  432. },
  433. "exception":true
  434. }
  435. }
  436. }