finspace-data-2020-07-13.min.json 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2020-07-13",
  5. "endpointPrefix": "finspace-api",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceAbbreviation": "FinSpace Data",
  9. "serviceFullName": "FinSpace Public API",
  10. "serviceId": "finspace data",
  11. "signatureVersion": "v4",
  12. "signingName": "finspace-api",
  13. "uid": "finspace-2020-07-13"
  14. },
  15. "operations": {
  16. "AssociateUserToPermissionGroup": {
  17. "http": {
  18. "requestUri": "/permission-group/{permissionGroupId}/users/{userId}"
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "permissionGroupId",
  24. "userId"
  25. ],
  26. "members": {
  27. "permissionGroupId": {
  28. "location": "uri",
  29. "locationName": "permissionGroupId"
  30. },
  31. "userId": {
  32. "location": "uri",
  33. "locationName": "userId"
  34. },
  35. "clientToken": {
  36. "idempotencyToken": true
  37. }
  38. }
  39. },
  40. "output": {
  41. "type": "structure",
  42. "members": {
  43. "statusCode": {
  44. "location": "statusCode",
  45. "type": "integer"
  46. }
  47. }
  48. },
  49. "deprecated": true,
  50. "deprecatedMessage": "This method will be discontinued."
  51. },
  52. "CreateChangeset": {
  53. "http": {
  54. "requestUri": "/datasets/{datasetId}/changesetsv2"
  55. },
  56. "input": {
  57. "type": "structure",
  58. "required": [
  59. "datasetId",
  60. "changeType",
  61. "sourceParams",
  62. "formatParams"
  63. ],
  64. "members": {
  65. "clientToken": {
  66. "idempotencyToken": true
  67. },
  68. "datasetId": {
  69. "location": "uri",
  70. "locationName": "datasetId"
  71. },
  72. "changeType": {},
  73. "sourceParams": {
  74. "shape": "Sa"
  75. },
  76. "formatParams": {
  77. "shape": "Sd"
  78. }
  79. }
  80. },
  81. "output": {
  82. "type": "structure",
  83. "members": {
  84. "datasetId": {},
  85. "changesetId": {}
  86. }
  87. },
  88. "deprecated": true,
  89. "deprecatedMessage": "This method will be discontinued."
  90. },
  91. "CreateDataView": {
  92. "http": {
  93. "requestUri": "/datasets/{datasetId}/dataviewsv2"
  94. },
  95. "input": {
  96. "type": "structure",
  97. "required": [
  98. "datasetId",
  99. "destinationTypeParams"
  100. ],
  101. "members": {
  102. "clientToken": {
  103. "idempotencyToken": true
  104. },
  105. "datasetId": {
  106. "location": "uri",
  107. "locationName": "datasetId"
  108. },
  109. "autoUpdate": {
  110. "type": "boolean"
  111. },
  112. "sortColumns": {
  113. "shape": "Si"
  114. },
  115. "partitionColumns": {
  116. "shape": "Sk"
  117. },
  118. "asOfTimestamp": {
  119. "type": "long"
  120. },
  121. "destinationTypeParams": {
  122. "shape": "Sm"
  123. }
  124. }
  125. },
  126. "output": {
  127. "type": "structure",
  128. "members": {
  129. "datasetId": {},
  130. "dataViewId": {}
  131. }
  132. },
  133. "deprecated": true,
  134. "deprecatedMessage": "This method will be discontinued."
  135. },
  136. "CreateDataset": {
  137. "http": {
  138. "requestUri": "/datasetsv2"
  139. },
  140. "input": {
  141. "type": "structure",
  142. "required": [
  143. "datasetTitle",
  144. "kind",
  145. "permissionGroupParams"
  146. ],
  147. "members": {
  148. "clientToken": {
  149. "idempotencyToken": true
  150. },
  151. "datasetTitle": {},
  152. "kind": {},
  153. "datasetDescription": {},
  154. "ownerInfo": {
  155. "shape": "Sw"
  156. },
  157. "permissionGroupParams": {
  158. "type": "structure",
  159. "members": {
  160. "permissionGroupId": {},
  161. "datasetPermissions": {
  162. "type": "list",
  163. "member": {
  164. "type": "structure",
  165. "members": {
  166. "permission": {}
  167. }
  168. }
  169. }
  170. }
  171. },
  172. "alias": {},
  173. "schemaDefinition": {
  174. "shape": "S15"
  175. }
  176. }
  177. },
  178. "output": {
  179. "type": "structure",
  180. "members": {
  181. "datasetId": {}
  182. }
  183. },
  184. "deprecated": true,
  185. "deprecatedMessage": "This method will be discontinued."
  186. },
  187. "CreatePermissionGroup": {
  188. "http": {
  189. "requestUri": "/permission-group"
  190. },
  191. "input": {
  192. "type": "structure",
  193. "required": [
  194. "name",
  195. "applicationPermissions"
  196. ],
  197. "members": {
  198. "name": {
  199. "shape": "S1f"
  200. },
  201. "description": {
  202. "shape": "S1g"
  203. },
  204. "applicationPermissions": {
  205. "shape": "S1h"
  206. },
  207. "clientToken": {
  208. "idempotencyToken": true
  209. }
  210. }
  211. },
  212. "output": {
  213. "type": "structure",
  214. "members": {
  215. "permissionGroupId": {}
  216. }
  217. },
  218. "deprecated": true,
  219. "deprecatedMessage": "This method will be discontinued."
  220. },
  221. "CreateUser": {
  222. "http": {
  223. "requestUri": "/user"
  224. },
  225. "input": {
  226. "type": "structure",
  227. "required": [
  228. "emailAddress",
  229. "type"
  230. ],
  231. "members": {
  232. "emailAddress": {
  233. "shape": "Sz"
  234. },
  235. "type": {},
  236. "firstName": {
  237. "shape": "S1m"
  238. },
  239. "lastName": {
  240. "shape": "S1n"
  241. },
  242. "apiAccess": {},
  243. "apiAccessPrincipalArn": {},
  244. "clientToken": {
  245. "idempotencyToken": true
  246. }
  247. }
  248. },
  249. "output": {
  250. "type": "structure",
  251. "members": {
  252. "userId": {}
  253. }
  254. },
  255. "deprecated": true,
  256. "deprecatedMessage": "This method will be discontinued."
  257. },
  258. "DeleteDataset": {
  259. "http": {
  260. "method": "DELETE",
  261. "requestUri": "/datasetsv2/{datasetId}"
  262. },
  263. "input": {
  264. "type": "structure",
  265. "required": [
  266. "datasetId"
  267. ],
  268. "members": {
  269. "clientToken": {
  270. "idempotencyToken": true,
  271. "location": "querystring",
  272. "locationName": "clientToken"
  273. },
  274. "datasetId": {
  275. "location": "uri",
  276. "locationName": "datasetId"
  277. }
  278. }
  279. },
  280. "output": {
  281. "type": "structure",
  282. "members": {
  283. "datasetId": {}
  284. }
  285. },
  286. "deprecated": true,
  287. "deprecatedMessage": "This method will be discontinued."
  288. },
  289. "DeletePermissionGroup": {
  290. "http": {
  291. "method": "DELETE",
  292. "requestUri": "/permission-group/{permissionGroupId}"
  293. },
  294. "input": {
  295. "type": "structure",
  296. "required": [
  297. "permissionGroupId"
  298. ],
  299. "members": {
  300. "permissionGroupId": {
  301. "location": "uri",
  302. "locationName": "permissionGroupId"
  303. },
  304. "clientToken": {
  305. "idempotencyToken": true,
  306. "location": "querystring",
  307. "locationName": "clientToken"
  308. }
  309. }
  310. },
  311. "output": {
  312. "type": "structure",
  313. "members": {
  314. "permissionGroupId": {}
  315. }
  316. },
  317. "deprecated": true,
  318. "deprecatedMessage": "This method will be discontinued."
  319. },
  320. "DisableUser": {
  321. "http": {
  322. "requestUri": "/user/{userId}/disable"
  323. },
  324. "input": {
  325. "type": "structure",
  326. "required": [
  327. "userId"
  328. ],
  329. "members": {
  330. "userId": {
  331. "location": "uri",
  332. "locationName": "userId"
  333. },
  334. "clientToken": {
  335. "idempotencyToken": true
  336. }
  337. }
  338. },
  339. "output": {
  340. "type": "structure",
  341. "members": {
  342. "userId": {}
  343. }
  344. },
  345. "deprecated": true,
  346. "deprecatedMessage": "This method will be discontinued."
  347. },
  348. "DisassociateUserFromPermissionGroup": {
  349. "http": {
  350. "method": "DELETE",
  351. "requestUri": "/permission-group/{permissionGroupId}/users/{userId}"
  352. },
  353. "input": {
  354. "type": "structure",
  355. "required": [
  356. "permissionGroupId",
  357. "userId"
  358. ],
  359. "members": {
  360. "permissionGroupId": {
  361. "location": "uri",
  362. "locationName": "permissionGroupId"
  363. },
  364. "userId": {
  365. "location": "uri",
  366. "locationName": "userId"
  367. },
  368. "clientToken": {
  369. "idempotencyToken": true,
  370. "location": "querystring",
  371. "locationName": "clientToken"
  372. }
  373. }
  374. },
  375. "output": {
  376. "type": "structure",
  377. "members": {
  378. "statusCode": {
  379. "location": "statusCode",
  380. "type": "integer"
  381. }
  382. }
  383. },
  384. "deprecated": true,
  385. "deprecatedMessage": "This method will be discontinued."
  386. },
  387. "EnableUser": {
  388. "http": {
  389. "requestUri": "/user/{userId}/enable"
  390. },
  391. "input": {
  392. "type": "structure",
  393. "required": [
  394. "userId"
  395. ],
  396. "members": {
  397. "userId": {
  398. "location": "uri",
  399. "locationName": "userId"
  400. },
  401. "clientToken": {
  402. "idempotencyToken": true
  403. }
  404. }
  405. },
  406. "output": {
  407. "type": "structure",
  408. "members": {
  409. "userId": {}
  410. }
  411. },
  412. "deprecated": true,
  413. "deprecatedMessage": "This method will be discontinued."
  414. },
  415. "GetChangeset": {
  416. "http": {
  417. "method": "GET",
  418. "requestUri": "/datasets/{datasetId}/changesetsv2/{changesetId}"
  419. },
  420. "input": {
  421. "type": "structure",
  422. "required": [
  423. "datasetId",
  424. "changesetId"
  425. ],
  426. "members": {
  427. "datasetId": {
  428. "location": "uri",
  429. "locationName": "datasetId"
  430. },
  431. "changesetId": {
  432. "location": "uri",
  433. "locationName": "changesetId"
  434. }
  435. }
  436. },
  437. "output": {
  438. "type": "structure",
  439. "members": {
  440. "changesetId": {},
  441. "changesetArn": {},
  442. "datasetId": {},
  443. "changeType": {},
  444. "sourceParams": {
  445. "shape": "Sa"
  446. },
  447. "formatParams": {
  448. "shape": "Sd"
  449. },
  450. "createTime": {
  451. "type": "long"
  452. },
  453. "status": {},
  454. "errorInfo": {
  455. "shape": "S25"
  456. },
  457. "activeUntilTimestamp": {
  458. "type": "long"
  459. },
  460. "activeFromTimestamp": {
  461. "type": "long"
  462. },
  463. "updatesChangesetId": {},
  464. "updatedByChangesetId": {}
  465. }
  466. },
  467. "deprecated": true,
  468. "deprecatedMessage": "This method will be discontinued."
  469. },
  470. "GetDataView": {
  471. "http": {
  472. "method": "GET",
  473. "requestUri": "/datasets/{datasetId}/dataviewsv2/{dataviewId}"
  474. },
  475. "input": {
  476. "type": "structure",
  477. "required": [
  478. "dataViewId",
  479. "datasetId"
  480. ],
  481. "members": {
  482. "dataViewId": {
  483. "location": "uri",
  484. "locationName": "dataviewId"
  485. },
  486. "datasetId": {
  487. "location": "uri",
  488. "locationName": "datasetId"
  489. }
  490. }
  491. },
  492. "output": {
  493. "type": "structure",
  494. "members": {
  495. "autoUpdate": {
  496. "type": "boolean"
  497. },
  498. "partitionColumns": {
  499. "shape": "Sk"
  500. },
  501. "datasetId": {},
  502. "asOfTimestamp": {
  503. "type": "long"
  504. },
  505. "errorInfo": {
  506. "shape": "S2a"
  507. },
  508. "lastModifiedTime": {
  509. "type": "long"
  510. },
  511. "createTime": {
  512. "type": "long"
  513. },
  514. "sortColumns": {
  515. "shape": "Si"
  516. },
  517. "dataViewId": {},
  518. "dataViewArn": {},
  519. "destinationTypeParams": {
  520. "shape": "Sm"
  521. },
  522. "status": {}
  523. }
  524. },
  525. "deprecated": true,
  526. "deprecatedMessage": "This method will be discontinued."
  527. },
  528. "GetDataset": {
  529. "http": {
  530. "method": "GET",
  531. "requestUri": "/datasetsv2/{datasetId}"
  532. },
  533. "input": {
  534. "type": "structure",
  535. "required": [
  536. "datasetId"
  537. ],
  538. "members": {
  539. "datasetId": {
  540. "location": "uri",
  541. "locationName": "datasetId"
  542. }
  543. }
  544. },
  545. "output": {
  546. "type": "structure",
  547. "members": {
  548. "datasetId": {},
  549. "datasetArn": {},
  550. "datasetTitle": {},
  551. "kind": {},
  552. "datasetDescription": {},
  553. "createTime": {
  554. "type": "long"
  555. },
  556. "lastModifiedTime": {
  557. "type": "long"
  558. },
  559. "schemaDefinition": {
  560. "shape": "S15"
  561. },
  562. "alias": {},
  563. "status": {}
  564. }
  565. },
  566. "deprecated": true,
  567. "deprecatedMessage": "This method will be discontinued."
  568. },
  569. "GetExternalDataViewAccessDetails": {
  570. "http": {
  571. "requestUri": "/datasets/{datasetId}/dataviewsv2/{dataviewId}/external-access-details"
  572. },
  573. "input": {
  574. "type": "structure",
  575. "required": [
  576. "dataViewId",
  577. "datasetId"
  578. ],
  579. "members": {
  580. "dataViewId": {
  581. "location": "uri",
  582. "locationName": "dataviewId"
  583. },
  584. "datasetId": {
  585. "location": "uri",
  586. "locationName": "datasetId"
  587. }
  588. }
  589. },
  590. "output": {
  591. "type": "structure",
  592. "members": {
  593. "credentials": {
  594. "type": "structure",
  595. "members": {
  596. "accessKeyId": {},
  597. "secretAccessKey": {
  598. "type": "string",
  599. "sensitive": true
  600. },
  601. "sessionToken": {
  602. "type": "string",
  603. "sensitive": true
  604. },
  605. "expiration": {
  606. "type": "long"
  607. }
  608. },
  609. "sensitive": true
  610. },
  611. "s3Location": {
  612. "type": "structure",
  613. "required": [
  614. "bucket",
  615. "key"
  616. ],
  617. "members": {
  618. "bucket": {},
  619. "key": {}
  620. }
  621. }
  622. }
  623. },
  624. "deprecated": true,
  625. "deprecatedMessage": "This method will be discontinued."
  626. },
  627. "GetPermissionGroup": {
  628. "http": {
  629. "method": "GET",
  630. "requestUri": "/permission-group/{permissionGroupId}"
  631. },
  632. "input": {
  633. "type": "structure",
  634. "required": [
  635. "permissionGroupId"
  636. ],
  637. "members": {
  638. "permissionGroupId": {
  639. "location": "uri",
  640. "locationName": "permissionGroupId"
  641. }
  642. }
  643. },
  644. "output": {
  645. "type": "structure",
  646. "members": {
  647. "permissionGroup": {
  648. "shape": "S2s"
  649. }
  650. }
  651. },
  652. "deprecated": true,
  653. "deprecatedMessage": "This method will be discontinued."
  654. },
  655. "GetProgrammaticAccessCredentials": {
  656. "http": {
  657. "method": "GET",
  658. "requestUri": "/credentials/programmatic"
  659. },
  660. "input": {
  661. "type": "structure",
  662. "required": [
  663. "environmentId"
  664. ],
  665. "members": {
  666. "durationInMinutes": {
  667. "location": "querystring",
  668. "locationName": "durationInMinutes",
  669. "type": "long"
  670. },
  671. "environmentId": {
  672. "location": "querystring",
  673. "locationName": "environmentId"
  674. }
  675. }
  676. },
  677. "output": {
  678. "type": "structure",
  679. "members": {
  680. "credentials": {
  681. "type": "structure",
  682. "members": {
  683. "accessKeyId": {},
  684. "secretAccessKey": {},
  685. "sessionToken": {}
  686. },
  687. "sensitive": true
  688. },
  689. "durationInMinutes": {
  690. "type": "long"
  691. }
  692. }
  693. },
  694. "deprecated": true,
  695. "deprecatedMessage": "This method will be discontinued."
  696. },
  697. "GetUser": {
  698. "http": {
  699. "method": "GET",
  700. "requestUri": "/user/{userId}"
  701. },
  702. "input": {
  703. "type": "structure",
  704. "required": [
  705. "userId"
  706. ],
  707. "members": {
  708. "userId": {
  709. "location": "uri",
  710. "locationName": "userId"
  711. }
  712. }
  713. },
  714. "output": {
  715. "type": "structure",
  716. "members": {
  717. "userId": {},
  718. "status": {},
  719. "firstName": {
  720. "shape": "S1m"
  721. },
  722. "lastName": {
  723. "shape": "S1n"
  724. },
  725. "emailAddress": {
  726. "shape": "Sz"
  727. },
  728. "type": {},
  729. "apiAccess": {},
  730. "apiAccessPrincipalArn": {},
  731. "createTime": {
  732. "type": "long"
  733. },
  734. "lastEnabledTime": {
  735. "type": "long"
  736. },
  737. "lastDisabledTime": {
  738. "type": "long"
  739. },
  740. "lastModifiedTime": {
  741. "type": "long"
  742. },
  743. "lastLoginTime": {
  744. "type": "long"
  745. }
  746. }
  747. },
  748. "deprecated": true,
  749. "deprecatedMessage": "This method will be discontinued."
  750. },
  751. "GetWorkingLocation": {
  752. "http": {
  753. "requestUri": "/workingLocationV1"
  754. },
  755. "input": {
  756. "type": "structure",
  757. "members": {
  758. "locationType": {}
  759. }
  760. },
  761. "output": {
  762. "type": "structure",
  763. "members": {
  764. "s3Uri": {},
  765. "s3Path": {},
  766. "s3Bucket": {}
  767. }
  768. },
  769. "deprecated": true,
  770. "deprecatedMessage": "This method will be discontinued."
  771. },
  772. "ListChangesets": {
  773. "http": {
  774. "method": "GET",
  775. "requestUri": "/datasets/{datasetId}/changesetsv2"
  776. },
  777. "input": {
  778. "type": "structure",
  779. "required": [
  780. "datasetId"
  781. ],
  782. "members": {
  783. "datasetId": {
  784. "location": "uri",
  785. "locationName": "datasetId"
  786. },
  787. "maxResults": {
  788. "location": "querystring",
  789. "locationName": "maxResults",
  790. "type": "integer"
  791. },
  792. "nextToken": {
  793. "location": "querystring",
  794. "locationName": "nextToken"
  795. }
  796. }
  797. },
  798. "output": {
  799. "type": "structure",
  800. "members": {
  801. "changesets": {
  802. "type": "list",
  803. "member": {
  804. "type": "structure",
  805. "members": {
  806. "changesetId": {},
  807. "changesetArn": {},
  808. "datasetId": {},
  809. "changeType": {},
  810. "sourceParams": {
  811. "shape": "Sa"
  812. },
  813. "formatParams": {
  814. "shape": "Sd"
  815. },
  816. "createTime": {
  817. "type": "long"
  818. },
  819. "status": {},
  820. "errorInfo": {
  821. "shape": "S25"
  822. },
  823. "activeUntilTimestamp": {
  824. "type": "long"
  825. },
  826. "activeFromTimestamp": {
  827. "type": "long"
  828. },
  829. "updatesChangesetId": {},
  830. "updatedByChangesetId": {}
  831. }
  832. }
  833. },
  834. "nextToken": {}
  835. }
  836. },
  837. "deprecated": true,
  838. "deprecatedMessage": "This method will be discontinued."
  839. },
  840. "ListDataViews": {
  841. "http": {
  842. "method": "GET",
  843. "requestUri": "/datasets/{datasetId}/dataviewsv2"
  844. },
  845. "input": {
  846. "type": "structure",
  847. "required": [
  848. "datasetId"
  849. ],
  850. "members": {
  851. "datasetId": {
  852. "location": "uri",
  853. "locationName": "datasetId"
  854. },
  855. "nextToken": {
  856. "location": "querystring",
  857. "locationName": "nextToken"
  858. },
  859. "maxResults": {
  860. "location": "querystring",
  861. "locationName": "maxResults",
  862. "type": "integer"
  863. }
  864. }
  865. },
  866. "output": {
  867. "type": "structure",
  868. "members": {
  869. "nextToken": {},
  870. "dataViews": {
  871. "type": "list",
  872. "member": {
  873. "type": "structure",
  874. "members": {
  875. "dataViewId": {},
  876. "dataViewArn": {},
  877. "datasetId": {},
  878. "asOfTimestamp": {
  879. "type": "long"
  880. },
  881. "partitionColumns": {
  882. "shape": "Sk"
  883. },
  884. "sortColumns": {
  885. "shape": "Si"
  886. },
  887. "status": {},
  888. "errorInfo": {
  889. "shape": "S2a"
  890. },
  891. "destinationTypeProperties": {
  892. "shape": "Sm"
  893. },
  894. "autoUpdate": {
  895. "type": "boolean"
  896. },
  897. "createTime": {
  898. "type": "long"
  899. },
  900. "lastModifiedTime": {
  901. "type": "long"
  902. }
  903. }
  904. }
  905. }
  906. }
  907. },
  908. "deprecated": true,
  909. "deprecatedMessage": "This method will be discontinued."
  910. },
  911. "ListDatasets": {
  912. "http": {
  913. "method": "GET",
  914. "requestUri": "/datasetsv2"
  915. },
  916. "input": {
  917. "type": "structure",
  918. "members": {
  919. "nextToken": {
  920. "location": "querystring",
  921. "locationName": "nextToken"
  922. },
  923. "maxResults": {
  924. "location": "querystring",
  925. "locationName": "maxResults",
  926. "type": "integer"
  927. }
  928. }
  929. },
  930. "output": {
  931. "type": "structure",
  932. "members": {
  933. "datasets": {
  934. "type": "list",
  935. "member": {
  936. "type": "structure",
  937. "members": {
  938. "datasetId": {},
  939. "datasetArn": {},
  940. "datasetTitle": {},
  941. "kind": {},
  942. "datasetDescription": {},
  943. "ownerInfo": {
  944. "shape": "Sw"
  945. },
  946. "createTime": {
  947. "type": "long"
  948. },
  949. "lastModifiedTime": {
  950. "type": "long"
  951. },
  952. "schemaDefinition": {
  953. "shape": "S15"
  954. },
  955. "alias": {}
  956. }
  957. }
  958. },
  959. "nextToken": {}
  960. }
  961. },
  962. "deprecated": true,
  963. "deprecatedMessage": "This method will be discontinued."
  964. },
  965. "ListPermissionGroups": {
  966. "http": {
  967. "method": "GET",
  968. "requestUri": "/permission-group"
  969. },
  970. "input": {
  971. "type": "structure",
  972. "required": [
  973. "maxResults"
  974. ],
  975. "members": {
  976. "nextToken": {
  977. "location": "querystring",
  978. "locationName": "nextToken"
  979. },
  980. "maxResults": {
  981. "location": "querystring",
  982. "locationName": "maxResults",
  983. "type": "integer"
  984. }
  985. }
  986. },
  987. "output": {
  988. "type": "structure",
  989. "members": {
  990. "permissionGroups": {
  991. "type": "list",
  992. "member": {
  993. "shape": "S2s"
  994. }
  995. },
  996. "nextToken": {}
  997. }
  998. },
  999. "deprecated": true,
  1000. "deprecatedMessage": "This method will be discontinued."
  1001. },
  1002. "ListPermissionGroupsByUser": {
  1003. "http": {
  1004. "method": "GET",
  1005. "requestUri": "/user/{userId}/permission-groups"
  1006. },
  1007. "input": {
  1008. "type": "structure",
  1009. "required": [
  1010. "userId",
  1011. "maxResults"
  1012. ],
  1013. "members": {
  1014. "userId": {
  1015. "location": "uri",
  1016. "locationName": "userId"
  1017. },
  1018. "nextToken": {
  1019. "location": "querystring",
  1020. "locationName": "nextToken"
  1021. },
  1022. "maxResults": {
  1023. "location": "querystring",
  1024. "locationName": "maxResults",
  1025. "type": "integer"
  1026. }
  1027. }
  1028. },
  1029. "output": {
  1030. "type": "structure",
  1031. "members": {
  1032. "permissionGroups": {
  1033. "type": "list",
  1034. "member": {
  1035. "type": "structure",
  1036. "members": {
  1037. "permissionGroupId": {},
  1038. "name": {
  1039. "shape": "S1f"
  1040. },
  1041. "membershipStatus": {}
  1042. }
  1043. }
  1044. },
  1045. "nextToken": {}
  1046. }
  1047. },
  1048. "deprecated": true,
  1049. "deprecatedMessage": "This method will be discontinued."
  1050. },
  1051. "ListUsers": {
  1052. "http": {
  1053. "method": "GET",
  1054. "requestUri": "/user"
  1055. },
  1056. "input": {
  1057. "type": "structure",
  1058. "required": [
  1059. "maxResults"
  1060. ],
  1061. "members": {
  1062. "nextToken": {
  1063. "location": "querystring",
  1064. "locationName": "nextToken"
  1065. },
  1066. "maxResults": {
  1067. "location": "querystring",
  1068. "locationName": "maxResults",
  1069. "type": "integer"
  1070. }
  1071. }
  1072. },
  1073. "output": {
  1074. "type": "structure",
  1075. "members": {
  1076. "users": {
  1077. "type": "list",
  1078. "member": {
  1079. "type": "structure",
  1080. "members": {
  1081. "userId": {},
  1082. "status": {},
  1083. "firstName": {
  1084. "shape": "S1m"
  1085. },
  1086. "lastName": {
  1087. "shape": "S1n"
  1088. },
  1089. "emailAddress": {
  1090. "shape": "Sz"
  1091. },
  1092. "type": {},
  1093. "apiAccess": {},
  1094. "apiAccessPrincipalArn": {},
  1095. "createTime": {
  1096. "type": "long"
  1097. },
  1098. "lastEnabledTime": {
  1099. "type": "long"
  1100. },
  1101. "lastDisabledTime": {
  1102. "type": "long"
  1103. },
  1104. "lastModifiedTime": {
  1105. "type": "long"
  1106. },
  1107. "lastLoginTime": {
  1108. "type": "long"
  1109. }
  1110. }
  1111. }
  1112. },
  1113. "nextToken": {}
  1114. }
  1115. },
  1116. "deprecated": true,
  1117. "deprecatedMessage": "This method will be discontinued."
  1118. },
  1119. "ListUsersByPermissionGroup": {
  1120. "http": {
  1121. "method": "GET",
  1122. "requestUri": "/permission-group/{permissionGroupId}/users"
  1123. },
  1124. "input": {
  1125. "type": "structure",
  1126. "required": [
  1127. "permissionGroupId",
  1128. "maxResults"
  1129. ],
  1130. "members": {
  1131. "permissionGroupId": {
  1132. "location": "uri",
  1133. "locationName": "permissionGroupId"
  1134. },
  1135. "nextToken": {
  1136. "location": "querystring",
  1137. "locationName": "nextToken"
  1138. },
  1139. "maxResults": {
  1140. "location": "querystring",
  1141. "locationName": "maxResults",
  1142. "type": "integer"
  1143. }
  1144. }
  1145. },
  1146. "output": {
  1147. "type": "structure",
  1148. "members": {
  1149. "users": {
  1150. "type": "list",
  1151. "member": {
  1152. "type": "structure",
  1153. "members": {
  1154. "userId": {},
  1155. "status": {},
  1156. "firstName": {
  1157. "shape": "S1m"
  1158. },
  1159. "lastName": {
  1160. "shape": "S1n"
  1161. },
  1162. "emailAddress": {
  1163. "shape": "Sz"
  1164. },
  1165. "type": {},
  1166. "apiAccess": {},
  1167. "apiAccessPrincipalArn": {},
  1168. "membershipStatus": {}
  1169. }
  1170. }
  1171. },
  1172. "nextToken": {}
  1173. }
  1174. },
  1175. "deprecated": true,
  1176. "deprecatedMessage": "This method will be discontinued."
  1177. },
  1178. "ResetUserPassword": {
  1179. "http": {
  1180. "requestUri": "/user/{userId}/password"
  1181. },
  1182. "input": {
  1183. "type": "structure",
  1184. "required": [
  1185. "userId"
  1186. ],
  1187. "members": {
  1188. "userId": {
  1189. "location": "uri",
  1190. "locationName": "userId"
  1191. },
  1192. "clientToken": {
  1193. "idempotencyToken": true
  1194. }
  1195. }
  1196. },
  1197. "output": {
  1198. "type": "structure",
  1199. "members": {
  1200. "userId": {},
  1201. "temporaryPassword": {
  1202. "type": "string",
  1203. "sensitive": true
  1204. }
  1205. }
  1206. },
  1207. "deprecated": true,
  1208. "deprecatedMessage": "This method will be discontinued."
  1209. },
  1210. "UpdateChangeset": {
  1211. "http": {
  1212. "method": "PUT",
  1213. "requestUri": "/datasets/{datasetId}/changesetsv2/{changesetId}"
  1214. },
  1215. "input": {
  1216. "type": "structure",
  1217. "required": [
  1218. "datasetId",
  1219. "changesetId",
  1220. "sourceParams",
  1221. "formatParams"
  1222. ],
  1223. "members": {
  1224. "clientToken": {
  1225. "idempotencyToken": true
  1226. },
  1227. "datasetId": {
  1228. "location": "uri",
  1229. "locationName": "datasetId"
  1230. },
  1231. "changesetId": {
  1232. "location": "uri",
  1233. "locationName": "changesetId"
  1234. },
  1235. "sourceParams": {
  1236. "shape": "Sa"
  1237. },
  1238. "formatParams": {
  1239. "shape": "Sd"
  1240. }
  1241. }
  1242. },
  1243. "output": {
  1244. "type": "structure",
  1245. "members": {
  1246. "changesetId": {},
  1247. "datasetId": {}
  1248. }
  1249. },
  1250. "deprecated": true,
  1251. "deprecatedMessage": "This method will be discontinued."
  1252. },
  1253. "UpdateDataset": {
  1254. "http": {
  1255. "method": "PUT",
  1256. "requestUri": "/datasetsv2/{datasetId}"
  1257. },
  1258. "input": {
  1259. "type": "structure",
  1260. "required": [
  1261. "datasetId",
  1262. "datasetTitle",
  1263. "kind"
  1264. ],
  1265. "members": {
  1266. "clientToken": {
  1267. "idempotencyToken": true
  1268. },
  1269. "datasetId": {
  1270. "location": "uri",
  1271. "locationName": "datasetId"
  1272. },
  1273. "datasetTitle": {},
  1274. "kind": {},
  1275. "datasetDescription": {},
  1276. "alias": {},
  1277. "schemaDefinition": {
  1278. "shape": "S15"
  1279. }
  1280. }
  1281. },
  1282. "output": {
  1283. "type": "structure",
  1284. "members": {
  1285. "datasetId": {}
  1286. }
  1287. },
  1288. "deprecated": true,
  1289. "deprecatedMessage": "This method will be discontinued."
  1290. },
  1291. "UpdatePermissionGroup": {
  1292. "http": {
  1293. "method": "PUT",
  1294. "requestUri": "/permission-group/{permissionGroupId}"
  1295. },
  1296. "input": {
  1297. "type": "structure",
  1298. "required": [
  1299. "permissionGroupId"
  1300. ],
  1301. "members": {
  1302. "permissionGroupId": {
  1303. "location": "uri",
  1304. "locationName": "permissionGroupId"
  1305. },
  1306. "name": {
  1307. "shape": "S1f"
  1308. },
  1309. "description": {
  1310. "shape": "S1g"
  1311. },
  1312. "applicationPermissions": {
  1313. "shape": "S1h"
  1314. },
  1315. "clientToken": {
  1316. "idempotencyToken": true
  1317. }
  1318. }
  1319. },
  1320. "output": {
  1321. "type": "structure",
  1322. "members": {
  1323. "permissionGroupId": {}
  1324. }
  1325. },
  1326. "deprecated": true,
  1327. "deprecatedMessage": "This method will be discontinued."
  1328. },
  1329. "UpdateUser": {
  1330. "http": {
  1331. "method": "PUT",
  1332. "requestUri": "/user/{userId}"
  1333. },
  1334. "input": {
  1335. "type": "structure",
  1336. "required": [
  1337. "userId"
  1338. ],
  1339. "members": {
  1340. "userId": {
  1341. "location": "uri",
  1342. "locationName": "userId"
  1343. },
  1344. "type": {},
  1345. "firstName": {
  1346. "shape": "S1m"
  1347. },
  1348. "lastName": {
  1349. "shape": "S1n"
  1350. },
  1351. "apiAccess": {},
  1352. "apiAccessPrincipalArn": {},
  1353. "clientToken": {
  1354. "idempotencyToken": true
  1355. }
  1356. }
  1357. },
  1358. "output": {
  1359. "type": "structure",
  1360. "members": {
  1361. "userId": {}
  1362. }
  1363. },
  1364. "deprecated": true,
  1365. "deprecatedMessage": "This method will be discontinued."
  1366. }
  1367. },
  1368. "shapes": {
  1369. "Sa": {
  1370. "type": "map",
  1371. "key": {},
  1372. "value": {}
  1373. },
  1374. "Sd": {
  1375. "type": "map",
  1376. "key": {},
  1377. "value": {}
  1378. },
  1379. "Si": {
  1380. "type": "list",
  1381. "member": {}
  1382. },
  1383. "Sk": {
  1384. "type": "list",
  1385. "member": {}
  1386. },
  1387. "Sm": {
  1388. "type": "structure",
  1389. "required": [
  1390. "destinationType"
  1391. ],
  1392. "members": {
  1393. "destinationType": {},
  1394. "s3DestinationExportFileFormat": {},
  1395. "s3DestinationExportFileFormatOptions": {
  1396. "type": "map",
  1397. "key": {},
  1398. "value": {}
  1399. }
  1400. }
  1401. },
  1402. "Sw": {
  1403. "type": "structure",
  1404. "members": {
  1405. "name": {},
  1406. "phoneNumber": {},
  1407. "email": {
  1408. "shape": "Sz"
  1409. }
  1410. }
  1411. },
  1412. "Sz": {
  1413. "type": "string",
  1414. "sensitive": true
  1415. },
  1416. "S15": {
  1417. "type": "structure",
  1418. "members": {
  1419. "tabularSchemaConfig": {
  1420. "type": "structure",
  1421. "members": {
  1422. "columns": {
  1423. "type": "list",
  1424. "member": {
  1425. "type": "structure",
  1426. "members": {
  1427. "dataType": {},
  1428. "columnName": {},
  1429. "columnDescription": {}
  1430. }
  1431. }
  1432. },
  1433. "primaryKeyColumns": {
  1434. "type": "list",
  1435. "member": {}
  1436. }
  1437. }
  1438. }
  1439. }
  1440. },
  1441. "S1f": {
  1442. "type": "string",
  1443. "sensitive": true
  1444. },
  1445. "S1g": {
  1446. "type": "string",
  1447. "sensitive": true
  1448. },
  1449. "S1h": {
  1450. "type": "list",
  1451. "member": {}
  1452. },
  1453. "S1m": {
  1454. "type": "string",
  1455. "sensitive": true
  1456. },
  1457. "S1n": {
  1458. "type": "string",
  1459. "sensitive": true
  1460. },
  1461. "S25": {
  1462. "type": "structure",
  1463. "members": {
  1464. "errorMessage": {},
  1465. "errorCategory": {}
  1466. }
  1467. },
  1468. "S2a": {
  1469. "type": "structure",
  1470. "members": {
  1471. "errorMessage": {},
  1472. "errorCategory": {}
  1473. }
  1474. },
  1475. "S2s": {
  1476. "type": "structure",
  1477. "members": {
  1478. "permissionGroupId": {},
  1479. "name": {
  1480. "shape": "S1f"
  1481. },
  1482. "description": {
  1483. "shape": "S1g"
  1484. },
  1485. "applicationPermissions": {
  1486. "shape": "S1h"
  1487. },
  1488. "createTime": {
  1489. "type": "long"
  1490. },
  1491. "lastModifiedTime": {
  1492. "type": "long"
  1493. },
  1494. "membershipStatus": {}
  1495. }
  1496. }
  1497. }
  1498. }