Skip to content

delete_ipam_prefix_list_resolver_target async

delete_ipam_prefix_list_resolver_target(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_prefix_list_resolver_target_id: Optional[
        IpamPrefixListResolverTargetId
    ] = None,
) -> DeleteIpamPrefixListResolverTargetResult

Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization.

For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.

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_prefix_list_resolver_target_id (Optional[IpamPrefixListResolverTargetId], default: None ) –

    The ID of the IPAM prefix list resolver target to delete.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def delete_ipam_prefix_list_resolver_target(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_prefix_list_resolver_target_id: Optional[
        "capo_ec2.types.ipam_prefix_list_resolver_target_id.IpamPrefixListResolverTargetId"
    ] = None,
) -> "capo_ec2.types.delete_ipam_prefix_list_resolver_target_result.DeleteIpamPrefixListResolverTargetResult":
    """<p>Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization.</p> <p>For more information about IPAM prefix list resolver, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/automate-prefix-list-updates.html">Automate prefix list updates with IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</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_prefix_list_resolver_target_id: <p>The ID of the IPAM prefix list resolver target to delete.</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_prefix_list_resolver_target_request.DeleteIpamPrefixListResolverTargetRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_ipam_prefix_list_resolver_target_result.DeleteIpamPrefixListResolverTargetResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_ipam_prefix_list_resolver_target

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIpamPrefixListResolverTarget")
    )
    input_: capo_ec2.types.delete_ipam_prefix_list_resolver_target_request.DeleteIpamPrefixListResolverTargetRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_prefix_list_resolver_target_id is not None:
        input_["ipam_prefix_list_resolver_target_id"] = (
            ipam_prefix_list_resolver_target_id
        )

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