Skip to content

delete_ipam_resource_discovery async

delete_ipam_resource_discovery(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_resource_discovery_id: Optional[IpamResourceDiscoveryId] = None,
) -> DeleteIpamResourceDiscoveryResult

Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • ipam_resource_discovery_id (Optional[IpamResourceDiscoveryId], default: None ) –

    The IPAM resource discovery ID.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def delete_ipam_resource_discovery(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_resource_discovery_id: Optional[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ] = None,
) -> "capo_ec2.types.delete_ipam_resource_discovery_result.DeleteIpamResourceDiscoveryResult":
    """<p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>

    Args:
        dry_run: <p>A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        ipam_resource_discovery_id: <p>The IPAM resource discovery ID.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.delete_ipam_resource_discovery_request.DeleteIpamResourceDiscoveryRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_ipam_resource_discovery_result.DeleteIpamResourceDiscoveryResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_ipam_resource_discovery

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.delete_ipam_resource_discovery.async_delete_ipam_resource_discovery(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIpamResourceDiscovery")
    )
    input_: capo_ec2.types.delete_ipam_resource_discovery_request.DeleteIpamResourceDiscoveryRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_resource_discovery_id is not None:
        input_["ipam_resource_discovery_id"] = ipam_resource_discovery_id

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