Skip to content

deprovision_public_ipv4_pool_cidr

deprovision_public_ipv4_pool_cidr(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    pool_id: Optional[Ipv4PoolEc2Id] = None,
    cidr: Optional[String] = None,
) -> DeprovisionPublicIpv4PoolCidrResult

Deprovision a CIDR from a public IPv4 pool.

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.

  • pool_id (Optional[Ipv4PoolEc2Id], default: None ) –

    The ID of the pool that you want to deprovision the CIDR from.

  • cidr (Optional[String], default: None ) –

    The CIDR you want to deprovision from the pool.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def deprovision_public_ipv4_pool_cidr(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    pool_id: Optional["capo_ec2.types.ipv4_pool_ec2_id.Ipv4PoolEc2Id"] = None,
    cidr: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.deprovision_public_ipv4_pool_cidr_result.DeprovisionPublicIpv4PoolCidrResult":
    """<p>Deprovision a CIDR from a public IPv4 pool.</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>
        pool_id: <p>The ID of the pool that you want to deprovision the CIDR from.</p>
        cidr: <p>The CIDR you want to deprovision from the pool.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.deprovision_public_ipv4_pool_cidr_request.DeprovisionPublicIpv4PoolCidrRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.deprovision_public_ipv4_pool_cidr_result.DeprovisionPublicIpv4PoolCidrResult"
    ]:
        import capo_ec2._operations.amazon_ec2.deprovision_public_ipv4_pool_cidr

        output, http_response = (
            capo_ec2._operations.amazon_ec2.deprovision_public_ipv4_pool_cidr.deprovision_public_ipv4_pool_cidr(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeprovisionPublicIpv4PoolCidr")
    )
    input_: capo_ec2.types.deprovision_public_ipv4_pool_cidr_request.DeprovisionPublicIpv4PoolCidrRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if pool_id is not None:
        input_["pool_id"] = pool_id
    if cidr is not None:
        input_["cidr"] = cidr

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output