@aws-sdk/client-acm
Advanced tools
AWS SDK for JavaScript Acm Client for Node.js, Browser and React Native
@aws-sdk/client-acm is a part of the AWS SDK for JavaScript, which allows developers to interact with the AWS Certificate Manager (ACM) service. This package provides methods to request, manage, and deploy SSL/TLS certificates for use with AWS services and internal connected resources.
Request a Certificate
This feature allows you to request a new SSL/TLS certificate for a specified domain. The code sample demonstrates how to request a certificate for 'example.com' using email validation.
const { ACMClient, RequestCertificateCommand } = require('@aws-sdk/client-acm');
const client = new ACMClient({ region: 'us-west-2' });
const command = new RequestCertificateCommand({
DomainName: 'example.com',
ValidationMethod: 'EMAIL',
});
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);List Certificates
This feature allows you to list all the certificates in your AWS account. The code sample demonstrates how to retrieve and log the list of certificates.
const { ACMClient, ListCertificatesCommand } = require('@aws-sdk/client-acm');
const client = new ACMClient({ region: 'us-west-2' });
const command = new ListCertificatesCommand({});
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Describe Certificate
This feature allows you to get detailed information about a specific certificate. The code sample demonstrates how to describe a certificate using its ARN.
const { ACMClient, DescribeCertificateCommand } = require('@aws-sdk/client-acm');
const client = new ACMClient({ region: 'us-west-2' });
const command = new DescribeCertificateCommand({
CertificateArn: 'arn:aws:acm:us-west-2:123456789012:certificate/abcd1234-5678-90ab-cdef-EXAMPLE11111',
});
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Delete Certificate
This feature allows you to delete a specified certificate. The code sample demonstrates how to delete a certificate using its ARN.
const { ACMClient, DeleteCertificateCommand } = require('@aws-sdk/client-acm');
const client = new ACMClient({ region: 'us-west-2' });
const command = new DeleteCertificateCommand({
CertificateArn: 'arn:aws:acm:us-west-2:123456789012:certificate/abcd1234-5678-90ab-cdef-EXAMPLE11111',
});
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);node-acme is a client library for the ACME protocol, which is used by Let's Encrypt to automate the process of obtaining SSL/TLS certificates. Unlike @aws-sdk/client-acm, which is specific to AWS Certificate Manager, node-acme can be used to interact with any ACME-compliant certificate authority.
acme-client is another library for the ACME protocol, providing a simple and flexible way to interact with ACME servers like Let's Encrypt. It offers similar functionalities to node-acme but with a different API design. It is not tied to AWS services and can be used with any ACME-compliant CA.
AWS SDK for JavaScript ACM Client for Node.js, Browser and React Native.
Certificate Manager
You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
To install the this package, simply type add or install @aws-sdk/client-acm using your favorite package manager:
npm install @aws-sdk/client-acmyarn add @aws-sdk/client-acmpnpm add @aws-sdk/client-acmThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ACMClient and
the commands you need, for example ListCertificatesCommand:
// ES5 example
const { ACMClient, ListCertificatesCommand } = require("@aws-sdk/client-acm");
// ES6+ example
import { ACMClient, ListCertificatesCommand } from "@aws-sdk/client-acm";
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 ACMClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListCertificatesCommand(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-acm";
const client = new AWS.ACM({ region: "REGION" });
// async/await.
try {
const data = await client.listCertificates(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listCertificates(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listCertificates(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-acm 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.
FAQs
AWS SDK for JavaScript Acm Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-acm receives a total of 216,659 weekly downloads. As such, @aws-sdk/client-acm popularity was classified as popular.
We found that @aws-sdk/client-acm 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.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.