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

*******************
get_device_instance
*******************



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

  

  Returns information about a device instance that belongs to a private device fleet.

  

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


  **Request Syntax**
  ::

    response = client.get_device_instance(
        arn='string'
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the instance you're requesting information about.

    

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

    
    ::

      {
          'deviceInstance': {
              'arn': 'string',
              'deviceArn': 'string',
              'labels': [
                  'string',
              ],
              'status': 'IN_USE'|'PREPARING'|'AVAILABLE'|'NOT_AVAILABLE',
              'udid': 'string',
              'instanceProfile': {
                  'arn': 'string',
                  'packageCleanup': True|False,
                  'excludeAppPackagesFromCleanup': [
                      'string',
                  ],
                  'rebootAfterUse': True|False,
                  'name': 'string',
                  'description': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **deviceInstance** *(dict) --* 

        An object that contains information about your device instance.

        
        

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

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

          
        

        - **deviceArn** *(string) --* 

          The ARN of the device.

          
        

        - **labels** *(list) --* 

          An array of strings that describe the device instance.

          
          

          - *(string) --* 
      
        

        - **status** *(string) --* 

          The status of the device instance. Valid values are listed here.

          
        

        - **udid** *(string) --* 

          Unique device identifier for the device instance.

          
        

        - **instanceProfile** *(dict) --* 

          A object that contains information about the instance profile.

          
          

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

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

            
          

          - **packageCleanup** *(boolean) --* 

            When set to ``true``, Device Farm removes app packages after a test run. The default value is ``false`` for private devices.

            
          

          - **excludeAppPackagesFromCleanup** *(list) --* 

            An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

             

            The list of packages is considered only if you set ``packageCleanup`` to ``true``.

            
            

            - *(string) --* 
        
          

          - **rebootAfterUse** *(boolean) --* 

            When set to ``true``, Device Farm reboots the instance after a test run. The default value is ``true``.

            
          

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

            The name of the instance profile.

            
          

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

            The description of the instance profile.

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

  