Continuum / Paginator / ListCodeScans

ListCodeScans

class Continuum.Paginator.ListCodeScans

paginator = client.get_paginator('list_code_scans')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Continuum.Client.list_code_scans().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    environmentId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• environmentId (string) –

  [REQUIRED]

  Environment whose scans to list.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.