ListTests

class DeviceFarm.Paginator.ListTests
paginator = client.get_paginator('list_tests')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DeviceFarm.Client.list_tests().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    arn='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • arn (string) --

    [REQUIRED]

    The test suite's Amazon Resource Name (ARN).

  • PaginationConfig (dict) --

    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.

Return type

dict

Returns

Response Syntax

{
    'tests': [
        {
            'arn': 'string',
            'name': 'string',
            'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST'|'XCTEST_UI'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
            '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
          • BUILTIN_EXPLORER

          Note

          For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.

          • 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
          • CALABASH
          • INSTRUMENTATION
          • UIAUTOMATION
          • UIAUTOMATOR
          • 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) --

      A token to resume pagination.