GuardDuty / Client / list_ip_sets

list_ip_sets#

GuardDuty.Client.list_ip_sets(**kwargs)#

Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated administrator account.

See also: AWS API Documentation

Request Syntax

response = client.list_ip_sets(
    DetectorId='string',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

  • NextToken (string) – You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • IpSetIds (list) –

      The IDs of the IPSet resources.

      • (string) –

    • NextToken (string) –

      The pagination parameter to be used on the next list operation to retrieve more items.

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException