CodeGuruSecurity / Client / get_scan
get_scan#
- CodeGuruSecurity.Client.get_scan(**kwargs)#
Returns details about a scan, including whether or not a scan has completed.
See also: AWS API Documentation
Request Syntax
response = client.get_scan( runId='string', scanName='string' )
- Parameters:
runId (string) – 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.scanName (string) –
[REQUIRED]
The name of the scan you want to view details about.
- Return type:
dict
- Returns:
Response Syntax
{ 'analysisType': 'Security'|'All', 'createdAt': datetime(2015, 1, 1), 'numberOfRevisions': 123, 'runId': 'string', 'scanName': 'string', 'scanNameArn': 'string', 'scanState': 'InProgress'|'Successful'|'Failed', 'updatedAt': datetime(2015, 1, 1) }
Response Structure
(dict) –
analysisType (string) –
The type of analysis CodeGuru Security performed in the scan, either
Security
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings.createdAt (datetime) –
The time the scan was created.
numberOfRevisions (integer) –
The number of times a scan has been re-run on a revised resource.
runId (string) –
UUID that identifies the individual scan run.
scanName (string) –
The name of the scan.
scanNameArn (string) –
The ARN for the scan name.
scanState (string) –
The current state of the scan. Pass either
InProgress
,Successful
, orFailed
.updatedAt (datetime) –
The time when the scan was last updated. Only available for
STANDARD
scan types.
Exceptions
CodeGuruSecurity.Client.exceptions.InternalServerException
CodeGuruSecurity.Client.exceptions.ResourceNotFoundException
CodeGuruSecurity.Client.exceptions.ThrottlingException
CodeGuruSecurity.Client.exceptions.AccessDeniedException