Application Discovery Service Describe Agents Request Structure

DescribeAgentsRequest schema from Amazon Application Discovery Service API

Type: object Properties: 4
Amazon Application Discovery ServiceMigrationDiscoveryInfrastructure

Application Discovery Service Describe Agents Request Structure is a JSON Structure definition published by Amazon Application Discovery Service, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

agentIds filters maxResults nextToken

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

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "DescribeAgentsRequest schema from Amazon Application Discovery Service API",
  "properties": {
    "agentIds": {
      "type": "array",
      "description": "The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your AWS user account.",
      "items": {
        "type": "string"
      },
      "example": [
        "d-agent-500123"
      ]
    },
    "filters": {
      "type": "array",
      "description": "You can filter the request using various logical operators and a key-value format.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the filter.",
            "example": "hostName"
          },
          "values": {
            "type": "array",
            "description": "A string value on which to filter.",
            "items": {
              "type": "string"
            },
            "example": [
              "server-01.example.com"
            ]
          },
          "condition": {
            "type": "string",
            "description": "A conditional operator. The following operators are valid \u2014 EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS.",
            "enum": [
              "EQUALS",
              "NOT_EQUALS",
              "CONTAINS",
              "NOT_CONTAINS"
            ],
            "example": "EQUALS"
          }
        },
        "required": [
          "name",
          "values",
          "condition"
        ]
      }
    },
    "maxResults": {
      "type": "int32",
      "description": "The total number of agents/collectors to return in a single page of output.",
      "minimum": 0,
      "maximum": 900,
      "example": 10
    },
    "nextToken": {
      "type": "string",
      "description": "Token to retrieve the next set of results.",
      "example": ""
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-application-discovery-service/refs/heads/main/json-structure/application-discovery-service-describe-agents-request-structure.json"
}