delete_ip_set¶
Operation¶
delete_ip_set
¶
delete_ip_set(request: DeleteIPSetInput | DeleteIPSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIPSetInputDict]) -> DeleteIPSetOutput
Deletes the IPSet specified by the ipSetId. IPSets are called trusted
IP lists in the console user interface.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteIPSetInput | DeleteIPSetInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteIPSetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteIPSetOutput
|
An instance of |
delete_ip_set
async
¶
delete_ip_set(request: DeleteIPSetInput | DeleteIPSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIPSetInputDict]) -> DeleteIPSetOutput
Deletes the IPSet specified by the ipSetId. IPSets are called trusted
IP lists in the console user interface.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteIPSetInput | DeleteIPSetInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteIPSetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteIPSetOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteIPSetInputDict
¶
Bases: TypedDict
Dictionary form of DeleteIPSetInput.
Attributes¶
detector_id
instance-attribute
¶
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.
DeleteIPSetInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteIPSetInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | 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.
Output¶
DeleteIPSetOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteIPSetOutput structure.