Inspector2 / Paginator / ListOnDemandScans

ListOnDemandScans¶

class Inspector2.Paginator.ListOnDemandScans¶

paginator = client.get_paginator('list_on_demand_scans')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Inspector2.Client.list_on_demand_scans().

Request Syntax

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

Parameters:

resourceId (string) –
[REQUIRED]

The ID of the resource whose on-demand scans are being listed.
resourceType (string) –
[REQUIRED]

The type of the resource whose on-demand scans are being listed.
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

{
    'items': [
        {
            'scanId': 'string',
            'resourceId': 'string',
            'resourceType': 'AMI',
            'scanStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
            'scanStatusReason': 'ACCESS_DENIED'|'INTERNAL_ERROR'|'STORAGE_LIMIT_EXCEEDED'|'EXTRACTION_COLLECTION_TIME_LIMIT_EXCEEDED'|'UNSUPPORTED_OS'|'RESOURCE_TERMINATED',
            'startedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The list of on-demand scans that match the request.
  - (dict) –
    
    Details of a single on-demand scan of a resource.
    - scanId (string) –
      
      The unique identifier of the on-demand scan.
    - resourceId (string) –
      
      The ID of the resource that was scanned.
    - resourceType (string) –
      
      The type of the resource that was scanned.
    - scanStatus (string) –
      
      The current status of the on-demand scan.
    - scanStatusReason (string) –
      
      The reason associated with the current on-demand scan status.
    - startedAt (datetime) –
      
      The date and time, in ISO 8601 format, when the on-demand scan started.
    - completedAt (datetime) –
      
      The date and time, in ISO 8601 format, when the on-demand scan completed. This field is absent if the scan has not completed.
- NextToken (string) –
  
  A token to resume pagination.