@aws-sdk/client-acm-pca

Description

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

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { ACMPCAClient, ListTagsCommand } = require("@aws-sdk/client-acm-pca");
`

`ts
// ES6+ example
import { ACMPCAClient, ListTagsCommand } from "@aws-sdk/client-acm-pca";
`

$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 ACMPCAClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListTagsCommand(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-acm-pca";
const client = new AWS.ACMPCA({ region: "REGION" });

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

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

// callbacks.
client.listTags(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-acm-pca` 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)

CreateCertificateAuthority

Command API Reference / Input / Output

CreateCertificateAuthorityAuditReport

Command API Reference / Input / Output

CreatePermission

Command API Reference / Input / Output

DeleteCertificateAuthority

Command API Reference / Input / Output

DeletePermission

Command API Reference / Input / Output

DeletePolicy

Command API Reference / Input / Output

DescribeCertificateAuthority

Command API Reference / Input / Output

DescribeCertificateAuthorityAuditReport

Command API Reference / Input / Output

GetCertificate

Command API Reference / Input / Output

GetCertificateAuthorityCertificate

Command API Reference / Input / Output

GetCertificateAuthorityCsr

Command API Reference / Input / Output

GetPolicy

Command API Reference / Input / Output

ImportCertificateAuthorityCertificate

Command API Reference / Input / Output

IssueCertificate

Command API Reference / Input / Output

ListCertificateAuthorities

Command API Reference / Input / Output

ListPermissions

Command API Reference / Input / Output

ListTags

Command API Reference / Input / Output

PutPolicy

Command API Reference / Input / Output

RestoreCertificateAuthority

Command API Reference / Input / Output

RevokeCertificate

Command API Reference / Input / Output

TagCertificateAuthority

Command API Reference / Input / Output

UntagCertificateAuthority

Command API Reference / Input / Output

UpdateCertificateAuthority

Command API Reference / Input / Output