You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-acm-pca/README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -7,21 +7,21 @@
7
7
8
8
AWS SDK for JavaScript ACMPCA Client for Node.js, Browser and React Native.
9
9
10
-
<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
10
+
<p>This is the <i>Certificate Manager Private Certificate Authority (PCA) API Reference</i>. It provides descriptions,
11
11
syntax, and usage examples for each of the actions and data types involved in creating
12
12
and managing a private certificate authority (CA) for your organization.</p>
13
13
<p>The documentation for each action shows the API request parameters and the JSON
14
14
response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
15
15
tailored to the programming language or platform that you prefer. For more information,
16
16
see <ahref="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
17
-
<p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
18
-
operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
19
-
depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
17
+
<p>Each ACM Private CA API operation has a quota that determines the number of times the
18
+
operation can be called per second. ACM Private CA throttles API requests at different rates
19
+
depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid
20
20
request because the request exceeds the operation's quota for the number of requests per
21
-
second. When a request is throttled, Amazon Web Services Private CA returns a <ahref="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
21
+
second. When a request is throttled, ACM Private CA returns a <ahref="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
22
22
rate for APIs. </p>
23
23
24
-
<p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
24
+
<p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
25
25
log into your Amazon Web Services account and visit the <ahref="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
322
+
* <p>This is the <i>Certificate Manager Private Certificate Authority (PCA) API Reference</i>. It provides descriptions,
323
323
* syntax, and usage examples for each of the actions and data types involved in creating
324
324
* and managing a private certificate authority (CA) for your organization.</p>
325
325
* <p>The documentation for each action shows the API request parameters and the JSON
326
326
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
327
327
* tailored to the programming language or platform that you prefer. For more information,
328
328
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
329
-
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
330
-
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
331
-
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
329
+
* <p>Each ACM Private CA API operation has a quota that determines the number of times the
330
+
* operation can be called per second. ACM Private CA throttles API requests at different rates
331
+
* depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid
332
332
* request because the request exceeds the operation's quota for the number of requests per
333
-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
333
+
* second. When a request is throttled, ACM Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
334
334
* rate for APIs. </p>
335
335
*
336
-
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
336
+
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
337
337
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
* <p>Creates an audit report that lists every time that your CA private key is used. The report
32
-
* is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
31
+
* <p>Creates an audit report that lists every time that your CA private key is used. The
32
+
* report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
33
33
* the private key. </p>
34
34
* <note>
35
35
* <p>Both PCA and the IAM principal must have permission to write to
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
39
39
* policies for CRLs in Amazon S3</a>.</p>
40
40
* </note>
41
-
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
41
+
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
42
42
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
* To do this, call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>. </p>
34
34
* <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
35
35
* the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
36
-
* been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
36
+
* been created but you haven't yet imported the signed certificate into ACM Private CA (that
37
37
* is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
38
38
* <p>When you successfully call <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>, the CA's status changes to
39
39
* <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
39
39
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
40
-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private CA</a>.</p>
40
+
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with ACM Private CA</a>.</p>
41
41
* </li>
42
42
* <li>
43
43
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
* <p>Retrieves the certificate signing request (CSR) for your private certificate authority
26
-
* (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. Sign the CSR with your Amazon Web Services Private CA-hosted
26
+
* (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. Sign the CSR with your ACM Private CA-hosted
27
27
* or on-premises root or subordinate CA. Then import the signed certificate back into
28
-
* Amazon Web Services Private CA by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action. The CSR is returned as a
28
+
* ACM Private CA by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action. The CSR is returned as a
29
29
* base64 PEM-encoded string. </p>
30
30
* @example
31
31
* Use a bare-bones client and the command you need to make an API call.
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
32
32
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
33
-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private CA</a>.</p>
33
+
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with ACM Private CA</a>.</p>
34
34
* </li>
35
35
* <li>
36
36
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
* <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
27
-
* are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
26
+
* <p>Imports a signed private CA certificate into ACM Private CA. This action is used when you
27
+
* are using a chain of trust whose root is located outside ACM Private CA. Before you can call
28
28
* this action, the following preparations must in place:</p>
29
29
* <ol>
30
30
* <li>
31
-
* <p>In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action to create the private CA that you
31
+
* <p>In ACM Private CA, call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action to create the private CA that you
0 commit comments