api-2.json 9.8 KB

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