Continuum / Client / list_code_scans

list_code_scans

Continuum.Client.list_code_scans(**kwargs)

Lists customer-visible scans for one environment in descending scanRunId order.

See also: AWS API Documentation

Request Syntax

response = client.list_code_scans(
    environmentId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    Environment whose scans to list.

  • maxResults (integer) – Maximum number of scans to return.

  • nextToken (string) – Pagination token returned by a prior request.

Return type:

dict

Returns:

Response Syntax

{
    'scans': [
        {
            '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • scans (list) –

      Customer-visible scans ordered by scanRunId descending.

      • (dict) –

        Customer-visible summary of one environment scan.

        • 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.

    • nextToken (string) –

      Pagination token for the next page, if present.

Exceptions