AWS CLI Command Reference

[ aws . devicefarm ]

list-uploads

Description

Gets information about uploads, given an AWS Device Farm project ARN.

See also: AWS API Documentation

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

Synopsis

  list-uploads
--arn <value>
[--type <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)

The Amazon Resource Name (ARN) of the project for which you want to list uploads.

--type (string)

The type of upload.

Must be one of the following values:

  • ANDROID_APP
  • IOS_APP
  • WEB_APP
  • EXTERNAL_DATA
  • APPIUM_JAVA_JUNIT_TEST_PACKAGE
  • APPIUM_JAVA_TESTNG_TEST_PACKAGE
  • APPIUM_PYTHON_TEST_PACKAGE
  • APPIUM_NODE_TEST_PACKAGE
  • APPIUM_RUBY_TEST_PACKAGE
  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
  • APPIUM_WEB_PYTHON_TEST_PACKAGE
  • APPIUM_WEB_NODE_TEST_PACKAGE
  • APPIUM_WEB_RUBY_TEST_PACKAGE
  • INSTRUMENTATION_TEST_PACKAGE
  • XCTEST_TEST_PACKAGE
  • XCTEST_UI_TEST_PACKAGE
  • APPIUM_JAVA_JUNIT_TEST_SPEC
  • APPIUM_JAVA_TESTNG_TEST_SPEC
  • APPIUM_PYTHON_TEST_SPEC
  • APPIUM_NODE_TEST_SPEC
  • APPIUM_RUBY_TEST_SPEC
  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
  • APPIUM_WEB_PYTHON_TEST_SPEC
  • APPIUM_WEB_NODE_TEST_SPEC
  • APPIUM_WEB_RUBY_TEST_SPEC
  • INSTRUMENTATION_TEST_SPEC
  • XCTEST_UI_TEST_SPEC

Possible values:

  • ANDROID_APP
  • IOS_APP
  • WEB_APP
  • EXTERNAL_DATA
  • APPIUM_JAVA_JUNIT_TEST_PACKAGE
  • APPIUM_JAVA_TESTNG_TEST_PACKAGE
  • APPIUM_PYTHON_TEST_PACKAGE
  • APPIUM_NODE_TEST_PACKAGE
  • APPIUM_RUBY_TEST_PACKAGE
  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
  • APPIUM_WEB_PYTHON_TEST_PACKAGE
  • APPIUM_WEB_NODE_TEST_PACKAGE
  • APPIUM_WEB_RUBY_TEST_PACKAGE
  • CALABASH_TEST_PACKAGE
  • INSTRUMENTATION_TEST_PACKAGE
  • UIAUTOMATION_TEST_PACKAGE
  • UIAUTOMATOR_TEST_PACKAGE
  • XCTEST_TEST_PACKAGE
  • XCTEST_UI_TEST_PACKAGE
  • APPIUM_JAVA_JUNIT_TEST_SPEC
  • APPIUM_JAVA_TESTNG_TEST_SPEC
  • APPIUM_PYTHON_TEST_SPEC
  • APPIUM_NODE_TEST_SPEC
  • APPIUM_RUBY_TEST_SPEC
  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
  • APPIUM_WEB_PYTHON_TEST_SPEC
  • APPIUM_WEB_NODE_TEST_SPEC
  • APPIUM_WEB_RUBY_TEST_SPEC
  • INSTRUMENTATION_TEST_SPEC
  • XCTEST_UI_TEST_SPEC

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

uploads -> (list)

Information about the uploads.

(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
  • IOS_APP
  • WEB_APP
  • EXTERNAL_DATA
  • APPIUM_JAVA_JUNIT_TEST_PACKAGE
  • APPIUM_JAVA_TESTNG_TEST_PACKAGE
  • APPIUM_PYTHON_TEST_PACKAGE
  • APPIUM_NODE_TEST_PACKAGE
  • APPIUM_RUBY_TEST_PACKAGE
  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
  • APPIUM_WEB_PYTHON_TEST_PACKAGE
  • APPIUM_WEB_NODE_TEST_PACKAGE
  • APPIUM_WEB_RUBY_TEST_PACKAGE
  • INSTRUMENTATION_TEST_PACKAGE
  • XCTEST_TEST_PACKAGE
  • XCTEST_UI_TEST_PACKAGE
  • APPIUM_JAVA_JUNIT_TEST_SPEC
  • APPIUM_JAVA_TESTNG_TEST_SPEC
  • APPIUM_PYTHON_TEST_SPEC
  • APPIUM_NODE_TEST_SPEC
  • APPIUM_RUBY_TEST_SPEC
  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
  • APPIUM_WEB_PYTHON_TEST_SPEC
  • APPIUM_WEB_NODE_TEST_SPEC
  • APPIUM_WEB_RUBY_TEST_SPEC
  • INSTRUMENTATION_TEST_SPEC
  • XCTEST_UI_TEST_SPEC

status -> (string)

The upload’s status.

Must be one of the following values:

  • FAILED
  • INITIALIZED
  • PROCESSING
  • SUCCEEDED

url -> (string)

The presigned Amazon S3 URL that was used to store a file using a 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.

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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.