Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Fargate Clusters API

Operations for managing ECS clusters that host Fargate tasks and services, including cluster creation, configuration, and capacity provider association.

AWS Fargate Clusters API is one of 8 APIs that AWS Fargate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, and a changelog.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2014-11-13.

Requests are made against a single base URL, https://ecs.{region}.amazonaws.com.

2 operations 2 paths 6 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2014-11-13
Base URL
https://ecs.{region}.amazonaws.com
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Fargate Clusters API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sig_v4). By default, every request must be authenticated.

  • aws_sig_v4 — AWS Signature Version 4 authentication. Requests must be signed using AWS access credentials.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Clusters 2

Operations for managing ECS clusters that host Fargate tasks and services, including cluster creation, configuration, and capacity provider association.

POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateCluster
AWS Fargate Create an ECS cluster
createCluster 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeClusters
AWS Fargate Describe one or more clusters
describeClusters 1 param body → 200400500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Cluster (11 properties), CreateClusterRequest (5 properties), CapacityProviderStrategyItem (3 properties), Failure (3 properties). Each schema is shown below with its type and property counts.

Failure
object
A failed resource from a batch operation.
3 properties
CreateClusterRequest
object
Request to create an ECS cluster for Fargate workloads.
5 properties
CapacityProviderStrategyItem
object
A capacity provider strategy item specifying a capacity provider and its weight and base values. Use FARGATE or FARGATESPOT for serverless compute.
3 properties 1 required
ErrorResponse
object
2 properties
Cluster
object
An ECS cluster that can host Fargate tasks and services.
11 properties
Tag
object
A key-value pair used to tag an Amazon ECS resource.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fargate-clusters-api-openapi.yml Raw ↑

Other APIs AWS Fargate publishes across the network.

AWS Fargate Task Definitions API
AWS Fargate Tasks API
AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.CreateService API
AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.DeleteService API
AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices API
AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.ListServices API
AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.UpdateService API