Table Of Contents


User Guide

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

[ aws . devicefarm ]



Gets information about an upload.

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


Viewing an upload

The following command retrieves information about an upload:

aws devicefarm get-upload --arn "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514"

You can get the upload ARN from the output of create-upload.


    "upload": {
        "status": "SUCCEEDED",
        "name": "app.apk",
        "created": 1505262773.186,
        "type": "ANDROID_APP",
        "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514",
        "metadata": "{\"device_admin\":false,\"activity_name\":\"ccom.example.client.LauncherActivity\",\"version_name\":\"\",\"screens\":[\"small\",\"normal\",\"large\",\"xlarge\"],\"error_type\":null,\"sdk_version\":\"16\",\"package_name\":\"com.example.client\",\"version_code\":\"20994\",\"native_code\":[\"armeabi-v7a\"],\"target_sdk_version\":\"25\"}"


upload -> (structure)

An app or a set of one or more tests to upload or that have been uploaded.

arn -> (string)

The upload's ARN.

name -> (string)

The upload's file name.

created -> (timestamp)

When the upload was created.

type -> (string)

The upload's type.

Must be one of the following values:

  • ANDROID_APP: An Android upload.
  • IOS_APP: An iOS upload.
  • WEB_APP: A web appliction upload.
  • EXTERNAL_DATA: An external data upload.
  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
  • CALABASH_TEST_PACKAGE: A Calabash test package upload.
  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
  • XCTEST_TEST_PACKAGE: An XCode test package upload.
  • XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.

status -> (string)

The upload's status.

Must be one of the following values:

  • FAILED: A failed status.
  • INITIALIZED: An initialized status.
  • PROCESSING: A processing status.
  • SUCCEEDED: A succeeded status.

url -> (string)

The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.

metadata -> (string)

The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.

contentType -> (string)

The upload's content type (for example, "application/octet-stream").

message -> (string)

A message about the upload's result.

category -> (string)

The upload's category. Allowed values include:

  • CURATED: An upload managed by AWS Device Farm.
  • PRIVATE: An upload managed by the AWS Device Farm customer.