[ aws . devicefarm ]

list-jobs

Description

Gets information about jobs for a given test run.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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

Synopsis

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

Options

--arn (string)

The run’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

jobs -> (list)

Information about the jobs.

(structure)

Represents a device.

arn -> (string)

The job’s ARN.

name -> (string)

The job’s name.

type -> (string)

The job’s type.

Allowed values include the following:

  • BUILTIN_FUZZ

  • BUILTIN_EXPLORER. 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 job was created.

status -> (string)

The job’s status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

result -> (string)

The job’s result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

started -> (timestamp)

The job’s start time.

stopped -> (timestamp)

The job’s stop time.

counters -> (structure)

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

device -> (structure)

The device (phone or tablet).

arn -> (string)

The device’s ARN.

name -> (string)

The device’s display name.

manufacturer -> (string)

The device’s manufacturer name.

model -> (string)

The device’s model name.

modelId -> (string)

The device’s model ID.

formFactor -> (string)

The device’s form factor.

Allowed values include:

  • PHONE

  • TABLET

platform -> (string)

The device’s platform.

Allowed values include:

  • ANDROID

  • IOS

os -> (string)

The device’s operating system type.

cpu -> (structure)

Information about the device’s CPU.

frequency -> (string)

The CPU’s frequency.

architecture -> (string)

The CPU’s architecture (for example, x86 or ARM).

clock -> (double)

The clock speed of the device’s CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.

resolution -> (structure)

The resolution of the device.

width -> (integer)

The screen resolution’s width, expressed in pixels.

height -> (integer)

The screen resolution’s height, expressed in pixels.

heapSize -> (long)

The device’s heap size, expressed in bytes.

memory -> (long)

The device’s total memory size, expressed in bytes.

image -> (string)

The device’s image name.

carrier -> (string)

The device’s carrier.

radio -> (string)

The device’s radio.

remoteAccessEnabled -> (boolean)

Specifies whether remote access has been enabled for the specified device.

remoteDebugEnabled -> (boolean)

This flag is set to true if remote debugging is enabled for the device.

Remote debugging is no longer supported .

fleetType -> (string)

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

fleetName -> (string)

The name of the fleet to which this device belongs.

instances -> (list)

The instances that belong to this device.

(structure)

Represents the device instance.

arn -> (string)

The Amazon Resource Name (ARN) of the device instance.

deviceArn -> (string)

The ARN of the device.

labels -> (list)

An array of strings that describe the device instance.

(string)

status -> (string)

The status of the device instance. Valid values are listed here.

udid -> (string)

Unique device identifier for the device instance.

instanceProfile -> (structure)

A object that contains information about the instance profile.

arn -> (string)

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

packageCleanup -> (boolean)

When set to true , Device Farm removes app packages after a test run. The default value is false for private devices.

excludeAppPackagesFromCleanup -> (list)

An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

The list of packages is considered only if you set packageCleanup to true .

(string)

rebootAfterUse -> (boolean)

When set to true , Device Farm reboots the instance after a test run. The default value is true .

name -> (string)

The name of the instance profile.

description -> (string)

The description of the instance profile.

availability -> (string)

Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.

instanceArn -> (string)

The ARN of the instance.

deviceMinutes -> (structure)

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

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.

videoEndpoint -> (string)

The endpoint for streaming device video.

videoCapture -> (boolean)

This value is set to true if video capture is enabled. Otherwise, it is set to false.

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.