CloudFormation / Client / list_resource_scans

list_resource_scans#

CloudFormation.Client.list_resource_scans(**kwargs)#

List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_scans(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A string that identifies the next page of resource scan results.

  • MaxResults (integer) – If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.

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
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.