Skip to content

Guardduty  >  Operations  >  list_ip_sets

list_ip_sets

Operation

list_ip_sets async

list_ip_sets(input: ListIPSetsInput, plugins: list[Plugin] | None = None) -> ListIPSetsOutput

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.

Parameters:

Name Type Description Default
input ListIPSetsInput

An instance of ListIPSetsInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ListIPSetsOutput

An instance of ListIPSetsOutput.

Input

ListIPSetsInput dataclass

Dataclass for ListIPSetsInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | None = None

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.

max_results class-attribute instance-attribute
max_results: int | None = None

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.

next_token class-attribute instance-attribute
next_token: str | None = None

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.

Output

ListIPSetsOutput dataclass

Dataclass for ListIPSetsOutput structure.

Attributes

ip_set_ids class-attribute instance-attribute
ip_set_ids: list[str] | None = None

The IDs of the IPSet resources.

next_token class-attribute instance-attribute
next_token: str | None = None

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