GlobalAccelerator / Client / withdraw_byoip_cidr

withdraw_byoip_cidr#

GlobalAccelerator.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 propagation delays.

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

Request Syntax

response = client.withdraw_byoip_cidr(
    Cidr='string'
)

Parameters:

Cidr (string) –

[REQUIRED]

The address range, in CIDR notation.

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 BYOIP address pool.
  - 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

GlobalAccelerator.Client.exceptions.InternalServiceErrorException
GlobalAccelerator.Client.exceptions.InvalidArgumentException
GlobalAccelerator.Client.exceptions.AccessDeniedException
GlobalAccelerator.Client.exceptions.ByoipCidrNotFoundException
GlobalAccelerator.Client.exceptions.IncorrectCidrStateException