AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateRemoteAccessSessionInput

import "github.com/aws/aws-sdk-go/service/devicefarm"

type CreateRemoteAccessSessionInput struct { ClientId *string `locationName:"clientId" type:"string"` Configuration *CreateRemoteAccessSessionConfiguration `locationName:"configuration" type:"structure"` DeviceArn *string `locationName:"deviceArn" min:"32" type:"string" required:"true"` InstanceArn *string `locationName:"instanceArn" min:"32" type:"string"` InteractionMode *string `locationName:"interactionMode" type:"string" enum:"InteractionMode"` Name *string `locationName:"name" type:"string"` ProjectArn *string `locationName:"projectArn" min:"32" type:"string" required:"true"` RemoteDebugEnabled *bool `locationName:"remoteDebugEnabled" type:"boolean"` RemoteRecordAppArn *string `locationName:"remoteRecordAppArn" min:"32" type:"string"` RemoteRecordEnabled *bool `locationName:"remoteRecordEnabled" type:"boolean"` SkipAppResign *bool `locationName:"skipAppResign" type:"boolean"` SshPublicKey *string `locationName:"sshPublicKey" type:"string"` }

Creates and submits a request to start a remote access session.

ClientId

Type: *string

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.

Configuration

Configuration settings for a remote access session, including billing method.

DeviceArn

Type: *string

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

DeviceArn is a required field

InstanceArn

Type: *string

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

InteractionMode

Type: *string

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

Type: *string

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

ProjectArn

Type: *string

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

ProjectArn is a required field

RemoteDebugEnabled

Type: *bool

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

RemoteRecordAppArn

Type: *string

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

RemoteRecordEnabled

Type: *bool

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

SkipAppResign

Type: *bool

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? (https://aws.amazon.com/device-farm/faq/) in the AWS Device Farm FAQs.

SshPublicKey

Type: *string

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.

Method

GoString

func (s CreateRemoteAccessSessionInput) GoString() string

GoString returns the string representation

SetClientId

func (s *CreateRemoteAccessSessionInput) SetClientId(v string) *CreateRemoteAccessSessionInput

SetClientId sets the ClientId field's value.

SetConfiguration

func (s *CreateRemoteAccessSessionInput) SetConfiguration(v *CreateRemoteAccessSessionConfiguration) *CreateRemoteAccessSessionInput

SetConfiguration sets the Configuration field's value.

SetDeviceArn

func (s *CreateRemoteAccessSessionInput) SetDeviceArn(v string) *CreateRemoteAccessSessionInput

SetDeviceArn sets the DeviceArn field's value.

SetInstanceArn

func (s *CreateRemoteAccessSessionInput) SetInstanceArn(v string) *CreateRemoteAccessSessionInput

SetInstanceArn sets the InstanceArn field's value.

SetInteractionMode

func (s *CreateRemoteAccessSessionInput) SetInteractionMode(v string) *CreateRemoteAccessSessionInput

SetInteractionMode sets the InteractionMode field's value.

SetName

func (s *CreateRemoteAccessSessionInput) SetName(v string) *CreateRemoteAccessSessionInput

SetName sets the Name field's value.

SetProjectArn

func (s *CreateRemoteAccessSessionInput) SetProjectArn(v string) *CreateRemoteAccessSessionInput

SetProjectArn sets the ProjectArn field's value.

SetRemoteDebugEnabled

func (s *CreateRemoteAccessSessionInput) SetRemoteDebugEnabled(v bool) *CreateRemoteAccessSessionInput

SetRemoteDebugEnabled sets the RemoteDebugEnabled field's value.

SetRemoteRecordAppArn

func (s *CreateRemoteAccessSessionInput) SetRemoteRecordAppArn(v string) *CreateRemoteAccessSessionInput

SetRemoteRecordAppArn sets the RemoteRecordAppArn field's value.

SetRemoteRecordEnabled

func (s *CreateRemoteAccessSessionInput) SetRemoteRecordEnabled(v bool) *CreateRemoteAccessSessionInput

SetRemoteRecordEnabled sets the RemoteRecordEnabled field's value.

SetSkipAppResign

func (s *CreateRemoteAccessSessionInput) SetSkipAppResign(v bool) *CreateRemoteAccessSessionInput

SetSkipAppResign sets the SkipAppResign field's value.

SetSshPublicKey

func (s *CreateRemoteAccessSessionInput) SetSshPublicKey(v string) *CreateRemoteAccessSessionInput

SetSshPublicKey sets the SshPublicKey field's value.

String

func (s CreateRemoteAccessSessionInput) String() string

String returns the string representation

Validate

func (s *CreateRemoteAccessSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: