@aws-sdk/client-ecr

What is @aws-sdk/client-ecr?

@aws-sdk/client-ecr is an AWS SDK for JavaScript package that allows developers to interact with Amazon Elastic Container Registry (ECR). ECR is a fully managed Docker container registry that makes it easy to store, manage, and deploy Docker container images.

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

Create Repository

This feature allows you to create a new repository in Amazon ECR. The code sample demonstrates how to create a repository named 'my-repo' using the ECRClient and CreateRepositoryCommand.

const { ECRClient, CreateRepositoryCommand } = require('@aws-sdk/client-ecr');

const client = new ECRClient({ region: 'us-west-2' });
const command = new CreateRepositoryCommand({ repositoryName: 'my-repo' });

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

List Repositories

This feature allows you to list all repositories in your Amazon ECR. The code sample demonstrates how to use the DescribeRepositoriesCommand to retrieve and log the list of repositories.

const { ECRClient, DescribeRepositoriesCommand } = require('@aws-sdk/client-ecr');

const client = new ECRClient({ region: 'us-west-2' });
const command = new DescribeRepositoriesCommand({});

client.send(command).then(
  (data) => console.log(data.repositories),
  (error) => console.error(error)
);

Delete Repository

This feature allows you to delete a repository from Amazon ECR. The code sample demonstrates how to delete a repository named 'my-repo' using the DeleteRepositoryCommand.

const { ECRClient, DeleteRepositoryCommand } = require('@aws-sdk/client-ecr');

const client = new ECRClient({ region: 'us-west-2' });
const command = new DeleteRepositoryCommand({ repositoryName: 'my-repo', force: true });

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Push Image

This feature allows you to push a Docker image to an Amazon ECR repository. The code sample demonstrates how to get an authorization token, log in to the ECR registry using Docker, and push an image named 'my-repo:latest'.

const { ECRClient, GetAuthorizationTokenCommand } = require('@aws-sdk/client-ecr');
const { exec } = require('child_process');

const client = new ECRClient({ region: 'us-west-2' });
const command = new GetAuthorizationTokenCommand({});

client.send(command).then(
  (data) => {
    const authData = data.authorizationData[0];
    const authToken = Buffer.from(authData.authorizationToken, 'base64').toString('utf-8').split(':')[1];
    const proxyEndpoint = authData.proxyEndpoint;

    exec(`docker login -u AWS -p ${authToken} ${proxyEndpoint}`, (err, stdout, stderr) => {
      if (err) {
        console.error('Login failed:', stderr);
        return;
      }
      console.log('Login successful:', stdout);
      exec('docker push my-repo:latest', (err, stdout, stderr) => {
        if (err) {
          console.error('Push failed:', stderr);
          return;
        }
        console.log('Push successful:', stdout);
      });
    });
  },
  (error) => console.error(error)
);

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

dockerode

Dockerode is a Node.js module that provides a Docker Remote API client. It allows you to manage Docker containers, images, and networks. Unlike @aws-sdk/client-ecr, which is specific to Amazon ECR, Dockerode provides a more general interface for interacting with Docker.

node-docker-api

Node-docker-api is another Node.js client for the Docker Remote API. It offers a promise-based interface for managing Docker containers, images, volumes, and networks. Similar to Dockerode, it is not specific to Amazon ECR but provides broader Docker management capabilities.

aws-sdk

The aws-sdk package is the older, monolithic AWS SDK for JavaScript. It includes support for all AWS services, including ECR. However, it is larger and less modular compared to the newer, service-specific packages like @aws-sdk/client-ecr.

README

@aws-sdk/client-ecr

For SDK usage, please step to SDK readme.

Changelog

3.1.0 (2020-12-23)

Bug Fixes

• clients: default region and credential provider (#1834) (bc79ab5)
• clients: populate sdkId in serviceId and default to use arnNamespace as signingName (#1786) (0011af2)
• clients: remove retry headers for several services (#1789) (fc98d2d)
• clients: update endpoint provider (#1824) (64d2210)
• clients: use signing name from auth sigv4 trait (#1835) (e539302)
• codegen: strip names from enums (#1837) (0711503)
• lib-storage: cleanup stream listeners to prevent memory leak (3d36682)
• middleware-user-agent: add middleware to final step of build (#1833) (e7dce39)
• signature-v4: add secrets to signing key cache key (#1776) (8785ad4)
• util-waiter: fix compiling error with waiter (#1812) (ca1f0d6), closes #1803
• log requestId, extendedRequestId, cfId in $metadata (#1819) (f2a47e8)

Features

• credential-provider-node: use credential_process from profile (#1773) (842e2a0), closes #1772
• standardize user agent value (#1775) (388b180)
• cucumber: use waiters in integration tests (#1792) (e151aee)
• middleware-logger: log clientName, commandName, input, output (#1788) (4f9e56f)