:doc:`DeviceFarm <../../devicefarm>` / Client / update_device_pool

******************
update_device_pool
******************



.. py:method:: DeviceFarm.Client.update_device_pool(**kwargs)

  

  Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

  

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


  **Request Syntax**
  ::

    response = client.update_device_pool(
        arn='string',
        name='string',
        description='string',
        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,
        clearMaxDevices=True|False
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the Device Farm device pool to update.

    

  
  :type name: string
  :param name: 

    A string that represents the name of the device pool to update.

    

  
  :type description: string
  :param description: 

    A description of the device pool to update.

    

  
  :type rules: list
  :param rules: 

    Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing 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.

        

      
    

  :type maxDevices: integer
  :param maxDevices: 

    The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that 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.

     

    If you use this parameter in your request, you cannot use the ``clearMaxDevices`` parameter in the same request.

    

  
  :type clearMaxDevices: boolean
  :param clearMaxDevices: 

    Sets whether the ``maxDevices`` parameter applies to your device pool. If you set this parameter to ``true``, the ``maxDevices`` parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the ``rules`` parameter.

     

    If you use this parameter in your request, you cannot use the ``maxDevices`` parameter in the same request.

    

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

    
    ::

      {
          'devicePool': {
              '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
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the result of an update device pool request.

      
      

      - **devicePool** *(dict) --* 

        The device pool you just updated.

        
        

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

          
    
  
  **Exceptions**
  
  *   :py:class:`DeviceFarm.Client.exceptions.ArgumentException`

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

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

  
  *   :py:class:`DeviceFarm.Client.exceptions.ServiceAccountException`

  

  **Examples**

  The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.
  ::

    response = client.update_device_pool(
        name='NewName',
        # You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.
        arn='arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE',
        description='NewDescription',
        rules=[
            {
                'value': 'True',
                'attribute': 'REMOTE_ACCESS_ENABLED',
                'operator': 'EQUALS',
            },
        ],
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        # Note: you cannot update curated device pools.
        'devicePool': {
        },
        'ResponseMetadata': {
            '...': '...',
        },
    }

  