AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . devicefarm ]

get-job

Description

Gets information about a job.

See also: AWS API Documentation

Synopsis

  get-job
--arn <value>
[--cli-input-json <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>]

Options

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

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

job -> (structure)

An object that contains 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
  • 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.