{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-ecs/json-schema/amazon-ecs-describe-clusters-response-schema.json",
  "title": "DescribeClustersResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-ecs-clusters-api-openapi.yml#/components/schemas/DescribeClustersResponse",
  "type": "object",
  "properties": {
    "clusters": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Cluster"
      },
      "description": "The list of clusters."
    },
    "failures": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Failure"
      },
      "description": "Any failures associated with the call."
    }
  },
  "$defs": {
    "Attachment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the attachment."
        },
        "type": {
          "type": "string",
          "description": "The type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage."
        },
        "status": {
          "type": "string",
          "description": "The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED."
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/KeyValuePair"
          },
          "description": "Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address. For Service Connect services, this includes portName, clientAliases, discoveryName, and ingressPortOverride. For Elastic Block Storage, this includes roleArn, deleteOnTermination, volumeName, volumeId, and statusReason (only when the attachment fails to create or attach)."
        }
      }
    },
    "CapacityProviderStrategyItem": {
      "type": "object",
      "properties": {
        "capacityProvider": {
          "type": "string",
          "description": "The short name of the capacity provider."
        },
        "weight": {
          "type": "integer",
          "description": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that"
        },
        "base": {
          "type": "integer",
          "description": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. Base value characteristics: Only one capacity provider in a strategy can have a base defined The default value is 0 if not specified The valid range is 0 to 100,000 Base requirements are satisfied first before weight distribution"
        }
      },
      "required": [
        "capacityProvider"
      ]
    },
    "Cluster": {
      "type": "object",
      "properties": {
        "clusterArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide."
        },
        "clusterName": {
          "type": "string",
          "description": "A user-generated string that you use to identify your cluster."
        },
        "configuration": {
          "$ref": "#/$defs/ClusterConfiguration"
        },
        "status": {
          "type": "string",
          "description": "The status of the cluster. The following are the possible states that are returned. ACTIVE The cluster is ready to accept tasks and if applicable you can register container instances with the cluster. PROVISIONING The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created. DEPROVISIONING The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted. FAILED The cluster has capacity providers that are associated with it and the resources needed for the ca"
        },
        "registeredContainerInstancesCount": {
          "type": "integer",
          "description": "The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status."
        },
        "runningTasksCount": {
          "type": "integer",
          "description": "The number of tasks in the cluster that are in the RUNNING state."
        },
        "pendingTasksCount": {
          "type": "integer",
          "description": "The number of tasks in the cluster that are in the PENDING state."
        },
        "activeServicesCount": {
          "type": "integer",
          "description": "The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices."
        },
        "statistics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/KeyValuePair"
          },
          "description": "Additional information about your clusters that are separated by launch type. They include the following: runningEC2TasksCount RunningFargateTasksCount pendingEC2TasksCount pendingFargateTasksCount activeEC2ServiceCount activeFargateServiceCount drainingEC2ServiceCount drainingFargateServiceCount"
        },
        "tags": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Tag"
          },
          "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowe"
        },
        "settings": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ClusterSetting"
          },
          "description": "The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster."
        },
        "capacityProviders": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The capacity providers associated with the cluster."
        },
        "defaultCapacityProviderStrategy": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CapacityProviderStrategyItem"
          },
          "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used."
        },
        "attachments": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Attachment"
          },
          "description": "The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments."
        },
        "attachmentsStatus": {
          "type": "string",
          "description": "The status of the capacity providers associated with the cluster. The following are the states that are returned. UPDATE_IN_PROGRESS The available capacity providers for the cluster are updating. UPDATE_COMPLETE The capacity providers have successfully updated. UPDATE_FAILED The capacity provider updates failed."
        },
        "serviceConnectDefaults": {
          "$ref": "#/$defs/ClusterServiceConnectDefaults"
        }
      }
    },
    "ClusterConfiguration": {
      "type": "object",
      "properties": {
        "executeCommandConfiguration": {
          "$ref": "#/$defs/ExecuteCommandConfiguration"
        },
        "managedStorageConfiguration": {
          "$ref": "#/$defs/ManagedStorageConfiguration"
        }
      }
    },
    "ClusterServiceConnectDefaults": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string",
          "description": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used."
        }
      }
    },
    "ClusterSetting": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "enum": [
            "containerInsights"
          ],
          "description": "The name of the cluster setting. The value is containerInsights."
        },
        "value": {
          "type": "string",
          "description": "The value to set for the cluster setting. The supported values are enhanced, enabled, and disabled. To use Container Insights with enhanced observability, set the containerInsights account setting to enhanced. To use Container Insights, set the containerInsights account setting to enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault."
        }
      }
    },
    "ExecuteCommandConfiguration": {
      "type": "object",
      "properties": {
        "kmsKeyId": {
          "type": "string",
          "description": "Specify an Key Management Service key ID to encrypt the data between the local client and the container."
        },
        "logging": {
          "type": "string",
          "enum": [
            "NONE",
            "DEFAULT",
            "OVERRIDE"
          ],
          "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available. NONE: The execute command session is not logged. DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged. OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required."
        },
        "logConfiguration": {
          "$ref": "#/$defs/ExecuteCommandLogConfiguration"
        }
      }
    },
    "ExecuteCommandLogConfiguration": {
      "type": "object",
      "properties": {
        "cloudWatchLogGroupName": {
          "type": "string",
          "description": "The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created."
        },
        "cloudWatchEncryptionEnabled": {
          "type": "boolean",
          "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off."
        },
        "s3BucketName": {
          "type": "string",
          "description": "The name of the S3 bucket to send logs to. The S3 bucket must already be created."
        },
        "s3EncryptionEnabled": {
          "type": "boolean",
          "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used."
        },
        "s3KeyPrefix": {
          "type": "string",
          "description": "An optional folder in the S3 bucket to place logs in."
        }
      }
    },
    "Failure": {
      "type": "object",
      "properties": {
        "arn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the failed resource."
        },
        "reason": {
          "type": "string",
          "description": "The reason for the failure."
        },
        "detail": {
          "type": "string",
          "description": "The details of the failure."
        }
      }
    },
    "KeyValuePair": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable."
        },
        "value": {
          "type": "string",
          "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable."
        }
      }
    },
    "ManagedStorageConfiguration": {
      "type": "object",
      "properties": {
        "kmsKeyId": {
          "type": "string",
          "description": "Specify a Key Management Service key ID to encrypt Amazon ECS managed storage. When you specify a kmsKeyId, Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the Amazon Elastic Container Service Developer Guide. The key must be a single Region key."
        },
        "fargateEphemeralStorageKmsKeyId": {
          "type": "string",
          "description": "Specify the Key Management Service key ID for Fargate ephemeral storage. When you specify a fargateEphemeralStorageKmsKeyId, Amazon Web Services Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see Customer managed keys for Amazon Web Services Fargate ephemeral storage for Amazon ECS in the Amazon Elastic Container Service Developer Guide. The key must be a single Region key."
        }
      }
    },
    "Tag": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values."
        },
        "value": {
          "type": "string",
          "description": "The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key)."
        }
      }
    }
  }
}