@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
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { DescribeCertificateAuthorityRequest, DescribeCertificateAuthorityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCertificateAuthorityCommand}.
8
10
  */
9
11
  export interface DescribeCertificateAuthorityCommandInput extends DescribeCertificateAuthorityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCertificateAuthorityCommand}.
13
17
  */
14
18
  export interface DescribeCertificateAuthorityCommandOutput extends DescribeCertificateAuthorityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists information about your private certificate authority (CA) or one that has been
18
23
  * shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
19
24
  * The output contains the status of your CA. This can be any of the following: </p>
@@ -65,6 +70,8 @@ export interface DescribeCertificateAuthorityCommandOutput extends DescribeCerti
65
70
  * const response = await client.send(command);
66
71
  * ```
67
72
  *
73
+ * @param DescribeCertificateAuthorityCommandInput - {@link DescribeCertificateAuthorityCommandInput}
74
+ * @returns {@link DescribeCertificateAuthorityCommandOutput}
68
75
  * @see {@link DescribeCertificateAuthorityCommandInput} for command's `input` shape.
69
76
  * @see {@link DescribeCertificateAuthorityCommandOutput} for command's `response` shape.
70
77
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -82,11 +89,20 @@ export interface DescribeCertificateAuthorityCommandOutput extends DescribeCerti
82
89
  export declare class DescribeCertificateAuthorityCommand extends $Command<DescribeCertificateAuthorityCommandInput, DescribeCertificateAuthorityCommandOutput, ACMPCAClientResolvedConfig> {
83
90
  readonly input: DescribeCertificateAuthorityCommandInput;
84
91
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
92
+ /**
93
+ * @public
94
+ */
85
95
  constructor(input: DescribeCertificateAuthorityCommandInput);
86
96
  /**
87
97
  * @internal
88
98
  */
89
99
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCertificateAuthorityCommandInput, DescribeCertificateAuthorityCommandOutput>;
100
+ /**
101
+ * @internal
102
+ */
90
103
  private serialize;
104
+ /**
105
+ * @internal
106
+ */
91
107
  private deserialize;
92
108
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { GetCertificateAuthorityCertificateRequest, GetCertificateAuthorityCertificateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCertificateAuthorityCertificateCommand}.
8
10
  */
9
11
  export interface GetCertificateAuthorityCertificateCommandInput extends GetCertificateAuthorityCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCertificateAuthorityCertificateCommand}.
13
17
  */
14
18
  export interface GetCertificateAuthorityCertificateCommandOutput extends GetCertificateAuthorityCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the certificate and certificate chain for your private certificate authority
18
23
  * (CA) or one that has been shared with you. Both the certificate and the chain are base64
19
24
  * PEM-encoded. The chain does not include the CA certificate. Each certificate in the
@@ -28,6 +33,8 @@ export interface GetCertificateAuthorityCertificateCommandOutput extends GetCert
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetCertificateAuthorityCertificateCommandInput - {@link GetCertificateAuthorityCertificateCommandInput}
37
+ * @returns {@link GetCertificateAuthorityCertificateCommandOutput}
31
38
  * @see {@link GetCertificateAuthorityCertificateCommandInput} for command's `input` shape.
32
39
  * @see {@link GetCertificateAuthorityCertificateCommandOutput} for command's `response` shape.
33
40
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -48,11 +55,20 @@ export interface GetCertificateAuthorityCertificateCommandOutput extends GetCert
48
55
  export declare class GetCertificateAuthorityCertificateCommand extends $Command<GetCertificateAuthorityCertificateCommandInput, GetCertificateAuthorityCertificateCommandOutput, ACMPCAClientResolvedConfig> {
49
56
  readonly input: GetCertificateAuthorityCertificateCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: GetCertificateAuthorityCertificateCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCertificateAuthorityCertificateCommandInput, GetCertificateAuthorityCertificateCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { GetCertificateAuthorityCsrRequest, GetCertificateAuthorityCsrResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCertificateAuthorityCsrCommand}.
8
10
  */
9
11
  export interface GetCertificateAuthorityCsrCommandInput extends GetCertificateAuthorityCsrRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCertificateAuthorityCsrCommand}.
13
17
  */
14
18
  export interface GetCertificateAuthorityCsrCommandOutput extends GetCertificateAuthorityCsrResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the certificate signing request (CSR) for your private certificate authority
18
23
  * (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
19
24
  * or on-premises root or subordinate CA. Then import the signed certificate back into
@@ -29,6 +34,8 @@ export interface GetCertificateAuthorityCsrCommandOutput extends GetCertificateA
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param GetCertificateAuthorityCsrCommandInput - {@link GetCertificateAuthorityCsrCommandInput}
38
+ * @returns {@link GetCertificateAuthorityCsrCommandOutput}
32
39
  * @see {@link GetCertificateAuthorityCsrCommandInput} for command's `input` shape.
33
40
  * @see {@link GetCertificateAuthorityCsrCommandOutput} for command's `response` shape.
34
41
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -55,11 +62,20 @@ export interface GetCertificateAuthorityCsrCommandOutput extends GetCertificateA
55
62
  export declare class GetCertificateAuthorityCsrCommand extends $Command<GetCertificateAuthorityCsrCommandInput, GetCertificateAuthorityCsrCommandOutput, ACMPCAClientResolvedConfig> {
56
63
  readonly input: GetCertificateAuthorityCsrCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: GetCertificateAuthorityCsrCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCertificateAuthorityCsrCommandInput, GetCertificateAuthorityCsrCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { GetCertificateRequest, GetCertificateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCertificateCommand}.
8
10
  */
9
11
  export interface GetCertificateCommandInput extends GetCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCertificateCommand}.
13
17
  */
14
18
  export interface GetCertificateCommandOutput extends GetCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a certificate from your private CA or one that has been shared with you. The
18
23
  * 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
19
24
  * must specify both the ARN of your private CA and the ARN of the issued certificate when
@@ -32,6 +37,8 @@ export interface GetCertificateCommandOutput extends GetCertificateResponse, __M
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param GetCertificateCommandInput - {@link GetCertificateCommandInput}
41
+ * @returns {@link GetCertificateCommandOutput}
35
42
  * @see {@link GetCertificateCommandInput} for command's `input` shape.
36
43
  * @see {@link GetCertificateCommandOutput} for command's `response` shape.
37
44
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -58,11 +65,20 @@ export interface GetCertificateCommandOutput extends GetCertificateResponse, __M
58
65
  export declare class GetCertificateCommand extends $Command<GetCertificateCommandInput, GetCertificateCommandOutput, ACMPCAClientResolvedConfig> {
59
66
  readonly input: GetCertificateCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: GetCertificateCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCertificateCommandInput, GetCertificateCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { GetPolicyRequest, GetPolicyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPolicyCommand}.
8
10
  */
9
11
  export interface GetPolicyCommandInput extends GetPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPolicyCommand}.
13
17
  */
14
18
  export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the resource-based policy attached to a private CA. If either the private CA
18
23
  * resource or the policy cannot be found, this action returns a
19
24
  * <code>ResourceNotFoundException</code>. </p>
@@ -55,6 +60,8 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea
55
60
  * const response = await client.send(command);
56
61
  * ```
57
62
  *
63
+ * @param GetPolicyCommandInput - {@link GetPolicyCommandInput}
64
+ * @returns {@link GetPolicyCommandOutput}
58
65
  * @see {@link GetPolicyCommandInput} for command's `input` shape.
59
66
  * @see {@link GetPolicyCommandOutput} for command's `response` shape.
60
67
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -78,11 +85,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea
78
85
  export declare class GetPolicyCommand extends $Command<GetPolicyCommandInput, GetPolicyCommandOutput, ACMPCAClientResolvedConfig> {
79
86
  readonly input: GetPolicyCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: GetPolicyCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPolicyCommandInput, GetPolicyCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { ImportCertificateAuthorityCertificateRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ImportCertificateAuthorityCertificateCommand}.
8
10
  */
9
11
  export interface ImportCertificateAuthorityCertificateCommandInput extends ImportCertificateAuthorityCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ImportCertificateAuthorityCertificateCommand}.
13
17
  */
14
18
  export interface ImportCertificateAuthorityCertificateCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
18
23
  * are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
19
24
  * this action, the following preparations must in place:</p>
@@ -152,6 +157,8 @@ export interface ImportCertificateAuthorityCertificateCommandOutput extends __Me
152
157
  * const response = await client.send(command);
153
158
  * ```
154
159
  *
160
+ * @param ImportCertificateAuthorityCertificateCommandInput - {@link ImportCertificateAuthorityCertificateCommandInput}
161
+ * @returns {@link ImportCertificateAuthorityCertificateCommandOutput}
155
162
  * @see {@link ImportCertificateAuthorityCertificateCommandInput} for command's `input` shape.
156
163
  * @see {@link ImportCertificateAuthorityCertificateCommandOutput} for command's `response` shape.
157
164
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -191,11 +198,20 @@ export interface ImportCertificateAuthorityCertificateCommandOutput extends __Me
191
198
  export declare class ImportCertificateAuthorityCertificateCommand extends $Command<ImportCertificateAuthorityCertificateCommandInput, ImportCertificateAuthorityCertificateCommandOutput, ACMPCAClientResolvedConfig> {
192
199
  readonly input: ImportCertificateAuthorityCertificateCommandInput;
193
200
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
201
+ /**
202
+ * @public
203
+ */
194
204
  constructor(input: ImportCertificateAuthorityCertificateCommandInput);
195
205
  /**
196
206
  * @internal
197
207
  */
198
208
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportCertificateAuthorityCertificateCommandInput, ImportCertificateAuthorityCertificateCommandOutput>;
209
+ /**
210
+ * @internal
211
+ */
199
212
  private serialize;
213
+ /**
214
+ * @internal
215
+ */
200
216
  private deserialize;
201
217
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { IssueCertificateRequest, IssueCertificateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link IssueCertificateCommand}.
8
10
  */
9
11
  export interface IssueCertificateCommandInput extends IssueCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link IssueCertificateCommand}.
13
17
  */
14
18
  export interface IssueCertificateCommandOutput extends IssueCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Uses your private certificate authority (CA), or one that has been shared with you, to
18
23
  * issue a client certificate. This action returns the Amazon Resource Name (ARN) of the
19
24
  * 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
@@ -32,6 +37,8 @@ export interface IssueCertificateCommandOutput extends IssueCertificateResponse,
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param IssueCertificateCommandInput - {@link IssueCertificateCommandInput}
41
+ * @returns {@link IssueCertificateCommandOutput}
35
42
  * @see {@link IssueCertificateCommandInput} for command's `input` shape.
36
43
  * @see {@link IssueCertificateCommandOutput} for command's `response` shape.
37
44
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -62,11 +69,20 @@ export interface IssueCertificateCommandOutput extends IssueCertificateResponse,
62
69
  export declare class IssueCertificateCommand extends $Command<IssueCertificateCommandInput, IssueCertificateCommandOutput, ACMPCAClientResolvedConfig> {
63
70
  readonly input: IssueCertificateCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: IssueCertificateCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<IssueCertificateCommandInput, IssueCertificateCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { ListCertificateAuthoritiesRequest, ListCertificateAuthoritiesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListCertificateAuthoritiesCommand}.
8
10
  */
9
11
  export interface ListCertificateAuthoritiesCommandInput extends ListCertificateAuthoritiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListCertificateAuthoritiesCommand}.
13
17
  */
14
18
  export interface ListCertificateAuthoritiesCommandOutput extends ListCertificateAuthoritiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListCertificateAuthoritiesCommandOutput extends ListCertificate
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListCertificateAuthoritiesCommandInput - {@link ListCertificateAuthoritiesCommandInput}
34
+ * @returns {@link ListCertificateAuthoritiesCommandOutput}
28
35
  * @see {@link ListCertificateAuthoritiesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListCertificateAuthoritiesCommandOutput} for command's `response` shape.
30
37
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -38,11 +45,20 @@ export interface ListCertificateAuthoritiesCommandOutput extends ListCertificate
38
45
  export declare class ListCertificateAuthoritiesCommand extends $Command<ListCertificateAuthoritiesCommandInput, ListCertificateAuthoritiesCommandOutput, ACMPCAClientResolvedConfig> {
39
46
  readonly input: ListCertificateAuthoritiesCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: ListCertificateAuthoritiesCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCertificateAuthoritiesCommandInput, ListCertificateAuthoritiesCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { ListPermissionsRequest, ListPermissionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPermissionsCommand}.
8
10
  */
9
11
  export interface ListPermissionsCommandInput extends ListPermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPermissionsCommand}.
13
17
  */
14
18
  export interface ListPermissionsCommandOutput extends ListPermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service
18
23
  * principal (acm.amazonaws.com). </p>
19
24
  * <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
@@ -52,6 +57,8 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
52
57
  * const response = await client.send(command);
53
58
  * ```
54
59
  *
60
+ * @param ListPermissionsCommandInput - {@link ListPermissionsCommandInput}
61
+ * @returns {@link ListPermissionsCommandOutput}
55
62
  * @see {@link ListPermissionsCommandInput} for command's `input` shape.
56
63
  * @see {@link ListPermissionsCommandOutput} for command's `response` shape.
57
64
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -79,11 +86,20 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
79
86
  export declare class ListPermissionsCommand extends $Command<ListPermissionsCommandInput, ListPermissionsCommandOutput, ACMPCAClientResolvedConfig> {
80
87
  readonly input: ListPermissionsCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: ListPermissionsCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPermissionsCommandInput, ListPermissionsCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { ListTagsRequest, ListTagsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsCommand}.
8
10
  */
9
11
  export interface ListTagsCommandInput extends ListTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsCommand}.
13
17
  */
14
18
  export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags, if any, that are associated with your private CA or one that has been
18
23
  * shared with you. Tags are labels that you can use to identify and organize your CAs.
19
24
  * 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>
@@ -28,6 +33,8 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListTagsCommandInput - {@link ListTagsCommandInput}
37
+ * @returns {@link ListTagsCommandOutput}
31
38
  * @see {@link ListTagsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListTagsCommandOutput} for command's `response` shape.
33
40
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare
48
55
  export declare class ListTagsCommand extends $Command<ListTagsCommandInput, ListTagsCommandOutput, ACMPCAClientResolvedConfig> {
49
56
  readonly input: ListTagsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListTagsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsCommandInput, ListTagsCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { PutPolicyRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutPolicyCommand}.
8
10
  */
9
11
  export interface PutPolicyCommandInput extends PutPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutPolicyCommand}.
13
17
  */
14
18
  export interface PutPolicyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Attaches a resource-based policy to a private CA. </p>
18
23
  * <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access
19
24
  * 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
@@ -56,6 +61,8 @@ export interface PutPolicyCommandOutput extends __MetadataBearer {
56
61
  * const response = await client.send(command);
57
62
  * ```
58
63
  *
64
+ * @param PutPolicyCommandInput - {@link PutPolicyCommandInput}
65
+ * @returns {@link PutPolicyCommandOutput}
59
66
  * @see {@link PutPolicyCommandInput} for command's `input` shape.
60
67
  * @see {@link PutPolicyCommandOutput} for command's `response` shape.
61
68
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -91,11 +98,20 @@ export interface PutPolicyCommandOutput extends __MetadataBearer {
91
98
  export declare class PutPolicyCommand extends $Command<PutPolicyCommandInput, PutPolicyCommandOutput, ACMPCAClientResolvedConfig> {
92
99
  readonly input: PutPolicyCommandInput;
93
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
94
104
  constructor(input: PutPolicyCommandInput);
95
105
  /**
96
106
  * @internal
97
107
  */
98
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPolicyCommandInput, PutPolicyCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
99
112
  private serialize;
113
+ /**
114
+ * @internal
115
+ */
100
116
  private deserialize;
101
117
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ACMPCAClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ACMPCAClient";
5
5
  import { RestoreCertificateAuthorityRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RestoreCertificateAuthorityCommand}.
8
10
  */
9
11
  export interface RestoreCertificateAuthorityCommandInput extends RestoreCertificateAuthorityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RestoreCertificateAuthorityCommand}.
13
17
  */
14
18
  export interface RestoreCertificateAuthorityCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
18
23
  * 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.
19
24
  * If you did not specify a <b>PermanentDeletionTimeInDays</b>
@@ -35,6 +40,8 @@ export interface RestoreCertificateAuthorityCommandOutput extends __MetadataBear
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param RestoreCertificateAuthorityCommandInput - {@link RestoreCertificateAuthorityCommandInput}
44
+ * @returns {@link RestoreCertificateAuthorityCommandOutput}
38
45
  * @see {@link RestoreCertificateAuthorityCommandInput} for command's `input` shape.
39
46
  * @see {@link RestoreCertificateAuthorityCommandOutput} for command's `response` shape.
40
47
  * @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
@@ -55,11 +62,20 @@ export interface RestoreCertificateAuthorityCommandOutput extends __MetadataBear
55
62
  export declare class RestoreCertificateAuthorityCommand extends $Command<RestoreCertificateAuthorityCommandInput, RestoreCertificateAuthorityCommandOutput, ACMPCAClientResolvedConfig> {
56
63
  readonly input: RestoreCertificateAuthorityCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: RestoreCertificateAuthorityCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ACMPCAClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreCertificateAuthorityCommandInput, RestoreCertificateAuthorityCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }