codeguru-reviewer-2019-09-19.min.json 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2019-09-19",
  5. "endpointPrefix": "codeguru-reviewer",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceAbbreviation": "CodeGuruReviewer",
  9. "serviceFullName": "Amazon CodeGuru Reviewer",
  10. "serviceId": "CodeGuru Reviewer",
  11. "signatureVersion": "v4",
  12. "signingName": "codeguru-reviewer",
  13. "uid": "codeguru-reviewer-2019-09-19"
  14. },
  15. "operations": {
  16. "AssociateRepository": {
  17. "http": {
  18. "requestUri": "/associations"
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "Repository"
  24. ],
  25. "members": {
  26. "Repository": {
  27. "type": "structure",
  28. "members": {
  29. "CodeCommit": {
  30. "type": "structure",
  31. "required": [
  32. "Name"
  33. ],
  34. "members": {
  35. "Name": {}
  36. }
  37. },
  38. "Bitbucket": {
  39. "shape": "S5"
  40. },
  41. "GitHubEnterpriseServer": {
  42. "shape": "S5"
  43. },
  44. "S3Bucket": {
  45. "type": "structure",
  46. "required": [
  47. "Name",
  48. "BucketName"
  49. ],
  50. "members": {
  51. "Name": {},
  52. "BucketName": {}
  53. }
  54. }
  55. }
  56. },
  57. "ClientRequestToken": {
  58. "idempotencyToken": true
  59. },
  60. "Tags": {
  61. "shape": "Sb"
  62. },
  63. "KMSKeyDetails": {
  64. "shape": "Se"
  65. }
  66. }
  67. },
  68. "output": {
  69. "type": "structure",
  70. "members": {
  71. "RepositoryAssociation": {
  72. "shape": "Si"
  73. },
  74. "Tags": {
  75. "shape": "Sb"
  76. }
  77. }
  78. }
  79. },
  80. "CreateCodeReview": {
  81. "http": {
  82. "requestUri": "/codereviews"
  83. },
  84. "input": {
  85. "type": "structure",
  86. "required": [
  87. "Name",
  88. "RepositoryAssociationArn",
  89. "Type"
  90. ],
  91. "members": {
  92. "Name": {},
  93. "RepositoryAssociationArn": {},
  94. "Type": {
  95. "type": "structure",
  96. "required": [
  97. "RepositoryAnalysis"
  98. ],
  99. "members": {
  100. "RepositoryAnalysis": {
  101. "type": "structure",
  102. "members": {
  103. "RepositoryHead": {
  104. "shape": "Sy"
  105. },
  106. "SourceCodeType": {
  107. "shape": "S10"
  108. }
  109. }
  110. },
  111. "AnalysisTypes": {
  112. "shape": "S1c"
  113. }
  114. }
  115. },
  116. "ClientRequestToken": {
  117. "idempotencyToken": true
  118. }
  119. }
  120. },
  121. "output": {
  122. "type": "structure",
  123. "members": {
  124. "CodeReview": {
  125. "shape": "S1f"
  126. }
  127. }
  128. }
  129. },
  130. "DescribeCodeReview": {
  131. "http": {
  132. "method": "GET",
  133. "requestUri": "/codereviews/{CodeReviewArn}"
  134. },
  135. "input": {
  136. "type": "structure",
  137. "required": [
  138. "CodeReviewArn"
  139. ],
  140. "members": {
  141. "CodeReviewArn": {
  142. "location": "uri",
  143. "locationName": "CodeReviewArn"
  144. }
  145. }
  146. },
  147. "output": {
  148. "type": "structure",
  149. "members": {
  150. "CodeReview": {
  151. "shape": "S1f"
  152. }
  153. }
  154. }
  155. },
  156. "DescribeRecommendationFeedback": {
  157. "http": {
  158. "method": "GET",
  159. "requestUri": "/feedback/{CodeReviewArn}"
  160. },
  161. "input": {
  162. "type": "structure",
  163. "required": [
  164. "CodeReviewArn",
  165. "RecommendationId"
  166. ],
  167. "members": {
  168. "CodeReviewArn": {
  169. "location": "uri",
  170. "locationName": "CodeReviewArn"
  171. },
  172. "RecommendationId": {
  173. "location": "querystring",
  174. "locationName": "RecommendationId"
  175. },
  176. "UserId": {
  177. "location": "querystring",
  178. "locationName": "UserId"
  179. }
  180. }
  181. },
  182. "output": {
  183. "type": "structure",
  184. "members": {
  185. "RecommendationFeedback": {
  186. "type": "structure",
  187. "members": {
  188. "CodeReviewArn": {},
  189. "RecommendationId": {},
  190. "Reactions": {
  191. "shape": "S1u"
  192. },
  193. "UserId": {},
  194. "CreatedTimeStamp": {
  195. "type": "timestamp"
  196. },
  197. "LastUpdatedTimeStamp": {
  198. "type": "timestamp"
  199. }
  200. }
  201. }
  202. }
  203. }
  204. },
  205. "DescribeRepositoryAssociation": {
  206. "http": {
  207. "method": "GET",
  208. "requestUri": "/associations/{AssociationArn}"
  209. },
  210. "input": {
  211. "type": "structure",
  212. "required": [
  213. "AssociationArn"
  214. ],
  215. "members": {
  216. "AssociationArn": {
  217. "location": "uri",
  218. "locationName": "AssociationArn"
  219. }
  220. }
  221. },
  222. "output": {
  223. "type": "structure",
  224. "members": {
  225. "RepositoryAssociation": {
  226. "shape": "Si"
  227. },
  228. "Tags": {
  229. "shape": "Sb"
  230. }
  231. }
  232. }
  233. },
  234. "DisassociateRepository": {
  235. "http": {
  236. "method": "DELETE",
  237. "requestUri": "/associations/{AssociationArn}"
  238. },
  239. "input": {
  240. "type": "structure",
  241. "required": [
  242. "AssociationArn"
  243. ],
  244. "members": {
  245. "AssociationArn": {
  246. "location": "uri",
  247. "locationName": "AssociationArn"
  248. }
  249. }
  250. },
  251. "output": {
  252. "type": "structure",
  253. "members": {
  254. "RepositoryAssociation": {
  255. "shape": "Si"
  256. },
  257. "Tags": {
  258. "shape": "Sb"
  259. }
  260. }
  261. }
  262. },
  263. "ListCodeReviews": {
  264. "http": {
  265. "method": "GET",
  266. "requestUri": "/codereviews"
  267. },
  268. "input": {
  269. "type": "structure",
  270. "required": [
  271. "Type"
  272. ],
  273. "members": {
  274. "ProviderTypes": {
  275. "shape": "S21",
  276. "location": "querystring",
  277. "locationName": "ProviderTypes"
  278. },
  279. "States": {
  280. "location": "querystring",
  281. "locationName": "States",
  282. "type": "list",
  283. "member": {}
  284. },
  285. "RepositoryNames": {
  286. "location": "querystring",
  287. "locationName": "RepositoryNames",
  288. "type": "list",
  289. "member": {}
  290. },
  291. "Type": {
  292. "location": "querystring",
  293. "locationName": "Type"
  294. },
  295. "MaxResults": {
  296. "location": "querystring",
  297. "locationName": "MaxResults",
  298. "type": "integer"
  299. },
  300. "NextToken": {
  301. "location": "querystring",
  302. "locationName": "NextToken"
  303. }
  304. }
  305. },
  306. "output": {
  307. "type": "structure",
  308. "members": {
  309. "CodeReviewSummaries": {
  310. "type": "list",
  311. "member": {
  312. "type": "structure",
  313. "members": {
  314. "Name": {},
  315. "CodeReviewArn": {},
  316. "RepositoryName": {},
  317. "Owner": {},
  318. "ProviderType": {},
  319. "State": {},
  320. "CreatedTimeStamp": {
  321. "type": "timestamp"
  322. },
  323. "LastUpdatedTimeStamp": {
  324. "type": "timestamp"
  325. },
  326. "Type": {},
  327. "PullRequestId": {},
  328. "MetricsSummary": {
  329. "type": "structure",
  330. "members": {
  331. "MeteredLinesOfCodeCount": {
  332. "type": "long"
  333. },
  334. "SuppressedLinesOfCodeCount": {
  335. "type": "long"
  336. },
  337. "FindingsCount": {
  338. "type": "long"
  339. }
  340. }
  341. },
  342. "SourceCodeType": {
  343. "shape": "S10"
  344. }
  345. }
  346. }
  347. },
  348. "NextToken": {}
  349. }
  350. }
  351. },
  352. "ListRecommendationFeedback": {
  353. "http": {
  354. "method": "GET",
  355. "requestUri": "/feedback/{CodeReviewArn}/RecommendationFeedback"
  356. },
  357. "input": {
  358. "type": "structure",
  359. "required": [
  360. "CodeReviewArn"
  361. ],
  362. "members": {
  363. "NextToken": {
  364. "location": "querystring",
  365. "locationName": "NextToken"
  366. },
  367. "MaxResults": {
  368. "location": "querystring",
  369. "locationName": "MaxResults",
  370. "type": "integer"
  371. },
  372. "CodeReviewArn": {
  373. "location": "uri",
  374. "locationName": "CodeReviewArn"
  375. },
  376. "UserIds": {
  377. "location": "querystring",
  378. "locationName": "UserIds",
  379. "type": "list",
  380. "member": {}
  381. },
  382. "RecommendationIds": {
  383. "location": "querystring",
  384. "locationName": "RecommendationIds",
  385. "type": "list",
  386. "member": {}
  387. }
  388. }
  389. },
  390. "output": {
  391. "type": "structure",
  392. "members": {
  393. "RecommendationFeedbackSummaries": {
  394. "type": "list",
  395. "member": {
  396. "type": "structure",
  397. "members": {
  398. "RecommendationId": {},
  399. "Reactions": {
  400. "shape": "S1u"
  401. },
  402. "UserId": {}
  403. }
  404. }
  405. },
  406. "NextToken": {}
  407. }
  408. }
  409. },
  410. "ListRecommendations": {
  411. "http": {
  412. "method": "GET",
  413. "requestUri": "/codereviews/{CodeReviewArn}/Recommendations"
  414. },
  415. "input": {
  416. "type": "structure",
  417. "required": [
  418. "CodeReviewArn"
  419. ],
  420. "members": {
  421. "NextToken": {
  422. "location": "querystring",
  423. "locationName": "NextToken"
  424. },
  425. "MaxResults": {
  426. "location": "querystring",
  427. "locationName": "MaxResults",
  428. "type": "integer"
  429. },
  430. "CodeReviewArn": {
  431. "location": "uri",
  432. "locationName": "CodeReviewArn"
  433. }
  434. }
  435. },
  436. "output": {
  437. "type": "structure",
  438. "members": {
  439. "RecommendationSummaries": {
  440. "type": "list",
  441. "member": {
  442. "type": "structure",
  443. "members": {
  444. "FilePath": {},
  445. "RecommendationId": {},
  446. "StartLine": {
  447. "type": "integer"
  448. },
  449. "EndLine": {
  450. "type": "integer"
  451. },
  452. "Description": {},
  453. "RecommendationCategory": {},
  454. "RuleMetadata": {
  455. "type": "structure",
  456. "members": {
  457. "RuleId": {},
  458. "RuleName": {},
  459. "ShortDescription": {},
  460. "LongDescription": {},
  461. "RuleTags": {
  462. "type": "list",
  463. "member": {}
  464. }
  465. }
  466. },
  467. "Severity": {}
  468. }
  469. }
  470. },
  471. "NextToken": {}
  472. }
  473. }
  474. },
  475. "ListRepositoryAssociations": {
  476. "http": {
  477. "method": "GET",
  478. "requestUri": "/associations"
  479. },
  480. "input": {
  481. "type": "structure",
  482. "members": {
  483. "ProviderTypes": {
  484. "shape": "S21",
  485. "location": "querystring",
  486. "locationName": "ProviderType"
  487. },
  488. "States": {
  489. "location": "querystring",
  490. "locationName": "State",
  491. "type": "list",
  492. "member": {}
  493. },
  494. "Names": {
  495. "location": "querystring",
  496. "locationName": "Name",
  497. "type": "list",
  498. "member": {}
  499. },
  500. "Owners": {
  501. "location": "querystring",
  502. "locationName": "Owner",
  503. "type": "list",
  504. "member": {}
  505. },
  506. "MaxResults": {
  507. "location": "querystring",
  508. "locationName": "MaxResults",
  509. "type": "integer"
  510. },
  511. "NextToken": {
  512. "location": "querystring",
  513. "locationName": "NextToken"
  514. }
  515. }
  516. },
  517. "output": {
  518. "type": "structure",
  519. "members": {
  520. "RepositoryAssociationSummaries": {
  521. "type": "list",
  522. "member": {
  523. "type": "structure",
  524. "members": {
  525. "AssociationArn": {},
  526. "ConnectionArn": {},
  527. "LastUpdatedTimeStamp": {
  528. "type": "timestamp"
  529. },
  530. "AssociationId": {},
  531. "Name": {},
  532. "Owner": {},
  533. "ProviderType": {},
  534. "State": {}
  535. }
  536. }
  537. },
  538. "NextToken": {}
  539. }
  540. }
  541. },
  542. "ListTagsForResource": {
  543. "http": {
  544. "method": "GET",
  545. "requestUri": "/tags/{resourceArn}"
  546. },
  547. "input": {
  548. "type": "structure",
  549. "required": [
  550. "resourceArn"
  551. ],
  552. "members": {
  553. "resourceArn": {
  554. "location": "uri",
  555. "locationName": "resourceArn"
  556. }
  557. }
  558. },
  559. "output": {
  560. "type": "structure",
  561. "members": {
  562. "Tags": {
  563. "shape": "Sb"
  564. }
  565. }
  566. }
  567. },
  568. "PutRecommendationFeedback": {
  569. "http": {
  570. "method": "PUT",
  571. "requestUri": "/feedback"
  572. },
  573. "input": {
  574. "type": "structure",
  575. "required": [
  576. "CodeReviewArn",
  577. "RecommendationId",
  578. "Reactions"
  579. ],
  580. "members": {
  581. "CodeReviewArn": {},
  582. "RecommendationId": {},
  583. "Reactions": {
  584. "shape": "S1u"
  585. }
  586. }
  587. },
  588. "output": {
  589. "type": "structure",
  590. "members": {}
  591. }
  592. },
  593. "TagResource": {
  594. "http": {
  595. "requestUri": "/tags/{resourceArn}"
  596. },
  597. "input": {
  598. "type": "structure",
  599. "required": [
  600. "resourceArn",
  601. "Tags"
  602. ],
  603. "members": {
  604. "resourceArn": {
  605. "location": "uri",
  606. "locationName": "resourceArn"
  607. },
  608. "Tags": {
  609. "shape": "Sb"
  610. }
  611. }
  612. },
  613. "output": {
  614. "type": "structure",
  615. "members": {}
  616. }
  617. },
  618. "UntagResource": {
  619. "http": {
  620. "method": "DELETE",
  621. "requestUri": "/tags/{resourceArn}"
  622. },
  623. "input": {
  624. "type": "structure",
  625. "required": [
  626. "resourceArn",
  627. "TagKeys"
  628. ],
  629. "members": {
  630. "resourceArn": {
  631. "location": "uri",
  632. "locationName": "resourceArn"
  633. },
  634. "TagKeys": {
  635. "location": "querystring",
  636. "locationName": "tagKeys",
  637. "type": "list",
  638. "member": {}
  639. }
  640. }
  641. },
  642. "output": {
  643. "type": "structure",
  644. "members": {}
  645. }
  646. }
  647. },
  648. "shapes": {
  649. "S5": {
  650. "type": "structure",
  651. "required": [
  652. "Name",
  653. "ConnectionArn",
  654. "Owner"
  655. ],
  656. "members": {
  657. "Name": {},
  658. "ConnectionArn": {},
  659. "Owner": {}
  660. }
  661. },
  662. "Sb": {
  663. "type": "map",
  664. "key": {},
  665. "value": {}
  666. },
  667. "Se": {
  668. "type": "structure",
  669. "members": {
  670. "KMSKeyId": {},
  671. "EncryptionOption": {}
  672. }
  673. },
  674. "Si": {
  675. "type": "structure",
  676. "members": {
  677. "AssociationId": {},
  678. "AssociationArn": {},
  679. "ConnectionArn": {},
  680. "Name": {},
  681. "Owner": {},
  682. "ProviderType": {},
  683. "State": {},
  684. "StateReason": {},
  685. "LastUpdatedTimeStamp": {
  686. "type": "timestamp"
  687. },
  688. "CreatedTimeStamp": {
  689. "type": "timestamp"
  690. },
  691. "KMSKeyDetails": {
  692. "shape": "Se"
  693. },
  694. "S3RepositoryDetails": {
  695. "shape": "Sp"
  696. }
  697. }
  698. },
  699. "Sp": {
  700. "type": "structure",
  701. "members": {
  702. "BucketName": {},
  703. "CodeArtifacts": {
  704. "type": "structure",
  705. "required": [
  706. "SourceCodeArtifactsObjectKey"
  707. ],
  708. "members": {
  709. "SourceCodeArtifactsObjectKey": {},
  710. "BuildArtifactsObjectKey": {}
  711. }
  712. }
  713. }
  714. },
  715. "Sy": {
  716. "type": "structure",
  717. "required": [
  718. "BranchName"
  719. ],
  720. "members": {
  721. "BranchName": {}
  722. }
  723. },
  724. "S10": {
  725. "type": "structure",
  726. "members": {
  727. "CommitDiff": {
  728. "type": "structure",
  729. "members": {
  730. "SourceCommit": {},
  731. "DestinationCommit": {},
  732. "MergeBaseCommit": {}
  733. }
  734. },
  735. "RepositoryHead": {
  736. "shape": "Sy"
  737. },
  738. "BranchDiff": {
  739. "type": "structure",
  740. "required": [
  741. "SourceBranchName",
  742. "DestinationBranchName"
  743. ],
  744. "members": {
  745. "SourceBranchName": {},
  746. "DestinationBranchName": {}
  747. }
  748. },
  749. "S3BucketRepository": {
  750. "type": "structure",
  751. "required": [
  752. "Name"
  753. ],
  754. "members": {
  755. "Name": {},
  756. "Details": {
  757. "shape": "Sp"
  758. }
  759. }
  760. },
  761. "RequestMetadata": {
  762. "type": "structure",
  763. "members": {
  764. "RequestId": {},
  765. "Requester": {},
  766. "EventInfo": {
  767. "type": "structure",
  768. "members": {
  769. "Name": {},
  770. "State": {}
  771. }
  772. },
  773. "VendorName": {}
  774. }
  775. }
  776. }
  777. },
  778. "S1c": {
  779. "type": "list",
  780. "member": {}
  781. },
  782. "S1f": {
  783. "type": "structure",
  784. "members": {
  785. "Name": {},
  786. "CodeReviewArn": {},
  787. "RepositoryName": {},
  788. "Owner": {},
  789. "ProviderType": {},
  790. "State": {},
  791. "StateReason": {},
  792. "CreatedTimeStamp": {
  793. "type": "timestamp"
  794. },
  795. "LastUpdatedTimeStamp": {
  796. "type": "timestamp"
  797. },
  798. "Type": {},
  799. "PullRequestId": {},
  800. "SourceCodeType": {
  801. "shape": "S10"
  802. },
  803. "AssociationArn": {},
  804. "Metrics": {
  805. "type": "structure",
  806. "members": {
  807. "MeteredLinesOfCodeCount": {
  808. "type": "long"
  809. },
  810. "SuppressedLinesOfCodeCount": {
  811. "type": "long"
  812. },
  813. "FindingsCount": {
  814. "type": "long"
  815. }
  816. }
  817. },
  818. "AnalysisTypes": {
  819. "shape": "S1c"
  820. },
  821. "ConfigFileState": {}
  822. }
  823. },
  824. "S1u": {
  825. "type": "list",
  826. "member": {}
  827. },
  828. "S21": {
  829. "type": "list",
  830. "member": {}
  831. }
  832. }
  833. }