Table Of Contents


User Guide

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

[ aws . devicefarm ]



Gets information about a job.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--arn (string)

The job's ARN.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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.

See 'aws help' for descriptions of global parameters.


job -> (structure)

An object containing information about the requested job.

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: 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_NODE: The Appium Node.js type.
  • APPIUM_RUBY: The Appium Ruby 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.
  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.
  • APPIUM_WEB_RUBY: The Appium Ruby test 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.

created -> (timestamp)

When the job was created.

status -> (string)

The job'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 job'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 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: The phone form factor.
  • TABLET: The tablet form factor.

platform -> (string)

The device's platform.

Allowed values include:

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

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.

fleetType -> (string)

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

fleetName -> (string)

The name of the fleet to which this device belongs.

instances -> (list)

The instances belonging to this device.


Represents the device instance.

arn -> (string)

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

deviceArn -> (string)

The Amazon Resource Name (ARN) of the device.

labels -> (list)

An array of strings describing the device instance.


status -> (string)

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

udid -> (string)

Unique device identifier for the device instance.

instanceProfile -> (structure)

A object containing information about the instance profile.

arn -> (string)

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

packageCleanup -> (boolean)

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

excludeAppPackagesFromCleanup -> (list)

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

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


rebootAfterUse -> (boolean)

When set to true , Device Farm will reboot 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)

Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.

instanceArn -> (string)

The Amazon Resource Name (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.