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 ]

install-to-remote-access-session

Description

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

See also: AWS API Documentation

Synopsis

  install-to-remote-access-session
--remote-access-session-arn <value>
--app-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

--remote-access-session-arn (string)

The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

--app-arn (string)

The ARN of the app about which you are requesting information.

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

appUpload -> (structure)

An app to upload or that has 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
  • 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

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.