Skip to content

Commit 1a757b7

Browse files
Documentation updates for CodeGuru Security.
1 parent 9fda5c6 commit 1a757b7

11 files changed

+1837
-46
lines changed

generator/ServiceModels/codeguru-security/codeguru-security-2018-05-10.docs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"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>",
44
"operations": {
55
"BatchGetFindings": "<p>Returns a list of all requested findings.</p>",
66
"CreateScan": "<p>Use to create a scan using code uploaded to an S3 bucket.</p>",
@@ -10,7 +10,7 @@
1010
"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>",
1111
"GetScan": "<p>Returns details about a scan, including whether or not a scan has completed.</p>",
1212
"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>",
1414
"ListTagsForResource": "<p>Returns a list of all tags associated with a scan.</p>",
1515
"TagResource": "<p>Use to add one or more tags to an existing scan.</p>",
1616
"UntagResource": "<p>Use to remove one or more tags from an existing scan.</p>",
@@ -31,7 +31,7 @@
3131
"AnalysisType": {
3232
"base": null,
3333
"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>",
3535
"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>"
3636
}
3737
},

0 commit comments

Comments
 (0)