Amazon ECS API

openapi: 3.1.0
info:
  title: Amazon ECS Amazon Elastic Container Service (ECS) API
  description: >-
    Amazon Elastic Container Service (Amazon ECS) is a fully managed container
    orchestration service that makes it easy to deploy, manage, and scale
    containerized applications. The Amazon ECS API uses an RPC model where all
    actions are routed to a single endpoint via POST with an X-Amz-Target header
    specifying the action. This specification models the core ECS resource
    operations for clusters, services, tasks, and task definitions.
  version: '2014-11-13'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/ecs/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-apisguru-categories:
  - cloud
  x-logo:
    url: https://aws.amazon.com/favicon.ico
  x-origin:
  - format: openapi
    url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/Welcome.html
    version: '3.1'

externalDocs:
  description: Amazon ECS API Reference
  url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/Welcome.html

servers:
- url: https://ecs.{region}.amazonaws.com
  description: Amazon ECS regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-north-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1

security:
- aws_sig_v4: []

tags:
- name: Capacity Providers
  description: Operations for managing capacity providers

- name: Clusters
  description: Operations for managing ECS clusters
  externalDocs:
    url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
- name: Container Instances
  description: Operations for managing container instances
- name: Task Definitions
  description: Operations for managing ECS task definitions
  externalDocs:
    url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RegisterTaskDefinition.html
- name: Tasks
  description: Operations for running and managing ECS tasks
  externalDocs:
    url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html
paths:
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateCluster:
    post:
      operationId: CreateCluster
      summary: Amazon Ecs Create a New Ecs Cluster
      description: >-
        Creates a new Amazon ECS cluster. By default, your account receives a
        default cluster when you launch your first container instance. You can
        create additional clusters to group resources.
      tags:
      - Clusters
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateClusterRequest'
            examples:
              CreateclusterRequestExample:
                summary: Default CreateCluster request
                x-microcks-default: true
                value:
                  clusterName: example_value
                  capacityProviders:
                  - example_value
                  defaultCapacityProviderStrategy:
                  - capacityProvider: example_value
                    weight: 10
                    base: 10
                  settings:
                  - name: Example Title
                    value: example_value
                  configuration:
                    executeCommandConfiguration:
                      kmsKeyId: '500123'
                      logConfiguration: {}
                      logging: NONE
                    managedStorageConfiguration:
                      fargateEphemeralStorageKmsKeyId: '500123'
                      kmsKeyId: '500123'
                  serviceConnectDefaults:
                    namespace: example_value
                  tags:
                  - key: example_value
                    value: example_value
      responses:
        '200':
          description: Cluster created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClusterResponse'
              examples:
                Createcluster200Example:
                  summary: Default CreateCluster 200 response
                  x-microcks-default: true
                  value:
                    cluster:
                      clusterArn: example_value
                      clusterName: example_value
                      status: ACTIVE
                      registeredContainerInstancesCount: 10
                      runningTasksCount: 10
                      pendingTasksCount: 10
                      activeServicesCount: 10
                      statistics:
                      - {}
                      tags:
                      - {}
                      settings:
                      - {}
                      capacityProviders:
                      - {}
                      defaultCapacityProviderStrategy:
                      - {}
                      attachments:
                      - {}
                      attachmentsStatus: example_value
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteCluster:
    post:
      operationId: DeleteCluster
      summary: Amazon Ecs Delete an Ecs Cluster
      description: >-
        Deletes the specified cluster. The cluster must have been deregistered,
        and must not contain any services or tasks.
      tags:
      - Clusters
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteCluster.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - cluster
              properties:
                cluster:
                  type: string
                  description: The short name or full ARN of the cluster to delete.
            examples:
              DeleteclusterRequestExample:
                summary: Default DeleteCluster request
                x-microcks-default: true
                value:
                  cluster: example_value
      responses:
        '200':
          description: Cluster deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cluster:
                    $ref: '#/components/schemas/Cluster'
              examples:
                Deletecluster200Example:
                  summary: Default DeleteCluster 200 response
                  x-microcks-default: true
                  value:
                    cluster:
                      clusterArn: example_value
                      clusterName: example_value
                      status: ACTIVE
                      registeredContainerInstancesCount: 10
                      runningTasksCount: 10
                      pendingTasksCount: 10
                      activeServicesCount: 10
                      statistics:
                      - name: Example Title
                        value: example_value
                      tags:
                      - {}
                      settings:
                      - {}
                      capacityProviders:
                      - example_value
                      defaultCapacityProviderStrategy:
                      - {}
                      attachments:
                      - {}
                      attachmentsStatus: example_value
                      configuration:
                        executeCommandConfiguration: {}
                        managedStorageConfiguration: {}
                      serviceConnectDefaults:
                        namespace: example_value
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeClusters:
    post:
      operationId: DescribeClusters
      summary: Amazon Ecs Describe One or More Ecs Clusters
      description: >-
        Describes one or more of your clusters. Returns details about a cluster
        including its status, statistics, tags, and settings.
      tags:
      - Clusters
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeClusters.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              properties:
                clusters:
                  type: array
                  description: >-
                    A list of up to 100 cluster names or full cluster ARN
                    entries.
                  items:
                    type: string
                include:
                  type: array
                  description: Additional information about your clusters to include in the response.
                  items:
                    type: string
                    enum:
                    - ATTACHMENTS
                    - CONFIGURATIONS
                    - SETTINGS
                    - STATISTICS
                    - TAGS
            examples:
              DescribeclustersRequestExample:
                summary: Default DescribeClusters request
                x-microcks-default: true
                value:
                  clusters:
                  - example_value
                  include:
                  - ATTACHMENTS
      responses:
        '200':
          description: Clusters described successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  clusters:
                    type: array
                    items:
                      $ref: '#/components/schemas/Cluster'
                  failures:
                    type: array
                    items:
                      $ref: '#/components/schemas/Failure'
              examples:
                Describeclusters200Example:
                  summary: Default DescribeClusters 200 response
                  x-microcks-default: true
                  value:
                    clusters:
                    - clusterArn: example_value
                      clusterName: example_value
                      status: ACTIVE
                      registeredContainerInstancesCount: 10
                      runningTasksCount: 10
                      pendingTasksCount: 10
                      activeServicesCount: 10
                      statistics:
                      - {}
                      tags:
                      - {}
                      settings:
                      - {}
                      capacityProviders:
                      - {}
                      defaultCapacityProviderStrategy:
                      - {}
                      attachments:
                      - {}
                      attachmentsStatus: example_value
                    failures:
                    - arn: example_value
                      reason: example_value
                      detail: example_value
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListClusters:
    post:
      operationId: ListClusters
      summary: Amazon Ecs List Ecs Clusters
      description: Returns a list of existing clusters.
      tags:
      - Clusters
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: false
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              properties:
                maxResults:
                  type: integer
                  description: Maximum number of cluster results per page (1-100).
                nextToken:
                  type: string
                  description: Pagination token from a previous response.
            examples:
              ListclustersRequestExample:
                summary: Default ListClusters request
                x-microcks-default: true
                value:
                  maxResults: 10
                  nextToken: example_value
      responses:
        '200':
          description: Clusters listed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  clusterArns:
                    type: array
                    items:
                      type: string
                  nextToken:
                    type: string
              examples:
                Listclusters200Example:
                  summary: Default ListClusters 200 response
                  x-microcks-default: true
                  value:
                    clusterArns:
                    - example_value
                    nextToken: example_value
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateCluster:
    post:
      operationId: UpdateCluster
      summary: Amazon Ecs Update an Ecs Cluster
      description: Updates the cluster settings and configuration.
      tags:
      - Clusters
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateCluster.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - cluster
              properties:
                cluster:
                  type: string
                  description: The name or ARN of the cluster to update.
                settings:
                  type: array
                  items:
                    $ref: '#/components/schemas/ClusterSetting'
                configuration:
                  $ref: '#/components/schemas/ClusterConfiguration'
                serviceConnectDefaults:
                  $ref: '#/components/schemas/ClusterServiceConnectDefaults'
            examples:
              UpdateclusterRequestExample:
                summary: Default UpdateCluster request
                x-microcks-default: true
                value:
                  cluster: example_value
                  settings:
                  - name: Example Title
                    value: example_value
                  configuration:
                    executeCommandConfiguration:
                      kmsKeyId: '500123'
                      logConfiguration:
                        cloudWatchEncryptionEnabled: true
                        cloudWatchLogGroupName: example_value
                        s3BucketName: example_value
                        s3EncryptionEnabled: true
                        s3KeyPrefix: example_value
                      logging: NONE
                    managedStorageConfiguration:
                      fargateEphemeralStorageKmsKeyId: '500123'
                      kmsKeyId: '500123'
                  serviceConnectDefaults:
                    namespace: example_value
      responses:
        '200':
          description: Cluster updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cluster:
                    $ref: '#/components/schemas/Cluster'
              examples:
                Updatecluster200Example:
                  summary: Default UpdateCluster 200 response
                  x-microcks-default: true
                  value:
                    cluster:
                      clusterArn: example_value
                      clusterName: example_value
                      status: ACTIVE
                      registeredContainerInstancesCount: 10
                      runningTasksCount: 10
                      pendingTasksCount: 10
                      activeServicesCount: 10
                      statistics:
                      - name: Example Title
                        value: example_value
                      tags:
                      - {}
                      settings:
                      - {}
                      capacityProviders:
                      - example_value
                      defaultCapacityProviderStrategy:
                      - {}
                      attachments:
                      - {}
                      attachmentsStatus: example_value
                      configuration:
                        executeCommandConfiguration: {}
                        managedStorageConfiguration: {}
                      serviceConnectDefaults:
                        namespace: example_value
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateService:
    post:
      operationId: CreateService
      summary: Amazon Ecs Create a New Ecs Service
      description: >-
        Runs and maintains a specified number of instances of a task definition
        simultaneously in an ECS cluster. If the desired count of tasks in a
        service drops below the desired count, Amazon ECS runs another
        instantiation of the task to bring the count back up.
      tags: []
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateServiceRequest'
            examples:
              CreateserviceRequestExample:
                summary: Default CreateService request
                x-microcks-default: true
                value:
                  serviceName: example_value
                  cluster: example_value
                  taskDefinition: example_value
                  desiredCount: 10
                  launchType: EC2
                  capacityProviderStrategy:
                  - capacityProvider: example_value
                    weight: 10
                    base: 10
                  platformVersion: example_value
                  loadBalancers:
                  - targetGroupArn: example_value
                    loadBalancerName: example_value
                    containerName: example_value
                    containerPort: 10
                  networkConfiguration:
                    awsvpcConfiguration:
                      subnets: {}
                      securityGroups: {}
                      assignPublicIp: ENABLED
                  deploymentConfiguration:
                    deploymentCircuitBreaker:
                      enable: true
                      rollback: true
                    maximumPercent: 10
                    minimumHealthyPercent: 10
                    alarms:
                      alarmNames: {}
                      enable: true
                      rollback: true
                  deploymentController:
                    type: ECS
                  schedulingStrategy: REPLICA
                  placementConstraints:
                  - type: distinctInstance
                    expression: example_value
                  placementStrategy:
                  - type: random
                    field: example_value
                  healthCheckGracePeriodSeconds: 10
                  enableECSManagedTags: true
                  enableExecuteCommand: true
                  propagateTags: TASK_DEFINITION
                  role: example_value
                  serviceRegistries:
                  - registryArn: example_value
                    port: 10
                    containerName: example_value
                    containerPort: 10
                  serviceConnectConfiguration:
                    enabled: true
                    namespace: example_value
                    services:
                    - {}
                    logConfiguration:
                      logDriver: json-file
                      options: example_value
                      secretOptions: {}
                  tags:
                  - key: example_value
                    value: example_value
                  clientToken: example_value
      responses:
        '200':
          description: Service created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    $ref: '#/components/schemas/Service'
              examples:
                Createservice200Example:
                  summary: Default CreateService 200 response
                  x-microcks-default: true
                  value:
                    service:
                      serviceArn: example_value
                      serviceName: example_value
                      clusterArn: example_value
                      loadBalancers:
                      - {}
                      serviceRegistries:
                      - {}
                      status: ACTIVE
                      desiredCount: 10
                      runningCount: 10
                      pendingCount: 10
                      launchType: EC2
                      capacityProviderStrategy:
                      - {}
                      platformVersion: example_value
                      platformFamily: example_value
                      taskDefinition: example_value
                      deploymentConfiguration:
                        deploymentCircuitBreaker: {}
                        maximumPercent: 10
                        minimumHealthyPercent: 10
                        alarms: {}
                      deployments:
                      - {}
                      roleArn: example_value
                      events:
                      - id: abc123
                        createdAt: 42.5
                        message: example_value
                      createdAt: 42.5
                      placementConstraints:
                      - {}
                      placementStrategy:
                      - {}
                      networkConfiguration:
                        awsvpcConfiguration: {}
                      healthCheckGracePeriodSeconds: 10
                      schedulingStrategy: REPLICA
                      deploymentController:
                        type: ECS
                      tags:
                      - {}
                      createdBy: example_value
                      enableECSManagedTags: true
                      enableExecuteCommand: true
                      propagateTags: TASK_DEFINITION
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteService:
    post:
      operationId: DeleteService
      summary: Amazon Ecs Delete an Ecs Service
      description: >-
        Deletes a specified service within a cluster. You can delete a service if
        you have no running tasks in it and the desired task count is zero.
      tags: []
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteService.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - service
              properties:
                cluster:
                  type: string
                  description: The short name or full ARN of the cluster hosting the service.
                service:
                  type: string
                  description: The name or ARN of the service to delete.
                force:
                  type: boolean
                  description: >-
                    If true, you can delete a service even if it has not been
                    scaled down to zero tasks.
            examples:
              DeleteserviceRequestExample:
                summary: Default DeleteService request
                x-microcks-default: true
                value:
                  cluster: example_value
                  service: example_value
                  force: true
      responses:
        '200':
          description: Service deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    $ref: '#/components/schemas/Service'
              examples:
                Deleteservice200Example:
                  summary: Default DeleteService 200 response
                  x-microcks-default: true
                  value:
                    service:
                      serviceArn: example_value
                      serviceName: example_value
                      clusterArn: example_value
                      loadBalancers:
                      - {}
                      serviceRegistries:
                      - {}
                      status: ACTIVE
                      desiredCount: 10
                      runningCount: 10
                      pendingCount: 10
                      launchType: EC2
                      capacityProviderStrategy:
                      - {}
                      platformVersion: example_value
                      platformFamily: example_value
                      taskDefinition: example_value
                      deploymentConfiguration:
                        deploymentCircuitBreaker: {}
                        maximumPercent: 10
                        minimumHealthyPercent: 10
                        alarms: {}
                      deployments:
                      - {}
                      roleArn: example_value
                      events:
                      - id: abc123
                        createdAt: 42.5
                        message: example_value
                      createdAt: 42.5
                      placementConstraints:
                      - {}
                      placementStrategy:
                      - {}
                      networkConfiguration:
                        awsvpcConfiguration: {}
                      healthCheckGracePeriodSeconds: 10
                      schedulingStrategy: REPLICA
                      deploymentController:
                        type: ECS
                      tags:
                      - {}
                      createdBy: example_value
                      enableECSManagedTags: true
                      enableExecuteCommand: true
                      propagateTags: TASK_DEFINITION
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServices:
    post:
      operationId: DescribeServices
      summary: Amazon Ecs Describe One or More Ecs Services
      description: Describes the specified services running in a cluster.
      tags: []
      externalDocs:
        url: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - services
              properties:
                cluster:
                  type: string
                  description: The short name or full ARN of the cluster hosting the services.
                services:
                  type: array
                  description: A list of services to describe (up to 10).
                  items:
                    type: string
                  maxItems: 10
                include:
                  type: array
                  description: Additional information to include in the response.
                  items:
                    type: string
                    enum:
                    - TAGS
            examples:
              DescribeservicesRequestExample:
                summary: Default DescribeServices request
                x-microcks-default: true
                value:
                  cluster: example_value
                  services:
                  - example_value
                  include:
                  - TAGS
      responses:
        '200':
          description: Services described successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  services:
                    type: array
                    items:
                      $ref: '#/components/schemas/Service'
                  failures:
                    type: array
                    items:
                      $ref: '#/components/schemas/Failure'
              examples:
                Describeservices200Example:
                  summary: Default DescribeServices 200 response
                  x-microcks-default: true
                  value:
                    services:
                    - serviceArn: example_value
                      serviceName: example_value
                      clusterArn: example_value
                      loadBalancers:
                      - {}
                      serviceRegistries:
                      - {}
                      status: ACTIVE
                      desiredCount: 10
                      runningCount: 10
                      pendingCount: 10
                      launchType: EC2
                      capacityProviderStrategy:
                      - {}
                      platformVersion: example_value
                      platformFamily: example_value
                      taskDefinition: example_value
                      deployments:
                      - {}
                      roleArn: example_value
                      events:
                      - {}
                      createdAt: 42.5
                      placementConstraints:
                      - {}
                      placementStrategy:
                      - {}
                      healthCheckGracePeriodSeconds: 10
                      schedulingStrategy: REPLICA
                      tags:
                      - {}
                      createdBy: example_value
                      enableECSManagedTags: true
                      enableExecuteCommand: true
                      propagateTags: TASK_DEFINITION
                    failures:
                    - arn: example_value
                      reason: example_value
                      detail: example_value
        '400':
          $ref: '#/components/responses/ClientError'
        '500':
          $ref: '#/components/responses/ServerError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#X-Amz-Target=AmazonEC2ContainerServic

# --- truncated at 32 KB (175 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ecs/refs/heads/main/openapi/amazon-ecs-openapi.yml