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