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 #X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices API

The #X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices API from AWS Fargate — 1 operation(s) for #x amz target=amazonec2containerservicev20141113.describeservices.

AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices 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 #X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices. 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 1 operation across 1 path, and defines 9 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.

1 operations 1 paths 9 schemas 1 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 #X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices 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 1

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

#X Amz Target=AmazonEC2ContainerServiceV20141113.DescribeServices 1
POST
/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServices
AWS Fargate Describe one or more services
describeServices 1 param body → 200400500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Service (21 properties), Deployment (12 properties), DeploymentConfiguration (3 properties), AwsVpcConfiguration (3 properties). Each schema is shown below with its type and property counts.

Failure
object
A failed resource from a batch operation.
3 properties
AwsVpcConfiguration
object
The VPC networking configuration for Fargate tasks, which always use the awsvpc network mode.
3 properties 1 required
Service
object
Details of an ECS service running Fargate tasks.
21 properties
NetworkConfiguration
object
The network configuration for a task or service. Required for Fargate tasks and services.
1 property
DeploymentConfiguration
object
The deployment configuration for a service, controlling how updates are rolled out.
3 properties
LoadBalancer
object
The load balancer configuration for a service. Fargate services support Application Load Balancers (ALB) and Network Load Balancers (NLB) with IP target type.
3 properties
ErrorResponse
object
2 properties
Tag
object
A key-value pair used to tag an Amazon ECS resource.
2 properties
Deployment
object
Details of a service deployment.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fargate-x-amz-target-amazonec2containerservicev20141113-describeservices-api-openapi.yml Raw ↑

Other APIs AWS Fargate publishes across the network.

AWS Fargate Clusters API
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.ListServices API
AWS Fargate #X Amz Target=AmazonEC2ContainerServiceV20141113.UpdateService API