GlobalAccelerator / Client / deprovision_byoip_cidr

deprovision_byoip_cidr#

GlobalAccelerator.Client.deprovision_byoip_cidr(**kwargs)#

Releases the specified address range that you provisioned to 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 by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.deprovision_byoip_cidr(
    Cidr='string'
)
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.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

  • (dict) –

    • ByoipCidr (dict) –

      Information about the address range.

      • Cidr (string) –

        The address range, in CIDR notation.

        For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

      • State (string) –

        The state of the address pool.

      • Events (list) –

        A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

        • (dict) –

          A complex type that contains a Message and a Timestamp value for changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

          • Message (string) –

            A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

          • Timestamp (datetime) –

            A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

Exceptions