:doc:`GlobalAccelerator <../../globalaccelerator>` / Client / provision_byoip_cidr

********************
provision_byoip_cidr
********************



.. py:method:: GlobalAccelerator.Client.provision_byoip_cidr(**kwargs)

  

  Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using `AdvertiseByoipCidr <https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html>`__.

   

  For more information, see `Bring your own IP addresses (BYOIP) <https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html>`__ in the *Global Accelerator Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ProvisionByoipCidr>`_  


  **Request Syntax**
  ::

    response = client.provision_byoip_cidr(
        Cidr='string',
        CidrAuthorizationContext={
            'Message': 'string',
            'Signature': 'string'
        }
    )
    
  :type Cidr: string
  :param Cidr: **[REQUIRED]** 

    The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region.

     

    For more information, see `Bring your own IP addresses (BYOIP) <https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html>`__ in the Global Accelerator Developer Guide.

    

  
  :type CidrAuthorizationContext: dict
  :param CidrAuthorizationContext: **[REQUIRED]** 

    A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

    

  
    - **Message** *(string) --* **[REQUIRED]** 

      The plain-text authorization message for the prefix and account.

      

    
    - **Signature** *(string) --* **[REQUIRED]** 

      The signed authorization message for the prefix and account.

      

    
  
  
  :rtype: 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) <https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html>`__ 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**
  
  *   :py:class:`GlobalAccelerator.Client.exceptions.InternalServiceErrorException`

  
  *   :py:class:`GlobalAccelerator.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`GlobalAccelerator.Client.exceptions.LimitExceededException`

  
  *   :py:class:`GlobalAccelerator.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`GlobalAccelerator.Client.exceptions.IncorrectCidrStateException`

  