@aws-sdk/client-acm-pca 3.857.0 → 3.859.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 +1 -16
- package/dist-types/ACMPCA.d.ts +1 -16
- package/dist-types/ACMPCAClient.d.ts +1 -16
- package/dist-types/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +3 -13
- package/dist-types/commands/CreateCertificateAuthorityCommand.d.ts +4 -27
- package/dist-types/commands/CreatePermissionCommand.d.ts +4 -33
- package/dist-types/commands/DeleteCertificateAuthorityCommand.d.ts +3 -24
- package/dist-types/commands/DeletePermissionCommand.d.ts +3 -33
- package/dist-types/commands/DeletePolicyCommand.d.ts +4 -42
- package/dist-types/commands/DescribeCertificateAuthorityAuditReportCommand.d.ts +3 -8
- package/dist-types/commands/DescribeCertificateAuthorityCommand.d.ts +3 -45
- package/dist-types/commands/GetCertificateAuthorityCertificateCommand.d.ts +3 -8
- package/dist-types/commands/GetCertificateAuthorityCsrCommand.d.ts +3 -9
- package/dist-types/commands/GetCertificateCommand.d.ts +3 -12
- package/dist-types/commands/GetPolicyCommand.d.ts +3 -35
- package/dist-types/commands/ImportCertificateAuthorityCertificateCommand.d.ts +4 -132
- package/dist-types/commands/IssueCertificateCommand.d.ts +4 -14
- package/dist-types/commands/ListCertificateAuthoritiesCommand.d.ts +1 -2
- package/dist-types/commands/ListPermissionsCommand.d.ts +4 -34
- package/dist-types/commands/ListTagsCommand.d.ts +3 -8
- package/dist-types/commands/PutPolicyCommand.d.ts +5 -41
- package/dist-types/commands/RestoreCertificateAuthorityCommand.d.ts +3 -15
- package/dist-types/commands/RevokeCertificateCommand.d.ts +4 -26
- package/dist-types/commands/TagCertificateAuthorityCommand.d.ts +5 -23
- package/dist-types/commands/UntagCertificateAuthorityCommand.d.ts +4 -11
- package/dist-types/commands/UpdateCertificateAuthorityCommand.d.ts +4 -17
- package/dist-types/index.d.ts +1 -16
- package/dist-types/models/models_0.d.ts +151 -848
- package/package.json +5 -5
|
@@ -27,14 +27,7 @@ declare const GetCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a certificate from your private CA or one that has been shared with you. The
|
|
31
|
-
* 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
|
|
32
|
-
* must specify both the ARN of your private CA and the ARN of the issued certificate when
|
|
33
|
-
* calling the <b>GetCertificate</b> action. You can retrieve the
|
|
34
|
-
* certificate if it is in the <b>ISSUED</b> state. You can call
|
|
35
|
-
* the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action to create a report that
|
|
36
|
-
* contains information about all of the certificates issued and revoked by your private
|
|
37
|
-
* CA. </p>
|
|
30
|
+
* <p>Retrieves a certificate from your private CA or one that has been shared with you. The 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 must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate if it is in the <b>ISSUED</b>, <b>EXPIRED</b>, or <b>REVOKED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -61,8 +54,7 @@ declare const GetCertificateCommand_base: {
|
|
|
61
54
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
62
55
|
*
|
|
63
56
|
* @throws {@link InvalidArnException} (client fault)
|
|
64
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
65
|
-
* resource.</p>
|
|
57
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
66
58
|
*
|
|
67
59
|
* @throws {@link InvalidStateException} (client fault)
|
|
68
60
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -74,8 +66,7 @@ declare const GetCertificateCommand_base: {
|
|
|
74
66
|
* <p>Your request is already in progress.</p>
|
|
75
67
|
*
|
|
76
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
78
|
-
* cannot be found.</p>
|
|
69
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
79
70
|
*
|
|
80
71
|
* @throws {@link ACMPCAServiceException}
|
|
81
72
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,37 +27,7 @@ declare const GetPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the resource-based policy attached to a private CA. If either the private CA
|
|
31
|
-
* resource or the policy cannot be found, this action returns a
|
|
32
|
-
* <code>ResourceNotFoundException</code>. </p>
|
|
33
|
-
* <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>
|
|
34
|
-
* <p class="title">
|
|
35
|
-
* <b>About Policies</b>
|
|
36
|
-
* </p>
|
|
37
|
-
* <ul>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
40
|
-
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
41
|
-
* 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>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
45
|
-
* signed by a CA in another account.</p>
|
|
46
|
-
* </li>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>For ACM to manage automatic renewal of these certificates,
|
|
49
|
-
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
50
|
-
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
51
|
-
* Amazon Web Services Private CA policy. For more information, see
|
|
52
|
-
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
53
|
-
* Service Linked Role with ACM</a>.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
57
|
-
* see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
58
|
-
* Access</a>.</p>
|
|
59
|
-
* </li>
|
|
60
|
-
* </ul>
|
|
30
|
+
* <p>Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>. </p> <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> <p class="title"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, 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> </li> <li> <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>
|
|
61
31
|
* @example
|
|
62
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
63
33
|
* ```javascript
|
|
@@ -82,8 +52,7 @@ declare const GetPolicyCommand_base: {
|
|
|
82
52
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
83
53
|
*
|
|
84
54
|
* @throws {@link InvalidArnException} (client fault)
|
|
85
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
86
|
-
* resource.</p>
|
|
55
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
87
56
|
*
|
|
88
57
|
* @throws {@link InvalidStateException} (client fault)
|
|
89
58
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -92,8 +61,7 @@ declare const GetPolicyCommand_base: {
|
|
|
92
61
|
* <p>The request has failed for an unspecified reason.</p>
|
|
93
62
|
*
|
|
94
63
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
95
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
96
|
-
* cannot be found.</p>
|
|
64
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
97
65
|
*
|
|
98
66
|
* @throws {@link ACMPCAServiceException}
|
|
99
67
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,132 +27,7 @@ declare const ImportCertificateAuthorityCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
|
|
31
|
-
* are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
|
|
32
|
-
* this action, the following preparations must in place:</p>
|
|
33
|
-
* <ol>
|
|
34
|
-
* <li>
|
|
35
|
-
* <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
|
|
36
|
-
* plan to back with the imported certificate.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a> action to generate a certificate signing
|
|
40
|
-
* request (CSR).</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>Sign the CSR using a root or intermediate CA hosted by either an on-premises
|
|
44
|
-
* PKI hierarchy or by a commercial CA.</p>
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>Create a certificate chain and copy the signed certificate and the certificate
|
|
48
|
-
* chain to your working directory.</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* </ol>
|
|
51
|
-
* <p>Amazon Web Services Private CA supports three scenarios for installing a CA certificate:</p>
|
|
52
|
-
* <ul>
|
|
53
|
-
* <li>
|
|
54
|
-
* <p>Installing a certificate for a root CA hosted by Amazon Web Services Private CA.</p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>Installing a subordinate CA certificate whose parent authority is hosted by
|
|
58
|
-
* Amazon Web Services Private CA.</p>
|
|
59
|
-
* </li>
|
|
60
|
-
* <li>
|
|
61
|
-
* <p>Installing a subordinate CA certificate whose parent authority is externally
|
|
62
|
-
* hosted.</p>
|
|
63
|
-
* </li>
|
|
64
|
-
* </ul>
|
|
65
|
-
* <p>The following additional requirements apply when you import a CA certificate.</p>
|
|
66
|
-
* <ul>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>Only a self-signed certificate can be imported as a root CA.</p>
|
|
69
|
-
* </li>
|
|
70
|
-
* <li>
|
|
71
|
-
* <p>A self-signed certificate cannot be imported as a subordinate CA.</p>
|
|
72
|
-
* </li>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>Your certificate chain must not include the private CA certificate that you
|
|
75
|
-
* are importing.</p>
|
|
76
|
-
* </li>
|
|
77
|
-
* <li>
|
|
78
|
-
* <p>Your root CA must be the last certificate in your chain. The subordinate
|
|
79
|
-
* certificate, if any, that your root CA signed must be next to last. The
|
|
80
|
-
* subordinate certificate signed by the preceding subordinate CA must come next,
|
|
81
|
-
* and so on until your chain is built. </p>
|
|
82
|
-
* </li>
|
|
83
|
-
* <li>
|
|
84
|
-
* <p>The chain must be PEM-encoded.</p>
|
|
85
|
-
* </li>
|
|
86
|
-
* <li>
|
|
87
|
-
* <p>The maximum allowed size of a certificate is 32 KB.</p>
|
|
88
|
-
* </li>
|
|
89
|
-
* <li>
|
|
90
|
-
* <p>The maximum allowed size of a certificate chain is 2 MB.</p>
|
|
91
|
-
* </li>
|
|
92
|
-
* </ul>
|
|
93
|
-
* <p>
|
|
94
|
-
* <i>Enforcement of Critical Constraints</i>
|
|
95
|
-
* </p>
|
|
96
|
-
* <p>Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA
|
|
97
|
-
* certificate or chain.</p>
|
|
98
|
-
* <ul>
|
|
99
|
-
* <li>
|
|
100
|
-
* <p>Authority key identifier</p>
|
|
101
|
-
* </li>
|
|
102
|
-
* <li>
|
|
103
|
-
* <p>Basic constraints (<i>must</i> be marked critical)</p>
|
|
104
|
-
* </li>
|
|
105
|
-
* <li>
|
|
106
|
-
* <p>Certificate policies</p>
|
|
107
|
-
* </li>
|
|
108
|
-
* <li>
|
|
109
|
-
* <p>Extended key usage</p>
|
|
110
|
-
* </li>
|
|
111
|
-
* <li>
|
|
112
|
-
* <p>Inhibit anyPolicy</p>
|
|
113
|
-
* </li>
|
|
114
|
-
* <li>
|
|
115
|
-
* <p>Issuer alternative name</p>
|
|
116
|
-
* </li>
|
|
117
|
-
* <li>
|
|
118
|
-
* <p>Key usage</p>
|
|
119
|
-
* </li>
|
|
120
|
-
* <li>
|
|
121
|
-
* <p>Name constraints</p>
|
|
122
|
-
* </li>
|
|
123
|
-
* <li>
|
|
124
|
-
* <p>Policy mappings</p>
|
|
125
|
-
* </li>
|
|
126
|
-
* <li>
|
|
127
|
-
* <p>Subject alternative name</p>
|
|
128
|
-
* </li>
|
|
129
|
-
* <li>
|
|
130
|
-
* <p>Subject directory attributes</p>
|
|
131
|
-
* </li>
|
|
132
|
-
* <li>
|
|
133
|
-
* <p>Subject key identifier</p>
|
|
134
|
-
* </li>
|
|
135
|
-
* <li>
|
|
136
|
-
* <p>Subject information access</p>
|
|
137
|
-
* </li>
|
|
138
|
-
* </ul>
|
|
139
|
-
* <p>Amazon Web Services Private CA rejects the following extensions when they are marked critical in an
|
|
140
|
-
* imported CA certificate or chain.</p>
|
|
141
|
-
* <ul>
|
|
142
|
-
* <li>
|
|
143
|
-
* <p>Authority information access</p>
|
|
144
|
-
* </li>
|
|
145
|
-
* <li>
|
|
146
|
-
* <p>CRL distribution points</p>
|
|
147
|
-
* </li>
|
|
148
|
-
* <li>
|
|
149
|
-
* <p>Freshest CRL</p>
|
|
150
|
-
* </li>
|
|
151
|
-
* <li>
|
|
152
|
-
* <p>Policy constraints</p>
|
|
153
|
-
* </li>
|
|
154
|
-
* </ul>
|
|
155
|
-
* <p>Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions.</p>
|
|
30
|
+
* <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:</p> <ol> <li> <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 plan to back with the imported certificate.</p> </li> <li> <p>Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a> action to generate a certificate signing request (CSR).</p> </li> <li> <p>Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.</p> </li> <li> <p>Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.</p> </li> </ol> <p>Amazon Web Services Private CA supports three scenarios for installing a CA certificate:</p> <ul> <li> <p>Installing a certificate for a root CA hosted by Amazon Web Services Private CA.</p> </li> <li> <p>Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.</p> </li> <li> <p>Installing a subordinate CA certificate whose parent authority is externally hosted.</p> </li> </ul> <p>The following additional requirements apply when you import a CA certificate.</p> <ul> <li> <p>Only a self-signed certificate can be imported as a root CA.</p> </li> <li> <p>A self-signed certificate cannot be imported as a subordinate CA.</p> </li> <li> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </li> <li> <p>Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </li> <li> <p>The chain must be PEM-encoded.</p> </li> <li> <p>The maximum allowed size of a certificate is 32 KB.</p> </li> <li> <p>The maximum allowed size of a certificate chain is 2 MB.</p> </li> </ul> <p> <i>Enforcement of Critical Constraints</i> </p> <p>Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.</p> <ul> <li> <p>Authority key identifier</p> </li> <li> <p>Basic constraints (<i>must</i> be marked critical)</p> </li> <li> <p>Certificate policies</p> </li> <li> <p>Extended key usage</p> </li> <li> <p>Inhibit anyPolicy</p> </li> <li> <p>Issuer alternative name</p> </li> <li> <p>Key usage</p> </li> <li> <p>Name constraints</p> </li> <li> <p>Policy mappings</p> </li> <li> <p>Subject alternative name</p> </li> <li> <p>Subject directory attributes</p> </li> <li> <p>Subject key identifier</p> </li> <li> <p>Subject information access</p> </li> </ul> <p>Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.</p> <ul> <li> <p>Authority information access</p> </li> <li> <p>CRL distribution points</p> </li> <li> <p>Freshest CRL</p> </li> <li> <p>Policy constraints</p> </li> </ul> <p>Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions.</p>
|
|
156
31
|
* @example
|
|
157
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
158
33
|
* ```javascript
|
|
@@ -177,15 +52,13 @@ declare const ImportCertificateAuthorityCertificateCommand_base: {
|
|
|
177
52
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
178
53
|
*
|
|
179
54
|
* @throws {@link CertificateMismatchException} (client fault)
|
|
180
|
-
* <p>The certificate authority certificate you are importing does not comply with
|
|
181
|
-
* conditions specified in the certificate that signed it.</p>
|
|
55
|
+
* <p>The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.</p>
|
|
182
56
|
*
|
|
183
57
|
* @throws {@link ConcurrentModificationException} (client fault)
|
|
184
58
|
* <p>A previous update to your private CA is still ongoing.</p>
|
|
185
59
|
*
|
|
186
60
|
* @throws {@link InvalidArnException} (client fault)
|
|
187
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
188
|
-
* resource.</p>
|
|
61
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
189
62
|
*
|
|
190
63
|
* @throws {@link InvalidRequestException} (client fault)
|
|
191
64
|
* <p>The request action cannot be performed or is prohibited.</p>
|
|
@@ -203,8 +76,7 @@ declare const ImportCertificateAuthorityCertificateCommand_base: {
|
|
|
203
76
|
* <p>Your request is already in progress.</p>
|
|
204
77
|
*
|
|
205
78
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
206
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
207
|
-
* cannot be found.</p>
|
|
79
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
208
80
|
*
|
|
209
81
|
* @throws {@link ACMPCAServiceException}
|
|
210
82
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,14 +27,7 @@ declare const IssueCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Uses your private certificate authority (CA), or one that has been shared with you, to
|
|
31
|
-
* issue a client certificate. This action returns the Amazon Resource Name (ARN) of the
|
|
32
|
-
* 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
|
|
33
|
-
* specifying the ARN. </p>
|
|
34
|
-
* <note>
|
|
35
|
-
* <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the
|
|
36
|
-
* certificates that you issue by using Amazon Web Services Private CA.</p>
|
|
37
|
-
* </note>
|
|
30
|
+
* <p>Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the 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 specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.</p> </note>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -176,22 +169,19 @@ declare const IssueCertificateCommand_base: {
|
|
|
176
169
|
* <p>One or more of the specified arguments was not valid.</p>
|
|
177
170
|
*
|
|
178
171
|
* @throws {@link InvalidArnException} (client fault)
|
|
179
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
180
|
-
* resource.</p>
|
|
172
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
181
173
|
*
|
|
182
174
|
* @throws {@link InvalidStateException} (client fault)
|
|
183
175
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
184
176
|
*
|
|
185
177
|
* @throws {@link LimitExceededException} (client fault)
|
|
186
|
-
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
|
|
187
|
-
* the quota that was exceeded.</p>
|
|
178
|
+
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.</p>
|
|
188
179
|
*
|
|
189
180
|
* @throws {@link MalformedCSRException} (client fault)
|
|
190
181
|
* <p>The certificate signing request is invalid.</p>
|
|
191
182
|
*
|
|
192
183
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
193
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
194
|
-
* cannot be found.</p>
|
|
184
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
195
185
|
*
|
|
196
186
|
* @throws {@link ACMPCAServiceException}
|
|
197
187
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -173,8 +173,7 @@ declare const ListCertificateAuthoritiesCommand_base: {
|
|
|
173
173
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
174
174
|
*
|
|
175
175
|
* @throws {@link InvalidNextTokenException} (client fault)
|
|
176
|
-
* <p>The token specified in the <code>NextToken</code> argument is not valid. Use the token
|
|
177
|
-
* returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.</p>
|
|
176
|
+
* <p>The token specified in the <code>NextToken</code> argument is not valid. Use the token returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.</p>
|
|
178
177
|
*
|
|
179
178
|
* @throws {@link ACMPCAServiceException}
|
|
180
179
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,34 +27,7 @@ declare const ListPermissionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service
|
|
31
|
-
* principal (acm.amazonaws.com). </p>
|
|
32
|
-
* <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
|
|
33
|
-
* same Amazon Web Services account as the CA. </p>
|
|
34
|
-
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
|
|
35
|
-
* revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
|
|
36
|
-
* <p class="title">
|
|
37
|
-
* <b>About Permissions</b>
|
|
38
|
-
* </p>
|
|
39
|
-
* <ul>
|
|
40
|
-
* <li>
|
|
41
|
-
* <p>If the private CA and the certificates it issues reside in the same
|
|
42
|
-
* account, you can use <code>CreatePermission</code> to grant permissions for ACM to
|
|
43
|
-
* carry out automatic certificate renewals.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>For automatic certificate renewal to succeed, the ACM service principal
|
|
47
|
-
* needs permissions to create, retrieve, and list certificates.</p>
|
|
48
|
-
* </li>
|
|
49
|
-
* <li>
|
|
50
|
-
* <p>If the private CA and the ACM certificates reside in different accounts,
|
|
51
|
-
* then permissions cannot be used to enable automatic renewals. Instead,
|
|
52
|
-
* the ACM certificate owner must set up a resource-based policy to enable
|
|
53
|
-
* cross-account issuance and renewals. For more information, see
|
|
54
|
-
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
|
|
55
|
-
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* </ul>
|
|
30
|
+
* <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). </p> <p>These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. </p> <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p> <p class="title"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, 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> </li> </ul>
|
|
58
31
|
* @example
|
|
59
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
60
33
|
* ```javascript
|
|
@@ -93,12 +66,10 @@ declare const ListPermissionsCommand_base: {
|
|
|
93
66
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
94
67
|
*
|
|
95
68
|
* @throws {@link InvalidArnException} (client fault)
|
|
96
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
97
|
-
* resource.</p>
|
|
69
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
98
70
|
*
|
|
99
71
|
* @throws {@link InvalidNextTokenException} (client fault)
|
|
100
|
-
* <p>The token specified in the <code>NextToken</code> argument is not valid. Use the token
|
|
101
|
-
* returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.</p>
|
|
72
|
+
* <p>The token specified in the <code>NextToken</code> argument is not valid. Use the token returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.</p>
|
|
102
73
|
*
|
|
103
74
|
* @throws {@link InvalidStateException} (client fault)
|
|
104
75
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -107,8 +78,7 @@ declare const ListPermissionsCommand_base: {
|
|
|
107
78
|
* <p>The request has failed for an unspecified reason.</p>
|
|
108
79
|
*
|
|
109
80
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
110
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
111
|
-
* cannot be found.</p>
|
|
81
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
112
82
|
*
|
|
113
83
|
* @throws {@link ACMPCAServiceException}
|
|
114
84
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,10 +27,7 @@ declare const ListTagsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the tags, if any, that are associated with your private CA or one that has been
|
|
31
|
-
* shared with you. Tags are labels that you can use to identify and organize your CAs.
|
|
32
|
-
* 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>
|
|
33
|
-
* 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>
|
|
30
|
+
* <p>Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. 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> 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>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -63,8 +60,7 @@ declare const ListTagsCommand_base: {
|
|
|
63
60
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
64
61
|
*
|
|
65
62
|
* @throws {@link InvalidArnException} (client fault)
|
|
66
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
67
|
-
* resource.</p>
|
|
63
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
68
64
|
*
|
|
69
65
|
* @throws {@link InvalidStateException} (client fault)
|
|
70
66
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -73,8 +69,7 @@ declare const ListTagsCommand_base: {
|
|
|
73
69
|
* <p>The request has failed for an unspecified reason.</p>
|
|
74
70
|
*
|
|
75
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
77
|
-
* cannot be found.</p>
|
|
72
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
78
73
|
*
|
|
79
74
|
* @throws {@link ACMPCAServiceException}
|
|
80
75
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,38 +27,7 @@ declare const PutPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Attaches a resource-based policy to a private CA. </p>
|
|
31
|
-
* <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access
|
|
32
|
-
* 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
|
|
33
|
-
* Access</a>.</p>
|
|
34
|
-
* <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>
|
|
35
|
-
* <p class="title">
|
|
36
|
-
* <b>About Policies</b>
|
|
37
|
-
* </p>
|
|
38
|
-
* <ul>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
41
|
-
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
42
|
-
* 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>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
46
|
-
* signed by a CA in another account.</p>
|
|
47
|
-
* </li>
|
|
48
|
-
* <li>
|
|
49
|
-
* <p>For ACM to manage automatic renewal of these certificates,
|
|
50
|
-
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
51
|
-
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
52
|
-
* Amazon Web Services Private CA policy. For more information, see
|
|
53
|
-
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
54
|
-
* Service Linked Role with ACM</a>.</p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
58
|
-
* see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
59
|
-
* Access</a>.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
30
|
+
* <p>Attaches a resource-based policy to a private CA. </p> <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access 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 Access</a>.</p> <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> <p class="title"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, 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> </li> <li> <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>
|
|
62
31
|
* @example
|
|
63
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
64
33
|
* ```javascript
|
|
@@ -85,27 +54,22 @@ declare const PutPolicyCommand_base: {
|
|
|
85
54
|
* <p>A previous update to your private CA is still ongoing.</p>
|
|
86
55
|
*
|
|
87
56
|
* @throws {@link InvalidArnException} (client fault)
|
|
88
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
89
|
-
* resource.</p>
|
|
57
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
90
58
|
*
|
|
91
59
|
* @throws {@link InvalidPolicyException} (client fault)
|
|
92
|
-
* <p>The resource policy is invalid or is missing a required statement. For general
|
|
93
|
-
* information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
|
|
60
|
+
* <p>The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
|
|
94
61
|
*
|
|
95
62
|
* @throws {@link InvalidStateException} (client fault)
|
|
96
63
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
97
64
|
*
|
|
98
65
|
* @throws {@link LockoutPreventedException} (client fault)
|
|
99
|
-
* <p>The current action was prevented because it would lock the caller out from performing
|
|
100
|
-
* subsequent actions. Verify that the specified parameters would not result in the caller
|
|
101
|
-
* being denied access to the resource. </p>
|
|
66
|
+
* <p>The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource. </p>
|
|
102
67
|
*
|
|
103
68
|
* @throws {@link RequestFailedException} (client fault)
|
|
104
69
|
* <p>The request has failed for an unspecified reason.</p>
|
|
105
70
|
*
|
|
106
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
107
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
108
|
-
* cannot be found.</p>
|
|
72
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
109
73
|
*
|
|
110
74
|
* @throws {@link ACMPCAServiceException}
|
|
111
75
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,17 +27,7 @@ declare const RestoreCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
|
|
31
|
-
* 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.
|
|
32
|
-
* If you did not specify a <b>PermanentDeletionTimeInDays</b>
|
|
33
|
-
* value, by default you can restore the CA at any time in a 30 day period. You can check
|
|
34
|
-
* the time remaining in the restoration period of a private CA in the <code>DELETED</code>
|
|
35
|
-
* 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
|
|
36
|
-
* its pre-deletion status when the <b>RestoreCertificateAuthority</b> action returns. To change its status to
|
|
37
|
-
* <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
|
|
38
|
-
* <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
|
|
39
|
-
* authority into the private CA before it can be activated. You cannot restore a CA after
|
|
40
|
-
* the restoration period has ended.</p>
|
|
30
|
+
* <p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You 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. If you did not specify a <b>PermanentDeletionTimeInDays</b> value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the <code>DELETED</code> 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 its pre-deletion status when the <b>RestoreCertificateAuthority</b> action returns. To change its status to <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 <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 authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.</p>
|
|
41
31
|
* @example
|
|
42
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
33
|
* ```javascript
|
|
@@ -60,15 +50,13 @@ declare const RestoreCertificateAuthorityCommand_base: {
|
|
|
60
50
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
61
51
|
*
|
|
62
52
|
* @throws {@link InvalidArnException} (client fault)
|
|
63
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
64
|
-
* resource.</p>
|
|
53
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
65
54
|
*
|
|
66
55
|
* @throws {@link InvalidStateException} (client fault)
|
|
67
56
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
68
57
|
*
|
|
69
58
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
71
|
-
* cannot be found.</p>
|
|
59
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
72
60
|
*
|
|
73
61
|
* @throws {@link ACMPCAServiceException}
|
|
74
62
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,26 +27,7 @@ declare const RevokeCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate
|
|
31
|
-
* revocation list (CRL) when you create or update your private CA, information about the
|
|
32
|
-
* revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3
|
|
33
|
-
* bucket that you specify. A CRL is typically updated approximately 30 minutes after a
|
|
34
|
-
* certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts
|
|
35
|
-
* makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms
|
|
36
|
-
* for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For
|
|
37
|
-
* more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported CloudWatch Metrics</a>.</p>
|
|
38
|
-
* <note>
|
|
39
|
-
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
40
|
-
* the S3 bucket that you specify. If the IAM principal making the call
|
|
41
|
-
* does not have permission to write to the bucket, then an exception is
|
|
42
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
43
|
-
* policies for CRLs in Amazon S3</a>.</p>
|
|
44
|
-
* </note>
|
|
45
|
-
* <p>Amazon Web Services Private CA also writes revocation information to the audit report. For more
|
|
46
|
-
* information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.</p>
|
|
47
|
-
* <note>
|
|
48
|
-
* <p>You cannot revoke a root CA self-signed certificate.</p>
|
|
49
|
-
* </note>
|
|
30
|
+
* <p>Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported CloudWatch Metrics</a>.</p> <note> <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access policies for CRLs in Amazon S3</a>.</p> </note> <p>Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.</p> <note> <p>You cannot revoke a root CA self-signed certificate.</p> </note>
|
|
50
31
|
* @example
|
|
51
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
33
|
* ```javascript
|
|
@@ -74,8 +55,7 @@ declare const RevokeCertificateCommand_base: {
|
|
|
74
55
|
* <p>A previous update to your private CA is still ongoing.</p>
|
|
75
56
|
*
|
|
76
57
|
* @throws {@link InvalidArnException} (client fault)
|
|
77
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
78
|
-
* resource.</p>
|
|
58
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
79
59
|
*
|
|
80
60
|
* @throws {@link InvalidRequestException} (client fault)
|
|
81
61
|
* <p>The request action cannot be performed or is prohibited.</p>
|
|
@@ -84,8 +64,7 @@ declare const RevokeCertificateCommand_base: {
|
|
|
84
64
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
85
65
|
*
|
|
86
66
|
* @throws {@link LimitExceededException} (client fault)
|
|
87
|
-
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
|
|
88
|
-
* the quota that was exceeded.</p>
|
|
67
|
+
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.</p>
|
|
89
68
|
*
|
|
90
69
|
* @throws {@link RequestAlreadyProcessedException} (client fault)
|
|
91
70
|
* <p>Your request has already been completed.</p>
|
|
@@ -97,8 +76,7 @@ declare const RevokeCertificateCommand_base: {
|
|
|
97
76
|
* <p>Your request is already in progress.</p>
|
|
98
77
|
*
|
|
99
78
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
100
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
101
|
-
* cannot be found.</p>
|
|
79
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
102
80
|
*
|
|
103
81
|
* @throws {@link ACMPCAServiceException}
|
|
104
82
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|