CloudFormation / Paginator / ListResourceScans

ListResourceScans

class CloudFormation.Paginator.ListResourceScans

paginator = client.get_paginator('list_resource_scans')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudFormation.Client.list_resource_scans().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'ResourceScanSummaries': [
        {
            'ResourceScanId': 'string',
            'Status': 'IN_PROGRESS'|'FAILED'|'COMPLETE'|'EXPIRED',
            'StatusReason': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'PercentageCompleted': 123.0
        },
    ],

}

Response Structure

• (dict) –

  • ResourceScanSummaries (list) –

    The list of scans returned.

    • (dict) –

      A summary of the resource scan. This is returned by the ListResourceScan API action.

      • ResourceScanId (string) –

        The Amazon Resource Name (ARN) of the resource scan.

      • Status (string) –

        Status of the resource scan.

        INPROGRESS

        The resource scan is still in progress.

        COMPLETE

        The resource scan is complete.

        EXPIRED

        The resource scan has expired.

        FAILED

        The resource scan has failed.

      • StatusReason (string) –

        The reason for the resource scan status, providing more information if a failure happened.

      • StartTime (datetime) –

        The time that the resource scan was started.

      • EndTime (datetime) –

        The time that the resource scan was finished.

      • PercentageCompleted (float) –

        The percentage of the resource scan that has been completed.