Amazon Fargate · JSON Structure

Amazon Fargate Structure

Represents an Amazon Fargate task with its associated configuration, state, and metadata.

Type: object Properties: 12 Required: 3
ComputeContainersECSEKSMicroservicesServerless

Amazon Fargate Task is a JSON Structure definition published by Amazon Fargate, describing 12 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

taskArn taskDefinitionArn clusterArn launchType lastStatus desiredStatus cpu memory containers platformVersion createdAt tags

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-fargate/refs/heads/main/json-structure/amazon-fargate-structure.json",
  "description": "Represents an Amazon Fargate task with its associated configuration, state, and metadata.",
  "type": "object",
  "required": [
    "taskArn",
    "taskDefinitionArn",
    "launchType"
  ],
  "properties": {
    "taskArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the task"
    },
    "taskDefinitionArn": {
      "type": "string",
      "description": "The ARN of the task definition that created the task"
    },
    "clusterArn": {
      "type": "string",
      "description": "The ARN of the cluster that hosts the task"
    },
    "launchType": {
      "type": "string",
      "enum": [
        "FARGATE",
        "EC2"
      ],
      "description": "The launch type on which the task is running"
    },
    "lastStatus": {
      "type": "string",
      "enum": [
        "PROVISIONING",
        "PENDING",
        "ACTIVATING",
        "RUNNING",
        "DEACTIVATING",
        "STOPPING",
        "DEPROVISIONING",
        "STOPPED"
      ],
      "description": "The last known status of the task"
    },
    "desiredStatus": {
      "type": "string",
      "description": "The desired status of the task"
    },
    "cpu": {
      "type": "string",
      "description": "The number of CPU units used by the task"
    },
    "memory": {
      "type": "string",
      "description": "The amount of memory (in MiB) used by the task"
    },
    "containers": {
      "type": "array",
      "description": "The containers associated with the task",
      "items": {
        "type": "object",
        "properties": {
          "containerArn": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "image": {
            "type": "string"
          },
          "lastStatus": {
            "type": "string"
          }
        }
      }
    },
    "platformVersion": {
      "type": "string",
      "description": "The Fargate platform version on which the task is running"
    },
    "createdAt": {
      "type": "datetime",
      "description": "The time the task was created"
    },
    "tags": {
      "type": "array",
      "description": "Tags associated with the task",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "name": "Amazon Fargate Task"
}