@aws-sdk/client-acm-pca 3.295.0 → 3.297.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.
Files changed (32) hide show
  1. package/dist-types/ACMPCA.d.ts +24 -0
  2. package/dist-types/ACMPCAClient.d.ts +24 -4
  3. package/dist-types/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateCertificateAuthorityCommand.d.ts +16 -0
  5. package/dist-types/commands/CreatePermissionCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteCertificateAuthorityCommand.d.ts +16 -0
  7. package/dist-types/commands/DeletePermissionCommand.d.ts +16 -0
  8. package/dist-types/commands/DeletePolicyCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeCertificateAuthorityAuditReportCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeCertificateAuthorityCommand.d.ts +16 -0
  11. package/dist-types/commands/GetCertificateAuthorityCertificateCommand.d.ts +16 -0
  12. package/dist-types/commands/GetCertificateAuthorityCsrCommand.d.ts +16 -0
  13. package/dist-types/commands/GetCertificateCommand.d.ts +16 -0
  14. package/dist-types/commands/GetPolicyCommand.d.ts +16 -0
  15. package/dist-types/commands/ImportCertificateAuthorityCertificateCommand.d.ts +16 -0
  16. package/dist-types/commands/IssueCertificateCommand.d.ts +16 -0
  17. package/dist-types/commands/ListCertificateAuthoritiesCommand.d.ts +16 -0
  18. package/dist-types/commands/ListPermissionsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListTagsCommand.d.ts +16 -0
  20. package/dist-types/commands/PutPolicyCommand.d.ts +16 -0
  21. package/dist-types/commands/RestoreCertificateAuthorityCommand.d.ts +16 -0
  22. package/dist-types/commands/RevokeCertificateCommand.d.ts +16 -0
  23. package/dist-types/commands/TagCertificateAuthorityCommand.d.ts +16 -0
  24. package/dist-types/commands/UntagCertificateAuthorityCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateCertificateAuthorityCommand.d.ts +16 -0
  26. package/dist-types/models/ACMPCAServiceException.d.ts +2 -0
  27. package/dist-types/models/models_0.d.ts +199 -0
  28. package/dist-types/pagination/Interfaces.d.ts +3 -0
  29. package/dist-types/pagination/ListCertificateAuthoritiesPaginator.d.ts +3 -0
  30. package/dist-types/pagination/ListPermissionsPaginator.d.ts +3 -0
  31. package/dist-types/pagination/ListTagsPaginator.d.ts +3 -0
  32. package/package.json +30 -30
@@ -24,6 +24,7 @@ import { TagCertificateAuthorityCommandInput, TagCertificateAuthorityCommandOutp
24
24
  import { UntagCertificateAuthorityCommandInput, UntagCertificateAuthorityCommandOutput } from "./commands/UntagCertificateAuthorityCommand";
25
25
  import { UpdateCertificateAuthorityCommandInput, UpdateCertificateAuthorityCommandOutput } from "./commands/UpdateCertificateAuthorityCommand";
26
26
  /**
27
+ * @public
27
28
  * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
28
29
  * syntax, and usage examples for each of the actions and data types involved in creating
29
30
  * and managing a private certificate authority (CA) for your organization.</p>
@@ -43,6 +44,7 @@ import { UpdateCertificateAuthorityCommandInput, UpdateCertificateAuthorityComma
43
44
  */
44
45
  export declare class ACMPCA extends ACMPCAClient {
45
46
  /**
47
+ * @public
46
48
  * <p>Creates a root or subordinate private certificate authority (CA). You must specify the
47
49
  * CA configuration, an optional configuration for Online Certificate Status Protocol
48
50
  * (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
@@ -69,6 +71,7 @@ export declare class ACMPCA extends ACMPCAClient {
69
71
  createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void): void;
70
72
  createCertificateAuthority(args: CreateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void): void;
71
73
  /**
74
+ * @public
72
75
  * <p>Creates an audit report that lists every time that your CA private key is used. The
73
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
74
77
  * the private key. </p>
@@ -90,6 +93,7 @@ export declare class ACMPCA extends ACMPCAClient {
90
93
  createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void): void;
91
94
  createCertificateAuthorityAuditReport(args: CreateCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void): void;
92
95
  /**
96
+ * @public
93
97
  * <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
94
98
  * principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
95
99
  * renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
@@ -122,6 +126,7 @@ export declare class ACMPCA extends ACMPCAClient {
122
126
  createPermission(args: CreatePermissionCommandInput, cb: (err: any, data?: CreatePermissionCommandOutput) => void): void;
123
127
  createPermission(args: CreatePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionCommandOutput) => void): void;
124
128
  /**
129
+ * @public
125
130
  * <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource
126
131
  * Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
127
132
  * the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p>
@@ -147,6 +152,7 @@ export declare class ACMPCA extends ACMPCAClient {
147
152
  deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void): void;
148
153
  deleteCertificateAuthority(args: DeleteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void): void;
149
154
  /**
155
+ * @public
150
156
  * <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
151
157
  * (acm.amazonaws.com). </p>
152
158
  * <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
@@ -181,6 +187,7 @@ export declare class ACMPCA extends ACMPCAClient {
181
187
  deletePermission(args: DeletePermissionCommandInput, cb: (err: any, data?: DeletePermissionCommandOutput) => void): void;
182
188
  deletePermission(args: DeletePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionCommandOutput) => void): void;
183
189
  /**
190
+ * @public
184
191
  * <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
185
192
  * access that the policy has granted. If there is no policy attached to the private CA,
186
193
  * this action will return successful.</p>
@@ -221,6 +228,7 @@ export declare class ACMPCA extends ACMPCAClient {
221
228
  deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void;
222
229
  deletePolicy(args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void;
223
230
  /**
231
+ * @public
224
232
  * <p>Lists information about your private certificate authority (CA) or one that has been
225
233
  * shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
226
234
  * The output contains the status of your CA. This can be any of the following: </p>
@@ -267,6 +275,7 @@ export declare class ACMPCA extends ACMPCAClient {
267
275
  describeCertificateAuthority(args: DescribeCertificateAuthorityCommandInput, cb: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void): void;
268
276
  describeCertificateAuthority(args: DescribeCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void): void;
269
277
  /**
278
+ * @public
270
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
271
280
  * every time the certificate authority (CA) private key is used. The private key is used
272
281
  * when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the
@@ -276,6 +285,7 @@ export declare class ACMPCA extends ACMPCAClient {
276
285
  describeCertificateAuthorityAuditReport(args: DescribeCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void): void;
277
286
  describeCertificateAuthorityAuditReport(args: DescribeCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void): void;
278
287
  /**
288
+ * @public
279
289
  * <p>Retrieves a certificate from your private CA or one that has been shared with you. The
280
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
281
291
  * must specify both the ARN of your private CA and the ARN of the issued certificate when
@@ -289,6 +299,7 @@ export declare class ACMPCA extends ACMPCAClient {
289
299
  getCertificate(args: GetCertificateCommandInput, cb: (err: any, data?: GetCertificateCommandOutput) => void): void;
290
300
  getCertificate(args: GetCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateCommandOutput) => void): void;
291
301
  /**
302
+ * @public
292
303
  * <p>Retrieves the certificate and certificate chain for your private certificate authority
293
304
  * (CA) or one that has been shared with you. Both the certificate and the chain are base64
294
305
  * PEM-encoded. The chain does not include the CA certificate. Each certificate in the
@@ -298,6 +309,7 @@ export declare class ACMPCA extends ACMPCAClient {
298
309
  getCertificateAuthorityCertificate(args: GetCertificateAuthorityCertificateCommandInput, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void): void;
299
310
  getCertificateAuthorityCertificate(args: GetCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void): void;
300
311
  /**
312
+ * @public
301
313
  * <p>Retrieves the certificate signing request (CSR) for your private certificate authority
302
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
303
315
  * or on-premises root or subordinate CA. Then import the signed certificate back into
@@ -308,6 +320,7 @@ export declare class ACMPCA extends ACMPCAClient {
308
320
  getCertificateAuthorityCsr(args: GetCertificateAuthorityCsrCommandInput, cb: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void): void;
309
321
  getCertificateAuthorityCsr(args: GetCertificateAuthorityCsrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void): void;
310
322
  /**
323
+ * @public
311
324
  * <p>Retrieves the resource-based policy attached to a private CA. If either the private CA
312
325
  * resource or the policy cannot be found, this action returns a
313
326
  * <code>ResourceNotFoundException</code>. </p>
@@ -344,6 +357,7 @@ export declare class ACMPCA extends ACMPCAClient {
344
357
  getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
345
358
  getPolicy(args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
346
359
  /**
360
+ * @public
347
361
  * <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
348
362
  * are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
349
363
  * this action, the following preparations must in place:</p>
@@ -477,6 +491,7 @@ export declare class ACMPCA extends ACMPCAClient {
477
491
  importCertificateAuthorityCertificate(args: ImportCertificateAuthorityCertificateCommandInput, cb: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void): void;
478
492
  importCertificateAuthorityCertificate(args: ImportCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void): void;
479
493
  /**
494
+ * @public
480
495
  * <p>Uses your private certificate authority (CA), or one that has been shared with you, to
481
496
  * issue a client certificate. This action returns the Amazon Resource Name (ARN) of the
482
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
@@ -490,12 +505,14 @@ export declare class ACMPCA extends ACMPCAClient {
490
505
  issueCertificate(args: IssueCertificateCommandInput, cb: (err: any, data?: IssueCertificateCommandOutput) => void): void;
491
506
  issueCertificate(args: IssueCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IssueCertificateCommandOutput) => void): void;
492
507
  /**
508
+ * @public
493
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>
494
510
  */
495
511
  listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, options?: __HttpHandlerOptions): Promise<ListCertificateAuthoritiesCommandOutput>;
496
512
  listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void): void;
497
513
  listCertificateAuthorities(args: ListCertificateAuthoritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void): void;
498
514
  /**
515
+ * @public
499
516
  * <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service
500
517
  * principal (acm.amazonaws.com). </p>
501
518
  * <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
@@ -529,6 +546,7 @@ export declare class ACMPCA extends ACMPCAClient {
529
546
  listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
530
547
  listPermissions(args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void;
531
548
  /**
549
+ * @public
532
550
  * <p>Lists the tags, if any, that are associated with your private CA or one that has been
533
551
  * shared with you. Tags are labels that you can use to identify and organize your CAs.
534
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>
@@ -538,6 +556,7 @@ export declare class ACMPCA extends ACMPCAClient {
538
556
  listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
539
557
  listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
540
558
  /**
559
+ * @public
541
560
  * <p>Attaches a resource-based policy to a private CA. </p>
542
561
  * <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access
543
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
@@ -575,6 +594,7 @@ export declare class ACMPCA extends ACMPCAClient {
575
594
  putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void;
576
595
  putPolicy(args: PutPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPolicyCommandOutput) => void): void;
577
596
  /**
597
+ * @public
578
598
  * <p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
579
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.
580
600
  * If you did not specify a <b>PermanentDeletionTimeInDays</b>
@@ -591,6 +611,7 @@ export declare class ACMPCA extends ACMPCAClient {
591
611
  restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void): void;
592
612
  restoreCertificateAuthority(args: RestoreCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void): void;
593
613
  /**
614
+ * @public
594
615
  * <p>Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate
595
616
  * revocation list (CRL) when you create or update your private CA, information about the
596
617
  * revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3
@@ -616,6 +637,7 @@ export declare class ACMPCA extends ACMPCAClient {
616
637
  revokeCertificate(args: RevokeCertificateCommandInput, cb: (err: any, data?: RevokeCertificateCommandOutput) => void): void;
617
638
  revokeCertificate(args: RevokeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeCertificateCommandOutput) => void): void;
618
639
  /**
640
+ * @public
619
641
  * <p>Adds one or more tags to your private CA. Tags are labels that you can use to identify
620
642
  * and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You
621
643
  * specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag
@@ -636,6 +658,7 @@ export declare class ACMPCA extends ACMPCAClient {
636
658
  tagCertificateAuthority(args: TagCertificateAuthorityCommandInput, cb: (err: any, data?: TagCertificateAuthorityCommandOutput) => void): void;
637
659
  tagCertificateAuthority(args: TagCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagCertificateAuthorityCommandOutput) => void): void;
638
660
  /**
661
+ * @public
639
662
  * <p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If
640
663
  * you do not specify the value portion of the tag when calling this action, the tag will
641
664
  * be removed regardless of value. If you specify a value, the tag is removed only if it is
@@ -646,6 +669,7 @@ export declare class ACMPCA extends ACMPCAClient {
646
669
  untagCertificateAuthority(args: UntagCertificateAuthorityCommandInput, cb: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void): void;
647
670
  untagCertificateAuthority(args: UntagCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void): void;
648
671
  /**
672
+ * @public
649
673
  * <p>Updates the status or configuration of a private certificate authority (CA). Your
650
674
  * private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you
651
675
  * can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or
@@ -31,15 +31,24 @@ import { TagCertificateAuthorityCommandInput, TagCertificateAuthorityCommandOutp
31
31
  import { UntagCertificateAuthorityCommandInput, UntagCertificateAuthorityCommandOutput } from "./commands/UntagCertificateAuthorityCommand";
32
32
  import { UpdateCertificateAuthorityCommandInput, UpdateCertificateAuthorityCommandOutput } from "./commands/UpdateCertificateAuthorityCommand";
33
33
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
34
+ /**
35
+ * @public
36
+ */
34
37
  export type ServiceInputTypes = CreateCertificateAuthorityAuditReportCommandInput | CreateCertificateAuthorityCommandInput | CreatePermissionCommandInput | DeleteCertificateAuthorityCommandInput | DeletePermissionCommandInput | DeletePolicyCommandInput | DescribeCertificateAuthorityAuditReportCommandInput | DescribeCertificateAuthorityCommandInput | GetCertificateAuthorityCertificateCommandInput | GetCertificateAuthorityCsrCommandInput | GetCertificateCommandInput | GetPolicyCommandInput | ImportCertificateAuthorityCertificateCommandInput | IssueCertificateCommandInput | ListCertificateAuthoritiesCommandInput | ListPermissionsCommandInput | ListTagsCommandInput | PutPolicyCommandInput | RestoreCertificateAuthorityCommandInput | RevokeCertificateCommandInput | TagCertificateAuthorityCommandInput | UntagCertificateAuthorityCommandInput | UpdateCertificateAuthorityCommandInput;
38
+ /**
39
+ * @public
40
+ */
35
41
  export type ServiceOutputTypes = CreateCertificateAuthorityAuditReportCommandOutput | CreateCertificateAuthorityCommandOutput | CreatePermissionCommandOutput | DeleteCertificateAuthorityCommandOutput | DeletePermissionCommandOutput | DeletePolicyCommandOutput | DescribeCertificateAuthorityAuditReportCommandOutput | DescribeCertificateAuthorityCommandOutput | GetCertificateAuthorityCertificateCommandOutput | GetCertificateAuthorityCsrCommandOutput | GetCertificateCommandOutput | GetPolicyCommandOutput | ImportCertificateAuthorityCertificateCommandOutput | IssueCertificateCommandOutput | ListCertificateAuthoritiesCommandOutput | ListPermissionsCommandOutput | ListTagsCommandOutput | PutPolicyCommandOutput | RestoreCertificateAuthorityCommandOutput | RevokeCertificateCommandOutput | TagCertificateAuthorityCommandOutput | UntagCertificateAuthorityCommandOutput | UpdateCertificateAuthorityCommandOutput;
42
+ /**
43
+ * @public
44
+ */
36
45
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
37
46
  /**
38
47
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
39
48
  */
40
49
  requestHandler?: __HttpHandler;
41
50
  /**
42
- * A constructor for a class implementing the {@link __Checksum} interface
51
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
43
52
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
44
53
  * @internal
45
54
  */
@@ -129,23 +138,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
129
138
  */
130
139
  logger?: __Logger;
131
140
  /**
132
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
142
  */
134
143
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
135
144
  }
145
+ /**
146
+ * @public
147
+ */
136
148
  type ACMPCAClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
137
149
  /**
138
- * The configuration interface of ACMPCAClient class constructor that set the region, credentials and other options.
150
+ * @public
151
+ *
152
+ * The configuration interface of ACMPCAClient class constructor that set the region, credentials and other options.
139
153
  */
140
154
  export interface ACMPCAClientConfig extends ACMPCAClientConfigType {
141
155
  }
156
+ /**
157
+ * @public
158
+ */
142
159
  type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
143
160
  /**
144
- * The resolved configuration interface of ACMPCAClient class. This is resolved and normalized from the {@link ACMPCAClientConfig | constructor configuration interface}.
161
+ * @public
162
+ *
163
+ * The resolved configuration interface of ACMPCAClient class. This is resolved and normalized from the {@link ACMPCAClientConfig | constructor configuration interface}.
145
164
  */
146
165
  export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {
147
166
  }
148
167
  /**
168
+ * @public
149
169
  * <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
150
170
  * syntax, and usage examples for each of the actions and data types involved in creating
151
171
  * and managing a private certificate authority (CA) for your organization.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { CreateCertificateAuthorityAuditReportRequest, CreateCertificateAuthorityAuditReportResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCertificateAuthorityAuditReportCommand}.
8
10
  */
9
11
  export interface CreateCertificateAuthorityAuditReportCommandInput extends CreateCertificateAuthorityAuditReportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCertificateAuthorityAuditReportCommand}.
13
17
  */
14
18
  export interface CreateCertificateAuthorityAuditReportCommandOutput extends CreateCertificateAuthorityAuditReportResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an audit report that lists every time that your CA private key is used. The
18
23
  * 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
19
24
  * the private key. </p>
@@ -40,6 +45,8 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput extends Crea
40
45
  * const response = await client.send(command);
41
46
  * ```
42
47
  *
48
+ * @param CreateCertificateAuthorityAuditReportCommandInput - {@link CreateCertificateAuthorityAuditReportCommandInput}
49
+ * @returns {@link CreateCertificateAuthorityAuditReportCommandOutput}
43
50
  * @see {@link CreateCertificateAuthorityAuditReportCommandInput} for command's `input` shape.
44
51
  * @see {@link CreateCertificateAuthorityAuditReportCommandOutput} for command's `response` shape.
45
52
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -69,11 +76,20 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput extends Crea
69
76
  export declare class CreateCertificateAuthorityAuditReportCommand extends $Command<CreateCertificateAuthorityAuditReportCommandInput, CreateCertificateAuthorityAuditReportCommandOutput, ACMPCAClientResolvedConfig> {
70
77
  readonly input: CreateCertificateAuthorityAuditReportCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: CreateCertificateAuthorityAuditReportCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCertificateAuthorityAuditReportCommandInput, CreateCertificateAuthorityAuditReportCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { CreateCertificateAuthorityRequest, CreateCertificateAuthorityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCertificateAuthorityCommand}.
8
10
  */
9
11
  export interface CreateCertificateAuthorityCommandInput extends CreateCertificateAuthorityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCertificateAuthorityCommand}.
13
17
  */
14
18
  export interface CreateCertificateAuthorityCommandOutput extends CreateCertificateAuthorityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a root or subordinate private certificate authority (CA). You must specify the
18
23
  * CA configuration, an optional configuration for Online Certificate Status Protocol
19
24
  * (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
@@ -45,6 +50,8 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param CreateCertificateAuthorityCommandInput - {@link CreateCertificateAuthorityCommandInput}
54
+ * @returns {@link CreateCertificateAuthorityCommandOutput}
48
55
  * @see {@link CreateCertificateAuthorityCommandInput} for command's `input` shape.
49
56
  * @see {@link CreateCertificateAuthorityCommandOutput} for command's `response` shape.
50
57
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -69,11 +76,20 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica
69
76
  export declare class CreateCertificateAuthorityCommand extends $Command<CreateCertificateAuthorityCommandInput, CreateCertificateAuthorityCommandOutput, ACMPCAClientResolvedConfig> {
70
77
  readonly input: CreateCertificateAuthorityCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: CreateCertificateAuthorityCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCertificateAuthorityCommandInput, CreateCertificateAuthorityCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { CreatePermissionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePermissionCommand}.
8
10
  */
9
11
  export interface CreatePermissionCommandInput extends CreatePermissionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePermissionCommand}.
13
17
  */
14
18
  export interface CreatePermissionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
18
23
  * principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
19
24
  * renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
@@ -51,6 +56,8 @@ export interface CreatePermissionCommandOutput extends __MetadataBearer {
51
56
  * const response = await client.send(command);
52
57
  * ```
53
58
  *
59
+ * @param CreatePermissionCommandInput - {@link CreatePermissionCommandInput}
60
+ * @returns {@link CreatePermissionCommandOutput}
54
61
  * @see {@link CreatePermissionCommandInput} for command's `input` shape.
55
62
  * @see {@link CreatePermissionCommandOutput} for command's `response` shape.
56
63
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -81,11 +88,20 @@ export interface CreatePermissionCommandOutput extends __MetadataBearer {
81
88
  export declare class CreatePermissionCommand extends $Command<CreatePermissionCommandInput, CreatePermissionCommandOutput, ACMPCAClientResolvedConfig> {
82
89
  readonly input: CreatePermissionCommandInput;
83
90
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
91
+ /**
92
+ * @public
93
+ */
84
94
  constructor(input: CreatePermissionCommandInput);
85
95
  /**
86
96
  * @internal
87
97
  */
88
98
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePermissionCommandInput, CreatePermissionCommandOutput>;
99
+ /**
100
+ * @internal
101
+ */
89
102
  private serialize;
103
+ /**
104
+ * @internal
105
+ */
90
106
  private deserialize;
91
107
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { DeleteCertificateAuthorityRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCertificateAuthorityCommand}.
8
10
  */
9
11
  export interface DeleteCertificateAuthorityCommandInput extends DeleteCertificateAuthorityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCertificateAuthorityCommand}.
13
17
  */
14
18
  export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource
18
23
  * Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
19
24
  * the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p>
@@ -44,6 +49,8 @@ export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBeare
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param DeleteCertificateAuthorityCommandInput - {@link DeleteCertificateAuthorityCommandInput}
53
+ * @returns {@link DeleteCertificateAuthorityCommandOutput}
47
54
  * @see {@link DeleteCertificateAuthorityCommandInput} for command's `input` shape.
48
55
  * @see {@link DeleteCertificateAuthorityCommandOutput} for command's `response` shape.
49
56
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -67,11 +74,20 @@ export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBeare
67
74
  export declare class DeleteCertificateAuthorityCommand extends $Command<DeleteCertificateAuthorityCommandInput, DeleteCertificateAuthorityCommandOutput, ACMPCAClientResolvedConfig> {
68
75
  readonly input: DeleteCertificateAuthorityCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: DeleteCertificateAuthorityCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCertificateAuthorityCommandInput, DeleteCertificateAuthorityCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { DeletePermissionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePermissionCommand}.
8
10
  */
9
11
  export interface DeletePermissionCommandInput extends DeletePermissionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePermissionCommand}.
13
17
  */
14
18
  export interface DeletePermissionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
18
23
  * (acm.amazonaws.com). </p>
19
24
  * <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
@@ -53,6 +58,8 @@ export interface DeletePermissionCommandOutput extends __MetadataBearer {
53
58
  * const response = await client.send(command);
54
59
  * ```
55
60
  *
61
+ * @param DeletePermissionCommandInput - {@link DeletePermissionCommandInput}
62
+ * @returns {@link DeletePermissionCommandOutput}
56
63
  * @see {@link DeletePermissionCommandInput} for command's `input` shape.
57
64
  * @see {@link DeletePermissionCommandOutput} for command's `response` shape.
58
65
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -76,11 +83,20 @@ export interface DeletePermissionCommandOutput extends __MetadataBearer {
76
83
  export declare class DeletePermissionCommand extends $Command<DeletePermissionCommandInput, DeletePermissionCommandOutput, ACMPCAClientResolvedConfig> {
77
84
  readonly input: DeletePermissionCommandInput;
78
85
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
79
89
  constructor(input: DeletePermissionCommandInput);
80
90
  /**
81
91
  * @internal
82
92
  */
83
93
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePermissionCommandInput, DeletePermissionCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
84
97
  private serialize;
98
+ /**
99
+ * @internal
100
+ */
85
101
  private deserialize;
86
102
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { DeletePolicyRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePolicyCommand}.
8
10
  */
9
11
  export interface DeletePolicyCommandInput extends DeletePolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePolicyCommand}.
13
17
  */
14
18
  export interface DeletePolicyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
18
23
  * access that the policy has granted. If there is no policy attached to the private CA,
19
24
  * this action will return successful.</p>
@@ -59,6 +64,8 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
59
64
  * const response = await client.send(command);
60
65
  * ```
61
66
  *
67
+ * @param DeletePolicyCommandInput - {@link DeletePolicyCommandInput}
68
+ * @returns {@link DeletePolicyCommandOutput}
62
69
  * @see {@link DeletePolicyCommandInput} for command's `input` shape.
63
70
  * @see {@link DeletePolicyCommandOutput} for command's `response` shape.
64
71
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -90,11 +97,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
90
97
  export declare class DeletePolicyCommand extends $Command<DeletePolicyCommandInput, DeletePolicyCommandOutput, ACMPCAClientResolvedConfig> {
91
98
  readonly input: DeletePolicyCommandInput;
92
99
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
100
+ /**
101
+ * @public
102
+ */
93
103
  constructor(input: DeletePolicyCommandInput);
94
104
  /**
95
105
  * @internal
96
106
  */
97
107
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePolicyCommandInput, DeletePolicyCommandOutput>;
108
+ /**
109
+ * @internal
110
+ */
98
111
  private serialize;
112
+ /**
113
+ * @internal
114
+ */
99
115
  private deserialize;
100
116
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { DescribeCertificateAuthorityAuditReportRequest, DescribeCertificateAuthorityAuditReportResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCertificateAuthorityAuditReportCommand}.
8
10
  */
9
11
  export interface DescribeCertificateAuthorityAuditReportCommandInput extends DescribeCertificateAuthorityAuditReportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCertificateAuthorityAuditReportCommand}.
13
17
  */
14
18
  export interface DescribeCertificateAuthorityAuditReportCommandOutput extends DescribeCertificateAuthorityAuditReportResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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
18
23
  * every time the certificate authority (CA) private key is used. The private key is used
19
24
  * when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the
@@ -28,6 +33,8 @@ export interface DescribeCertificateAuthorityAuditReportCommandOutput extends De
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeCertificateAuthorityAuditReportCommandInput - {@link DescribeCertificateAuthorityAuditReportCommandInput}
37
+ * @returns {@link DescribeCertificateAuthorityAuditReportCommandOutput}
31
38
  * @see {@link DescribeCertificateAuthorityAuditReportCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeCertificateAuthorityAuditReportCommandOutput} for command's `response` shape.
33
40
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DescribeCertificateAuthorityAuditReportCommandOutput extends De
48
55
  export declare class DescribeCertificateAuthorityAuditReportCommand extends $Command<DescribeCertificateAuthorityAuditReportCommandInput, DescribeCertificateAuthorityAuditReportCommandOutput, ACMPCAClientResolvedConfig> {
49
56
  readonly input: DescribeCertificateAuthorityAuditReportCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DescribeCertificateAuthorityAuditReportCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCertificateAuthorityAuditReportCommandInput, DescribeCertificateAuthorityAuditReportCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }