@aws-sdk/client-acm-pca 3.315.0 → 3.319.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.
@@ -23,666 +23,164 @@ import { RevokeCertificateCommandInput, RevokeCertificateCommandOutput } from ".
23
23
  import { TagCertificateAuthorityCommandInput, TagCertificateAuthorityCommandOutput } from "./commands/TagCertificateAuthorityCommand";
24
24
  import { UntagCertificateAuthorityCommandInput, UntagCertificateAuthorityCommandOutput } from "./commands/UntagCertificateAuthorityCommand";
25
25
  import { UpdateCertificateAuthorityCommandInput, UpdateCertificateAuthorityCommandOutput } from "./commands/UpdateCertificateAuthorityCommand";
26
- /**
27
- * @public
28
- * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
29
- * syntax, and usage examples for each of the actions and data types involved in creating
30
- * and managing a private certificate authority (CA) for your organization.</p>
31
- * <p>The documentation for each action shows the API request parameters and the JSON
32
- * response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
33
- * tailored to the programming language or platform that you prefer. For more information,
34
- * see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
35
- * <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
36
- * operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
37
- * depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
38
- * request because the request exceeds the operation's quota for the number of requests per
39
- * 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
- * rate for APIs. </p>
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>
43
- * console.</p>
44
- */
45
- export declare class ACMPCA extends ACMPCAClient {
26
+ export interface ACMPCA {
46
27
  /**
47
- * @public
48
- * <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
- * (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
51
- * idempotency token to avoid accidental creation of multiple CAs. The CA configuration
52
- * specifies the name of the algorithm and key size to be used to create the CA private
53
- * key, the type of signing algorithm that the CA uses, and X.500 subject information. The
54
- * OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL
55
- * configuration specifies the CRL expiration period in days (the validity period of the
56
- * CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
57
- * bucket that is included in certificates issued by the CA. If successful, this action
58
- * returns the Amazon Resource Name (ARN) of the CA.</p>
59
- * <note>
60
- * <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
61
- * the S3 bucket that you specify. If the IAM principal making the call
62
- * does not have permission to write to the bucket, then an exception is
63
- * thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
64
- * policies for CRLs in Amazon S3</a>.</p>
65
- * </note>
66
- * <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
67
- * For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
68
- * CRLs</a>.</p>
28
+ * @see {@link CreateCertificateAuthorityCommand}
69
29
  */
70
30
  createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<CreateCertificateAuthorityCommandOutput>;
71
31
  createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void): void;
72
32
  createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void): void;
73
33
  /**
74
- * @public
75
- * <p>Creates an audit report that lists every time that your CA private key is used. The
76
- * report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
77
- * the private key. </p>
78
- * <note>
79
- * <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
80
- * the S3 bucket that you specify. If the IAM principal making the call
81
- * does not have permission to write to the bucket, then an exception is
82
- * thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
83
- * policies for CRLs in Amazon S3</a>.</p>
84
- * </note>
85
- * <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
86
- * For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
87
- * Reports</a>.</p>
88
- * <note>
89
- * <p>You can generate a maximum of one report every 30 minutes.</p>
90
- * </note>
34
+ * @see {@link CreateCertificateAuthorityAuditReportCommand}
91
35
  */
92
36
  createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, options?: __HttpHandlerOptions): Promise<CreateCertificateAuthorityAuditReportCommandOutput>;
93
37
  createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void): void;
94
38
  createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void): void;
95
39
  /**
96
- * @public
97
- * <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
98
- * principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
99
- * renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
100
- * <p>You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action and
101
- * revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
102
- * <p class="title">
103
- * <b>About Permissions</b>
104
- * </p>
105
- * <ul>
106
- * <li>
107
- * <p>If the private CA and the certificates it issues reside in the same
108
- * account, you can use <code>CreatePermission</code> to grant permissions for ACM to
109
- * carry out automatic certificate renewals.</p>
110
- * </li>
111
- * <li>
112
- * <p>For automatic certificate renewal to succeed, the ACM service principal
113
- * needs permissions to create, retrieve, and list certificates.</p>
114
- * </li>
115
- * <li>
116
- * <p>If the private CA and the ACM certificates reside in different accounts,
117
- * then permissions cannot be used to enable automatic renewals. Instead,
118
- * the ACM certificate owner must set up a resource-based policy to enable
119
- * cross-account issuance and renewals. For more information, see
120
- * <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
121
- * Based Policy with Amazon Web Services Private CA</a>.</p>
122
- * </li>
123
- * </ul>
40
+ * @see {@link CreatePermissionCommand}
124
41
  */
125
42
  createPermission(args: CreatePermissionCommandInput, options?: __HttpHandlerOptions): Promise<CreatePermissionCommandOutput>;
126
43
  createPermission(args: CreatePermissionCommandInput, cb: (err: any, data?: CreatePermissionCommandOutput) => void): void;
127
44
  createPermission(args: CreatePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionCommandOutput) => void): void;
128
45
  /**
129
- * @public
130
- * <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource
131
- * Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
132
- * the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p>
133
- * <note>
134
- * <p>Deleting a CA will invalidate other CAs and certificates below it in your CA
135
- * hierarchy.</p>
136
- * </note>
137
- * <p>Before you can delete a CA that you have created and activated, you must disable it.
138
- * To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>. </p>
139
- * <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
140
- * the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
141
- * been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
142
- * is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
143
- * <p>When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>, the CA's status changes to
144
- * <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
145
- * period has passed. By default, if you do not set the
146
- * <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for 30
147
- * days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a> action returns the time remaining in the
148
- * restoration window of a private CA in the <code>DELETED</code> state. To restore an
149
- * eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a> action.</p>
46
+ * @see {@link DeleteCertificateAuthorityCommand}
150
47
  */
151
48
  deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCertificateAuthorityCommandOutput>;
152
49
  deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void): void;
153
50
  deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void): void;
154
51
  /**
155
- * @public
156
- * <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
157
- * (acm.amazonaws.com). </p>
158
- * <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
159
- * same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer
160
- * renew the affected certificates automatically.</p>
161
- * <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
162
- * listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p>
163
- * <p class="title">
164
- * <b>About Permissions</b>
165
- * </p>
166
- * <ul>
167
- * <li>
168
- * <p>If the private CA and the certificates it issues reside in the same
169
- * account, you can use <code>CreatePermission</code> to grant permissions for ACM to
170
- * carry out automatic certificate renewals.</p>
171
- * </li>
172
- * <li>
173
- * <p>For automatic certificate renewal to succeed, the ACM service principal
174
- * needs permissions to create, retrieve, and list certificates.</p>
175
- * </li>
176
- * <li>
177
- * <p>If the private CA and the ACM certificates reside in different accounts,
178
- * then permissions cannot be used to enable automatic renewals. Instead,
179
- * the ACM certificate owner must set up a resource-based policy to enable
180
- * cross-account issuance and renewals. For more information, see
181
- * <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
182
- * Based Policy with Amazon Web Services Private CA</a>.</p>
183
- * </li>
184
- * </ul>
52
+ * @see {@link DeletePermissionCommand}
185
53
  */
186
54
  deletePermission(args: DeletePermissionCommandInput, options?: __HttpHandlerOptions): Promise<DeletePermissionCommandOutput>;
187
55
  deletePermission(args: DeletePermissionCommandInput, cb: (err: any, data?: DeletePermissionCommandOutput) => void): void;
188
56
  deletePermission(args: DeletePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionCommandOutput) => void): void;
189
57
  /**
190
- * @public
191
- * <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
192
- * access that the policy has granted. If there is no policy attached to the private CA,
193
- * this action will return successful.</p>
194
- * <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),
195
- * the CA will be removed from all shares in which it was included. </p>
196
- * <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you
197
- * delete the policy. </p>
198
- * <p>The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a> and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.</p>
199
- * <p class="title">
200
- * <b>About Policies</b>
201
- * </p>
202
- * <ul>
203
- * <li>
204
- * <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
205
- * an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
206
- * see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private CA</a>.</p>
207
- * </li>
208
- * <li>
209
- * <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
210
- * signed by a CA in another account.</p>
211
- * </li>
212
- * <li>
213
- * <p>For ACM to manage automatic renewal of these certificates,
214
- * the ACM user must configure a Service Linked Role (SLR). The SLR allows
215
- * the ACM service to assume the identity of the user, subject to confirmation against the
216
- * Amazon Web Services Private CA policy. For more information, see
217
- * <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
218
- * Service Linked Role with ACM</a>.</p>
219
- * </li>
220
- * <li>
221
- * <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
222
- * see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
223
- * Access</a>.</p>
224
- * </li>
225
- * </ul>
58
+ * @see {@link DeletePolicyCommand}
226
59
  */
227
60
  deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeletePolicyCommandOutput>;
228
61
  deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void;
229
62
  deletePolicy(args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void;
230
63
  /**
231
- * @public
232
- * <p>Lists information about your private certificate authority (CA) or one that has been
233
- * shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
234
- * The output contains the status of your CA. This can be any of the following: </p>
235
- * <ul>
236
- * <li>
237
- * <p>
238
- * <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
239
- * authority.</p>
240
- * </li>
241
- * <li>
242
- * <p>
243
- * <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use
244
- * your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your
245
- * private CA CSR and then import it into Amazon Web Services Private CA. </p>
246
- * </li>
247
- * <li>
248
- * <p>
249
- * <code>ACTIVE</code> - Your private CA is active.</p>
250
- * </li>
251
- * <li>
252
- * <p>
253
- * <code>DISABLED</code> - Your private CA has been disabled.</p>
254
- * </li>
255
- * <li>
256
- * <p>
257
- * <code>EXPIRED</code> - Your private CA certificate has expired.</p>
258
- * </li>
259
- * <li>
260
- * <p>
261
- * <code>FAILED</code> - Your private CA has failed. Your CA can fail because of
262
- * problems such a network outage or back-end Amazon Web Services failure or other errors. A
263
- * failed CA can never return to the pending state. You must create a new CA.
264
- * </p>
265
- * </li>
266
- * <li>
267
- * <p>
268
- * <code>DELETED</code> - Your private CA is within the restoration period, after
269
- * which it is permanently deleted. The length of time remaining in the CA's
270
- * restoration period is also included in this action's output.</p>
271
- * </li>
272
- * </ul>
64
+ * @see {@link DescribeCertificateAuthorityCommand}
273
65
  */
274
66
  describeCertificateAuthority(args: DescribeCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCertificateAuthorityCommandOutput>;
275
67
  describeCertificateAuthority(args: DescribeCertificateAuthorityCommandInput, cb: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void): void;
276
68
  describeCertificateAuthority(args: DescribeCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void): void;
277
69
  /**
278
- * @public
279
- * <p>Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action. Audit information is created
280
- * every time the certificate authority (CA) private key is used. The private key is used
281
- * when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the
282
- * <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> action. </p>
70
+ * @see {@link DescribeCertificateAuthorityAuditReportCommand}
283
71
  */
284
72
  describeCertificateAuthorityAuditReport(args: DescribeCertificateAuthorityAuditReportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCertificateAuthorityAuditReportCommandOutput>;
285
73
  describeCertificateAuthorityAuditReport(args: DescribeCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void): void;
286
74
  describeCertificateAuthorityAuditReport(args: DescribeCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void): void;
287
75
  /**
288
- * @public
289
- * <p>Retrieves a certificate from your private CA or one that has been shared with you. The
290
- * ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action. You
291
- * must specify both the ARN of your private CA and the ARN of the issued certificate when
292
- * calling the <b>GetCertificate</b> action. You can retrieve the
293
- * certificate if it is in the <b>ISSUED</b> state. You can call
294
- * the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action to create a report that
295
- * contains information about all of the certificates issued and revoked by your private
296
- * CA. </p>
76
+ * @see {@link GetCertificateCommand}
297
77
  */
298
78
  getCertificate(args: GetCertificateCommandInput, options?: __HttpHandlerOptions): Promise<GetCertificateCommandOutput>;
299
79
  getCertificate(args: GetCertificateCommandInput, cb: (err: any, data?: GetCertificateCommandOutput) => void): void;
300
80
  getCertificate(args: GetCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateCommandOutput) => void): void;
301
81
  /**
302
- * @public
303
- * <p>Retrieves the certificate and certificate chain for your private certificate authority
304
- * (CA) or one that has been shared with you. Both the certificate and the chain are base64
305
- * PEM-encoded. The chain does not include the CA certificate. Each certificate in the
306
- * chain signs the one before it. </p>
82
+ * @see {@link GetCertificateAuthorityCertificateCommand}
307
83
  */
308
84
  getCertificateAuthorityCertificate(args: GetCertificateAuthorityCertificateCommandInput, options?: __HttpHandlerOptions): Promise<GetCertificateAuthorityCertificateCommandOutput>;
309
85
  getCertificateAuthorityCertificate(args: GetCertificateAuthorityCertificateCommandInput, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void): void;
310
86
  getCertificateAuthorityCertificate(args: GetCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void): void;
311
87
  /**
312
- * @public
313
- * <p>Retrieves the certificate signing request (CSR) for your private certificate authority
314
- * (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. Sign the CSR with your Amazon Web Services Private CA-hosted
315
- * or on-premises root or subordinate CA. Then import the signed certificate back into
316
- * Amazon Web Services Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action. The CSR is returned as a
317
- * base64 PEM-encoded string. </p>
88
+ * @see {@link GetCertificateAuthorityCsrCommand}
318
89
  */
319
90
  getCertificateAuthorityCsr(args: GetCertificateAuthorityCsrCommandInput, options?: __HttpHandlerOptions): Promise<GetCertificateAuthorityCsrCommandOutput>;
320
91
  getCertificateAuthorityCsr(args: GetCertificateAuthorityCsrCommandInput, cb: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void): void;
321
92
  getCertificateAuthorityCsr(args: GetCertificateAuthorityCsrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void): void;
322
93
  /**
323
- * @public
324
- * <p>Retrieves the resource-based policy attached to a private CA. If either the private CA
325
- * resource or the policy cannot be found, this action returns a
326
- * <code>ResourceNotFoundException</code>. </p>
327
- * <p>The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a> and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.</p>
328
- * <p class="title">
329
- * <b>About Policies</b>
330
- * </p>
331
- * <ul>
332
- * <li>
333
- * <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
334
- * an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
335
- * see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private CA</a>.</p>
336
- * </li>
337
- * <li>
338
- * <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
339
- * signed by a CA in another account.</p>
340
- * </li>
341
- * <li>
342
- * <p>For ACM to manage automatic renewal of these certificates,
343
- * the ACM user must configure a Service Linked Role (SLR). The SLR allows
344
- * the ACM service to assume the identity of the user, subject to confirmation against the
345
- * Amazon Web Services Private CA policy. For more information, see
346
- * <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
347
- * Service Linked Role with ACM</a>.</p>
348
- * </li>
349
- * <li>
350
- * <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
351
- * see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
352
- * Access</a>.</p>
353
- * </li>
354
- * </ul>
94
+ * @see {@link GetPolicyCommand}
355
95
  */
356
96
  getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetPolicyCommandOutput>;
357
97
  getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
358
98
  getPolicy(args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
359
99
  /**
360
- * @public
361
- * <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
362
- * are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
363
- * this action, the following preparations must in place:</p>
364
- * <ol>
365
- * <li>
366
- * <p>In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action to create the private CA that you
367
- * plan to back with the imported certificate.</p>
368
- * </li>
369
- * <li>
370
- * <p>Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a> action to generate a certificate signing
371
- * request (CSR).</p>
372
- * </li>
373
- * <li>
374
- * <p>Sign the CSR using a root or intermediate CA hosted by either an on-premises
375
- * PKI hierarchy or by a commercial CA.</p>
376
- * </li>
377
- * <li>
378
- * <p>Create a certificate chain and copy the signed certificate and the certificate
379
- * chain to your working directory.</p>
380
- * </li>
381
- * </ol>
382
- * <p>Amazon Web Services Private CA supports three scenarios for installing a CA certificate:</p>
383
- * <ul>
384
- * <li>
385
- * <p>Installing a certificate for a root CA hosted by Amazon Web Services Private CA.</p>
386
- * </li>
387
- * <li>
388
- * <p>Installing a subordinate CA certificate whose parent authority is hosted by
389
- * Amazon Web Services Private CA.</p>
390
- * </li>
391
- * <li>
392
- * <p>Installing a subordinate CA certificate whose parent authority is externally
393
- * hosted.</p>
394
- * </li>
395
- * </ul>
396
- * <p>The following additional requirements apply when you import a CA certificate.</p>
397
- * <ul>
398
- * <li>
399
- * <p>Only a self-signed certificate can be imported as a root CA.</p>
400
- * </li>
401
- * <li>
402
- * <p>A self-signed certificate cannot be imported as a subordinate CA.</p>
403
- * </li>
404
- * <li>
405
- * <p>Your certificate chain must not include the private CA certificate that you
406
- * are importing.</p>
407
- * </li>
408
- * <li>
409
- * <p>Your root CA must be the last certificate in your chain. The subordinate
410
- * certificate, if any, that your root CA signed must be next to last. The
411
- * subordinate certificate signed by the preceding subordinate CA must come next,
412
- * and so on until your chain is built. </p>
413
- * </li>
414
- * <li>
415
- * <p>The chain must be PEM-encoded.</p>
416
- * </li>
417
- * <li>
418
- * <p>The maximum allowed size of a certificate is 32 KB.</p>
419
- * </li>
420
- * <li>
421
- * <p>The maximum allowed size of a certificate chain is 2 MB.</p>
422
- * </li>
423
- * </ul>
424
- * <p>
425
- * <i>Enforcement of Critical Constraints</i>
426
- * </p>
427
- * <p>Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA
428
- * certificate or chain.</p>
429
- * <ul>
430
- * <li>
431
- * <p>Basic constraints (<i>must</i> be marked critical)</p>
432
- * </li>
433
- * <li>
434
- * <p>Subject alternative names</p>
435
- * </li>
436
- * <li>
437
- * <p>Key usage</p>
438
- * </li>
439
- * <li>
440
- * <p>Extended key usage</p>
441
- * </li>
442
- * <li>
443
- * <p>Authority key identifier</p>
444
- * </li>
445
- * <li>
446
- * <p>Subject key identifier</p>
447
- * </li>
448
- * <li>
449
- * <p>Issuer alternative name</p>
450
- * </li>
451
- * <li>
452
- * <p>Subject directory attributes</p>
453
- * </li>
454
- * <li>
455
- * <p>Subject information access</p>
456
- * </li>
457
- * <li>
458
- * <p>Certificate policies</p>
459
- * </li>
460
- * <li>
461
- * <p>Policy mappings</p>
462
- * </li>
463
- * <li>
464
- * <p>Inhibit anyPolicy</p>
465
- * </li>
466
- * </ul>
467
- * <p>Amazon Web Services Private CA rejects the following extensions when they are marked critical in an
468
- * imported CA certificate or chain.</p>
469
- * <ul>
470
- * <li>
471
- * <p>Name constraints</p>
472
- * </li>
473
- * <li>
474
- * <p>Policy constraints</p>
475
- * </li>
476
- * <li>
477
- * <p>CRL distribution points</p>
478
- * </li>
479
- * <li>
480
- * <p>Authority information access</p>
481
- * </li>
482
- * <li>
483
- * <p>Freshest CRL</p>
484
- * </li>
485
- * <li>
486
- * <p>Any other extension</p>
487
- * </li>
488
- * </ul>
100
+ * @see {@link ImportCertificateAuthorityCertificateCommand}
489
101
  */
490
102
  importCertificateAuthorityCertificate(args: ImportCertificateAuthorityCertificateCommandInput, options?: __HttpHandlerOptions): Promise<ImportCertificateAuthorityCertificateCommandOutput>;
491
103
  importCertificateAuthorityCertificate(args: ImportCertificateAuthorityCertificateCommandInput, cb: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void): void;
492
104
  importCertificateAuthorityCertificate(args: ImportCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void): void;
493
105
  /**
494
- * @public
495
- * <p>Uses your private certificate authority (CA), or one that has been shared with you, to
496
- * issue a client certificate. This action returns the Amazon Resource Name (ARN) of the
497
- * certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> action and
498
- * specifying the ARN. </p>
499
- * <note>
500
- * <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the
501
- * certificates that you issue by using Amazon Web Services Private CA.</p>
502
- * </note>
106
+ * @see {@link IssueCertificateCommand}
503
107
  */
504
108
  issueCertificate(args: IssueCertificateCommandInput, options?: __HttpHandlerOptions): Promise<IssueCertificateCommandOutput>;
505
109
  issueCertificate(args: IssueCertificateCommandInput, cb: (err: any, data?: IssueCertificateCommandOutput) => void): void;
506
110
  issueCertificate(args: IssueCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IssueCertificateCommandOutput) => void): void;
507
111
  /**
508
- * @public
509
- * <p>Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action.</p>
112
+ * @see {@link ListCertificateAuthoritiesCommand}
510
113
  */
511
114
  listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, options?: __HttpHandlerOptions): Promise<ListCertificateAuthoritiesCommandOutput>;
512
115
  listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void): void;
513
116
  listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void): void;
514
117
  /**
515
- * @public
516
- * <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service
517
- * principal (acm.amazonaws.com). </p>
518
- * <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
519
- * same Amazon Web Services account as the CA. </p>
520
- * <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
521
- * revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
522
- * <p class="title">
523
- * <b>About Permissions</b>
524
- * </p>
525
- * <ul>
526
- * <li>
527
- * <p>If the private CA and the certificates it issues reside in the same
528
- * account, you can use <code>CreatePermission</code> to grant permissions for ACM to
529
- * carry out automatic certificate renewals.</p>
530
- * </li>
531
- * <li>
532
- * <p>For automatic certificate renewal to succeed, the ACM service principal
533
- * needs permissions to create, retrieve, and list certificates.</p>
534
- * </li>
535
- * <li>
536
- * <p>If the private CA and the ACM certificates reside in different accounts,
537
- * then permissions cannot be used to enable automatic renewals. Instead,
538
- * the ACM certificate owner must set up a resource-based policy to enable
539
- * cross-account issuance and renewals. For more information, see
540
- * <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
541
- * Based Policy with Amazon Web Services Private CA</a>.</p>
542
- * </li>
543
- * </ul>
118
+ * @see {@link ListPermissionsCommand}
544
119
  */
545
120
  listPermissions(args: ListPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionsCommandOutput>;
546
121
  listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
547
122
  listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
548
123
  /**
549
- * @public
550
- * <p>Lists the tags, if any, that are associated with your private CA or one that has been
551
- * shared with you. Tags are labels that you can use to identify and organize your CAs.
552
- * Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
553
- * action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action to remove tags. </p>
124
+ * @see {@link ListTagsCommand}
554
125
  */
555
126
  listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsCommandOutput>;
556
127
  listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
557
128
  listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
558
129
  /**
559
- * @public
560
- * <p>Attaches a resource-based policy to a private CA. </p>
561
- * <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access
562
- * Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
563
- * Access</a>.</p>
564
- * <p>The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a> and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.</p>
565
- * <p class="title">
566
- * <b>About Policies</b>
567
- * </p>
568
- * <ul>
569
- * <li>
570
- * <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
571
- * an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
572
- * see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private CA</a>.</p>
573
- * </li>
574
- * <li>
575
- * <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
576
- * signed by a CA in another account.</p>
577
- * </li>
578
- * <li>
579
- * <p>For ACM to manage automatic renewal of these certificates,
580
- * the ACM user must configure a Service Linked Role (SLR). The SLR allows
581
- * the ACM service to assume the identity of the user, subject to confirmation against the
582
- * Amazon Web Services Private CA policy. For more information, see
583
- * <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
584
- * Service Linked Role with ACM</a>.</p>
585
- * </li>
586
- * <li>
587
- * <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
588
- * see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
589
- * Access</a>.</p>
590
- * </li>
591
- * </ul>
130
+ * @see {@link PutPolicyCommand}
592
131
  */
593
132
  putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutPolicyCommandOutput>;
594
133
  putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void;
595
134
  putPolicy(args: PutPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPolicyCommandOutput) => void): void;
596
135
  /**
597
- * @public
598
- * <p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
599
- * can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b> parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a> action. Currently, you can specify 7 to 30 days.
600
- * If you did not specify a <b>PermanentDeletionTimeInDays</b>
601
- * value, by default you can restore the CA at any time in a 30 day period. You can check
602
- * the time remaining in the restoration period of a private CA in the <code>DELETED</code>
603
- * state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a> or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> actions. The status of a restored CA is set to
604
- * its pre-deletion status when the <b>RestoreCertificateAuthority</b> action returns. To change its status to
605
- * <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action. If the private CA was in the
606
- * <code>PENDING_CERTIFICATE</code> state at deletion, you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action to import a certificate
607
- * authority into the private CA before it can be activated. You cannot restore a CA after
608
- * the restoration period has ended.</p>
136
+ * @see {@link RestoreCertificateAuthorityCommand}
609
137
  */
610
138
  restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<RestoreCertificateAuthorityCommandOutput>;
611
139
  restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void): void;
612
140
  restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void): void;
613
141
  /**
614
- * @public
615
- * <p>Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate
616
- * revocation list (CRL) when you create or update your private CA, information about the
617
- * revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3
618
- * bucket that you specify. A CRL is typically updated approximately 30 minutes after a
619
- * certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts
620
- * makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms
621
- * for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For
622
- * more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported CloudWatch Metrics</a>.</p>
623
- * <note>
624
- * <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
625
- * the S3 bucket that you specify. If the IAM principal making the call
626
- * does not have permission to write to the bucket, then an exception is
627
- * thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
628
- * policies for CRLs in Amazon S3</a>.</p>
629
- * </note>
630
- * <p>Amazon Web Services Private CA also writes revocation information to the audit report. For more
631
- * information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.</p>
632
- * <note>
633
- * <p>You cannot revoke a root CA self-signed certificate.</p>
634
- * </note>
142
+ * @see {@link RevokeCertificateCommand}
635
143
  */
636
144
  revokeCertificate(args: RevokeCertificateCommandInput, options?: __HttpHandlerOptions): Promise<RevokeCertificateCommandOutput>;
637
145
  revokeCertificate(args: RevokeCertificateCommandInput, cb: (err: any, data?: RevokeCertificateCommandOutput) => void): void;
638
146
  revokeCertificate(args: RevokeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeCertificateCommandOutput) => void): void;
639
147
  /**
640
- * @public
641
- * <p>Adds one or more tags to your private CA. Tags are labels that you can use to identify
642
- * and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You
643
- * specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag
644
- * by using a key-value pair. You can apply a tag to just one private CA if you want to
645
- * identify a specific characteristic of that CA, or you can apply the same tag to multiple
646
- * private CAs if you want to filter for a common relationship among those CAs. To remove
647
- * one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are
648
- * associated with your CA. </p>
649
- * <note>
650
- * <p>To attach tags to a private CA during the creation procedure, a CA administrator
651
- * must first associate an inline IAM policy with the
652
- * <code>CreateCertificateAuthority</code> action and explicitly allow tagging. For
653
- * more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching tags to a CA
654
- * at the time of creation</a>.</p>
655
- * </note>
148
+ * @see {@link TagCertificateAuthorityCommand}
656
149
  */
657
150
  tagCertificateAuthority(args: TagCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<TagCertificateAuthorityCommandOutput>;
658
151
  tagCertificateAuthority(args: TagCertificateAuthorityCommandInput, cb: (err: any, data?: TagCertificateAuthorityCommandOutput) => void): void;
659
152
  tagCertificateAuthority(args: TagCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagCertificateAuthorityCommandOutput) => void): void;
660
153
  /**
661
- * @public
662
- * <p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If
663
- * you do not specify the value portion of the tag when calling this action, the tag will
664
- * be removed regardless of value. If you specify a value, the tag is removed only if it is
665
- * associated with the specified value. To add tags to a private CA, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are
666
- * associated with your CA. </p>
154
+ * @see {@link UntagCertificateAuthorityCommand}
667
155
  */
668
156
  untagCertificateAuthority(args: UntagCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<UntagCertificateAuthorityCommandOutput>;
669
157
  untagCertificateAuthority(args: UntagCertificateAuthorityCommandInput, cb: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void): void;
670
158
  untagCertificateAuthority(args: UntagCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void): void;
671
159
  /**
672
- * @public
673
- * <p>Updates the status or configuration of a private certificate authority (CA). Your
674
- * private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you
675
- * can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or
676
- * make a CA that is in the <code>DISABLED</code> state active again.</p>
677
- * <note>
678
- * <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
679
- * the S3 bucket that you specify. If the IAM principal making the call
680
- * does not have permission to write to the bucket, then an exception is
681
- * thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
682
- * policies for CRLs in Amazon S3</a>.</p>
683
- * </note>
160
+ * @see {@link UpdateCertificateAuthorityCommand}
684
161
  */
685
162
  updateCertificateAuthority(args: UpdateCertificateAuthorityCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCertificateAuthorityCommandOutput>;
686
163
  updateCertificateAuthority(args: UpdateCertificateAuthorityCommandInput, cb: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void): void;
687
164
  updateCertificateAuthority(args: UpdateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void): void;
688
165
  }
166
+ /**
167
+ * @public
168
+ * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
169
+ * syntax, and usage examples for each of the actions and data types involved in creating
170
+ * and managing a private certificate authority (CA) for your organization.</p>
171
+ * <p>The documentation for each action shows the API request parameters and the JSON
172
+ * response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
173
+ * tailored to the programming language or platform that you prefer. For more information,
174
+ * see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
175
+ * <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
176
+ * operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
177
+ * depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
178
+ * request because the request exceeds the operation's quota for the number of requests per
179
+ * 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
180
+ * rate for APIs. </p>
181
+ * <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
182
+ * log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
183
+ * console.</p>
184
+ */
185
+ export declare class ACMPCA extends ACMPCAClient implements ACMPCA {
186
+ }