GetCodeSecurityScan
Retrieves information about a specific code security scan.
Request Syntax
POST /codesecurity/scan/get HTTP/1.1
Content-type: application/json
{
"resource": { ... },
"scanId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- resource
-
The resource identifier for the code repository that was scanned.
Type: CodeSecurityResource object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- scanId
-
The unique identifier of the scan to retrieve.
Type: String
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accountId": "string",
"createdAt": number,
"lastCommitId": "string",
"resource": { ... },
"scanId": "string",
"status": "string",
"statusReason": "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.
- accountId
-
The Amazon account ID associated with the scan.
Type: String
- createdAt
-
The timestamp when the scan was created.
Type: Timestamp
- lastCommitId
-
The identifier of the last commit that was scanned. This is only returned if the scan was successful or skipped.
Type: String
- resource
-
The resource identifier for the code repository that was scanned.
Type: CodeSecurityResource object
Note: This object is a Union. Only one member of this object can be specified or returned.
- scanId
-
The unique identifier of the scan.
Type: String
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} - status
-
The current status of the scan.
Type: String
Valid Values:
IN_PROGRESS | SUCCESSFUL | FAILED | SKIPPED - statusReason
-
The reason for the current status of the scan.
Type: String
- updatedAt
-
The timestamp when the scan was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
For
Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.HTTP Status Code: 403
- ConflictException
-
A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal failure of the Amazon Inspector service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access an invalid resource. Make sure the resource is specified correctly.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The request has failed validation due to missing required fields or having invalid inputs.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: