Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetScan

Returns details about a scan, including whether or not a scan has completed.

Request Syntax


GET /scans/scanName?runId=runId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

runId

UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

scanName

The name of the scan you want to view details about.

Length Constraints: Minimum length of 1. Maximum length of 140.

Pattern: ^[a-zA-Z0-9-_$:.]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "analysisType": "string",
   "createdAt": number,
   "errorMessage": "string",
   "numberOfRevisions": number,
   "runId": "string",
   "scanName": "string",
   "scanNameArn": "string",
   "scanState": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

analysisType

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

Type: String

Valid Values: Security | All

createdAt