---
title: "POST /#X-Amz-Target=DeviceFarm_20150623.GetRemoteAccessSession"
method: POST
path: "/#X-Amz-Target=DeviceFarm_20150623.GetRemoteAccessSession"
---

# POST /#X-Amz-Target=DeviceFarm_20150623.GetRemoteAccessSession

`POST /#X-Amz-Target=DeviceFarm_20150623.GetRemoteAccessSession`

Returns a link to a currently running remote access session.

## Headers

- `X-Amz-Target` 'DeviceFarm_20150623.GetRemoteAccessSession', required

## Request body

- GetRemoteAccessSessionRequest — Represents the request to get information about the specified remote access session.
  - `arn` string, required — The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

## Response `200`

Success

- GetRemoteAccessSessionResult — Represents the response from the server that lists detailed information about the remote access session.
  - `remoteAccessSession` object — A container that lists detailed information about the remote access session.
    - `arn` string — The Amazon Resource Name (ARN) of the remote access session.
    - `name` string — The name of the remote access session.
    - `created` string, date-time — The date and time the remote access session was created.
    - `status` 'PENDING' | 'PENDING_CONCURRENCY' | 'PENDING_DEVICE' | 'PROCESSING' | 'SCHEDULING' | 'PREPARING' | 'RUNNING' | 'COMPLETED' | 'STOPPING' — <p>The status of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING.</p> </li> <li> <p>PENDING_CONCURRENCY.</p> </li> <li> <p>PENDING_DEVICE.</p> </li> <li> <p>PROCESSING.</p> </li> <li> <p>SCHEDULING.</p> </li> <li> <p>PREPARING.</p> </li> <li> <p>RUNNING.</p> </li> <li> <p>COMPLETED.</p> </li> <li> <p>STOPPING.</p> </li> </ul>
    - `result` 'PENDING' | 'PASSED' | 'WARNED' | 'FAILED' | 'SKIPPED' | 'ERRORED' | 'STOPPED' — <p>The result of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING.</p> </li> <li> <p>PASSED.</p> </li> <li> <p>WARNED.</p> </li> <li> <p>FAILED.</p> </li> <li> <p>SKIPPED.</p> </li> <li> <p>ERRORED.</p> </li> <li> <p>STOPPED.</p> </li> </ul>
    - `message` string — A message about the remote access session.
    - `started` string, date-time — The date and time the remote access session was started.
    - `stopped` string, date-time — The date and time the remote access session was stopped.
    - `device` object — 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` 'PHONE' | 'TABLET' — <p>The device's form factor.</p> <p>Allowed values include:</p> <ul> <li> <p>PHONE</p> </li> <li> <p>TABLET</p> </li> </ul>
      - `platform` 'ANDROID' | 'IOS' — <p>The device's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID</p> </li> <li> <p>IOS</p> </li> </ul>
      - `os` string — The device's operating system type.
      - `cpu` object — Information about the device's CPU.
        - `frequency` string — The CPU's frequency.
        - `architecture` string — The CPU's architecture (for example, x86 or ARM).
        - `clock` number, 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` object — 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` integer — The device's heap size, expressed in bytes.
      - `memory` integer — 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 — <p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
      - `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` DeviceInstance[] — The instances that belong to this device.
        - `arn` string — The Amazon Resource Name (ARN) of the device instance.
        - `deviceArn` string — The ARN of the device.
        - `labels` String[] — An array of strings that describe the device instance.
        - `status` 'IN_USE' | 'PREPARING' | 'AVAILABLE' | 'NOT_AVAILABLE' — The status of the device instance. Valid values are listed here.
        - `udid` string — Unique device identifier for the device instance.
        - `instanceProfile` object — 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 <code>true</code>, Device Farm removes app packages after a test run. The default value is <code>false</code> for private devices.
          - `excludeAppPackagesFromCleanup` String[] — <p>An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.</p> <p>The list of packages is considered only if you set <code>packageCleanup</code> to <code>true</code>.</p>
          - `rebootAfterUse` boolean — When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is <code>true</code>.
          - `name` string — The name of the instance profile.
          - `description` string — The description of the instance profile.
      - `availability` 'TEMPORARY_NOT_AVAILABLE' | 'BUSY' | 'AVAILABLE' | 'HIGHLY_AVAILABLE' — Indicates how likely a device is available for a test run. Currently available in the <a>ListDevices</a> and GetDevice API methods.
    - `instanceArn` string — The ARN of the instance.
    - `remoteDebugEnabled` boolean — <p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
    - `remoteRecordEnabled` boolean — This flag is set to <code>true</code> if remote recording is enabled for the remote access session.
    - `remoteRecordAppArn` string — The ARN for the app to be recorded in the remote access session.
    - `hostAddress` string — <p>IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
    - `clientId` string — <p>Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
    - `billingMethod` 'METERED' | 'UNMETERED' — The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology">AWS Device Farm terminology</a>.
    - `deviceMinutes` object — The number of minutes a device is used in a remote access session (including setup and teardown minutes).
      - `total` number, double — When specified, represents the total minutes used by the resource to run tests.
      - `metered` number, double — When specified, represents only the sum of metered minutes used by the resource to run tests.
      - `unmetered` number, 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 sesssion.
    - `deviceUdid` string — <p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
    - `interactionMode` 'INTERACTIVE' | 'NO_VIDEO' | 'VIDEO_ONLY' — <p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>
    - `skipAppResign` boolean — <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>
    - `vpcConfig` object — The VPC security groups and subnets that are attached to a project.
      - `securityGroupIds` SecurityGroupId[], required — An array of one or more security groups IDs in your Amazon VPC.
      - `subnetIds` SubnetId[], required — An array of one or more subnet IDs in your Amazon VPC.
      - `vpcId` string, required — The ID of the Amazon VPC.

## Other responses

- `480` — ArgumentException
- `481` — NotFoundException
- `482` — LimitExceededException
- `483` — ServiceAccountException

---

[API](https://skmtc.net/aws/apis/devicefarm.md) · [All operations](https://skmtc.net/aws/apis/devicefarm/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/devicefarm/versions/a20834382f29/schema)