CreateRemoteAccessSessionRequest Class

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

public class CreateRemoteAccessSessionRequest : AmazonDeviceFarmRequest
         IAmazonWebServiceRequest

The CreateRemoteAccessSessionRequest type exposes the following members

Constructors

	Name	Description
	CreateRemoteAccessSessionRequest()

Properties

Name	Type	Description
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 identifier is required only if `remoteDebugEnabled` is set to `true`. Remote debugging is no longer supported.
Configuration	Amazon.DeviceFarm.Model.CreateRemoteAccessSessionConfiguration	Gets and sets the property Configuration. The configuration information for the remote access session request.
DeviceArn	System.String	Gets and sets the property DeviceArn. The ARN of the device for which you want to create a remote access session.
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.
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.
Name	System.String	Gets and sets the property Name. The name of the remote access session to create.
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.
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. Remote debugging is no longer supported.
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.
RemoteRecordEnabled	System.Boolean	Gets and sets the property RemoteRecordEnabled. Set to `true` to enable remote recording for the remote access session.
SkipAppResign	System.Boolean	Gets and sets the property SkipAppResign. 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?
SshPublicKey	System.String	Gets and sets the property SshPublicKey. Ignored. The public key of the `ssh` key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if `remoteDebugEnabled` is set to `true`. Remote debugging is no longer supported.

Examples

The following example creates a remote access session named MySession.

To create a remote access session


var client = new AmazonDeviceFarmClient();
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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