Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14139565.0 KB

Use to create a scan using code uploaded to an Amazon S3 bucket.

post/scans

Request body

clientTokenstring

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

scanNamestring required

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.

scanType'Standard' | 'Express'
<p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p> <p> <code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
analysisType'Security' | 'All'

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.

tagsobject
<p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p> </li> <li> <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p> </li> </ul>

Response

Success

scanNamestring required

The name of the scan.

runIdstring required

UUID that identifies the individual scan run.

scanState'InProgress' | 'Successful' | 'Failed' required

The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.

scanNameArnstring

The ARN for the scan name.