Amazon Elastic Container Service

Developer Guide (API Version 2014-11-13)

What is Amazon ECS?
Setting Up
Docker Basics for Amazon ECS
Getting Started with Amazon ECS using Fargate
Getting Started with Amazon ECS
Cleaning Up
AWS Fargate
AWS Fargate Platform Versions
Clusters
- Creating a Cluster
- Scaling a Cluster
- Deleting a Cluster
Container Instances
- Container Instance AMIs
  - Amazon ECS-Optimized Amazon Linux 2 AMI
  - Amazon ECS-Optimized Amazon Linux AMI
- Retrieving Amazon ECS-Optimized AMI Metadata
- Subscribing to Amazon ECS-Optimized Amazon Linux AMI Update Notifications
- Launching a Container Instance
- Bootstrap Container Instances
  - Example User Data Scripts
- Connect to Your Container Instance
- CloudWatch Logs
- Container Instance Draining
- Memory Management
- Managing Container Instances Remotely
- Starting a Task at Container Instance Launch Time
- Deregister Container Instances
Container Agent
- Installing the Amazon ECS Container Agent
- Container Agent Versions
- Updating the Amazon ECS Container Agent
  - Updating the Amazon ECS Container Agent on an Amazon ECS-optimized AMI
  - Manually Updating the Amazon ECS Container Agent (for Non-Amazon ECS-Optimized AMIs)
- Amazon ECS Container Agent Configuration
- Private Registry Authentication for Container Instances
- Automated Task and Image Cleanup
- Container Metadata File
- Task Metadata Endpoint
  - Task Metadata Endpoint version 3
  - Task Metadata Endpoint version 2
- Amazon ECS Container Agent Introspection
- HTTP Proxy Configuration
Task Definitions
- Application Architecture
- Creating a Task Definition
- Task Definition Parameters
- Launch Types
- Using Data Volumes in Tasks
- Task Networking
- Using the awslogs Log Driver
- Private Registry Authentication for Tasks
- Specifying Sensitive Data
- Example Task Definitions
- Updating a Task Definition
- Deregistering Task Definitions
Scheduling Tasks
- Running Tasks
- Task Placement
- Scheduled Tasks (cron)
- Task Lifecycle
- Task Retirement
- Creating a Scheduled Task Using the AWS CLI
Services
- Service Definition Parameters
- Service Load Balancing
- Service Auto Scaling
  - Target Tracking Scaling Policies
  - Step Scaling Policies
- Service Discovery
  - Tutorial: Creating a Service Using Service Discovery
- Creating a Service
- Updating a Service
- Deleting a Service
- Service Throttle Logic
Resources and Tags
- Amazon Resource Names (ARNs) and IDs
- Tagging Your Resources
- Usage Reports
Repositories
Monitoring
- Monitoring Tools
- CloudWatch Metrics
  - Viewing Amazon ECS Metrics
  - Tutorial: Scaling with CloudWatch Alarms
- CloudWatch Events
IAM Policies, Roles, and Permissions
- Policy Structure
- Supported Resource-Level Permissions
- Creating IAM Policies
- Managed Policies and Trust Relationships
  - Amazon ECS Managed Policies and Trust Relationships
  - Amazon ECR Managed Policies
- Amazon ECS Container Instance IAM Role
- Amazon ECS Task Execution IAM Role
- Using Service-Linked Roles
- Amazon ECS Service Scheduler IAM Role
- Amazon ECS Service Auto Scaling IAM Role
- Amazon ECS Task Role
- CloudWatch Events IAM Role
- IAM Roles for Tasks
- Amazon ECS IAM Policy Examples
Using the Amazon ECS CLI
- Installing the Amazon ECS CLI
- Configuring the Amazon ECS CLI
- Migrating Configuration Files
- Tutorial: Creating a Cluster with a Fargate Task Using the Amazon ECS CLI
- Tutorial: Creating a Cluster with an EC2 Task Using the Amazon ECS CLI
- Tutorial: Creating an Amazon ECS Service That Uses Service Discovery Using the Amazon ECS CLI
- Amazon ECS Command Line Reference
Using the AWS CLI
- Tutorial: Creating a Cluster with a Fargate Task Using the AWS CLI
- Tutorial: Creating a Cluster with an EC2 Task Using the AWS CLI
Common Use Cases
Tutorial: Creating a VPC
Tutorial: Using Amazon EFS
Tutorial: Continuous Deployment with AWS CodePipeline
Service Limits
Logging Amazon ECS API Calls with AWS CloudTrail
Troubleshooting
- Troubleshooting First-Run Wizard Launch Issues
- Checking Stopped Tasks for Errors
- Service Event Messages
- Invalid CPU or Memory Value Specified
- Cannot Pull Container Image Error
- CannotCreateContainerError: API error (500): devmapper
- Troubleshooting Service Load Balancers
- Enabling Docker Debug Output
- Amazon ECS Log File Locations
- Amazon ECS Logs Collector
- Agent Introspection Diagnostics
- Docker Diagnostics
- API failures Error Messages
- Troubleshooting IAM Roles for Tasks
Windows Containers
- Getting Started with Windows Containers
- Windows Task Definitions
- Windows IAM Roles for Tasks
- Pushing Windows Images to Amazon ECR
Document History
AWS Glossary

Amazon ECS Task Metadata Endpoint

The Amazon ECS container agent provides a method to retrieve various task metadata and Docker stats. This is referred to as the task metadata endpoint. The following versions are available:

Task metadata endpoint version 3 – Available for all tasks that use the EC2 launch type and are launched on Amazon EC2 infrastructure running at least version 1.21.0 of the Amazon ECS container agent. For more information, see Task Metadata Endpoint version 3.
Task metadata endpoint version 2 – Available for tasks that use the Fargate launch type on platform version v1.1.0 or later and tasks that use the EC2 launch type that also use the awsvpc network mode and are launched on Amazon EC2 infrastructure running at least version 1.17.0 of the Amazon ECS container agent. For more information, see Task Metadata Endpoint version 2.

For information about a sample Go application that queries the metadata and stats API endpoints, see https://github.com/aws/amazon-ecs-agent/blob/2bf4348a0ff89e23be4e82a6c5ff28edf777092c/misc/taskmetadata-validator/taskmetadata-validator.go.

Topics

Warning Javascript is disabled or is unavailable in your browser.

To use the AWS Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

« Previous Next »

© 2018, Amazon Web Services, Inc. or its affiliates. All rights reserved.