delete_ip_set `async` ¶

delete_ip_set(
    detector_id: DetectorId,
    ip_set_id: String,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
) -> DeleteIPSetResponse

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

Parameters:

detector_id (DetectorId) –

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 (String) –

The unique ID of the IPSet to delete.

Raises:

BadRequestException –

A bad request exception object.
InternalServerErrorException –

An internal server error exception object.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_guardduty/_services/async_guard_duty.py

async def delete_ip_set(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    ip_set_id: "capo_guardduty.types.string.String",
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
) -> "capo_guardduty.types.delete_ip_set_response.DeleteIPSetResponse":
    """<p>Deletes the IPSet specified by the <code>ipSetId</code>. IPSets are called trusted IP lists in the console user interface.</p>

    Args:
        detector_id: <p>The unique ID of the detector associated with the IPSet.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
        ip_set_id: <p>The unique ID of the IPSet to delete.</p>

    Raises:
        capo_guardduty.errors.bad_request_exception.BadRequestException: <p>A bad request exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_guardduty.types.delete_ip_set_request.DeleteIPSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.delete_ip_set_response.DeleteIPSetResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.delete_ip_set

        (
            output,
            http_response,
        ) = await capo_guardduty._operations.guard_duty_api_service.delete_ip_set.async_delete_ip_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIPSet")
    )
    input_: capo_guardduty.types.delete_ip_set_request.DeleteIPSetRequest = {
        "detector_id": detector_id,
        "ip_set_id": ip_set_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_ip_set async ¶

delete_ip_set `async` ¶