DeviceFarm / Client / get_suite

get_suite

DeviceFarm.Client.get_suite(**kwargs)

Gets information about a suite.

See also: AWS API Documentation

Request Syntax

response = client.get_suite(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

The suite’s ARN.

Return type:

dict

Returns:

Response Syntax

{
    'suite': {
        '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
        }
    }
}

Response Structure

• (dict) –

  Represents the result of a get suite request.

  • suite (dict) –

    A collection of one or more tests.

    • arn (string) –

      The suite’s ARN.

    • name (string) –

      The suite’s name.

    • type (string) –

      The suite’s type.

      Must be one of the following values:

      • BUILTIN_FUZZ

      • BUILTIN_EXPLORER

      Note

      Only available 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 suite was created.

    • status (string) –

      The suite’s status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

    • result (string) –

      The suite’s result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

    • started (datetime) –

      The suite’s start time.

    • stopped (datetime) –

      The suite’s stop time.

    • counters (dict) –

      The suite’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 suite’s result.

    • deviceMinutes (dict) –

      Represents the total (metered or unmetered) minutes used by the test suite.

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

Exceptions

• DeviceFarm.Client.exceptions.ArgumentException

• DeviceFarm.Client.exceptions.NotFoundException

• DeviceFarm.Client.exceptions.LimitExceededException

• DeviceFarm.Client.exceptions.ServiceAccountException

Examples

The following example gets information about a specific test suite.

response = client.get_suite(
    # You can get the suite ARN by using the list-suites CLI command.
    arn='arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456',
)

print(response)

Expected Output:

{
    'suite': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}