:doc:`PinpointEmail <../../pinpoint-email>` / Client / get_dedicated_ip

****************
get_dedicated_ip
****************



.. py:method:: PinpointEmail.Client.get_dedicated_ip(**kwargs)

  

  Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIp>`_  


  **Request Syntax**
  ::

    response = client.get_dedicated_ip(
        Ip='string'
    )
    
  :type Ip: string
  :param Ip: **[REQUIRED]** 

    The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'DedicatedIp': {
              'Ip': 'string',
              'WarmupStatus': 'IN_PROGRESS'|'DONE',
              'WarmupPercentage': 123,
              'PoolName': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Information about a dedicated IP address.

      
      

      - **DedicatedIp** *(dict) --* 

        An object that contains information about a dedicated IP address.

        
        

        - **Ip** *(string) --* 

          An IP address that is reserved for use by your Amazon Pinpoint account.

          
        

        - **WarmupStatus** *(string) --* 

          The warm-up status of a dedicated IP address. The status can have one of the following values:

           

          
          * ``IN_PROGRESS`` – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
           
          * ``DONE`` – The dedicated IP warm-up process is complete, and the IP address is ready to use.
          

          
        

        - **WarmupPercentage** *(integer) --* 

          Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

          
        

        - **PoolName** *(string) --* 

          The name of the dedicated IP pool that the IP address is associated with.

          
    
  
  **Exceptions**
  
  *   :py:class:`PinpointEmail.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`PinpointEmail.Client.exceptions.NotFoundException`

  
  *   :py:class:`PinpointEmail.Client.exceptions.BadRequestException`

  