@aws-sdk/client-acm-pca 3.957.0 → 3.958.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/README.md CHANGED
@@ -9,10 +9,8 @@ AWS SDK for JavaScript ACMPCA Client for Node.js, Browser and React Native.
9
9
  <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
10
10
 
11
11
  ## Installing
12
-
13
12
  To install this package, simply type add or install @aws-sdk/client-acm-pca
14
13
  using your favorite package manager:
15
-
16
14
  - `npm install @aws-sdk/client-acm-pca`
17
15
  - `yarn add @aws-sdk/client-acm-pca`
18
16
  - `pnpm add @aws-sdk/client-acm-pca`
@@ -48,9 +46,7 @@ To send a request, you:
48
46
  // a client can be shared by different commands.
49
47
  const client = new ACMPCAClient({ region: "REGION" });
50
48
 
51
- const params = {
52
- /** input parameters */
53
- };
49
+ const params = { /** input parameters */ };
54
50
  const command = new ListTagsCommand(params);
55
51
  ```
56
52
 
@@ -209,7 +205,6 @@ CreateCertificateAuthority
209
205
  </summary>
210
206
 
211
207
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/CreateCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/CreateCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/CreateCertificateAuthorityCommandOutput/)
212
-
213
208
  </details>
214
209
  <details>
215
210
  <summary>
@@ -217,7 +212,6 @@ CreateCertificateAuthorityAuditReport
217
212
  </summary>
218
213
 
219
214
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/CreateCertificateAuthorityAuditReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/CreateCertificateAuthorityAuditReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/CreateCertificateAuthorityAuditReportCommandOutput/)
220
-
221
215
  </details>
222
216
  <details>
223
217
  <summary>
@@ -225,7 +219,6 @@ CreatePermission
225
219
  </summary>
226
220
 
227
221
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/CreatePermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/CreatePermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/CreatePermissionCommandOutput/)
228
-
229
222
  </details>
230
223
  <details>
231
224
  <summary>
@@ -233,7 +226,6 @@ DeleteCertificateAuthority
233
226
  </summary>
234
227
 
235
228
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/DeleteCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DeleteCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DeleteCertificateAuthorityCommandOutput/)
236
-
237
229
  </details>
238
230
  <details>
239
231
  <summary>
@@ -241,7 +233,6 @@ DeletePermission
241
233
  </summary>
242
234
 
243
235
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/DeletePermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DeletePermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DeletePermissionCommandOutput/)
244
-
245
236
  </details>
246
237
  <details>
247
238
  <summary>
@@ -249,7 +240,6 @@ DeletePolicy
249
240
  </summary>
250
241
 
251
242
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/DeletePolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DeletePolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DeletePolicyCommandOutput/)
252
-
253
243
  </details>
254
244
  <details>
255
245
  <summary>
@@ -257,7 +247,6 @@ DescribeCertificateAuthority
257
247
  </summary>
258
248
 
259
249
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/DescribeCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DescribeCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DescribeCertificateAuthorityCommandOutput/)
260
-
261
250
  </details>
262
251
  <details>
263
252
  <summary>
@@ -265,7 +254,6 @@ DescribeCertificateAuthorityAuditReport
265
254
  </summary>
266
255
 
267
256
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/DescribeCertificateAuthorityAuditReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DescribeCertificateAuthorityAuditReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/DescribeCertificateAuthorityAuditReportCommandOutput/)
268
-
269
257
  </details>
270
258
  <details>
271
259
  <summary>
@@ -273,7 +261,6 @@ GetCertificate
273
261
  </summary>
274
262
 
275
263
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/GetCertificateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetCertificateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetCertificateCommandOutput/)
276
-
277
264
  </details>
278
265
  <details>
279
266
  <summary>
@@ -281,7 +268,6 @@ GetCertificateAuthorityCertificate
281
268
  </summary>
282
269
 
283
270
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/GetCertificateAuthorityCertificateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetCertificateAuthorityCertificateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetCertificateAuthorityCertificateCommandOutput/)
284
-
285
271
  </details>
286
272
  <details>
287
273
  <summary>
@@ -289,7 +275,6 @@ GetCertificateAuthorityCsr
289
275
  </summary>
290
276
 
291
277
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/GetCertificateAuthorityCsrCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetCertificateAuthorityCsrCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetCertificateAuthorityCsrCommandOutput/)
292
-
293
278
  </details>
294
279
  <details>
295
280
  <summary>
@@ -297,7 +282,6 @@ GetPolicy
297
282
  </summary>
298
283
 
299
284
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/GetPolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetPolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/GetPolicyCommandOutput/)
300
-
301
285
  </details>
302
286
  <details>
303
287
  <summary>
@@ -305,7 +289,6 @@ ImportCertificateAuthorityCertificate
305
289
  </summary>
306
290
 
307
291
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/ImportCertificateAuthorityCertificateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ImportCertificateAuthorityCertificateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ImportCertificateAuthorityCertificateCommandOutput/)
308
-
309
292
  </details>
310
293
  <details>
311
294
  <summary>
@@ -313,7 +296,6 @@ IssueCertificate
313
296
  </summary>
314
297
 
315
298
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/IssueCertificateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/IssueCertificateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/IssueCertificateCommandOutput/)
316
-
317
299
  </details>
318
300
  <details>
319
301
  <summary>
@@ -321,7 +303,6 @@ ListCertificateAuthorities
321
303
  </summary>
322
304
 
323
305
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/ListCertificateAuthoritiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ListCertificateAuthoritiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ListCertificateAuthoritiesCommandOutput/)
324
-
325
306
  </details>
326
307
  <details>
327
308
  <summary>
@@ -329,7 +310,6 @@ ListPermissions
329
310
  </summary>
330
311
 
331
312
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/ListPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ListPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ListPermissionsCommandOutput/)
332
-
333
313
  </details>
334
314
  <details>
335
315
  <summary>
@@ -337,7 +317,6 @@ ListTags
337
317
  </summary>
338
318
 
339
319
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/ListTagsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ListTagsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/ListTagsCommandOutput/)
340
-
341
320
  </details>
342
321
  <details>
343
322
  <summary>
@@ -345,7 +324,6 @@ PutPolicy
345
324
  </summary>
346
325
 
347
326
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/PutPolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/PutPolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/PutPolicyCommandOutput/)
348
-
349
327
  </details>
350
328
  <details>
351
329
  <summary>
@@ -353,7 +331,6 @@ RestoreCertificateAuthority
353
331
  </summary>
354
332
 
355
333
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/RestoreCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/RestoreCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/RestoreCertificateAuthorityCommandOutput/)
356
-
357
334
  </details>
358
335
  <details>
359
336
  <summary>
@@ -361,7 +338,6 @@ RevokeCertificate
361
338
  </summary>
362
339
 
363
340
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/RevokeCertificateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/RevokeCertificateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/RevokeCertificateCommandOutput/)
364
-
365
341
  </details>
366
342
  <details>
367
343
  <summary>
@@ -369,7 +345,6 @@ TagCertificateAuthority
369
345
  </summary>
370
346
 
371
347
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/TagCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/TagCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/TagCertificateAuthorityCommandOutput/)
372
-
373
348
  </details>
374
349
  <details>
375
350
  <summary>
@@ -377,7 +352,6 @@ UntagCertificateAuthority
377
352
  </summary>
378
353
 
379
354
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/UntagCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/UntagCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/UntagCertificateAuthorityCommandOutput/)
380
-
381
355
  </details>
382
356
  <details>
383
357
  <summary>
@@ -385,5 +359,4 @@ UpdateCertificateAuthority
385
359
  </summary>
386
360
 
387
361
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/acm-pca/command/UpdateCertificateAuthorityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/UpdateCertificateAuthorityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-acm-pca/Interface/UpdateCertificateAuthorityCommandOutput/)
388
-
389
362
  </details>
@@ -6,10 +6,9 @@ const util_middleware_1 = require("@smithy/util-middleware");
6
6
  const defaultACMPCAHttpAuthSchemeParametersProvider = async (config, context, input) => {
7
7
  return {
8
8
  operation: (0, util_middleware_1.getSmithyContext)(context).operation,
9
- region: (await (0, util_middleware_1.normalizeProvider)(config.region)()) ||
10
- (() => {
11
- throw new Error("expected `region` to be configured for `aws.auth#sigv4`");
12
- })(),
9
+ region: await (0, util_middleware_1.normalizeProvider)(config.region)() || (() => {
10
+ throw new Error("expected `region` to be configured for `aws.auth#sigv4`");
11
+ })(),
13
12
  };
14
13
  };
15
14
  exports.defaultACMPCAHttpAuthSchemeParametersProvider = defaultACMPCAHttpAuthSchemeParametersProvider;