Skip to content

deprovision_byoip_cidr async

deprovision_byoip_cidr(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    cidr: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DeprovisionByoipCidrResult

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it and you must not have any IP addresses allocated from its address range.

Parameters:

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

    The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

  • dry_run (Optional[Boolean], default: None ) –

    Checks 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.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def deprovision_byoip_cidr(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    cidr: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.deprovision_byoip_cidr_result.DeprovisionByoipCidrResult":
    """<p>Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.</p> <p>Before you can release an address range, you must stop advertising it and you must not have any IP addresses allocated from its address range.</p>

    Args:
        cidr: <p>The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.</p>
        dry_run: <p>Checks 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>

    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_byoip_cidr_request.DeprovisionByoipCidrRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.deprovision_byoip_cidr_result.DeprovisionByoipCidrResult"
    ]:
        import capo_ec2._operations.amazon_ec2.deprovision_byoip_cidr

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeprovisionByoipCidr")
    )
    input_: capo_ec2.types.deprovision_byoip_cidr_request.DeprovisionByoipCidrRequest = {}
    if cidr is not None:
        input_["cidr"] = cidr
    if dry_run is not None:
        input_["dry_run"] = dry_run

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