DeviceFarm / Client / list_tests

list_tests#

DeviceFarm.Client.list_tests(**kwargs)#

Gets information about tests in a given test suite.

Request Syntax

response = client.list_tests(
    arn='string',
    nextToken='string'
)

Parameters:

arn (string) –
[REQUIRED]

The test suite’s Amazon Resource Name (ARN).
nextToken (string) – An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Return type:

dict

Returns:

Response Syntax

{
    'tests': [
        {
            'arn': 'string',
            'name': 'string',
            'type': 'BUILTIN_FUZZ'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'APPIUM_PYTHON'|'APPIUM_NODE'|'APPIUM_RUBY'|'APPIUM_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'APPIUM_WEB_NODE'|'APPIUM_WEB_RUBY'|'INSTRUMENTATION'|'XCTEST'|'XCTEST_UI',
            'created': datetime(2015, 1, 1),
            'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
            'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
            'started': datetime(2015, 1, 1),
            'stopped': datetime(2015, 1, 1),
            'counters': {
                'total': 123,
                'passed': 123,
                'failed': 123,
                'warned': 123,
                'errored': 123,
                'stopped': 123,
                'skipped': 123
            },
            'message': 'string',
            'deviceMinutes': {
                'total': 123.0,
                'metered': 123.0,
                'unmetered': 123.0
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Represents the result of a list tests request.
- tests (list) –
  
  Information about the tests.
  - (dict) –
    
    Represents a condition that is evaluated.
    - arn (string) –
      
      The test’s ARN.
    - name (string) –
      
      The test’s name.
    - type (string) –
      
      The test’s type.
      
      Must be one of the following values:
      - BUILTIN_FUZZ
      - APPIUM_JAVA_JUNIT
      - APPIUM_JAVA_TESTNG
      - APPIUM_PYTHON
      - APPIUM_NODE
      - APPIUM_RUBY
      - APPIUM_WEB_JAVA_JUNIT
      - APPIUM_WEB_JAVA_TESTNG
      - APPIUM_WEB_PYTHON
      - APPIUM_WEB_NODE
      - APPIUM_WEB_RUBY
      - INSTRUMENTATION
      - XCTEST
      - XCTEST_UI
    - created (datetime) –
      
      When the test was created.
    - status (string) –
      
      The test’s status.
      
      Allowed values include:
      - PENDING
      - PENDING_CONCURRENCY
      - PENDING_DEVICE
      - PROCESSING
      - SCHEDULING
      - PREPARING
      - RUNNING
      - COMPLETED
      - STOPPING
    - result (string) –
      
      The test’s result.
      
      Allowed values include:
      - PENDING
      - PASSED
      - WARNED
      - FAILED
      - SKIPPED
      - ERRORED
      - STOPPED
    - started (datetime) –
      
      The test’s start time.
    - stopped (datetime) –
      
      The test’s stop time.
    - counters (dict) –
      
      The test’s result counters.
      - total (integer) –
        
        The total number of entities.
      - passed (integer) –
        
        The number of passed entities.
      - failed (integer) –
        
        The number of failed entities.
      - warned (integer) –
        
        The number of warned entities.
      - errored (integer) –
        
        The number of errored entities.
      - stopped (integer) –
        
        The number of stopped entities.
      - skipped (integer) –
        
        The number of skipped entities.
    - message (string) –
      
      A message about the test’s result.
    - deviceMinutes (dict) –
      
      Represents the total (metered or unmetered) minutes used by the test.
      - total (float) –
        
        When specified, represents the total minutes used by the resource to run tests.
      - metered (float) –
        
        When specified, represents only the sum of metered minutes used by the resource to run tests.
      - unmetered (float) –
        
        When specified, represents only the sum of unmetered minutes used by the resource to run tests.
- nextToken (string) –
  
  If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

Exceptions

Examples

The following example returns information about tests, given a specific Device Farm project.

response = client.list_tests(
    # You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
    arn='arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456',
    # A dynamically generated value, used for paginating results.
    nextToken='RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE',
)

print(response)

Expected Output:

{
    'tests': [
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}