openapi: 3.0.0 info: version: 2015-06-23 x-release: v4 title: 'AWS Device Farm #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateRemoteAccessSession API' description:
Welcome to the AWS Device Farm API documentation, which contains APIs for:
Testing on desktop browsers
Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device Farm.
Testing on real mobile devices
Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide.
The status of the remote access session. Can be any of the following:
PENDING.
PENDING_CONCURRENCY.
PENDING_DEVICE.
PROCESSING.
SCHEDULING.
PREPARING.
RUNNING.
COMPLETED.
STOPPING.
The result of the remote access session. Can be any of the following:
PENDING.
PASSED.
WARNED.
FAILED.
SKIPPED.
ERRORED.
STOPPED.
This flag is set to true if remote debugging is enabled for the remote access session.
Remote debugging is no longer supported.
remoteRecordEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: This flag is set totrue if remote recording is enabled for the remote access session.
remoteRecordAppArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN for the app to be recorded in the remote access session.
hostAddress:
allOf:
- $ref: '#/components/schemas/HostAddress'
- description: IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
Remote debugging is no longer supported.
clientId: allOf: - $ref: '#/components/schemas/ClientId' - description:Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
Remote debugging is no longer supported.
billingMethod: allOf: - $ref: '#/components/schemas/BillingMethod' - description: The billing method of the remote access session. Possible values includeMETERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
deviceMinutes:
allOf:
- $ref: '#/components/schemas/DeviceMinutes'
- description: The number of minutes a device is used in a remote access session (including setup and teardown minutes).
endpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The endpoint for the remote access sesssion.
deviceUdid:
allOf:
- $ref: '#/components/schemas/String'
- description: 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.
interactionMode: allOf: - $ref: '#/components/schemas/InteractionMode' - description: '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.
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.
vpcConfig: allOf: - $ref: '#/components/schemas/VpcConfig' - description: The VPC security groups and subnets that are attached to a project. description: Represents information about the remote access session. InstanceLabels: type: array items: $ref: '#/components/schemas/String' String: type: string DeviceAvailability: type: string enum: - TEMPORARY_NOT_AVAILABLE - BUSY - AVAILABLE - HIGHLY_AVAILABLE Integer: type: integer DeviceMinutes: type: object properties: total: allOf: - $ref: '#/components/schemas/Double' - description: When specified, represents the total minutes used by the resource to run tests. metered: allOf: - $ref: '#/components/schemas/Double' - description: When specified, represents only the sum of metered minutes used by the resource to run tests. unmetered: allOf: - $ref: '#/components/schemas/Double' - description: When specified, represents only the sum of unmetered minutes used by the resource to run tests. description: Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children. Message: type: string minLength: 0 maxLength: 16384 VpcSubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' minItems: 1 maxItems: 8 DeviceFormFactor: type: string enum: - PHONE - TABLET NonEmptyString: type: string pattern: .*\S.* minLength: 1 maxLength: 4096 SshPublicKey: type: string minLength: 0 maxLength: 8192 LimitExceededException: {} Boolean: type: boolean DeviceInstance: type: object properties: arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the device instance. deviceArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the device. labels: allOf: - $ref: '#/components/schemas/InstanceLabels' - description: An array of strings that describe the device instance. status: allOf: - $ref: '#/components/schemas/InstanceStatus' - description: The status of the device instance. Valid values are listed here. udid: allOf: - $ref: '#/components/schemas/String' - description: Unique device identifier for the device instance. instanceProfile: allOf: - $ref: '#/components/schemas/InstanceProfile' - description: A object that contains information about the instance profile. description: Represents the device instance. AmazonResourceNames: type: array items: $ref: '#/components/schemas/AmazonResourceName' CreateRemoteAccessSessionRequest: type: object required: - projectArn - deviceArn title: CreateRemoteAccessSessionRequest properties: projectArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the project for which you want to create a remote access session. deviceArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the device for which you want to create a remote access session. instanceArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session. sshPublicKey: allOf: - $ref: '#/components/schemas/SshPublicKey' - description: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.
remoteDebugEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description:Set to true if you want to access devices remotely for debugging in your remote access session.
Remote debugging is no longer supported.
remoteRecordEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Set totrue to enable remote recording for the remote access session.
remoteRecordAppArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the remote access session to create.
clientId:
allOf:
- $ref: '#/components/schemas/ClientId'
- description: 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: allOf: - $ref: '#/components/schemas/CreateRemoteAccessSessionConfiguration' - description: The configuration information for the remote access session request. interactionMode: allOf: - $ref: '#/components/schemas/InteractionMode' - description: '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.
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?
description: Creates and submits a request to start a remote access session. SubnetId: type: string pattern: ^subnet-[0-9a-fA-F]{8,}$ minLength: 1 maxLength: 4096 DateTime: type: string format: date-time ExecutionResult: type: string enum: - PENDING - PASSED - WARNED - FAILED - SKIPPED - ERRORED - STOPPED VpcConfig: type: object required: - securityGroupIds - subnetIds - vpcId properties: securityGroupIds: allOf: - $ref: '#/components/schemas/VpcSecurityGroupIds' - description: An array of one or more security groups IDs in your Amazon VPC. subnetIds: allOf: - $ref: '#/components/schemas/VpcSubnetIds' - description: An array of one or more subnet IDs in your Amazon VPC. vpcId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The ID of the Amazon VPC. description: Contains the VPC configuration data necessary to interface with AWS Device Farm's services. VpcSecurityGroupIds: type: array items: $ref: '#/components/schemas/SecurityGroupId' minItems: 1 maxItems: 5 CPU: type: object properties: frequency: allOf: - $ref: '#/components/schemas/String' - description: The CPU's frequency. architecture: allOf: - $ref: '#/components/schemas/String' - description: The CPU's architecture (for example, x86 or ARM). clock: allOf: - $ref: '#/components/schemas/Double' - description: The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000. description: Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage. PackageIds: type: array items: $ref: '#/components/schemas/String' CreateRemoteAccessSessionResult: type: object example: remoteAccessSession: {} properties: remoteAccessSession: allOf: - $ref: '#/components/schemas/RemoteAccessSession' - description: A container that describes the remote access session when the request to create a remote access session is sent. description: Represents the server response from a request to create a remote access session. SecurityGroupId: type: string pattern: ^sg-[0-9a-fA-F]{8,}$ minLength: 1 maxLength: 4096 InteractionMode: type: string enum: - INTERACTIVE - NO_VIDEO - VIDEO_ONLY minLength: 0 maxLength: 64 ExecutionStatus: type: string enum: - PENDING - PENDING_CONCURRENCY - PENDING_DEVICE - PROCESSING - SCHEDULING - PREPARING - RUNNING - COMPLETED - STOPPING CreateRemoteAccessSessionConfiguration: type: object properties: billingMethod: allOf: - $ref: '#/components/schemas/BillingMethod' - description: The billing method for the remote access session. vpceConfigurationArns: allOf: - $ref: '#/components/schemas/AmazonResourceNames' - description: An array of ARNs included in the VPC endpoint configuration. description: Configuration settings for a remote access session, including billing method. ServiceAccountException: {} NotFoundException: {} AmazonResourceName: type: string pattern: ^arn:.+ minLength: 32 maxLength: 1011 Double: type: number format: double HostAddress: type: string maxLength: 1024 InstanceStatus: type: string enum: - IN_USE - PREPARING - AVAILABLE - NOT_AVAILABLE DeviceInstances: type: array items: $ref: '#/components/schemas/DeviceInstance' Name: type: string minLength: 0 maxLength: 256 Device: type: object properties: arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The device's ARN. name: allOf: - $ref: '#/components/schemas/Name' - description: The device's display name. manufacturer: allOf: - $ref: '#/components/schemas/String' - description: The device's manufacturer name. model: allOf: - $ref: '#/components/schemas/String' - description: The device's model name. modelId: allOf: - $ref: '#/components/schemas/String' - description: The device's model ID. formFactor: allOf: - $ref: '#/components/schemas/DeviceFormFactor' - description:The device's form factor.
Allowed values include:
PHONE
TABLET
The device's platform.
Allowed values include:
ANDROID
IOS
This flag is set to true if remote debugging is enabled for the device.
Remote debugging is no longer supported.
fleetType: allOf: - $ref: '#/components/schemas/String' - description: The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC. fleetName: allOf: - $ref: '#/components/schemas/String' - description: The name of the fleet to which this device belongs. instances: allOf: - $ref: '#/components/schemas/DeviceInstances' - description: The instances that belong to this device. availability: allOf: - $ref: '#/components/schemas/DeviceAvailability' - description: Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods. description: Represents a device type that an app is tested against. BillingMethod: type: string enum: - METERED - UNMETERED Resolution: type: object properties: width: allOf: - $ref: '#/components/schemas/Integer' - description: The screen resolution's width, expressed in pixels. height: allOf: - $ref: '#/components/schemas/Integer' - description: The screen resolution's height, expressed in pixels. description: Represents the screen resolution of a device in height and width, expressed in pixels. ArgumentException: {} InstanceProfile: type: object properties: arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the instance profile. packageCleanup: allOf: - $ref: '#/components/schemas/Boolean' - description: When set totrue, Device Farm removes app packages after a test run. The default value is false for private devices.
excludeAppPackagesFromCleanup:
allOf:
- $ref: '#/components/schemas/PackageIds'
- description: An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.
The list of packages is considered only if you set packageCleanup to true.
true, Device Farm reboots the instance after a test run. The default value is true.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the instance profile.
description:
allOf:
- $ref: '#/components/schemas/Message'
- description: The description of the instance profile.
description: Represents the instance profile.
SkipAppResign:
type: boolean
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/devicefarm/
x-hasEquivalentPaths: true