@aws-sdk/client-ecs

What is @aws-sdk/client-ecs?

@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.

What are @aws-sdk/client-ecs's main functionalities?

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)
);

Other packages similar to @aws-sdk/client-ecs

dockerode

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

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

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.

README

@aws-sdk/client-ecs

Description

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 that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you 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. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

Installing

To install the this package, simply type add or install @aws-sdk/client-ecs using your favorite package manager:

• npm install @aws-sdk/client-ecs
• yarn add @aws-sdk/client-ecs
• pnpm add @aws-sdk/client-ecs

Getting Started

Import

The 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 CreateCapacityProviderCommand:

// ES5 example
const { ECSClient, CreateCapacityProviderCommand } = require("@aws-sdk/client-ecs");

// ES6+ example
import { ECSClient, CreateCapacityProviderCommand } from "@aws-sdk/client-ecs";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by difference commands.
const client = new ECSClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new CreateCapacityProviderCommand(params);

Async/await

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.

Promises

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.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // proccess err and data.
});

v2 compatible style

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 = client.createCapacityProvider(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .createCapacityProvider(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.createCapacityProvider(params, (err, data) => {
  // proccess err and data.
});

Troubleshooting

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;
   * }
   */
}

Getting Help

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.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.