Amazon Device Farm · JSON Structure

Amazon Device Farm Device Pool Structure

Represents a collection of device types.

Type: object Properties: 6
Application TestingDevice TestingMobile TestingQuality Assurance

DevicePool is a JSON Structure definition published by Amazon Device Farm, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

arn name description type rules maxDevices

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-device-farm/refs/heads/main/json-structure/amazon-device-farm-device-pool-structure.json",
  "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>"
        }
      ]
    }
  },
  "name": "DevicePool"
}