:doc:`DeviceFarm <../../devicefarm>` / Paginator / ListDevicePools

***************
ListDevicePools
***************



.. py:class:: DeviceFarm.Paginator.ListDevicePools

  ::

    
    paginator = client.get_paginator('list_device_pools')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DeviceFarm.Client.list_device_pools`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/ListDevicePools>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          arn='string',
          type='CURATED'|'PRIVATE',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type arn: string
    :param arn: **[REQUIRED]** 

      The project ARN.

      

    
    :type type: string
    :param type: 

      The device pools' type.

       

      Allowed values include:

       

      
      * CURATED: A device pool that is created and managed by AWS Device Farm.
       
      * PRIVATE: A device pool that is created and managed by the device pool developer.
      

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'devicePools': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'description': 'string',
                    'type': 'CURATED'|'PRIVATE',
                    'rules': [
                        {
                            'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
                            'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
                            'value': 'string'
                        },
                    ],
                    'maxDevices': 123
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the result of a list device pools request.

        
        

        - **devicePools** *(list) --* 

          Information about the device pools.

          
          

          - *(dict) --* 

            Represents a collection of device types.

            
            

            - **arn** *(string) --* 

              The device pool's ARN.

              
            

            - **name** *(string) --* 

              The device pool's name.

              
            

            - **description** *(string) --* 

              The device pool's description.

              
            

            - **type** *(string) --* 

              The device pool's type.

               

              Allowed values include:

               

              
              * CURATED: A device pool that is created and managed by AWS Device Farm.
               
              * PRIVATE: A device pool that is created and managed by the device pool developer.
              

              
            

            - **rules** *(list) --* 

              Information about the device pool's rules.

              
              

              - *(dict) --* 

                Represents a condition for a device pool.

                
                

                - **attribute** *(string) --* 

                  The rule's stringified attribute. For example, specify the value as ``"\"abc\""``.

                   

                  The supported operators for each attribute are provided in the following list.

                    APPIUM_VERSION  

                  The Appium version for the test.

                   

                  Supported operators: ``CONTAINS``

                    ARN  

                  The Amazon Resource Name (ARN) of the device (for example, ``arn:aws:devicefarm:us-west-2::device:12345Example``.

                   

                  Supported operators: ``EQUALS``, ``IN``, ``NOT_IN``

                    AVAILABILITY  

                  The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

                   

                  Supported operators: ``EQUALS``

                    FLEET_TYPE  

                  The fleet type. Valid values are PUBLIC or PRIVATE.

                   

                  Supported operators: ``EQUALS``

                    FORM_FACTOR  

                  The device form factor. Valid values are PHONE or TABLET.

                   

                  Supported operators: ``EQUALS``, ``IN``, ``NOT_IN``

                    INSTANCE_ARN  

                  The Amazon Resource Name (ARN) of the device instance.

                   

                  Supported operators: ``IN``, ``NOT_IN``

                    INSTANCE_LABELS  

                  The label of the device instance.

                   

                  Supported operators: ``CONTAINS``

                    MANUFACTURER  

                  The device manufacturer (for example, Apple).

                   

                  Supported operators: ``EQUALS``, ``IN``, ``NOT_IN``

                    MODEL  

                  The device model, such as Apple iPad Air 2 or Google Pixel.

                   

                  Supported operators: ``CONTAINS``, ``EQUALS``, ``IN``, ``NOT_IN``

                    OS_VERSION  

                  The operating system version (for example, 10.3.2).

                   

                  Supported operators: ``EQUALS``, ``GREATER_THAN``, ``GREATER_THAN_OR_EQUALS``, ``IN``, ``LESS_THAN``, ``LESS_THAN_OR_EQUALS``, ``NOT_IN``

                    PLATFORM  

                  The device platform. Valid values are ANDROID or IOS.

                   

                  Supported operators: ``EQUALS``, ``IN``, ``NOT_IN``

                    REMOTE_ACCESS_ENABLED  

                  Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

                   

                  Supported operators: ``EQUALS``

                    REMOTE_DEBUG_ENABLED  

                  Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

                   

                  Supported operators: ``EQUALS``

                   

                  Because remote debugging is `no longer supported <https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html>`__, this filter is ignored.

                  
                

                - **operator** *(string) --* 

                  Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

                  
                

                - **value** *(string) --* 

                  The rule's value.

                  
            
          
            

            - **maxDevices** *(integer) --* 

              The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the ``rules`` parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

               

              By specifying the maximum number of devices, you can control the costs that you incur by running tests.

              
        
      
        

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

          A token to resume pagination.

          
    