EC2 / Client / deprovision_byoip_cidr

deprovision_byoip_cidr#

EC2.Client.deprovision_byoip_cidr(**kwargs)#

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 using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

See also: AWS API Documentation

Request Syntax

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

  • Cidr (string) –

    [REQUIRED]

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

  • 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 range.

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