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 Tasks API

Operations for running and managing individual Fargate tasks, including launching tasks, stopping tasks, and querying task status.

AWS Fargate Tasks 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 Tasks. 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 5 operations across 5 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.

5 operations 5 paths 13 schemas 5 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 Tasks 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 5

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

Tasks 5

Operations for running and managing individual Fargate tasks, including launching tasks, stopping tasks, and querying task status.

POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RunTask
AWS Fargate Run a Fargate task
runTask 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.StopTask
AWS Fargate Stop a running task
stopTask 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTasks
AWS Fargate Describe one or more tasks
describeTasks 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTasks
AWS Fargate List tasks in a cluster
listTasks 1 param body → 200400500
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ExecuteCommand
AWS Fargate Execute a command in a Fargate task container
executeCommand 1 param body → 200400500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Task (24 properties), RunTaskRequest (15 properties), Container (10 properties), TaskOverride (6 properties). Each schema is shown below with its type and property counts.

TaskOverride
object
The overrides associated with a task, used to override task definition values at runtime.
6 properties
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
AwsVpcConfiguration
object
The VPC networking configuration for Fargate tasks, which always use the awsvpc network mode.
3 properties 1 required
Task
object
Details of a running or stopped Fargate task.
24 properties
Failure
object
A failed resource from a batch operation.
3 properties
NetworkConfiguration
object
The network configuration for a task or service. Required for Fargate tasks and services.
1 property
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
Container
object
A container running as part of a task.
10 properties
ErrorResponse
object
2 properties
RunTaskResponse
object
2 properties
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
RunTaskRequest
object
Request to run a Fargate task.
15 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fargate-tasks-api-openapi.yml Raw ↑

Other APIs AWS Fargate publishes across the network.

AWS Fargate Clusters API
AWS Fargate Task Definitions 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