[ aws . devicefarm ]

list-suites

Description

Gets information about test suites for a given job.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-suites is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: suites

Synopsis

  list-suites
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--arn (string)

The job’s Amazon Resource Name (ARN).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

suites -> (list)

Information about the suites.

(structure)

Represents 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 -> (timestamp)

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 -> (timestamp)

The suite’s start time.

stopped -> (timestamp)

The suite’s stop time.

counters -> (structure)

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 -> (structure)

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

total -> (double)

When specified, represents the total minutes used by the resource to run tests.

metered -> (double)

When specified, represents only the sum of metered minutes used by the resource to run tests.

unmetered -> (double)

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.