Skip to content
AWS for Query.Farm

aws.devicefarm.get_remote_access_session

Example SQL Queries

SELECT * FROM
aws.devicefarm.get_remote_access_session
WHERE
"arn" = 'VALUE';

Description

Returns a link to a currently running remote access session.

Table Definition

Column NameColumn Data Type
arn Required Input Column

The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
remote_access_session

A container that lists detailed information about the remote access session.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "created" TIMESTAMP_S,
    "status" VARCHAR,
    "result" VARCHAR,
    "message" VARCHAR,
    "started" TIMESTAMP_S,
    "stopped" TIMESTAMP_S,
    "device" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR,
        "manufacturer" VARCHAR,
        "model" VARCHAR,
        "model_id" VARCHAR,
        "form_factor" VARCHAR,
        "platform" VARCHAR,
        "os" VARCHAR,
        "cpu" STRUCT(
            "frequency" VARCHAR,
            "architecture" VARCHAR,
            "clock" DOUBLE
        ),
        "resolution" STRUCT(
            "width" BIGINT,
            "height" BIGINT
        ),
        "heap_size" BIGINT,
        "memory" BIGINT,
        "image" VARCHAR,
        "carrier" VARCHAR,
        "radio" VARCHAR,
        "remote_access_enabled" BOOLEAN,
        "remote_debug_enabled" BOOLEAN,
        "fleet_type" VARCHAR,
        "fleet_name" VARCHAR,
        "instances" STRUCT(
            "arn" VARCHAR,
            "device_arn" VARCHAR,
            "labels" VARCHAR[],
            "status" VARCHAR,
            "udid" VARCHAR,
            "instance_profile" STRUCT(
                "arn" VARCHAR,
                "package_cleanup" BOOLEAN,
                "exclude_app_packages_from_cleanup" VARCHAR[],
                "reboot_after_use" BOOLEAN,
                "name" VARCHAR,
                "description" VARCHAR
            )
        )[],
        "availability" VARCHAR
    ),
    "instance_arn" VARCHAR,
    "remote_debug_enabled" BOOLEAN,
    "remote_record_enabled" BOOLEAN,
    "remote_record_app_arn" VARCHAR,
    "host_address" VARCHAR,
    "client_id" VARCHAR,
    "billing_method" VARCHAR,
    "device_minutes" STRUCT(
        "total" DOUBLE,
        "metered" DOUBLE,
        "unmetered" DOUBLE
    ),
    "endpoint" VARCHAR,
    "device_udid" VARCHAR,
    "interaction_mode" VARCHAR,
    "skip_app_resign" BOOLEAN,
    "vpc_config" STRUCT(
        "security_group_ids" VARCHAR[],
        "subnet_ids" VARCHAR[],
        "vpc_id" VARCHAR
    )
)
Show child fields
remote_access_session.arn

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

remote_access_session.billing_method

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.

remote_access_session.client_id

Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

remote_access_session.created

The date and time the remote access session was created.

remote_access_session.device

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

Show child fields
remote_access_session.device.arn

The device's ARN.

remote_access_session.device.availability

Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.

remote_access_session.device.carrier

The device's carrier.

remote_access_session.device.cpu

Information about the device's CPU.

Show child fields
remote_access_session.device.cpu.architecture

The CPU's architecture (for example, x86 or ARM).

remote_access_session.device.cpu.clock

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.

remote_access_session.device.cpu.frequency

The CPU's frequency.

remote_access_session.device.fleet_name

The name of the fleet to which this device belongs.

remote_access_session.device.fleet_type

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

remote_access_session.device.form_factor

The device's form factor.

Allowed values include:

  • PHONE

  • TABLET

remote_access_session.device.heap_size

The device's heap size, expressed in bytes.

remote_access_session.device.image

The device's image name.

remote_access_session.device.instances[]
Show child fields
remote_access_session.device.instances[].arn

The Amazon Resource Name (ARN) of the device instance.

remote_access_session.device.instances[].device_arn

The ARN of the device.

remote_access_session.device.instances[].instance_profile

A object that contains information about the instance profile.

Show child fields
remote_access_session.device.instances[].instance_profile.arn

The Amazon Resource Name (ARN) of the instance profile.

remote_access_session.device.instances[].instance_profile.description

The description of the instance profile.

remote_access_session.device.instances[].instance_profile.exclude_app_packages_from_cleanup[]
remote_access_session.device.instances[].instance_profile.name

The name of the instance profile.

remote_access_session.device.instances[].instance_profile.package_cleanup

When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.

remote_access_session.device.instances[].instance_profile.reboot_after_use

When set to true, Device Farm reboots the instance after a test run. The default value is true.

remote_access_session.device.instances[].labels[]
remote_access_session.device.instances[].status

The status of the device instance. Valid values are listed here.

remote_access_session.device.instances[].udid

Unique device identifier for the device instance.

remote_access_session.device.manufacturer

The device's manufacturer name.

remote_access_session.device.memory

The device's total memory size, expressed in bytes.

remote_access_session.device.model

The device's model name.

remote_access_session.device.model_id

The device's model ID.

remote_access_session.device.name

The device's display name.

remote_access_session.device.os

The device's operating system type.

remote_access_session.device.platform

The device's platform.

Allowed values include:

  • ANDROID

  • IOS

remote_access_session.device.radio

The device's radio.

remote_access_session.device.remote_access_enabled

Specifies whether remote access has been enabled for the specified device.

remote_access_session.device.remote_debug_enabled

This flag is set to true if remote debugging is enabled for the device.

Remote debugging is no longer supported.

remote_access_session.device.resolution

The resolution of the device.

Show child fields
remote_access_session.device.resolution.height

The screen resolution's height, expressed in pixels.

remote_access_session.device.resolution.width

The screen resolution's width, expressed in pixels.

remote_access_session.device_minutes

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

Show child fields
remote_access_session.device_minutes.metered

When specified, represents only the sum of metered minutes used by the resource to run tests.

remote_access_session.device_minutes.total

When specified, represents the total minutes used by the resource to run tests.

remote_access_session.device_minutes.unmetered

When specified, represents only the sum of unmetered minutes used by the resource to run tests.

remote_access_session.device_udid

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.

remote_access_session.endpoint

The endpoint for the remote access sesssion.

remote_access_session.host_address

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.

Remote debugging is no longer supported.

remote_access_session.instance_arn

The ARN of the instance.

remote_access_session.interaction_mode

The interaction mode of the remote access session. Valid values are:

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

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

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

remote_access_session.message

A message about the remote access session.

remote_access_session.name

The name of the remote access session.

remote_access_session.remote_debug_enabled

This flag is set to true if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

remote_access_session.remote_record_app_arn

The ARN for the app to be recorded in the remote access session.

remote_access_session.remote_record_enabled

This flag is set to true if remote recording is enabled for the remote access session.

remote_access_session.result

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

  • PENDING.

  • PASSED.

  • WARNED.

  • FAILED.

  • SKIPPED.

  • ERRORED.

  • STOPPED.

remote_access_session.skip_app_resign

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.

remote_access_session.started

The date and time the remote access session was started.

remote_access_session.status

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

  • PENDING.

  • PENDING_CONCURRENCY.

  • PENDING_DEVICE.

  • PROCESSING.

  • SCHEDULING.

  • PREPARING.

  • RUNNING.

  • COMPLETED.

  • STOPPING.

remote_access_session.stopped

The date and time the remote access session was stopped.

remote_access_session.vpc_config

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

Show child fields
remote_access_session.vpc_config.security_group_ids[]
remote_access_session.vpc_config.subnet_ids[]
remote_access_session.vpc_config.vpc_id

The ID of the Amazon VPC.