@aws-sdk/client-ecr-public

Description

AWS SDK for JavaScript ECRPUBLIC Client for Node.js, Browser and React Native.

Amazon Elastic Container Registry Public

Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both
public and private registries to host your container images. You can use the Docker CLI or
your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable,
and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR
supports public repositories with this API. For information about the Amazon ECR API for private
repositories, see Amazon Elastic Container Registry API Reference.

Installing

To install this package, simply type add or install @aws-sdk/client-ecr-public
using your favorite package manager:
- npm install @aws-sdk/client-ecr-public
- yarn add @aws-sdk/client-ecr-public
- pnpm add @aws-sdk/client-ecr-public

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ECRPUBLICClient and
the commands you need, for example ListTagsForResourceCommand:

``js
// ES5 example
const { ECRPUBLICClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ecr-public");
`

`ts
// ES6+ example
import { ECRPUBLICClient, ListTagsForResourceCommand } from "@aws-sdk/client-ecr-public";
`

$3

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.

`js
// a client can be shared by different commands.
const client = new ECRPUBLICClient({ region: "REGION" });

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

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
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.

`js
// callbacks.
client.send(command, (err, data) => {
// process 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

`ts
import * as AWS from "@aws-sdk/client-ecr-public";
const client = new AWS.ECRPUBLIC({ region: "REGION" });

// async/await.
try {
const data = await client.listTagsForResource(params);
// process data.
} catch (error) {
// error handling.
}

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

// callbacks.
client.listTagsForResource(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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-ecr-public` 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.

Client Commands (Operations List)

BatchCheckLayerAvailability

Command API Reference / Input / Output

BatchDeleteImage

Command API Reference / Input / Output

CompleteLayerUpload

Command API Reference / Input / Output

CreateRepository

Command API Reference / Input / Output

DeleteRepository

Command API Reference / Input / Output

DeleteRepositoryPolicy

Command API Reference / Input / Output

DescribeImages

Command API Reference / Input / Output

DescribeImageTags

Command API Reference / Input / Output

DescribeRegistries

Command API Reference / Input / Output

DescribeRepositories

Command API Reference / Input / Output

GetAuthorizationToken

Command API Reference / Input / Output

GetRegistryCatalogData

Command API Reference / Input / Output

GetRepositoryCatalogData

Command API Reference / Input / Output

GetRepositoryPolicy

Command API Reference / Input / Output

InitiateLayerUpload

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutImage

Command API Reference / Input / Output

PutRegistryCatalogData

Command API Reference / Input / Output

PutRepositoryCatalogData

Command API Reference / Input / Output

SetRepositoryPolicy

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UploadLayerPart

Command API Reference / Input / Output