deprovision_ipam_pool_cidr¶
Operation¶
deprovision_ipam_pool_cidr
¶
deprovision_ipam_pool_cidr(request: DeprovisionIpamPoolCidrInput | DeprovisionIpamPoolCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeprovisionIpamPoolCidrInputDict]) -> DeprovisionIpamPoolCidrOutput
Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeprovisionIpamPoolCidrInput | DeprovisionIpamPoolCidrInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeprovisionIpamPoolCidrInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeprovisionIpamPoolCidrOutput
|
An instance of |
deprovision_ipam_pool_cidr
async
¶
deprovision_ipam_pool_cidr(request: DeprovisionIpamPoolCidrInput | DeprovisionIpamPoolCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeprovisionIpamPoolCidrInputDict]) -> DeprovisionIpamPoolCidrOutput
Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeprovisionIpamPoolCidrInput | DeprovisionIpamPoolCidrInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeprovisionIpamPoolCidrInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeprovisionIpamPoolCidrOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeprovisionIpamPoolCidrInputDict
¶
Bases: TypedDict
Dictionary form of DeprovisionIpamPoolCidrInput.
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.
DeprovisionIpamPoolCidrInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeprovisionIpamPoolCidrInput structure.
Attributes¶
cidr
class-attribute
instance-attribute
¶
cidr: str | None = ...
The CIDR which you want to deprovision from the pool.
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.
Output¶
DeprovisionIpamPoolCidrOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeprovisionIpamPoolCidrOutput structure.
Attributes¶
ipam_pool_cidr
class-attribute
instance-attribute
¶
ipam_pool_cidr: IpamPoolCidr | None = ...
The deprovisioned pool CIDR.
response_metadata
class-attribute
instance-attribute
¶
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.