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

*****************
get_dedicated_ips
*****************



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

  

  List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

  

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


  **Request Syntax**
  ::

    response = client.get_dedicated_ips(
        PoolName='string',
        NextToken='string',
        PageSize=123
    )
    
  :type PoolName: string
  :param PoolName: 

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

    

  
  :type NextToken: string
  :param NextToken: 

    A token returned from a previous call to ``GetDedicatedIps`` to indicate the position of the dedicated IP pool in the list of IP pools.

    

  
  :type PageSize: integer
  :param PageSize: 

    The number of results to show in a single call to ``GetDedicatedIpsRequest``. If the number of results is larger than the number you specified in this parameter, then the response includes a ``NextToken`` element, which you can use to obtain additional results.

    

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

    
    ::

      {
          'DedicatedIps': [
              {
                  'Ip': 'string',
                  'WarmupStatus': 'IN_PROGRESS'|'DONE',
                  'WarmupPercentage': 123,
                  'PoolName': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.

      
      

      - **DedicatedIps** *(list) --* 

        A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

        
        

        - *(dict) --* 

          Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

          
          

          - **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.

            
      
    
      

      - **NextToken** *(string) --* 

        A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to ``GetDedicatedIps``, passing this token in the ``NextToken`` parameter.

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

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

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

  