Continuum / Client / get_code_scan

get_code_scan¶

Continuum.Client.get_code_scan(**kwargs)¶

Retrieves one customer-visible environment scan.

Request Syntax

response = client.get_code_scan(
    environmentId='string',
    scanRunId='string'
)

Parameters:

environmentId (string) –
[REQUIRED]

Environment that owns the scan.
scanRunId (string) –
[REQUIRED]

Scan to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'scan': {
        'scanRunId': 'string',
        'status': 'SUBMITTED'|'WAITING_FOR_BUILD'|'BUILDING'|'WAITING_FOR_SCAN'|'SCANNING'|'SUCCEEDED'|'FAILED',
        'origin': 'MANUAL'|'SCHEDULED',
        'createdAt': datetime(2015, 1, 1),
        'completedAt': datetime(2015, 1, 1),
        'failureMessage': 'string',
        'failureStage': 'SUBMITTED'|'WAITING_FOR_BUILD'|'BUILDING'|'WAITING_FOR_SCAN'|'SCANNING'
    }
}

Response Structure

(dict) –
- scan (dict) –
  
  Complete customer-visible scan data.
  - scanRunId (string) –
    
    The unique scan identifier.
  - status (string) –
    
    Current customer-visible status.
  - origin (string) –
    
    Why the scan was created. Always present.
  - createdAt (datetime) –
    
    Time at which Continuum accepted the scan request.
  - completedAt (datetime) –
    
    Time at which a terminal result was recorded.
  - failureMessage (string) –
    
    Failure detail present for unsuccessful scans.
  - failureStage (string) –
    
    Phase this scan failed in. Present only when status is FAILED, and absent for a scan that failed before this field existed.

Exceptions

Continuum.Client.exceptions.ValidationException
Continuum.Client.exceptions.InternalServerException
Continuum.Client.exceptions.ResourceNotFoundException
Continuum.Client.exceptions.ThrottlingException
Continuum.Client.exceptions.AccessDeniedException