|
1 | 1 | {
|
2 | 2 | "version": "2.0",
|
3 |
| - "service": "<p>This section provides documentation for the <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html\">Amazon CodeGuru Security</a> API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.</p> <p>By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the <a href=\"https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html\">Amazon CodeGuru Security User Guide</a>. </p>", |
| 3 | + "service": "<note> <p>Amazon CodeGuru Security is in preview release and is subject to change.</p> </note> <p>This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.</p> <p>By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the <a href=\"https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html\">Amazon CodeGuru Security User Guide</a>. </p>", |
4 | 4 | "operations": {
|
5 | 5 | "BatchGetFindings": "<p>Returns a list of all requested findings.</p>",
|
6 | 6 | "CreateScan": "<p>Use to create a scan using code uploaded to an S3 bucket.</p>",
|
|
10 | 10 | "GetMetricsSummary": "<p>Returns top level metrics about an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings. </p>",
|
11 | 11 | "GetScan": "<p>Returns details about a scan, including whether or not a scan has completed.</p>",
|
12 | 12 | "ListFindingsMetrics": "<p>Returns metrics about all findings in an account within a specified time range.</p>",
|
13 |
| - "ListScans": "<p>Returns a list of all the scans in an account.</p>", |
| 13 | + "ListScans": "<p>Returns a list of all the standard scans in an account. Does not return express scans.</p>", |
14 | 14 | "ListTagsForResource": "<p>Returns a list of all tags associated with a scan.</p>",
|
15 | 15 | "TagResource": "<p>Use to add one or more tags to an existing scan.</p>",
|
16 | 16 | "UntagResource": "<p>Use to remove one or more tags from an existing scan.</p>",
|
|
31 | 31 | "AnalysisType": {
|
32 | 32 | "base": null,
|
33 | 33 | "refs": {
|
34 |
| - "CreateScanRequest$analysisType": "<p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Secuirty</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>", |
| 34 | + "CreateScanRequest$analysisType": "<p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>", |
35 | 35 | "GetScanResponse$analysisType": "<p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>"
|
36 | 36 | }
|
37 | 37 | },
|
|
0 commit comments