@aws-sdk/client-acm
Description
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.
Installing
To install this package, use the CLI of your favorite package manager:
npm install @aws-sdk/client-acm
yarn add @aws-sdk/client-acm
pnpm add @aws-sdk/client-acm
Getting Started
Import
The 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:
const { ACMClient, ListCertificatesCommand } = require("@aws-sdk/client-acm");
import { ACMClient, ListCertificatesCommand } from "@aws-sdk/client-acm";
Usage
To send a request:
- Instantiate a client with configuration (e.g. credentials, region).
- Instantiate a command with input parameters.
- Call the
send operation on the client, providing the command object as input.
const client = new ACMClient({ region: "REGION" });
const params = { };
const command = new ListCertificatesCommand(params);
Async/await
We recommend using the await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Promises
You can also use Promise chaining.
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Aggregated client
The aggregated client class is exported from the same package, but without the "Client" suffix.
ACM extends ACMClient and additionally supports all operations, waiters, and paginators as methods.
This style may be familiar to you from the AWS SDK for JavaScript v2.
If you are bundling the AWS SDK, we recommend using only the bare-bones client (ACMClient).
More details are in the blog post on
modular packages in AWS SDK for JavaScript.
import { ACM } from "@aws-sdk/client-acm";
const client = new ACM({ region: "REGION" });
try {
const data = await client.listCertificates(params);
} catch (error) {
}
client
.listCertificates(params)
.then((data) => {
})
.catch((error) => {
});
client.listCertificates(params, (err, 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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
See also docs/ERROR_HANDLING.
Getting Help
Please use these community resources for getting help.
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
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-acm 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)
AddTagsToCertificate
Command API Reference / Input / Output
DeleteCertificate
Command API Reference / Input / Output
DescribeCertificate
Command API Reference / Input / Output
ExportCertificate
Command API Reference / Input / Output
GetAccountConfiguration
Command API Reference / Input / Output
GetCertificate
Command API Reference / Input / Output
ImportCertificate
Command API Reference / Input / Output
ListCertificates
Command API Reference / Input / Output
ListTagsForCertificate
Command API Reference / Input / Output
PutAccountConfiguration
Command API Reference / Input / Output
RemoveTagsFromCertificate
Command API Reference / Input / Output
RenewCertificate
Command API Reference / Input / Output
RequestCertificate
Command API Reference / Input / Output
ResendValidationEmail
Command API Reference / Input / Output
RevokeCertificate
Command API Reference / Input / Output
SearchCertificates
Command API Reference / Input / Output
UpdateCertificateOptions
Command API Reference / Input / Output