AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . devicefarm ]

create-remote-access-session

Description

Specifies and starts a remote access session.

See also: AWS API Documentation

Synopsis

  create-remote-access-session
--project-arn <value>
--device-arn <value>
[--app-arn <value>]
[--instance-arn <value>]
[--name <value>]
[--configuration <value>]
[--interaction-mode <value>]
[--skip-app-resign | --no-skip-app-resign]
[--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>]
[--v2-debug]

Options

--project-arn (string)

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

--device-arn (string)

The ARN of the device for which you want to create a remote access session.

--app-arn (string)

The Amazon Resource Name (ARN) of the app to create the remote access session.

--instance-arn (string)

The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

--name (string)

The name of the remote access session to create.

--configuration (structure)

The configuration information for the remote access session request.

auxiliaryApps -> (list)

A list of upload ARNs for app packages to be installed onto your device. (Maximum 3)

(string)

billingMethod -> (string)

The billing method for the remote access session.

vpceConfigurationArns -> (list)

An array of ARNs included in the VPC endpoint configuration.

(string)

deviceProxy -> (structure)

The device proxy to be configured on the device for the remote access session.

host -> (string)

Hostname or IPv4 address of the proxy.

port -> (integer)

The port number on which the http/s proxy is listening.

Shorthand Syntax:

auxiliaryApps=string,string,billingMethod=string,vpceConfigurationArns=string,string,deviceProxy={host=string,port=integer}

JSON Syntax:

{
  "auxiliaryApps": ["string", ...],
  "billingMethod": "METERED"|"UNMETERED",
  "vpceConfigurationArns": ["string", ...],
  "deviceProxy": {
    "host": "string",
    "port": integer
  }
}

--interaction-mode (string)

The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

Possible values:

  • INTERACTIVE
  • NO_VIDEO
  • VIDEO_ONLY

--skip-app-resign | --no-skip-app-resign (boolean)

When set to true , for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

remoteAccessSession -> (structure)

A container that describes the remote access session when the request to create a remote access session is sent.

arn -> (string)

The Amazon Resource Name (ARN) of the remote access session.

name -> (string)

The name of the remote access session.

created -> (timestamp)

The date and time the remote access session was created.

status -> (string)

The status of the remote access session. Can be any of the following:

  • PENDING.
  • PENDING_CONCURRENCY.
  • PENDING_DEVICE.
  • PROCESSING.
  • SCHEDULING.
  • PREPARING.
  • RUNNING.
  • COMPLETED.
  • STOPPING.

result -> (string)

The result of the remote access session. Can be any of the following:

  • PENDING.
  • PASSED.
  • WARNED.
  • FAILED.
  • SKIPPED.
  • ERRORED.
  • STOPPED.

message -> (string)

A message about the remote access session.

started -> (timestamp)

The date and time the remote access session was started.

stopped -> (timestamp)

The date and time the remote access session was stopped.

device -> (structure)

The device (phone or tablet) used in the remote access session.

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.

billingMethod -> (string)

The billing method of the remote access session. Possible values include METERED or UNMETERED . For more information about metered devices, see AWS Device Farm terminology .

deviceMinutes -> (structure)

The number of minutes a device is used in a remote access session (including setup and teardown minutes).

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.

endpoint -> (string)

The endpoint for the remote access session. This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.

deviceUdid -> (string)

Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported .

interactionMode -> (string)

The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

skipAppResign -> (boolean)

When set to true , for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs .

vpcConfig -> (structure)

The VPC security groups and subnets that are attached to a project.

securityGroupIds -> (list)

An array of one or more security groups IDs in your Amazon VPC.

(string)

subnetIds -> (list)

An array of one or more subnet IDs in your Amazon VPC.

(string)

vpcId -> (string)

The ID of the Amazon VPC.

deviceProxy -> (structure)

The device proxy configured for the remote access session.

host -> (string)

Hostname or IPv4 address of the proxy.

port -> (integer)

The port number on which the http/s proxy is listening.

appUpload -> (string)

The ARN for the app to be installed onto your device.

endpoints -> (structure)

Represents the remote endpoints for viewing and controlling a device during a remote access session.

remoteDriverEndpoint -> (string)

URL for controlling the device using WebDriver-compliant clients, like Appium, during the remote access session.

interactiveEndpoint -> (string)

URL for viewing and interacting with the device during the remote access session.