list_scans#

CodeGuruSecurity.Client.list_scans(**kwargs)#

Returns a list of all the scans in an account.

Request Syntax

response = client.list_scans(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results.
nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'summaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'runId': 'string',
            'scanName': 'string',
            'scanNameArn': 'string',
            'scanState': 'InProgress'|'Successful'|'Failed',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A pagination token. You can use this in future calls to ListScans to continue listing results after the current page.
- summaries (list) –
  
  A list of ScanSummary objects with information about all scans in an account.
  - (dict) –
    
    Information about a scan.
    - createdAt (datetime) –
      
      The time when the scan was created.
    - runId (string) –
      
      The identifier for the scan run.
    - scanName (string) –
      
      The name of the scan.
    - scanNameArn (string) –
      
      The ARN for the scan name.
    - scanState (string) –
      
      The state of the scan. A scan can be In Progress, Complete, or Failed.
    - updatedAt (datetime) –
      
      The time the scan was last updated. A scan is updated when it is re-run.

Exceptions

CodeGuruSecurity.Client.exceptions.InternalServerException
CodeGuruSecurity.Client.exceptions.ThrottlingException
CodeGuruSecurity.Client.exceptions.ValidationException
CodeGuruSecurity.Client.exceptions.AccessDeniedException