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 Task Definitions API

Operations for registering and managing ECS task definitions with Fargate compatibility, including CPU, memory, network mode, and container configuration.

AWS Fargate Task Definitions 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 Task Definitions. 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 4 operations across 4 paths, and defines 13 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.

4 operations 4 paths 13 schemas 4 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 Task Definitions 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 4

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

Task Definitions 4

Operations for registering and managing ECS task definitions with Fargate compatibility, including CPU, memory, network mode, and container configuration.

POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RegisterTaskDefinition
AWS Fargate Register a Fargate task definition
registerTaskDefinition 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTaskDefinition
AWS Fargate Describe a task definition
describeTaskDefinition 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTaskDefinitions
AWS Fargate List task definitions
listTaskDefinitions 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeregisterTaskDefinition
AWS Fargate Deregister a task definition
deregisterTaskDefinition 1 param body → 200400500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ContainerDefinition (18 properties), TaskDefinition (17 properties), RegisterTaskDefinitionRequest (12 properties), PortMapping (5 properties). Each schema is shown below with its type and property counts.

LogConfiguration
object
Log configuration for the container. Fargate tasks support the awslogs, splunk, and awsfirelens log drivers.
3 properties 1 required
EphemeralStorage
object
The amount of ephemeral storage to allocate for the Fargate task. Available on platform version 1.4.0 or later for Linux and 1.0.0 or later for Windows.
1 property 1 required
RegisterTaskDefinitionResponse
object
2 properties
Volume
object
A data volume used by containers in a task. Fargate tasks support bind mounts and EFS volumes.
2 properties
TaskDefinition
object
A Fargate task definition describes the containers and parameters required to run a Fargate task.
17 properties
PortMapping
object
A port mapping for a container. For Fargate tasks, the containerPort is the only required field. The hostPort is automatically set to match the containerPort.
5 properties
ErrorResponse
object
2 properties
HealthCheck
object
Container health check configuration. The health check command is run inside the container.
5 properties 1 required
RegisterTaskDefinitionRequest
object
Request to register a Fargate task definition.
12 properties 2 required
ContainerDefinition
object
A container definition describes a container that is part of a task.
18 properties 2 required
KeyValuePair
object
A key-value pair representing an environment variable.
2 properties
Tag
object
A key-value pair used to tag an Amazon ECS resource.
2 properties
RuntimePlatform
object
The operating system and CPU architecture for the Fargate task.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fargate-task-definitions-api-openapi.yml Raw ↑

Other APIs AWS Fargate publishes across the network.

AWS Fargate Clusters 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