deprovision_ipam_pool_cidr `async` ¶

deprovision_ipam_pool_cidr(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_pool_id: Optional[IpamPoolId] = None,
    cidr: Optional[String] = None,
) -> DeprovisionIpamPoolCidrResult

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:

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

The ID of the pool that has the CIDR you want to deprovision.
cidr (Optional[String], default: None ) –

The CIDR which you want to deprovision from the pool.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def deprovision_ipam_pool_cidr(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_pool_id: Optional["capo_ec2.types.ipam_pool_id.IpamPoolId"] = None,
    cidr: Optional["capo_ec2.types.string.String"] = None,
) -> (
    "capo_ec2.types.deprovision_ipam_pool_cidr_result.DeprovisionIpamPoolCidrResult"
):
    """<p>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 <a href="https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html">Deprovision pool CIDRs</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_pool_id: <p>The ID of the pool that has the CIDR you want to deprovision.</p>
        cidr: <p>The CIDR which you want to deprovision from the pool.</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.deprovision_ipam_pool_cidr_request.DeprovisionIpamPoolCidrRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.deprovision_ipam_pool_cidr_result.DeprovisionIpamPoolCidrResult"
    ]:
        import capo_ec2._operations.amazon_ec2.deprovision_ipam_pool_cidr

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeprovisionIpamPoolCidr")
    )
    input_: capo_ec2.types.deprovision_ipam_pool_cidr_request.DeprovisionIpamPoolCidrRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_pool_id is not None:
        input_["ipam_pool_id"] = ipam_pool_id
    if cidr is not None:
        input_["cidr"] = cidr

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

deprovision_ipam_pool_cidr async ¶

deprovision_ipam_pool_cidr `async` ¶