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.ListRuns API' description:

Welcome to the AWS Device Farm API documentation, which contains APIs for:

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: devicefarm x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devicefarm-2015-06-23.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://devicefarm.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Device Farm multi-region endpoint - url: https://devicefarm.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Device Farm multi-region endpoint - url: http://devicefarm.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia) - url: https://devicefarm.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=DeviceFarm 20150623.ListRuns' paths: /#X-Amz-Target=DeviceFarm_20150623.ListRuns: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListRuns description: Gets information about runs, given an AWS Device Farm project ARN. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRunsResult' '480': description: ArgumentException content: application/json: schema: $ref: '#/components/schemas/ArgumentException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ServiceAccountException content: application/json: schema: $ref: '#/components/schemas/ServiceAccountException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListRunsRequest' parameters: - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - DeviceFarm_20150623.ListRuns tags: - '#X Amz Target=DeviceFarm 20150623.ListRuns' components: schemas: Long: type: integer DevicePlatform: type: string enum: - ANDROID - IOS String: type: string 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 AndroidPaths: type: array items: $ref: '#/components/schemas/String' DeviceFilterValues: type: array items: $ref: '#/components/schemas/String' VpcSubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' minItems: 1 maxItems: 8 PaginationToken: type: string minLength: 4 maxLength: 1024 NonEmptyString: type: string pattern: .*\S.* minLength: 1 maxLength: 4096 NetworkProfile: type: object properties: arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the network profile. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the network profile. description: allOf: - $ref: '#/components/schemas/Message' - description: The description of the network profile. type: allOf: - $ref: '#/components/schemas/NetworkProfileType' - description: The type of network profile. Valid values are listed here. uplinkBandwidthBits: allOf: - $ref: '#/components/schemas/Long' - description: The data throughput rate in bits per second, as an integer from 0 to 104857600. downlinkBandwidthBits: allOf: - $ref: '#/components/schemas/Long' - description: The data throughput rate in bits per second, as an integer from 0 to 104857600. uplinkDelayMs: allOf: - $ref: '#/components/schemas/Long' - description: Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. downlinkDelayMs: allOf: - $ref: '#/components/schemas/Long' - description: Delay time for all packets to destination in milliseconds as an integer from 0 to 2000. uplinkJitterMs: allOf: - $ref: '#/components/schemas/Long' - description: Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. downlinkJitterMs: allOf: - $ref: '#/components/schemas/Long' - description: Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000. uplinkLossPercent: allOf: - $ref: '#/components/schemas/PercentInteger' - description: Proportion of transmitted packets that fail to arrive from 0 to 100 percent. downlinkLossPercent: allOf: - $ref: '#/components/schemas/PercentInteger' - description: Proportion of received packets that fail to arrive from 0 to 100 percent. description: An array of settings that describes characteristics of a network profile. LimitExceededException: {} Location: type: object required: - latitude - longitude properties: latitude: allOf: - $ref: '#/components/schemas/Double' - description: The latitude. longitude: allOf: - $ref: '#/components/schemas/Double' - description: The longitude. description:

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).

Elevation is currently not supported.

Boolean: type: boolean DeviceFilters: type: array items: $ref: '#/components/schemas/DeviceFilter' DeviceFilterAttribute: type: string enum: - ARN - PLATFORM - OS_VERSION - MODEL - AVAILABILITY - FORM_FACTOR - MANUFACTURER - REMOTE_ACCESS_ENABLED - REMOTE_DEBUG_ENABLED - INSTANCE_ARN - INSTANCE_LABELS - FLEET_TYPE SubnetId: type: string pattern: ^subnet-[0-9a-fA-F]{8,}$ minLength: 1 maxLength: 4096 DateTime: type: string format: date-time DeviceHostPaths: type: array items: $ref: '#/components/schemas/String' ExecutionResult: type: string enum: - PENDING - PASSED - WARNED - FAILED - SKIPPED - ERRORED - STOPPED Counters: type: object properties: total: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of entities. passed: allOf: - $ref: '#/components/schemas/Integer' - description: The number of passed entities. failed: allOf: - $ref: '#/components/schemas/Integer' - description: The number of failed entities. warned: allOf: - $ref: '#/components/schemas/Integer' - description: The number of warned entities. errored: allOf: - $ref: '#/components/schemas/Integer' - description: The number of errored entities. stopped: allOf: - $ref: '#/components/schemas/Integer' - description: The number of stopped entities. skipped: allOf: - $ref: '#/components/schemas/Integer' - description: The number of skipped entities. description: Represents entity counters. 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. CustomerArtifactPaths: type: object properties: iosPaths: allOf: - $ref: '#/components/schemas/IosPaths' - description: Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from. androidPaths: allOf: - $ref: '#/components/schemas/AndroidPaths' - description: Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from. deviceHostPaths: allOf: - $ref: '#/components/schemas/DeviceHostPaths' - description: Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from. description:

A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

ExecutionResultCode: type: string enum: - PARSING_FAILED - VPC_ENDPOINT_SETUP_FAILED ListRunsResult: type: object example: runs: - name: My Test Run type: BUILTIN_EXPLORER arn: arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE billingMethod: METERED completedJobs: 0 counters: errored: 0 failed: 0 passed: 0 skipped: 0 stopped: 0 total: 0 warned: 0 created: '1472667509.852' deviceMinutes: metered: 0 total: 0 unmetered: 0 platform: ANDROID result: PENDING status: RUNNING totalJobs: 3 properties: runs: allOf: - $ref: '#/components/schemas/Runs' - description: Information about the runs. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list. description: Represents the result of a list runs request. VpcSecurityGroupIds: type: array items: $ref: '#/components/schemas/SecurityGroupId' minItems: 1 maxItems: 5 DeviceFilter: type: object required: - attribute - operator - values properties: attribute: allOf: - $ref: '#/components/schemas/DeviceFilterAttribute' - description: '

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS

OS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

The device model (for example, iPad 5th Gen).

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS

MANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

' operator: allOf: - $ref: '#/components/schemas/RuleOperator' - description: Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions. values: allOf: - $ref: '#/components/schemas/DeviceFilterValues' - description:

An array of one or more filter values used in a device filter.

Operator Values

Attribute Values

description:

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

Runs: type: array items: $ref: '#/components/schemas/Run' PercentInteger: type: integer minimum: 0 maximum: 100 Run: type: object properties: arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The run's ARN. name: allOf: - $ref: '#/components/schemas/Name' - description: The run's name. type: allOf: - $ref: '#/components/schemas/TestType' - description:

The run's type.

Must be one of the following values:

platform: allOf: - $ref: '#/components/schemas/DevicePlatform' - description:

The run's platform.

Allowed values include:

created: allOf: - $ref: '#/components/schemas/DateTime' - description: When the run was created. status: allOf: - $ref: '#/components/schemas/ExecutionStatus' - description:

The run's status.

Allowed values include:

result: allOf: - $ref: '#/components/schemas/ExecutionResult' - description:

The run's result.

Allowed values include:

started: allOf: - $ref: '#/components/schemas/DateTime' - description: The run's start time. stopped: allOf: - $ref: '#/components/schemas/DateTime' - description: The run's stop time. counters: allOf: - $ref: '#/components/schemas/Counters' - description: The run's result counters. message: allOf: - $ref: '#/components/schemas/Message' - description: A message about the run's result. totalJobs: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of jobs for the run. completedJobs: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of completed jobs. billingMethod: allOf: - $ref: '#/components/schemas/BillingMethod' - description: '

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

' deviceMinutes: allOf: - $ref: '#/components/schemas/DeviceMinutes' - description: Represents the total (metered or unmetered) minutes used by the test run. networkProfile: allOf: - $ref: '#/components/schemas/NetworkProfile' - description: The network profile being used for a test run. parsingResultUrl: allOf: - $ref: '#/components/schemas/String' - description: Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to. resultCode: allOf: - $ref: '#/components/schemas/ExecutionResultCode' - description: Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure. seed: allOf: - $ref: '#/components/schemas/Integer' - description: For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences. appUpload: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: An app to upload or that has been uploaded. eventCount: allOf: - $ref: '#/components/schemas/Integer' - description: For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform. jobTimeoutMinutes: allOf: - $ref: '#/components/schemas/JobTimeoutMinutes' - description: The number of minutes the job executes before it times out. devicePoolArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the device pool for the run. locale: allOf: - $ref: '#/components/schemas/String' - description: Information about the locale that is used for the run. radios: allOf: - $ref: '#/components/schemas/Radios' - description: Information about the radio states for the run. location: allOf: - $ref: '#/components/schemas/Location' - description: Information about the location that is used for the run. customerArtifactPaths: allOf: - $ref: '#/components/schemas/CustomerArtifactPaths' - description: Output CustomerArtifactPaths object for the test run. webUrl: allOf: - $ref: '#/components/schemas/String' - description: The Device Farm console URL for the recording of the run. skipAppResign: allOf: - $ref: '#/components/schemas/SkipAppResign' - description:

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.

testSpecArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the YAML-formatted test specification for the run. deviceSelectionResult: allOf: - $ref: '#/components/schemas/DeviceSelectionResult' - description: The results of a device filter used to select the devices for a test run. vpcConfig: allOf: - $ref: '#/components/schemas/VpcConfig' - description: The VPC security groups and subnets that are attached to a project. description: Represents a test run on a set of devices with a given app package, test parameters, and so on. SecurityGroupId: type: string pattern: ^sg-[0-9a-fA-F]{8,}$ minLength: 1 maxLength: 4096 ExecutionStatus: type: string enum: - PENDING - PENDING_CONCURRENCY - PENDING_DEVICE - PROCESSING - SCHEDULING - PREPARING - RUNNING - COMPLETED - STOPPING TestType: type: string enum: - BUILTIN_FUZZ - BUILTIN_EXPLORER - WEB_PERFORMANCE_PROFILE - APPIUM_JAVA_JUNIT - APPIUM_JAVA_TESTNG - APPIUM_PYTHON - APPIUM_NODE - APPIUM_RUBY - APPIUM_WEB_JAVA_JUNIT - APPIUM_WEB_JAVA_TESTNG - APPIUM_WEB_PYTHON - APPIUM_WEB_NODE - APPIUM_WEB_RUBY - CALABASH - INSTRUMENTATION - UIAUTOMATION - UIAUTOMATOR - XCTEST - XCTEST_UI - REMOTE_ACCESS_RECORD - REMOTE_ACCESS_REPLAY ServiceAccountException: {} NotFoundException: {} IosPaths: type: array items: $ref: '#/components/schemas/String' AmazonResourceName: type: string pattern: ^arn:.+ minLength: 32 maxLength: 1011 Double: type: number format: double Radios: type: object properties: wifi: allOf: - $ref: '#/components/schemas/Boolean' - description: True if Wi-Fi is enabled at the beginning of the test. Otherwise, false. bluetooth: allOf: - $ref: '#/components/schemas/Boolean' - description: True if Bluetooth is enabled at the beginning of the test. Otherwise, false. nfc: allOf: - $ref: '#/components/schemas/Boolean' - description: True if NFC is enabled at the beginning of the test. Otherwise, false. gps: allOf: - $ref: '#/components/schemas/Boolean' - description: True if GPS is enabled at the beginning of the test. Otherwise, false. description: Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC. JobTimeoutMinutes: type: integer DeviceSelectionResult: type: object properties: filters: allOf: - $ref: '#/components/schemas/DeviceFilters' - description: The filters in a device selection result. matchedDevicesCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of devices that matched the device filter selection criteria. maxDevices: allOf: - $ref: '#/components/schemas/Integer' - description: The maximum number of devices to be selected by a device filter and included in a test run. description: Contains the run results requested by the device selection configuration and how many devices were returned. For an example of the JSON response syntax, see ScheduleRun. Name: type: string minLength: 0 maxLength: 256 BillingMethod: type: string enum: - METERED - UNMETERED RuleOperator: type: string enum: - EQUALS - LESS_THAN - LESS_THAN_OR_EQUALS - GREATER_THAN - GREATER_THAN_OR_EQUALS - IN - NOT_IN - CONTAINS ListRunsRequest: type: object required: - arn title: ListRunsRequest properties: arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the project for which you want to list runs. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. description: Represents a request to the list runs operation. ArgumentException: {} SkipAppResign: type: boolean NetworkProfileType: type: string enum: - CURATED - PRIVATE 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