osis-2022-01-01.min.json 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2022-01-01",
  5. "endpointPrefix": "osis",
  6. "protocol": "rest-json",
  7. "serviceFullName": "Amazon OpenSearch Ingestion",
  8. "serviceId": "OSIS",
  9. "signatureVersion": "v4",
  10. "uid": "osis-2022-01-01"
  11. },
  12. "operations": {
  13. "CreatePipeline": {
  14. "http": {
  15. "requestUri": "/2022-01-01/osis/createPipeline"
  16. },
  17. "input": {
  18. "type": "structure",
  19. "required": [
  20. "PipelineName",
  21. "MinUnits",
  22. "MaxUnits",
  23. "PipelineConfigurationBody"
  24. ],
  25. "members": {
  26. "PipelineName": {},
  27. "MinUnits": {
  28. "type": "integer"
  29. },
  30. "MaxUnits": {
  31. "type": "integer"
  32. },
  33. "PipelineConfigurationBody": {},
  34. "LogPublishingOptions": {
  35. "shape": "S5"
  36. },
  37. "VpcOptions": {
  38. "shape": "S9"
  39. },
  40. "BufferOptions": {
  41. "shape": "Se"
  42. },
  43. "EncryptionAtRestOptions": {
  44. "shape": "Sf"
  45. },
  46. "Tags": {
  47. "shape": "Sh"
  48. }
  49. }
  50. },
  51. "output": {
  52. "type": "structure",
  53. "members": {
  54. "Pipeline": {
  55. "shape": "Sm"
  56. }
  57. }
  58. }
  59. },
  60. "DeletePipeline": {
  61. "http": {
  62. "method": "DELETE",
  63. "requestUri": "/2022-01-01/osis/deletePipeline/{PipelineName}"
  64. },
  65. "input": {
  66. "type": "structure",
  67. "required": [
  68. "PipelineName"
  69. ],
  70. "members": {
  71. "PipelineName": {
  72. "location": "uri",
  73. "locationName": "PipelineName"
  74. }
  75. }
  76. },
  77. "output": {
  78. "type": "structure",
  79. "members": {}
  80. }
  81. },
  82. "GetPipeline": {
  83. "http": {
  84. "method": "GET",
  85. "requestUri": "/2022-01-01/osis/getPipeline/{PipelineName}"
  86. },
  87. "input": {
  88. "type": "structure",
  89. "required": [
  90. "PipelineName"
  91. ],
  92. "members": {
  93. "PipelineName": {
  94. "location": "uri",
  95. "locationName": "PipelineName"
  96. }
  97. }
  98. },
  99. "output": {
  100. "type": "structure",
  101. "members": {
  102. "Pipeline": {
  103. "shape": "Sm"
  104. }
  105. }
  106. }
  107. },
  108. "GetPipelineBlueprint": {
  109. "http": {
  110. "method": "GET",
  111. "requestUri": "/2022-01-01/osis/getPipelineBlueprint/{BlueprintName}"
  112. },
  113. "input": {
  114. "type": "structure",
  115. "required": [
  116. "BlueprintName"
  117. ],
  118. "members": {
  119. "BlueprintName": {
  120. "location": "uri",
  121. "locationName": "BlueprintName"
  122. }
  123. }
  124. },
  125. "output": {
  126. "type": "structure",
  127. "members": {
  128. "Blueprint": {
  129. "type": "structure",
  130. "members": {
  131. "BlueprintName": {},
  132. "PipelineConfigurationBody": {}
  133. }
  134. }
  135. }
  136. }
  137. },
  138. "GetPipelineChangeProgress": {
  139. "http": {
  140. "method": "GET",
  141. "requestUri": "/2022-01-01/osis/getPipelineChangeProgress/{PipelineName}"
  142. },
  143. "input": {
  144. "type": "structure",
  145. "required": [
  146. "PipelineName"
  147. ],
  148. "members": {
  149. "PipelineName": {
  150. "location": "uri",
  151. "locationName": "PipelineName"
  152. }
  153. }
  154. },
  155. "output": {
  156. "type": "structure",
  157. "members": {
  158. "ChangeProgressStatuses": {
  159. "type": "list",
  160. "member": {
  161. "type": "structure",
  162. "members": {
  163. "StartTime": {
  164. "type": "timestamp"
  165. },
  166. "Status": {},
  167. "TotalNumberOfStages": {
  168. "type": "integer"
  169. },
  170. "ChangeProgressStages": {
  171. "type": "list",
  172. "member": {
  173. "type": "structure",
  174. "members": {
  175. "Name": {},
  176. "Status": {},
  177. "Description": {},
  178. "LastUpdatedAt": {
  179. "type": "timestamp"
  180. }
  181. }
  182. }
  183. }
  184. }
  185. }
  186. }
  187. }
  188. }
  189. },
  190. "ListPipelineBlueprints": {
  191. "http": {
  192. "requestUri": "/2022-01-01/osis/listPipelineBlueprints"
  193. },
  194. "input": {
  195. "type": "structure",
  196. "members": {}
  197. },
  198. "output": {
  199. "type": "structure",
  200. "members": {
  201. "Blueprints": {
  202. "type": "list",
  203. "member": {
  204. "type": "structure",
  205. "members": {
  206. "BlueprintName": {}
  207. }
  208. }
  209. }
  210. }
  211. }
  212. },
  213. "ListPipelines": {
  214. "http": {
  215. "method": "GET",
  216. "requestUri": "/2022-01-01/osis/listPipelines"
  217. },
  218. "input": {
  219. "type": "structure",
  220. "members": {
  221. "MaxResults": {
  222. "location": "querystring",
  223. "locationName": "maxResults",
  224. "type": "integer"
  225. },
  226. "NextToken": {
  227. "location": "querystring",
  228. "locationName": "nextToken"
  229. }
  230. }
  231. },
  232. "output": {
  233. "type": "structure",
  234. "members": {
  235. "NextToken": {},
  236. "Pipelines": {
  237. "type": "list",
  238. "member": {
  239. "type": "structure",
  240. "members": {
  241. "Status": {},
  242. "StatusReason": {
  243. "shape": "Sq"
  244. },
  245. "PipelineName": {},
  246. "PipelineArn": {},
  247. "MinUnits": {
  248. "type": "integer"
  249. },
  250. "MaxUnits": {
  251. "type": "integer"
  252. },
  253. "CreatedAt": {
  254. "type": "timestamp"
  255. },
  256. "LastUpdatedAt": {
  257. "type": "timestamp"
  258. },
  259. "Tags": {
  260. "shape": "Sh"
  261. }
  262. }
  263. }
  264. }
  265. }
  266. }
  267. },
  268. "ListTagsForResource": {
  269. "http": {
  270. "method": "GET",
  271. "requestUri": "/2022-01-01/osis/listTagsForResource/"
  272. },
  273. "input": {
  274. "type": "structure",
  275. "required": [
  276. "Arn"
  277. ],
  278. "members": {
  279. "Arn": {
  280. "location": "querystring",
  281. "locationName": "arn"
  282. }
  283. }
  284. },
  285. "output": {
  286. "type": "structure",
  287. "members": {
  288. "Tags": {
  289. "shape": "Sh"
  290. }
  291. }
  292. }
  293. },
  294. "StartPipeline": {
  295. "http": {
  296. "method": "PUT",
  297. "requestUri": "/2022-01-01/osis/startPipeline/{PipelineName}"
  298. },
  299. "input": {
  300. "type": "structure",
  301. "required": [
  302. "PipelineName"
  303. ],
  304. "members": {
  305. "PipelineName": {
  306. "location": "uri",
  307. "locationName": "PipelineName"
  308. }
  309. }
  310. },
  311. "output": {
  312. "type": "structure",
  313. "members": {
  314. "Pipeline": {
  315. "shape": "Sm"
  316. }
  317. }
  318. }
  319. },
  320. "StopPipeline": {
  321. "http": {
  322. "method": "PUT",
  323. "requestUri": "/2022-01-01/osis/stopPipeline/{PipelineName}"
  324. },
  325. "input": {
  326. "type": "structure",
  327. "required": [
  328. "PipelineName"
  329. ],
  330. "members": {
  331. "PipelineName": {
  332. "location": "uri",
  333. "locationName": "PipelineName"
  334. }
  335. }
  336. },
  337. "output": {
  338. "type": "structure",
  339. "members": {
  340. "Pipeline": {
  341. "shape": "Sm"
  342. }
  343. }
  344. }
  345. },
  346. "TagResource": {
  347. "http": {
  348. "requestUri": "/2022-01-01/osis/tagResource/"
  349. },
  350. "input": {
  351. "type": "structure",
  352. "required": [
  353. "Arn",
  354. "Tags"
  355. ],
  356. "members": {
  357. "Arn": {
  358. "location": "querystring",
  359. "locationName": "arn"
  360. },
  361. "Tags": {
  362. "shape": "Sh"
  363. }
  364. }
  365. },
  366. "output": {
  367. "type": "structure",
  368. "members": {}
  369. }
  370. },
  371. "UntagResource": {
  372. "http": {
  373. "requestUri": "/2022-01-01/osis/untagResource/"
  374. },
  375. "input": {
  376. "type": "structure",
  377. "required": [
  378. "Arn",
  379. "TagKeys"
  380. ],
  381. "members": {
  382. "Arn": {
  383. "location": "querystring",
  384. "locationName": "arn"
  385. },
  386. "TagKeys": {
  387. "type": "list",
  388. "member": {}
  389. }
  390. }
  391. },
  392. "output": {
  393. "type": "structure",
  394. "members": {}
  395. }
  396. },
  397. "UpdatePipeline": {
  398. "http": {
  399. "method": "PUT",
  400. "requestUri": "/2022-01-01/osis/updatePipeline/{PipelineName}"
  401. },
  402. "input": {
  403. "type": "structure",
  404. "required": [
  405. "PipelineName"
  406. ],
  407. "members": {
  408. "PipelineName": {
  409. "location": "uri",
  410. "locationName": "PipelineName"
  411. },
  412. "MinUnits": {
  413. "type": "integer"
  414. },
  415. "MaxUnits": {
  416. "type": "integer"
  417. },
  418. "PipelineConfigurationBody": {},
  419. "LogPublishingOptions": {
  420. "shape": "S5"
  421. },
  422. "BufferOptions": {
  423. "shape": "Se"
  424. },
  425. "EncryptionAtRestOptions": {
  426. "shape": "Sf"
  427. }
  428. }
  429. },
  430. "output": {
  431. "type": "structure",
  432. "members": {
  433. "Pipeline": {
  434. "shape": "Sm"
  435. }
  436. }
  437. }
  438. },
  439. "ValidatePipeline": {
  440. "http": {
  441. "requestUri": "/2022-01-01/osis/validatePipeline"
  442. },
  443. "input": {
  444. "type": "structure",
  445. "required": [
  446. "PipelineConfigurationBody"
  447. ],
  448. "members": {
  449. "PipelineConfigurationBody": {}
  450. }
  451. },
  452. "output": {
  453. "type": "structure",
  454. "members": {
  455. "isValid": {
  456. "type": "boolean"
  457. },
  458. "Errors": {
  459. "type": "list",
  460. "member": {
  461. "type": "structure",
  462. "members": {
  463. "Message": {}
  464. }
  465. }
  466. }
  467. }
  468. }
  469. }
  470. },
  471. "shapes": {
  472. "S5": {
  473. "type": "structure",
  474. "members": {
  475. "IsLoggingEnabled": {
  476. "type": "boolean"
  477. },
  478. "CloudWatchLogDestination": {
  479. "type": "structure",
  480. "required": [
  481. "LogGroup"
  482. ],
  483. "members": {
  484. "LogGroup": {}
  485. }
  486. }
  487. }
  488. },
  489. "S9": {
  490. "type": "structure",
  491. "required": [
  492. "SubnetIds"
  493. ],
  494. "members": {
  495. "SubnetIds": {
  496. "type": "list",
  497. "member": {}
  498. },
  499. "SecurityGroupIds": {
  500. "type": "list",
  501. "member": {}
  502. }
  503. }
  504. },
  505. "Se": {
  506. "type": "structure",
  507. "required": [
  508. "PersistentBufferEnabled"
  509. ],
  510. "members": {
  511. "PersistentBufferEnabled": {
  512. "type": "boolean"
  513. }
  514. }
  515. },
  516. "Sf": {
  517. "type": "structure",
  518. "required": [
  519. "KmsKeyArn"
  520. ],
  521. "members": {
  522. "KmsKeyArn": {}
  523. }
  524. },
  525. "Sh": {
  526. "type": "list",
  527. "member": {
  528. "type": "structure",
  529. "required": [
  530. "Key",
  531. "Value"
  532. ],
  533. "members": {
  534. "Key": {},
  535. "Value": {}
  536. }
  537. }
  538. },
  539. "Sm": {
  540. "type": "structure",
  541. "members": {
  542. "PipelineName": {},
  543. "PipelineArn": {},
  544. "MinUnits": {
  545. "type": "integer"
  546. },
  547. "MaxUnits": {
  548. "type": "integer"
  549. },
  550. "Status": {},
  551. "StatusReason": {
  552. "shape": "Sq"
  553. },
  554. "PipelineConfigurationBody": {},
  555. "CreatedAt": {
  556. "type": "timestamp"
  557. },
  558. "LastUpdatedAt": {
  559. "type": "timestamp"
  560. },
  561. "IngestEndpointUrls": {
  562. "type": "list",
  563. "member": {}
  564. },
  565. "LogPublishingOptions": {
  566. "shape": "S5"
  567. },
  568. "VpcEndpoints": {
  569. "type": "list",
  570. "member": {
  571. "type": "structure",
  572. "members": {
  573. "VpcEndpointId": {},
  574. "VpcId": {},
  575. "VpcOptions": {
  576. "shape": "S9"
  577. }
  578. }
  579. }
  580. },
  581. "BufferOptions": {
  582. "shape": "Se"
  583. },
  584. "EncryptionAtRestOptions": {
  585. "shape": "Sf"
  586. },
  587. "ServiceVpcEndpoints": {
  588. "type": "list",
  589. "member": {
  590. "type": "structure",
  591. "members": {
  592. "ServiceName": {},
  593. "VpcEndpointId": {}
  594. }
  595. }
  596. },
  597. "Tags": {
  598. "shape": "Sh"
  599. }
  600. }
  601. },
  602. "Sq": {
  603. "type": "structure",
  604. "members": {
  605. "Description": {}
  606. }
  607. }
  608. }
  609. }