Skip to content

GuardDuty  >  Operations  >  delete_ip_set

delete_ip_set

Operation

delete_ip_set async 

delete_ip_set(input: DeleteIPSetInput, plugins: list[Plugin] | None = None) -> DeleteIPSetOutput

Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.

Parameters:

Name Type Description Default
input DeleteIPSetInput

An instance of DeleteIPSetInput.

 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
DeleteIPSetOutput

An instance of DeleteIPSetOutput.

Input

DeleteIPSetInput dataclass

Dataclass for DeleteIPSetInput structure.

Attributes

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

The unique ID of the detector associated with the IPSet.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

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

The unique ID of the IPSet to delete.

Output

DeleteIPSetOutput dataclass

Dataclass for DeleteIPSetOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.