Skip to content

EC2  >  Operations  >  delete_public_ipv4_pool

delete_public_ipv4_pool

Operation

delete_public_ipv4_pool async

delete_public_ipv4_pool(request: DeletePublicIpv4PoolInput | DeletePublicIpv4PoolInputDict, /, *, plugins: list[Plugin] | None = None) -> DeletePublicIpv4PoolOutput
delete_public_ipv4_pool(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePublicIpv4PoolInputDict]) -> DeletePublicIpv4PoolOutput

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

Parameters:

Name Type Description Default
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
DeletePublicIpv4PoolOutput

An instance of DeletePublicIpv4PoolOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DeletePublicIpv4PoolInput dataclass

Bases: _SerdeShape

Dataclass for DeletePublicIpv4PoolInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | 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.

network_border_group class-attribute instance-attribute
network_border_group: str | None = ...

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

pool_id class-attribute instance-attribute
pool_id: str | None = ...

The ID of the public IPv4 pool you want to delete.

Dictionaries

DeletePublicIpv4PoolInputDict

Bases: TypedDict

Dictionary form of DeletePublicIpv4PoolInput.

Attributes
dry_run instance-attribute
dry_run: bool | 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.

network_border_group instance-attribute
network_border_group: str | None

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

pool_id instance-attribute
pool_id: Required[str]

The ID of the public IPv4 pool you want to delete.

Output

DeletePublicIpv4PoolOutput dataclass

Bases: _SerdeShape

Dataclass for DeletePublicIpv4PoolOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

return_value class-attribute instance-attribute
return_value: bool | None = ...

Information about the result of deleting the public IPv4 pool.