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.

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',
        'AsnAssociations': [
            {
                'Asn': 'string',
                'Cidr': 'string',
                'StatusMessage': 'string',
                'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
            },
        ],
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
        'NetworkBorderGroup': 'string'
    }
}

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.
  - AsnAssociations (list) –
    
    The BYOIP CIDR associations with ASNs.
    - (dict) –
      
      An Autonomous System Number (ASN) and BYOIP CIDR association.
      - Asn (string) –
        
        The association’s ASN.
      - Cidr (string) –
        
        The association’s CIDR.
      - StatusMessage (string) –
        
        The association’s status message.
      - State (string) –
        
        The association’s state.
  - StatusMessage (string) –
    
    Upon success, contains the ID of the address pool. Otherwise, contains an error message.
  - State (string) –
    
    The state of the address range.
    - advertised: The address range is being advertised to the internet by Amazon Web Services.
    - deprovisioned: The address range is deprovisioned.
    - failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
    - failed-provision: The request to provision the address range was unsuccessful.
    - pending-deprovision: You’ve submitted a request to deprovision an address range and it’s pending.
    - pending-provision: You’ve submitted a request to provision an address range and it’s pending.
    - provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
    - provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
  - NetworkBorderGroup (string) –
    
    If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
    
    You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
    - us-east-1-dfw-2
    - us-west-2-lax-1
    - us-west-2-phx-2
    Note
    You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.