Suite - AWS Device Farm Documentation
ContentsSee Also

Suite

Represents a collection of one or more tests.

Contents

arn

The suite's ARN.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

counters

The suite's result counters.

Type: Counters object

Required: No

created

When the suite was created.

Type: Timestamp

Required: No

deviceMinutes

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

Type: DeviceMinutes object

Required: No

message

A message about the suite's result.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: No

name

The suite's name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

result

The suite's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

Type: String

Valid Values: PENDING | PASSED | WARNED | FAILED | SKIPPED | ERRORED | STOPPED

Required: No

started

The suite's start time.

Type: Timestamp

Required: No

status

The suite's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

Type: String

Valid Values: PENDING | PENDING_CONCURRENCY | PENDING_DEVICE | PROCESSING | SCHEDULING | PREPARING | RUNNING | COMPLETED | STOPPING

Required: No

stopped

The suite's stop time.

Type: Timestamp

Required: No

type

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

Type: String

Valid Values: 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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: