Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . devicefarm ]

list-runs

Description

Gets information about runs, given an AWS Device Farm project ARN.

See also: AWS API Documentation

list-runs 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: runs

Synopsis

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

Options

--arn (string)

The Amazon Resource Name (ARN) of the project for which you want to list runs.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

runs -> (list)

Information about the runs.

(structure)

Represents a test run on a set of devices with a given app package, test parameters, etc.

arn -> (string)

The run's ARN.

name -> (string)

The run's name.

type -> (string)

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.
  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
  • APPIUM_PYTHON: The Appium Python type.
  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
  • CALABASH: The Calabash type.
  • INSTRUMENTATION: The Instrumentation type.
  • UIAUTOMATION: The uiautomation type.
  • UIAUTOMATOR: The uiautomator type.
  • XCTEST: The XCode test type.
  • XCTEST_UI: The XCode UI test type.

platform -> (string)

The run's platform.

Allowed values include:

  • ANDROID: The Android platform.
  • IOS: The iOS platform.

created -> (timestamp)

When the run was created.

status -> (string)

The run's status.

Allowed values include:

  • PENDING: A pending status.
  • PENDING_CONCURRENCY: A pending concurrency status.
  • PENDING_DEVICE: A pending device status.
  • PROCESSING: A processing status.
  • SCHEDULING: A scheduling status.
  • PREPARING: A preparing status.
  • RUNNING: A running status.
  • COMPLETED: A completed status.
  • STOPPING: A stopping status.

result -> (string)

The run's result.

Allowed values include:

  • PENDING: A pending condition.
  • PASSED: A passing condition.
  • WARNED: A warning condition.
  • FAILED: A failed condition.
  • SKIPPED: A skipped condition.
  • ERRORED: An error condition.
  • STOPPED: A stopped condition.

started -> (timestamp)

The run's start time.

stopped -> (timestamp)

The run's stop time.

counters -> (structure)

The run'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 run's result.

totalJobs -> (integer)

The total number of jobs for the run.

completedJobs -> (integer)

The total number of completed jobs.

billingMethod -> (string)

Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .

deviceMinutes -> (structure)

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

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.

networkProfile -> (structure)

The network profile being used for a test run.

arn -> (string)

The Amazon Resource Name (ARN) of the network profile.

name -> (string)

The name of the network profile.

description -> (string)

The description of the network profile.

type -> (string)

The type of network profile. Valid values are listed below.

uplinkBandwidthBits -> (long)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

downlinkBandwidthBits -> (long)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

uplinkDelayMs -> (long)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

downlinkDelayMs -> (long)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

uplinkJitterMs -> (long)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

downlinkJitterMs -> (long)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

uplinkLossPercent -> (integer)

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

downlinkLossPercent -> (integer)

Proportion of received packets that fail to arrive from 0 to 100 percent.

parsingResultUrl -> (string)

Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

resultCode -> (string)

Supporting field for the result field. Set only if result is SKIPPED . PARSING_FAILED if the result is skipped because of test package parsing failure.

customerArtifactPaths -> (structure)

Output CustomerArtifactPaths object for the test run.

iosPaths -> (list)

Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.

(string)

androidPaths -> (list)

Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.

(string)

deviceHostPaths -> (list)

Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.

(string)

nextToken -> (string)

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.