@aws-sdk/client-acm-pca 3.53.0 → 3.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +13 -14
- package/dist-cjs/ACMPCAClient.js +13 -13
- package/dist-cjs/commands/CreateCertificateAuthorityAuditReportCommand.js +3 -3
- package/dist-cjs/commands/CreateCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/commands/CreatePermissionCommand.js +3 -3
- package/dist-cjs/commands/DeleteCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/commands/DeletePermissionCommand.js +3 -3
- package/dist-cjs/commands/DeletePolicyCommand.js +3 -3
- package/dist-cjs/commands/DescribeCertificateAuthorityAuditReportCommand.js +3 -3
- package/dist-cjs/commands/DescribeCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/commands/GetCertificateAuthorityCertificateCommand.js +3 -3
- package/dist-cjs/commands/GetCertificateAuthorityCsrCommand.js +3 -3
- package/dist-cjs/commands/GetCertificateCommand.js +3 -3
- package/dist-cjs/commands/GetPolicyCommand.js +3 -3
- package/dist-cjs/commands/ImportCertificateAuthorityCertificateCommand.js +3 -3
- package/dist-cjs/commands/IssueCertificateCommand.js +3 -3
- package/dist-cjs/commands/ListCertificateAuthoritiesCommand.js +3 -3
- package/dist-cjs/commands/ListPermissionsCommand.js +3 -3
- package/dist-cjs/commands/ListTagsCommand.js +3 -3
- package/dist-cjs/commands/PutPolicyCommand.js +3 -3
- package/dist-cjs/commands/RestoreCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/commands/RevokeCertificateCommand.js +3 -3
- package/dist-cjs/commands/TagCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/commands/UntagCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/commands/UpdateCertificateAuthorityCommand.js +3 -3
- package/dist-cjs/endpoints.js +1 -1
- package/dist-cjs/models/models_0.js +14 -2
- package/dist-cjs/protocols/Aws_json1_1.js +204 -141
- package/dist-cjs/runtimeConfig.browser.js +4 -4
- package/dist-cjs/runtimeConfig.js +9 -9
- package/dist-cjs/runtimeConfig.native.js +1 -1
- package/dist-cjs/waiters/waitForAuditReportCreated.js +3 -3
- package/dist-cjs/waiters/waitForCertificateAuthorityCSRCreated.js +3 -3
- package/dist-cjs/waiters/waitForCertificateIssued.js +3 -3
- package/dist-es/ACMPCA.js +23 -23
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/pagination/ListCertificateAuthoritiesPaginator.js +4 -4
- package/dist-es/pagination/ListPermissionsPaginator.js +4 -4
- package/dist-es/pagination/ListTagsPaginator.js +4 -4
- package/dist-es/protocols/Aws_json1_1.js +56 -2
- package/dist-types/ACMPCA.d.ts +110 -111
- package/dist-types/ACMPCAClient.d.ts +15 -16
- package/dist-types/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +10 -10
- package/dist-types/commands/CreateCertificateAuthorityCommand.d.ts +15 -15
- package/dist-types/commands/CreatePermissionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteCertificateAuthorityCommand.d.ts +2 -2
- package/dist-types/commands/DeletePermissionCommand.d.ts +4 -4
- package/dist-types/commands/DeletePolicyCommand.d.ts +9 -9
- package/dist-types/commands/DescribeCertificateAuthorityCommand.d.ts +4 -4
- package/dist-types/commands/GetCertificateAuthorityCsrCommand.d.ts +3 -3
- package/dist-types/commands/GetPolicyCommand.d.ts +7 -7
- package/dist-types/commands/ImportCertificateAuthorityCertificateCommand.d.ts +10 -10
- package/dist-types/commands/IssueCertificateCommand.d.ts +1 -1
- package/dist-types/commands/ListPermissionsCommand.d.ts +3 -3
- package/dist-types/commands/PutPolicyCommand.d.ts +8 -8
- package/dist-types/commands/RevokeCertificateCommand.d.ts +13 -13
- package/dist-types/commands/TagCertificateAuthorityCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCertificateAuthorityCommand.d.ts +4 -4
- package/dist-types/models/models_0.d.ts +194 -85
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +3 -3
- package/dist-types/ts3.4/ACMPCAClient.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +28 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
- package/package.json +35 -35
package/dist-types/ACMPCA.d.ts
CHANGED
|
@@ -24,77 +24,76 @@ import { TagCertificateAuthorityCommandInput, TagCertificateAuthorityCommandOutp
|
|
|
24
24
|
import { UntagCertificateAuthorityCommandInput, UntagCertificateAuthorityCommandOutput } from "./commands/UntagCertificateAuthorityCommand";
|
|
25
25
|
import { UpdateCertificateAuthorityCommandInput, UpdateCertificateAuthorityCommandOutput } from "./commands/UpdateCertificateAuthorityCommand";
|
|
26
26
|
/**
|
|
27
|
-
* <p>This is the <i>
|
|
27
|
+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
28
28
|
* syntax, and usage examples for each of the actions and data types involved in creating
|
|
29
|
-
* and managing private certificate
|
|
30
|
-
* <p>The documentation for each action shows the
|
|
31
|
-
* response. Alternatively, you can use one of the
|
|
32
|
-
* tailored to the programming language or platform that you
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* 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
|
|
29
|
+
* and managing a private certificate authority (CA) for your organization.</p>
|
|
30
|
+
* <p>The documentation for each action shows the API request parameters and the JSON
|
|
31
|
+
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
32
|
+
* tailored to the programming language or platform that you prefer. For more information,
|
|
33
|
+
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
34
|
+
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
35
|
+
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
36
|
+
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
37
|
+
* request because the request exceeds the operation's quota for the number of requests per
|
|
38
|
+
* 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
|
|
40
39
|
* rate for APIs. </p>
|
|
41
40
|
*
|
|
42
|
-
* <p>To see an up-to-date list of your
|
|
43
|
-
* log into your
|
|
41
|
+
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
42
|
+
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
44
43
|
* console.</p>
|
|
45
44
|
*/
|
|
46
45
|
export declare class ACMPCA extends ACMPCAClient {
|
|
47
46
|
/**
|
|
48
47
|
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
|
|
49
|
-
* CA configuration, an optional configuration for Online Certificate Status Protocol
|
|
50
|
-
* and/or a certificate revocation list (CRL), the CA type, and
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* <p>
|
|
48
|
+
* CA configuration, an optional configuration for Online Certificate Status Protocol
|
|
49
|
+
* (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
|
|
50
|
+
* idempotency token to avoid accidental creation of multiple CAs. The CA configuration
|
|
51
|
+
* specifies the name of the algorithm and key size to be used to create the CA private
|
|
52
|
+
* key, the type of signing algorithm that the CA uses, and X.500 subject information. The
|
|
53
|
+
* OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL
|
|
54
|
+
* configuration specifies the CRL expiration period in days (the validity period of the
|
|
55
|
+
* CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
|
|
56
|
+
* bucket that is included in certificates issued by the CA. If successful, this action
|
|
57
|
+
* returns the Amazon Resource Name (ARN) of the CA.</p>
|
|
58
|
+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
60
59
|
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
|
|
61
60
|
* CRLs</a>.</p>
|
|
62
|
-
*
|
|
61
|
+
* <note>
|
|
63
62
|
* <p>Both PCA and the IAM principal must have permission to write to
|
|
64
63
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
65
64
|
* does not have permission to write to the bucket, then an exception is
|
|
66
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/
|
|
67
|
-
*
|
|
68
|
-
*
|
|
65
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
66
|
+
* policies for CRLs in Amazon S3</a>.</p>
|
|
67
|
+
* </note>
|
|
69
68
|
*/
|
|
70
69
|
createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<CreateCertificateAuthorityCommandOutput>;
|
|
71
70
|
createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void): void;
|
|
72
71
|
createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void): void;
|
|
73
72
|
/**
|
|
74
|
-
* <p>Creates an audit report that lists every time that your CA private key is used. The
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* 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
|
|
73
|
+
* <p>Creates an audit report that lists every time that your CA private key is used. The report
|
|
74
|
+
* 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
|
|
78
75
|
* the private key. </p>
|
|
79
|
-
*
|
|
76
|
+
* <note>
|
|
80
77
|
* <p>Both PCA and the IAM principal must have permission to write to
|
|
81
78
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
82
79
|
* does not have permission to write to the bucket, then an exception is
|
|
83
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
80
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
81
|
+
* policies for CRLs in Amazon S3</a>.</p>
|
|
82
|
+
* </note>
|
|
83
|
+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
88
84
|
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
|
|
89
85
|
* Reports</a>.</p>
|
|
86
|
+
* <note>
|
|
87
|
+
* <p>You can generate a maximum of one report every 30 minutes.</p>
|
|
88
|
+
* </note>
|
|
90
89
|
*/
|
|
91
90
|
createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, options?: __HttpHandlerOptions): Promise<CreateCertificateAuthorityAuditReportCommandOutput>;
|
|
92
91
|
createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void): void;
|
|
93
92
|
createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void): void;
|
|
94
93
|
/**
|
|
95
|
-
* <p>Grants one or more permissions on a private CA to the
|
|
94
|
+
* <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
|
|
96
95
|
* principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
|
|
97
|
-
* renew ACM certificates that reside in the same
|
|
96
|
+
* renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
|
|
98
97
|
* <p>You can list current permissions with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action and
|
|
99
98
|
* revoke them with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
|
|
100
99
|
* <p class="title">
|
|
@@ -116,7 +115,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
116
115
|
* the ACM certificate owner must set up a resource-based policy to enable
|
|
117
116
|
* cross-account issuance and renewals. For more information, see
|
|
118
117
|
* <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource
|
|
119
|
-
* Based Policy with
|
|
118
|
+
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
120
119
|
* </li>
|
|
121
120
|
* </ul>
|
|
122
121
|
*/
|
|
@@ -135,8 +134,8 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
135
134
|
* 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>
|
|
136
135
|
* <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
|
|
137
136
|
* the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
|
|
138
|
-
* been created but you haven't yet imported the signed certificate into
|
|
139
|
-
* the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
|
|
137
|
+
* been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
|
|
138
|
+
* is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
|
|
140
139
|
* <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
|
|
141
140
|
* <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
|
|
142
141
|
* period has passed. By default, if you do not set the
|
|
@@ -149,14 +148,14 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
149
148
|
deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void): void;
|
|
150
149
|
deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void): void;
|
|
151
150
|
/**
|
|
152
|
-
* <p>Revokes permissions on a private CA granted to the
|
|
151
|
+
* <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
|
|
153
152
|
* (acm.amazonaws.com). </p>
|
|
154
153
|
* <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
|
|
155
|
-
* same
|
|
154
|
+
* same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer
|
|
156
155
|
* renew the affected certificates automatically.</p>
|
|
157
156
|
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
|
|
158
157
|
* listed with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p>
|
|
159
|
-
*
|
|
158
|
+
* <p class="title">
|
|
160
159
|
* <b>About Permissions</b>
|
|
161
160
|
* </p>
|
|
162
161
|
* <ul>
|
|
@@ -175,7 +174,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
175
174
|
* the ACM certificate owner must set up a resource-based policy to enable
|
|
176
175
|
* cross-account issuance and renewals. For more information, see
|
|
177
176
|
* <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource
|
|
178
|
-
* Based Policy with
|
|
177
|
+
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
179
178
|
* </li>
|
|
180
179
|
* </ul>
|
|
181
180
|
*/
|
|
@@ -186,9 +185,9 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
186
185
|
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
|
|
187
186
|
* access that the policy has granted. If there is no policy attached to the private CA,
|
|
188
187
|
* this action will return successful.</p>
|
|
189
|
-
* <p>If you delete a policy that was applied through
|
|
190
|
-
* CA will be removed from all shares in which it was included. </p>
|
|
191
|
-
* <p>The
|
|
188
|
+
* <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),
|
|
189
|
+
* the CA will be removed from all shares in which it was included. </p>
|
|
190
|
+
* <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you
|
|
192
191
|
* delete the policy. </p>
|
|
193
192
|
* <p>The current policy can be shown with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html">GetPolicy</a> and updated with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.</p>
|
|
194
193
|
* <p class="title">
|
|
@@ -196,24 +195,24 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
196
195
|
* </p>
|
|
197
196
|
* <ul>
|
|
198
197
|
* <li>
|
|
199
|
-
* <p>A policy grants access on a private CA to an
|
|
200
|
-
* an
|
|
201
|
-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with
|
|
198
|
+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
199
|
+
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
200
|
+
* 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>
|
|
202
201
|
* </li>
|
|
203
202
|
* <li>
|
|
204
|
-
* <p>A policy permits a user of
|
|
203
|
+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
205
204
|
* signed by a CA in another account.</p>
|
|
206
205
|
* </li>
|
|
207
206
|
* <li>
|
|
208
207
|
* <p>For ACM to manage automatic renewal of these certificates,
|
|
209
208
|
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
210
209
|
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
211
|
-
*
|
|
210
|
+
* Amazon Web Services Private CA policy. For more information, see
|
|
212
211
|
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
213
212
|
* Service Linked Role with ACM</a>.</p>
|
|
214
213
|
* </li>
|
|
215
214
|
* <li>
|
|
216
|
-
* <p>Updates made in
|
|
215
|
+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
217
216
|
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
218
217
|
* Access</a>.</p>
|
|
219
218
|
* </li>
|
|
@@ -229,14 +228,14 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
229
228
|
* <ul>
|
|
230
229
|
* <li>
|
|
231
230
|
* <p>
|
|
232
|
-
* <code>CREATING</code> -
|
|
231
|
+
* <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
|
|
233
232
|
* authority.</p>
|
|
234
233
|
* </li>
|
|
235
234
|
* <li>
|
|
236
235
|
* <p>
|
|
237
236
|
* <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use
|
|
238
|
-
* your
|
|
239
|
-
* CSR and then import it into PCA. </p>
|
|
237
|
+
* your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your
|
|
238
|
+
* private CA CSR and then import it into PCA. </p>
|
|
240
239
|
* </li>
|
|
241
240
|
* <li>
|
|
242
241
|
* <p>
|
|
@@ -253,7 +252,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
253
252
|
* <li>
|
|
254
253
|
* <p>
|
|
255
254
|
* <code>FAILED</code> - Your private CA has failed. Your CA can fail because of
|
|
256
|
-
* problems such a network outage or back-end
|
|
255
|
+
* problems such a network outage or back-end Amazon Web Services failure or other errors. A
|
|
257
256
|
* failed CA can never return to the pending state. You must create a new CA.
|
|
258
257
|
* </p>
|
|
259
258
|
* </li>
|
|
@@ -301,9 +300,9 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
301
300
|
getCertificateAuthorityCertificate(args: GetCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void): void;
|
|
302
301
|
/**
|
|
303
302
|
* <p>Retrieves the certificate signing request (CSR) for your private certificate authority
|
|
304
|
-
* (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
|
|
305
|
-
* on-premises root or subordinate CA. Then import the signed certificate back into
|
|
306
|
-
* 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
|
|
303
|
+
* (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
|
|
304
|
+
* or on-premises root or subordinate CA. Then import the signed certificate back into
|
|
305
|
+
* 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
|
|
307
306
|
* base64 PEM-encoded string. </p>
|
|
308
307
|
*/
|
|
309
308
|
getCertificateAuthorityCsr(args: GetCertificateAuthorityCsrCommandInput, options?: __HttpHandlerOptions): Promise<GetCertificateAuthorityCsrCommandOutput>;
|
|
@@ -314,29 +313,29 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
314
313
|
* resource or the policy cannot be found, this action returns a
|
|
315
314
|
* <code>ResourceNotFoundException</code>. </p>
|
|
316
315
|
* <p>The policy can be attached or updated with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html">PutPolicy</a> and removed with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.</p>
|
|
317
|
-
*
|
|
316
|
+
* <p class="title">
|
|
318
317
|
* <b>About Policies</b>
|
|
319
318
|
* </p>
|
|
320
319
|
* <ul>
|
|
321
320
|
* <li>
|
|
322
|
-
* <p>A policy grants access on a private CA to an
|
|
323
|
-
* an
|
|
324
|
-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with
|
|
321
|
+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
322
|
+
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
323
|
+
* 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>
|
|
325
324
|
* </li>
|
|
326
325
|
* <li>
|
|
327
|
-
* <p>A policy permits a user of
|
|
326
|
+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
328
327
|
* signed by a CA in another account.</p>
|
|
329
328
|
* </li>
|
|
330
329
|
* <li>
|
|
331
330
|
* <p>For ACM to manage automatic renewal of these certificates,
|
|
332
331
|
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
333
332
|
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
334
|
-
*
|
|
333
|
+
* Amazon Web Services Private CA policy. For more information, see
|
|
335
334
|
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
336
335
|
* Service Linked Role with ACM</a>.</p>
|
|
337
336
|
* </li>
|
|
338
337
|
* <li>
|
|
339
|
-
* <p>Updates made in
|
|
338
|
+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
340
339
|
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
341
340
|
* Access</a>.</p>
|
|
342
341
|
* </li>
|
|
@@ -346,12 +345,12 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
346
345
|
getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
|
|
347
346
|
getPolicy(args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
|
|
348
347
|
/**
|
|
349
|
-
* <p>Imports a signed private CA certificate into
|
|
350
|
-
* using a chain of trust whose root is located outside
|
|
351
|
-
* action, the following preparations must in place:</p>
|
|
348
|
+
* <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
|
|
349
|
+
* are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
|
|
350
|
+
* this action, the following preparations must in place:</p>
|
|
352
351
|
* <ol>
|
|
353
352
|
* <li>
|
|
354
|
-
* <p>In
|
|
353
|
+
* <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
|
|
355
354
|
* plan to back with the imported certificate.</p>
|
|
356
355
|
* </li>
|
|
357
356
|
* <li>
|
|
@@ -367,14 +366,14 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
367
366
|
* chain to your working directory.</p>
|
|
368
367
|
* </li>
|
|
369
368
|
* </ol>
|
|
370
|
-
* <p>
|
|
369
|
+
* <p>Amazon Web Services Private CA supports three scenarios for installing a CA certificate:</p>
|
|
371
370
|
* <ul>
|
|
372
371
|
* <li>
|
|
373
|
-
* <p>Installing a certificate for a root CA hosted by
|
|
372
|
+
* <p>Installing a certificate for a root CA hosted by Amazon Web Services Private CA.</p>
|
|
374
373
|
* </li>
|
|
375
374
|
* <li>
|
|
376
375
|
* <p>Installing a subordinate CA certificate whose parent authority is hosted by
|
|
377
|
-
*
|
|
376
|
+
* Amazon Web Services Private CA.</p>
|
|
378
377
|
* </li>
|
|
379
378
|
* <li>
|
|
380
379
|
* <p>Installing a subordinate CA certificate whose parent authority is externally
|
|
@@ -412,7 +411,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
412
411
|
* <p>
|
|
413
412
|
* <i>Enforcement of Critical Constraints</i>
|
|
414
413
|
* </p>
|
|
415
|
-
* <p>
|
|
414
|
+
* <p>Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA
|
|
416
415
|
* certificate or chain.</p>
|
|
417
416
|
* <ul>
|
|
418
417
|
* <li>
|
|
@@ -452,8 +451,8 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
452
451
|
* <p>Inhibit anyPolicy</p>
|
|
453
452
|
* </li>
|
|
454
453
|
* </ul>
|
|
455
|
-
* <p>
|
|
456
|
-
* certificate or chain.</p>
|
|
454
|
+
* <p>Amazon Web Services Private CA rejects the following extensions when they are marked critical in an
|
|
455
|
+
* imported CA certificate or chain.</p>
|
|
457
456
|
* <ul>
|
|
458
457
|
* <li>
|
|
459
458
|
* <p>Name constraints</p>
|
|
@@ -485,7 +484,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
485
484
|
* specifying the ARN. </p>
|
|
486
485
|
* <note>
|
|
487
486
|
* <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the
|
|
488
|
-
* certificates that you issue by using
|
|
487
|
+
* certificates that you issue by using Amazon Web Services Private CA.</p>
|
|
489
488
|
* </note>
|
|
490
489
|
*/
|
|
491
490
|
issueCertificate(args: IssueCertificateCommandInput, options?: __HttpHandlerOptions): Promise<IssueCertificateCommandOutput>;
|
|
@@ -498,10 +497,10 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
498
497
|
listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void): void;
|
|
499
498
|
listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void): void;
|
|
500
499
|
/**
|
|
501
|
-
* <p>List all permissions on a private CA, if any, granted to the
|
|
500
|
+
* <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service
|
|
502
501
|
* principal (acm.amazonaws.com). </p>
|
|
503
502
|
* <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
|
|
504
|
-
* same
|
|
503
|
+
* same Amazon Web Services account as the CA. </p>
|
|
505
504
|
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
|
|
506
505
|
* revoked with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
|
|
507
506
|
* <p class="title">
|
|
@@ -523,7 +522,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
523
522
|
* the ACM certificate owner must set up a resource-based policy to enable
|
|
524
523
|
* cross-account issuance and renewals. For more information, see
|
|
525
524
|
* <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource
|
|
526
|
-
* Based Policy with
|
|
525
|
+
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
527
526
|
* </li>
|
|
528
527
|
* </ul>
|
|
529
528
|
*/
|
|
@@ -541,33 +540,33 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
541
540
|
listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
|
|
542
541
|
/**
|
|
543
542
|
* <p>Attaches a resource-based policy to a private CA. </p>
|
|
544
|
-
* <p>A policy can also be applied by sharing a private CA through
|
|
543
|
+
* <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access
|
|
545
544
|
* Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
546
545
|
* Access</a>.</p>
|
|
547
546
|
* <p>The policy can be displayed with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html">GetPolicy</a> and removed with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.</p>
|
|
548
|
-
*
|
|
547
|
+
* <p class="title">
|
|
549
548
|
* <b>About Policies</b>
|
|
550
549
|
* </p>
|
|
551
550
|
* <ul>
|
|
552
551
|
* <li>
|
|
553
|
-
* <p>A policy grants access on a private CA to an
|
|
554
|
-
* an
|
|
555
|
-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with
|
|
552
|
+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
553
|
+
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
554
|
+
* 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>
|
|
556
555
|
* </li>
|
|
557
556
|
* <li>
|
|
558
|
-
* <p>A policy permits a user of
|
|
557
|
+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
559
558
|
* signed by a CA in another account.</p>
|
|
560
559
|
* </li>
|
|
561
560
|
* <li>
|
|
562
561
|
* <p>For ACM to manage automatic renewal of these certificates,
|
|
563
562
|
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
564
563
|
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
565
|
-
*
|
|
564
|
+
* Amazon Web Services Private CA policy. For more information, see
|
|
566
565
|
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
567
566
|
* Service Linked Role with ACM</a>.</p>
|
|
568
567
|
* </li>
|
|
569
568
|
* <li>
|
|
570
|
-
* <p>Updates made in
|
|
569
|
+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
571
570
|
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
572
571
|
* Access</a>.</p>
|
|
573
572
|
* </li>
|
|
@@ -593,23 +592,23 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
593
592
|
restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void): void;
|
|
594
593
|
restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void): void;
|
|
595
594
|
/**
|
|
596
|
-
* <p>Revokes a certificate that was issued inside
|
|
595
|
+
* <p>Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate
|
|
597
596
|
* revocation list (CRL) when you create or update your private CA, information about the
|
|
598
|
-
* revoked certificates will be included in the CRL.
|
|
599
|
-
* that you specify. A CRL is typically updated approximately 30 minutes after a
|
|
600
|
-
* certificate is revoked. If for any reason the CRL update fails,
|
|
601
|
-
* further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms
|
|
602
|
-
* metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For
|
|
603
|
-
* information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html">Supported CloudWatch Metrics</a>.</p>
|
|
604
|
-
*
|
|
597
|
+
* revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3
|
|
598
|
+
* bucket that you specify. A CRL is typically updated approximately 30 minutes after a
|
|
599
|
+
* certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts
|
|
600
|
+
* makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms
|
|
601
|
+
* for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For
|
|
602
|
+
* more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html">Supported CloudWatch Metrics</a>.</p>
|
|
603
|
+
* <note>
|
|
605
604
|
* <p>Both PCA and the IAM principal must have permission to write to
|
|
606
605
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
607
606
|
* does not have permission to write to the bucket, then an exception is
|
|
608
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
*
|
|
607
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
608
|
+
* policies for CRLs in Amazon S3</a>.</p>
|
|
609
|
+
* </note>
|
|
610
|
+
* <p>Amazon Web Services Private CA also writes revocation information to the audit report. For more
|
|
611
|
+
* information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.</p>
|
|
613
612
|
* <note>
|
|
614
613
|
* <p>You cannot revoke a root CA self-signed certificate.</p>
|
|
615
614
|
* </note>
|
|
@@ -619,7 +618,7 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
619
618
|
revokeCertificate(args: RevokeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeCertificateCommandOutput) => void): void;
|
|
620
619
|
/**
|
|
621
620
|
* <p>Adds one or more tags to your private CA. Tags are labels that you can use to identify
|
|
622
|
-
* and organize your
|
|
621
|
+
* and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You
|
|
623
622
|
* specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag
|
|
624
623
|
* by using a key-value pair. You can apply a tag to just one private CA if you want to
|
|
625
624
|
* identify a specific characteristic of that CA, or you can apply the same tag to multiple
|
|
@@ -645,13 +644,13 @@ export declare class ACMPCA extends ACMPCAClient {
|
|
|
645
644
|
* private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you
|
|
646
645
|
* can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or
|
|
647
646
|
* make a CA that is in the <code>DISABLED</code> state active again.</p>
|
|
648
|
-
*
|
|
647
|
+
* <note>
|
|
649
648
|
* <p>Both PCA and the IAM principal must have permission to write to
|
|
650
649
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
651
650
|
* does not have permission to write to the bucket, then an exception is
|
|
652
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/
|
|
653
|
-
*
|
|
654
|
-
*
|
|
651
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
652
|
+
* policies for CRLs in Amazon S3</a>.</p>
|
|
653
|
+
* </note>
|
|
655
654
|
*/
|
|
656
655
|
updateCertificateAuthority(args: UpdateCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCertificateAuthorityCommandOutput>;
|
|
657
656
|
updateCertificateAuthority(args: UpdateCertificateAuthorityCommandInput, cb: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void): void;
|
|
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
|
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
7
|
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
|
-
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
8
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { CreateCertificateAuthorityAuditReportCommandInput, CreateCertificateAuthorityAuditReportCommandOutput } from "./commands/CreateCertificateAuthorityAuditReportCommand";
|
|
10
10
|
import { CreateCertificateAuthorityCommandInput, CreateCertificateAuthorityCommandOutput } from "./commands/CreateCertificateAuthorityCommand";
|
|
11
11
|
import { CreatePermissionCommandInput, CreatePermissionCommandOutput } from "./commands/CreatePermissionCommand";
|
|
@@ -51,7 +51,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
51
51
|
* A function that can calculate the length of a request body.
|
|
52
52
|
* @internal
|
|
53
53
|
*/
|
|
54
|
-
bodyLengthChecker?:
|
|
54
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
55
55
|
/**
|
|
56
56
|
* A function that converts a stream into an array of bytes.
|
|
57
57
|
* @internal
|
|
@@ -149,23 +149,22 @@ declare type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
|
|
|
149
149
|
export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* <p>This is the <i>
|
|
152
|
+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
153
153
|
* syntax, and usage examples for each of the actions and data types involved in creating
|
|
154
|
-
* and managing private certificate
|
|
155
|
-
* <p>The documentation for each action shows the
|
|
156
|
-
* response. Alternatively, you can use one of the
|
|
157
|
-
* tailored to the programming language or platform that you
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
* 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
|
|
154
|
+
* and managing a private certificate authority (CA) for your organization.</p>
|
|
155
|
+
* <p>The documentation for each action shows the API request parameters and the JSON
|
|
156
|
+
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
157
|
+
* tailored to the programming language or platform that you prefer. For more information,
|
|
158
|
+
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
159
|
+
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
160
|
+
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
161
|
+
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
162
|
+
* request because the request exceeds the operation's quota for the number of requests per
|
|
163
|
+
* 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
|
|
165
164
|
* rate for APIs. </p>
|
|
166
165
|
*
|
|
167
|
-
* <p>To see an up-to-date list of your
|
|
168
|
-
* log into your
|
|
166
|
+
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
167
|
+
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
169
168
|
* console.</p>
|
|
170
169
|
*/
|
|
171
170
|
export declare class ACMPCAClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ACMPCAClientResolvedConfig> {
|
|
@@ -7,22 +7,22 @@ export interface CreateCertificateAuthorityAuditReportCommandInput extends Creat
|
|
|
7
7
|
export interface CreateCertificateAuthorityAuditReportCommandOutput extends CreateCertificateAuthorityAuditReportResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an audit report that lists every time that your CA private key is used. The
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* 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
|
|
10
|
+
* <p>Creates an audit report that lists every time that your CA private key is used. The report
|
|
11
|
+
* 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
|
|
14
12
|
* the private key. </p>
|
|
15
|
-
*
|
|
13
|
+
* <note>
|
|
16
14
|
* <p>Both PCA and the IAM principal must have permission to write to
|
|
17
15
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
18
16
|
* does not have permission to write to the bucket, then an exception is
|
|
19
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
17
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
18
|
+
* policies for CRLs in Amazon S3</a>.</p>
|
|
19
|
+
* </note>
|
|
20
|
+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
24
21
|
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
|
|
25
22
|
* Reports</a>.</p>
|
|
23
|
+
* <note>
|
|
24
|
+
* <p>You can generate a maximum of one report every 30 minutes.</p>
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|