GuardDuty / Paginator / ListIPSets

ListIPSets¶

class GuardDuty.Paginator.ListIPSets¶

paginator = client.get_paginator('list_ip_sets')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from GuardDuty.Client.list_ip_sets().

Request Syntax

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

Parameters:

DetectorId (string) –
[REQUIRED]

The unique ID of the detector that is associated with IPSet.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
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

{
    'IpSetIds': [
        'string',
    ],

}

Response Structure

(dict) –
- IpSetIds (list) –
  
  The IDs of the IPSet resources.
  - (string) –