Amazon Device Farm · Schema

DevicePool

Represents a collection of device types.

Application TestingDevice TestingMobile TestingQuality Assurance

Properties

Name Type Description
arn object
name object
description object
type object
rules object
maxDevices object
View JSON Schema on GitHub

JSON Schema

amazon-device-farm-device-pool-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-device-farm/refs/heads/main/json-schema/amazon-device-farm-device-pool-schema.json",
  "title": "DevicePool",
  "description": "Represents a collection of device types.",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonResourceName"
        },
        {
          "description": "The device pool's ARN."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The device pool's name."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Message"
        },
        {
          "description": "The device pool's description."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DevicePoolType"
        },
        {
          "description": "<p>The device pool's type.</p> <p>Allowed values include:</p> <ul> <li> <p>CURATED: A device pool that is created and managed by AWS Device Farm.</p> </li> <li> <p>PRIVATE: A device pool that is created and managed by the device pool developer.</p> </li> </ul>"
        }
      ]
    },
    "rules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Rules"
        },
        {
          "description": "Information about the device pool's rules."
        }
      ]
    },
    "maxDevices": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
        }
      ]
    }
  }
}