[ 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 | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--arn (string)
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
runs -> (list)
Information about the runs.
(structure)
Represents a test run on a set of devices with a given app package, test parameters, and so on.
arn -> (string)
name -> (string)
type -> (string)
The run’s type.
Must be one of the following values:
- BUILTIN_FUZZ
- 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
- INSTRUMENTATION
- XCTEST
- XCTEST_UI
platform -> (string)
The run’s platform.
Allowed values include:
- ANDROID
- IOS
created -> (timestamp)
status -> (string)
The run’s status.
Allowed values include:
- PENDING
- PENDING_CONCURRENCY
- PENDING_DEVICE
- PROCESSING
- SCHEDULING
- PREPARING
- RUNNING
- COMPLETED
- STOPPING
result -> (string)
The run’s result.
Allowed values include:
- PENDING
- PASSED
- WARNED
- FAILED
- SKIPPED
- ERRORED
- STOPPED
started -> (timestamp)
stopped -> (timestamp)
counters -> (structure)
The run’s result counters.
total -> (integer)
passed -> (integer)
failed -> (integer)
warned -> (integer)
errored -> (integer)
stopped -> (integer)
skipped -> (integer)
message -> (string)
totalJobs -> (integer)
completedJobs -> (integer)
billingMethod -> (string)
Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .
Note
If you have unmetered device slots, you must set this tounmetered to use them. Otherwise, the run is counted toward metered device minutes.deviceMinutes -> (structure)
Represents the total (metered or unmetered) minutes used by the test run.
total -> (double)
metered -> (double)
unmetered -> (double)
networkProfile -> (structure)
The network profile being used for a test run.
arn -> (string)
name -> (string)
description -> (string)
type -> (string)
uplinkBandwidthBits -> (long)
downlinkBandwidthBits -> (long)
uplinkDelayMs -> (long)
downlinkDelayMs -> (long)
uplinkJitterMs -> (long)
downlinkJitterMs -> (long)
uplinkLossPercent -> (integer)
downlinkLossPercent -> (integer)
deviceProxy -> (structure)
The device proxy configured for the devices in the run.
host -> (string)
port -> (integer)
parsingResultUrl -> (string)
resultCode -> (string)
result is SKIPPED . PARSING_FAILED if the result is skipped because of test package parsing failure.seed -> (integer)
appUpload -> (string)
eventCount -> (integer)
jobTimeoutMinutes -> (integer)
devicePoolArn -> (string)
locale -> (string)
radios -> (structure)
Information about the radio states for the run.
wifi -> (boolean)
bluetooth -> (boolean)
nfc -> (boolean)
gps -> (boolean)
location -> (structure)
Information about the location that is used for the run.
latitude -> (double)
longitude -> (double)
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 are pulled from.
(string)
androidPaths -> (list)
Comma-separated list of paths on the Android device where the artifacts generated by the customer’s tests are pulled from.
(string)
deviceHostPaths -> (list)
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer’s tests are pulled from.
(string)
webUrl -> (string)
skipAppResign -> (boolean)
When set to true , for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs .
testSpecArn -> (string)
deviceSelectionResult -> (structure)
The results of a device filter used to select the devices for a test run.
filters -> (list)
The filters in a device selection result.
(structure)
Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun . For an example of the JSON request syntax, see ScheduleRun .
It is also passed in as the filters parameter to ListDevices . For an example of the JSON request syntax, see ListDevices .
attribute -> (string)
The aspect of a device such as platform or model used as the selection criteria in a device filter.
The supported operators for each attribute are provided in the following list.
The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example ).
Supported operators: EQUALS , IN , NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
The operating system version (for example, 10.3.2).
Supported operators: EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS , EQUALS , IN , NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS , IN , NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
Supported operators: EQUALS
Because remote debugging is no longer supported , this filter is ignored.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS , IN , NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
operator -> (string)
values -> (list)
An array of one or more filter values used in a device filter.
- The IN and NOT_IN operators can take a values array that has more than one element.
- The other operators require an array with a single element.
- The PLATFORM attribute can be set to ANDROID or IOS.
- The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
- The FORM_FACTOR attribute can be set to PHONE or TABLET.
- The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.
(string)
matchedDevicesCount -> (integer)
maxDevices -> (integer)
vpcConfig -> (structure)
The VPC security groups and subnets that are attached to a project.
securityGroupIds -> (list)
An array of one or more security groups IDs in your Amazon VPC.
(string)
subnetIds -> (list)
An array of one or more subnet IDs in your Amazon VPC.
(string)
vpcId -> (string)
nextToken -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.