Skip to content

EC2  >  Operations  >  modify_ipam_pool_allocation

modify_ipam_pool_allocation

Operation

modify_ipam_pool_allocation async 

modify_ipam_pool_allocation(input: ModifyIpamPoolAllocationInput, plugins: list[Plugin] | None = None) -> ModifyIpamPoolAllocationOutput

Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.

Parameters:

Name Type Description Default
input ModifyIpamPoolAllocationInput

An instance of ModifyIpamPoolAllocationInput.

 required
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
ModifyIpamPoolAllocationOutput

An instance of ModifyIpamPoolAllocationOutput.

Input

ModifyIpamPoolAllocationInput dataclass

Bases: _SerdeShape

Dataclass for ModifyIpamPoolAllocationInput structure.

Attributes

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

The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation.

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.

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

The ID of the IPAM pool allocation you want to modify.

Output

ModifyIpamPoolAllocationOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyIpamPoolAllocationOutput structure.

Attributes

ipam_pool_allocation class-attribute instance-attribute 
ipam_pool_allocation: IpamPoolAllocation | None = ...

The modified IPAM pool allocation.

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.