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