CodeGuruSecurity / Paginator / ListScans


class CodeGuruSecurity.Paginator.ListScans#
paginator = client.get_paginator('list_scans')

Creates an iterator that will paginate through responses from CodeGuruSecurity.Client.list_scans().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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:



Response Syntax

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

Response Structure

  • (dict) –

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

    • NextToken (string) –

      A token to resume pagination.