AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateRemoteAccessSession operation. Specifies and starts a remote access session.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DeviceFarm.AmazonDeviceFarmRequest
      Amazon.DeviceFarm.Model.CreateRemoteAccessSessionRequest

Namespace: Amazon.DeviceFarm.Model
Assembly: AWSSDK.DeviceFarm.dll
Version: 3.x.y.z

Syntax

C#
public class CreateRemoteAccessSessionRequest : AmazonDeviceFarmRequest
         IAmazonWebServiceRequest

The CreateRemoteAccessSessionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ClientId System.String

Gets and sets the property ClientId.

Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This is required only if remoteDebugEnabled is set to true.

Public Property Configuration Amazon.DeviceFarm.Model.CreateRemoteAccessSessionConfiguration

Gets and sets the property Configuration.

The configuration information for the remote access session request.

Public Property DeviceArn System.String

Gets and sets the property DeviceArn.

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

Public Property InstanceArn System.String

Gets and sets the property InstanceArn.

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

Public Property InteractionMode Amazon.DeviceFarm.InteractionMode

Gets and sets the property InteractionMode.

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.

Public Property Name System.String

Gets and sets the property Name.

The name of the remote access session that you wish to create.

Public Property ProjectArn System.String

Gets and sets the property ProjectArn.

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

Public Property RemoteDebugEnabled System.Boolean

Gets and sets the property RemoteDebugEnabled.

Set to true if you want to access devices remotely for debugging in your remote access session.

Public Property RemoteRecordAppArn System.String

Gets and sets the property RemoteRecordAppArn.

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

Public Property RemoteRecordEnabled System.Boolean

Gets and sets the property RemoteRecordEnabled.

Set to true to enable remote recording for the remote access session.

Public Property SkipAppResign System.Boolean

Gets and sets the property SkipAppResign.

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

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

Public Property SshPublicKey System.String

Gets and sets the property SshPublicKey.

The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.

Examples

The following example creates a remote access session named MySession.

To create a remote access session


var response = client.CreateRemoteAccessSession(new CreateRemoteAccessSessionRequest 
{
    Name = "MySession",
    Configuration = new CreateRemoteAccessSessionConfiguration { BillingMethod = "METERED" },
    DeviceArn = "arn:aws:devicefarm:us-west-2::device:123EXAMPLE", // You can get the device ARN by using the list-devices CLI command.
    ProjectArn = "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" // You can get the project ARN by using the list-projects CLI command.
});

RemoteAccessSession remoteAccessSession = response.RemoteAccessSession;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms