EC2 / Client / withdraw_byoip_cidr

withdraw_byoip_cidr#

EC2.Client.withdraw_byoip_cidr(**kwargs)#

Stops advertising an address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.

See also: AWS API Documentation

Request Syntax

response = client.withdraw_byoip_cidr(
    Cidr='string',
    DryRun=True|False
)
Parameters:

  • Cidr (string) –

    [REQUIRED]

    The address range, in CIDR notation.

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'Description': 'string',
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
    }
}

Response Structure

  • (dict) –

    • ByoipCidr (dict) –

      Information about the address pool.

      • Cidr (string) –

        The address range, in CIDR notation.

      • Description (string) –

        The description of the address range.

      • StatusMessage (string) –

        Upon success, contains the ID of the address pool. Otherwise, contains an error message.

      • State (string) –

        The state of the address pool.