@aws-sdk/client-ecs
Advanced tools
AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native
@aws-sdk/client-ecs is a part of the AWS SDK for JavaScript, which allows developers to interact with the Amazon Elastic Container Service (ECS). ECS is a fully managed container orchestration service that makes it easy to deploy, manage, and scale containerized applications using Docker. This package provides a set of APIs to manage ECS clusters, services, tasks, and more.
Create Cluster
This feature allows you to create a new ECS cluster. The code sample demonstrates how to create a cluster named 'my-cluster' using the ECSClient and CreateClusterCommand.
const { ECSClient, CreateClusterCommand } = require('@aws-sdk/client-ecs');
const client = new ECSClient({ region: 'us-west-2' });
const command = new CreateClusterCommand({ clusterName: 'my-cluster' });
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Register Task Definition
This feature allows you to register a new task definition. The code sample demonstrates how to register a task definition with a single container named 'my-container' using the ECSClient and RegisterTaskDefinitionCommand.
const { ECSClient, RegisterTaskDefinitionCommand } = require('@aws-sdk/client-ecs');
const client = new ECSClient({ region: 'us-west-2' });
const command = new RegisterTaskDefinitionCommand({
family: 'my-task-family',
containerDefinitions: [
{
name: 'my-container',
image: 'my-image',
memory: 512,
cpu: 256,
essential: true,
},
],
});
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Run Task
This feature allows you to run a task on an ECS cluster. The code sample demonstrates how to run a task using a task definition named 'my-task-family' on a cluster named 'my-cluster' using the ECSClient and RunTaskCommand.
const { ECSClient, RunTaskCommand } = require('@aws-sdk/client-ecs');
const client = new ECSClient({ region: 'us-west-2' });
const command = new RunTaskCommand({
cluster: 'my-cluster',
taskDefinition: 'my-task-family',
count: 1,
});
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);List Services
This feature allows you to list the services running in an ECS cluster. The code sample demonstrates how to list services in a cluster named 'my-cluster' using the ECSClient and ListServicesCommand.
const { ECSClient, ListServicesCommand } = require('@aws-sdk/client-ecs');
const client = new ECSClient({ region: 'us-west-2' });
const command = new ListServicesCommand({ cluster: 'my-cluster' });
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Dockerode is a Docker client for Node.js. It provides a way to interact with Docker containers, images, and other Docker resources. Unlike @aws-sdk/client-ecs, which is specific to AWS ECS, Dockerode is a more general-purpose Docker client that can be used with any Docker environment.
Kubernetes-client is a Node.js client for the Kubernetes API. It allows developers to interact with Kubernetes clusters, manage pods, services, deployments, and other Kubernetes resources. While @aws-sdk/client-ecs is specific to AWS ECS, kubernetes-client is used for managing Kubernetes clusters, which is another popular container orchestration platform.
Node-docker-api is another Docker client for Node.js. It provides a simple and flexible API to interact with Docker resources. Similar to Dockerode, it is not specific to AWS ECS and can be used with any Docker environment.
AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
Amazon Elastic Container Service
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.
To install this package, simply type add or install @aws-sdk/client-ecs using your favorite package manager:
npm install @aws-sdk/client-ecsyarn add @aws-sdk/client-ecspnpm add @aws-sdk/client-ecsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ECSClient and
the commands you need, for example ListTasksCommand:
// ES5 example
const { ECSClient, ListTasksCommand } = require("@aws-sdk/client-ecs");
// ES6+ example
import { ECSClient, ListTasksCommand } from "@aws-sdk/client-ecs";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new ECSClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListTasksCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-ecs";
const client = new AWS.ECS({ region: "REGION" });
// async/await.
try {
const data = await client.listTasks(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listTasks(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listTasks(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-ecs package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.708.0 (2024-12-09)
CustomDomainConfig from a required to an optional parameter for the UpdateUserPoolDomain operation. (7c1425c)FAQs
AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-ecs receives a total of 380,371 weekly downloads. As such, @aws-sdk/client-ecs popularity was classified as popular.
We found that @aws-sdk/client-ecs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.