remote_access_sessions

Creates, updates, deletes, gets or lists a remote_access_sessions resource.

Overview

Name	remote_access_sessions
Type	Resource
Id	aws.devicefarm.remote_access_sessions

Fields

The following fields are returned by SELECT queries:

get_remote_access_session

Name	Datatype	Description
name	string	The name of the remote access session.
app_upload	string	The ARN for the app to be installed onto your device. (pattern: <code>^arn:aws:devicefarm:.+</code>)
arn	string	The Amazon Resource Name (ARN) of the remote access session. (pattern: <code>^arn:aws:devicefarm:.+</code>)
billing_method	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. (METERED, UNMETERED)
created	string (date-time)	The date and time the remote access session was created.
device	object	The device (phone or tablet) used in the remote access session.
device_minutes	object	The number of minutes a device is used in a remote access session (including setup and teardown minutes).
device_proxy	object	The device proxy configured for the remote access session.
device_udid	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.
endpoint	string	The endpoint for the remote access session. This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.
endpoints	object	Represents the remote endpoints for viewing and controlling a device during a remote access session.
instance_arn	string	The ARN of the instance. (pattern: <code>^arn:aws:devicefarm:.+</code>)
interaction_mode	string	The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available. (INTERACTIVE, NO_VIDEO, VIDEO_ONLY)
message	string	A message about the remote access session.
result	string	The result of the remote access session. Can be any of the following: PENDING. PASSED. WARNED. FAILED. SKIPPED. ERRORED. STOPPED. (PENDING, PASSED, WARNED, FAILED, SKIPPED, ERRORED, STOPPED)
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 about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
started	string (date-time)	The date and time the remote access session was started.
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. (PENDING, PENDING_CONCURRENCY, PENDING_DEVICE, PROCESSING, SCHEDULING, PREPARING, RUNNING, COMPLETED, STOPPING)
stopped	string (date-time)	The date and time the remote access session was stopped.
vpc_config	object	The VPC security groups and subnets that are attached to a project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_remote_access_session	select	region		Returns a link to a currently running remote access session.
create_remote_access_session	insert	region, projectArn, deviceArn		Specifies and starts a remote access session.
delete_remote_access_session	delete	region		Deletes a completed remote access session and its results. You cannot delete a remote access session if it is still active. You cannot undo this operation.
install_to_remote_access_session	exec	region, remoteAccessSessionArn, appArn		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.
list_remote_access_sessions	exec	region, arn		Returns a list of all currently running remote access sessions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_remote_access_session

Returns a link to a currently running remote access session.

SELECT
name,
app_upload,
arn,
billing_method,
created,
device,
device_minutes,
device_proxy,
device_udid,
endpoint,
endpoints,
instance_arn,
interaction_mode,
message,
result,
skip_app_resign,
started,
status,
stopped,
vpc_config
FROM aws.devicefarm.remote_access_sessions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_remote_access_session

Specifies and starts a remote access session.

INSERT INTO aws.devicefarm.remote_access_sessions (
projectArn,
deviceArn,
appArn,
instanceArn,
name,
configuration,
interactionMode,
skipAppResign,
region
)
SELECT 
'{{ projectArn }}' /* required */,
'{{ deviceArn }}' /* required */,
'{{ appArn }}',
'{{ instanceArn }}',
'{{ name }}',
'{{ configuration }}',
'{{ interactionMode }}',
{{ skipAppResign }},
'{{ region }}'
RETURNING
remote_access_session
;

Manifest

# Description fields are for documentation purposes
- name: remote_access_sessions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the remote_access_sessions resource.
  - name: projectArn
    value: "{{ projectArn }}"
    description: |
      The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
  - name: deviceArn
    value: "{{ deviceArn }}"
    description: |
      The ARN of the device for which you want to create a remote access session.
  - name: appArn
    value: "{{ appArn }}"
    description: |
      The Amazon Resource Name (ARN) of the app to create the remote access session.
  - name: instanceArn
    value: "{{ instanceArn }}"
    description: |
      The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the remote access session to create.
  - name: configuration
    description: |
      The configuration information for the remote access session request.
    value:
      auxiliaryApps:
        - "{{ auxiliaryApps }}"
      billingMethod: "{{ billingMethod }}"
      vpceConfigurationArns:
        - "{{ vpceConfigurationArns }}"
      deviceProxy:
        host: "{{ host }}"
        port: {{ port }}
  - name: interactionMode
    value: "{{ interactionMode }}"
    description: |
      The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.
    valid_values: ['INTERACTIVE', 'NO_VIDEO', 'VIDEO_ONLY']
  - name: skipAppResign
    value: {{ skipAppResign }}
    description: |
      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?

DELETE examples

delete_remote_access_session

Deletes a completed remote access session and its results. You cannot delete a remote access session if it is still active. You cannot undo this operation.

DELETE FROM aws.devicefarm.remote_access_sessions
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

install_to_remote_access_session

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.

EXEC aws.devicefarm.remote_access_sessions.install_to_remote_access_session 
@region='{{ region }}' --required 
@@json=
'{
"remoteAccessSessionArn": "{{ remoteAccessSessionArn }}", 
"appArn": "{{ appArn }}"
}'
;

list_remote_access_sessions

Returns a list of all currently running remote access sessions.

EXEC aws.devicefarm.remote_access_sessions.list_remote_access_sessions 
@region='{{ region }}' --required 
@@json=
'{
"arn": "{{ arn }}", 
"nextToken": "{{ nextToken }}"
}'
;