DiscoverInstancesRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloud-map/json-schema/amazon-cloud-map-discover-instances-request-schema.json",
  "title": "DiscoverInstancesRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloud-map-instances-api-openapi.yml#/components/schemas/DiscoverInstancesRequest",
  "type": "object",
  "properties": {
    "NamespaceName": {
      "type": "string",
      "description": "The HttpName name of the namespace. The HttpName is found in the HttpProperties member of the Properties member of the namespace. In most cases, Name and HttpName match. However, if you reuse Name for namespace creation, a generated hash is added to HttpName to distinguish the two."
    },
    "ServiceName": {
      "type": "string",
      "description": "The name of the service that you specified when you registered the instance."
    },
    "MaxResults": {
      "type": "integer",
      "description": "The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances."
    },
    "QueryParameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned."
    },
    "OptionalParameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned."
    },
    "HealthStatus": {
      "type": "string",
      "enum": [
        "HEALTHY",
        "UNHEALTHY",
        "ALL",
        "HEALTHY_OR_ELSE_ALL"
      ],
      "description": "The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned. HEALTHY Returns healthy instances. UNHEALTHY Returns unhealthy instances. ALL Returns all instances. HEALTHY_OR_ELSE_ALL Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open."
    },
    "OwnerAccount": {
      "type": "string",
      "description": "The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace ResourceOwner field. For instances associated with namespaces that are shared with your account, you must specify an OwnerAccount."
    }
  },
  "required": [
    "NamespaceName",
    "ServiceName"
  ]
}