@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
package/README.md
CHANGED
|
@@ -6,22 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript ACMPCA Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
10
|
-
syntax, and usage examples for each of the actions and data types involved in creating
|
|
11
|
-
and managing a private certificate authority (CA) for your organization.</p>
|
|
12
|
-
<p>The documentation for each action shows the API request parameters and the JSON
|
|
13
|
-
response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
14
|
-
tailored to the programming language or platform that you prefer. For more information,
|
|
15
|
-
see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
16
|
-
<p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
17
|
-
operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
18
|
-
depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
19
|
-
request because the request exceeds the operation's quota for the number of requests per
|
|
20
|
-
second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
|
|
21
|
-
rate for APIs. </p>
|
|
22
|
-
<p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
23
|
-
log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
24
|
-
console.</p>
|
|
9
|
+
<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
|
|
25
10
|
|
|
26
11
|
## Installing
|
|
27
12
|
|
package/dist-types/ACMPCA.d.ts
CHANGED
|
@@ -165,22 +165,7 @@ export interface ACMPCA {
|
|
|
165
165
|
updateCertificateAuthority(args: UpdateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void): void;
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
169
|
-
* syntax, and usage examples for each of the actions and data types involved in creating
|
|
170
|
-
* and managing a private certificate authority (CA) for your organization.</p>
|
|
171
|
-
* <p>The documentation for each action shows the API request parameters and the JSON
|
|
172
|
-
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
173
|
-
* tailored to the programming language or platform that you prefer. For more information,
|
|
174
|
-
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
175
|
-
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
176
|
-
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
177
|
-
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
178
|
-
* request because the request exceeds the operation's quota for the number of requests per
|
|
179
|
-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
|
|
180
|
-
* rate for APIs. </p>
|
|
181
|
-
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
182
|
-
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
183
|
-
* console.</p>
|
|
168
|
+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
|
|
184
169
|
* @public
|
|
185
170
|
*/
|
|
186
171
|
export declare class ACMPCA extends ACMPCAClient implements ACMPCA {
|
|
@@ -192,22 +192,7 @@ export type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt
|
|
|
192
192
|
export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
|
-
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
196
|
-
* syntax, and usage examples for each of the actions and data types involved in creating
|
|
197
|
-
* and managing a private certificate authority (CA) for your organization.</p>
|
|
198
|
-
* <p>The documentation for each action shows the API request parameters and the JSON
|
|
199
|
-
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
200
|
-
* tailored to the programming language or platform that you prefer. For more information,
|
|
201
|
-
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
202
|
-
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
203
|
-
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
204
|
-
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
205
|
-
* request because the request exceeds the operation's quota for the number of requests per
|
|
206
|
-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
|
|
207
|
-
* rate for APIs. </p>
|
|
208
|
-
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
209
|
-
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
210
|
-
* console.</p>
|
|
195
|
+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
|
|
211
196
|
* @public
|
|
212
197
|
*/
|
|
213
198
|
export declare class ACMPCAClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ACMPCAClientResolvedConfig> {
|
|
@@ -27,15 +27,7 @@ declare const CreateCertificateAuthorityAuditReportCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an audit report that lists every time that your CA private key is used to issue a certificate. 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
|
|
31
|
-
* the private key.</p>
|
|
32
|
-
* <p>To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#s3-access">Prepare an Amazon S3 bucket for audit reports</a>.</p>
|
|
33
|
-
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
34
|
-
* For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
|
|
35
|
-
* Reports</a>.</p>
|
|
36
|
-
* <note>
|
|
37
|
-
* <p>You can generate a maximum of one report every 30 minutes.</p>
|
|
38
|
-
* </note>
|
|
30
|
+
* <p>Creates an audit report that lists every time that your CA private key is used to issue a certificate. 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 the private key.</p> <p>To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#s3-access">Prepare an Amazon S3 bucket for audit reports</a>.</p> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit Reports</a>.</p> <note> <p>You can generate a maximum of one report every 30 minutes.</p> </note>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -66,8 +58,7 @@ declare const CreateCertificateAuthorityAuditReportCommand_base: {
|
|
|
66
58
|
* <p>One or more of the specified arguments was not valid.</p>
|
|
67
59
|
*
|
|
68
60
|
* @throws {@link InvalidArnException} (client fault)
|
|
69
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
70
|
-
* resource.</p>
|
|
61
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
71
62
|
*
|
|
72
63
|
* @throws {@link InvalidStateException} (client fault)
|
|
73
64
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -79,8 +70,7 @@ declare const CreateCertificateAuthorityAuditReportCommand_base: {
|
|
|
79
70
|
* <p>Your request is already in progress.</p>
|
|
80
71
|
*
|
|
81
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
83
|
-
* cannot be found.</p>
|
|
73
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
84
74
|
*
|
|
85
75
|
* @throws {@link ACMPCAServiceException}
|
|
86
76
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,27 +27,7 @@ declare const CreateCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
|
|
31
|
-
* CA configuration, an optional configuration for Online Certificate Status Protocol
|
|
32
|
-
* (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
|
|
33
|
-
* idempotency token to avoid accidental creation of multiple CAs. The CA configuration
|
|
34
|
-
* specifies the name of the algorithm and key size to be used to create the CA private
|
|
35
|
-
* key, the type of signing algorithm that the CA uses, and X.500 subject information. The
|
|
36
|
-
* OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL
|
|
37
|
-
* configuration specifies the CRL expiration period in days (the validity period of the
|
|
38
|
-
* CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
|
|
39
|
-
* bucket that is included in certificates issued by the CA. If successful, this action
|
|
40
|
-
* returns the Amazon Resource Name (ARN) of the CA.</p>
|
|
41
|
-
* <note>
|
|
42
|
-
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
43
|
-
* the S3 bucket that you specify. If the IAM principal making the call
|
|
44
|
-
* does not have permission to write to the bucket, then an exception is
|
|
45
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
46
|
-
* policies for CRLs in Amazon S3</a>.</p>
|
|
47
|
-
* </note>
|
|
48
|
-
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
49
|
-
* For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#crl-encryption">Encrypting Your
|
|
50
|
-
* CRLs</a>.</p>
|
|
30
|
+
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.</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 assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#crl-encryption">Encrypting Your CRLs</a>.</p>
|
|
51
31
|
* @example
|
|
52
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
53
33
|
* ```javascript
|
|
@@ -186,16 +166,13 @@ declare const CreateCertificateAuthorityCommand_base: {
|
|
|
186
166
|
* <p>One or more of the specified arguments was not valid.</p>
|
|
187
167
|
*
|
|
188
168
|
* @throws {@link InvalidPolicyException} (client fault)
|
|
189
|
-
* <p>The resource policy is invalid or is missing a required statement. For general
|
|
190
|
-
* 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>
|
|
169
|
+
* <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>
|
|
191
170
|
*
|
|
192
171
|
* @throws {@link InvalidTagException} (client fault)
|
|
193
|
-
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the
|
|
194
|
-
* message field.</p>
|
|
172
|
+
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the message field.</p>
|
|
195
173
|
*
|
|
196
174
|
* @throws {@link LimitExceededException} (client fault)
|
|
197
|
-
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
|
|
198
|
-
* the quota that was exceeded.</p>
|
|
175
|
+
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.</p>
|
|
199
176
|
*
|
|
200
177
|
* @throws {@link ACMPCAServiceException}
|
|
201
178
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,33 +27,7 @@ declare const CreatePermissionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
|
|
31
|
-
* principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
|
|
32
|
-
* renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
|
|
33
|
-
* <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
|
|
34
|
-
* revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
|
|
35
|
-
* <p class="title">
|
|
36
|
-
* <b>About Permissions</b>
|
|
37
|
-
* </p>
|
|
38
|
-
* <ul>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>If the private CA and the certificates it issues reside in the same
|
|
41
|
-
* account, you can use <code>CreatePermission</code> to grant permissions for ACM to
|
|
42
|
-
* carry out automatic certificate renewals.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>For automatic certificate renewal to succeed, the ACM service principal
|
|
46
|
-
* needs permissions to create, retrieve, and list certificates.</p>
|
|
47
|
-
* </li>
|
|
48
|
-
* <li>
|
|
49
|
-
* <p>If the private CA and the ACM certificates reside in different accounts,
|
|
50
|
-
* then permissions cannot be used to enable automatic renewals. Instead,
|
|
51
|
-
* the ACM certificate owner must set up a resource-based policy to enable
|
|
52
|
-
* cross-account issuance and renewals. For more information, see
|
|
53
|
-
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
|
|
54
|
-
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
55
|
-
* </li>
|
|
56
|
-
* </ul>
|
|
30
|
+
* <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p> <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 revoke them 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>
|
|
57
31
|
* @example
|
|
58
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
59
33
|
* ```javascript
|
|
@@ -81,15 +55,13 @@ declare const CreatePermissionCommand_base: {
|
|
|
81
55
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
82
56
|
*
|
|
83
57
|
* @throws {@link InvalidArnException} (client fault)
|
|
84
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
85
|
-
* resource.</p>
|
|
58
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
86
59
|
*
|
|
87
60
|
* @throws {@link InvalidStateException} (client fault)
|
|
88
61
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
89
62
|
*
|
|
90
63
|
* @throws {@link LimitExceededException} (client fault)
|
|
91
|
-
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
|
|
92
|
-
* the quota that was exceeded.</p>
|
|
64
|
+
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.</p>
|
|
93
65
|
*
|
|
94
66
|
* @throws {@link PermissionAlreadyExistsException} (client fault)
|
|
95
67
|
* <p>The designated permission has already been given to the user.</p>
|
|
@@ -98,8 +70,7 @@ declare const CreatePermissionCommand_base: {
|
|
|
98
70
|
* <p>The request has failed for an unspecified reason.</p>
|
|
99
71
|
*
|
|
100
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
101
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
102
|
-
* cannot be found.</p>
|
|
73
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
103
74
|
*
|
|
104
75
|
* @throws {@link ACMPCAServiceException}
|
|
105
76
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,26 +27,7 @@ declare const DeleteCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource
|
|
31
|
-
* Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
|
|
32
|
-
* the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p>
|
|
33
|
-
* <note>
|
|
34
|
-
* <p>Deleting a CA will invalidate other CAs and certificates below it in your CA
|
|
35
|
-
* hierarchy.</p>
|
|
36
|
-
* </note>
|
|
37
|
-
* <p>Before you can delete a CA that you have created and activated, you must disable it.
|
|
38
|
-
* 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>
|
|
39
|
-
* <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
|
|
40
|
-
* the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
|
|
41
|
-
* been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
|
|
42
|
-
* is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
|
|
43
|
-
* <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
|
|
44
|
-
* <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
|
|
45
|
-
* period has passed. By default, if you do not set the
|
|
46
|
-
* <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for 30
|
|
47
|
-
* 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
|
|
48
|
-
* restoration window of a private CA in the <code>DELETED</code> state. To restore an
|
|
49
|
-
* eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a> action.</p>
|
|
30
|
+
* <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p> <note> <p>Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.</p> </note> <p>Before you can delete a CA that you have created and activated, you must disable it. 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> <p>Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is <code>CREATING</code>). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p> <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 <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for 30 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 restoration window of a private CA in the <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a> action.</p> <important> <p>A private CA can be deleted if it is in the <code>PENDING_CERTIFICATE</code>, <code>CREATING</code>, <code>EXPIRED</code>, <code>DISABLED</code>, or <code>FAILED</code> state. To delete a CA in the <code>ACTIVE</code> state, you must first disable it, or else the delete request results in an exception. If you are deleting a private CA in the <code>PENDING_CERTIFICATE</code> or <code>DISABLED</code> state, you can set the length of its restoration period to 7-30 days. The default is 30. During this time, the status is set to <code>DELETED</code> and the CA can be restored. A private CA deleted in the <code>CREATING</code> or <code>FAILED</code> state has no assigned restoration period and cannot be restored.</p> </important>
|
|
50
31
|
* @example
|
|
51
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
33
|
* ```javascript
|
|
@@ -73,15 +54,13 @@ declare const DeleteCertificateAuthorityCommand_base: {
|
|
|
73
54
|
* <p>A previous update to your private CA is still ongoing.</p>
|
|
74
55
|
*
|
|
75
56
|
* @throws {@link InvalidArnException} (client fault)
|
|
76
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
77
|
-
* resource.</p>
|
|
57
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
78
58
|
*
|
|
79
59
|
* @throws {@link InvalidStateException} (client fault)
|
|
80
60
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
81
61
|
*
|
|
82
62
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
84
|
-
* cannot be found.</p>
|
|
63
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
85
64
|
*
|
|
86
65
|
* @throws {@link ACMPCAServiceException}
|
|
87
66
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,35 +27,7 @@ declare const DeletePermissionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
|
|
31
|
-
* (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. If you revoke these permissions, ACM will no longer
|
|
34
|
-
* renew the affected certificates automatically.</p>
|
|
35
|
-
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
|
|
36
|
-
* listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p>
|
|
37
|
-
* <p class="title">
|
|
38
|
-
* <b>About Permissions</b>
|
|
39
|
-
* </p>
|
|
40
|
-
* <ul>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p>If the private CA and the certificates it issues reside in the same
|
|
43
|
-
* account, you can use <code>CreatePermission</code> to grant permissions for ACM to
|
|
44
|
-
* carry out automatic certificate renewals.</p>
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>For automatic certificate renewal to succeed, the ACM service principal
|
|
48
|
-
* needs permissions to create, retrieve, and list certificates.</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>If the private CA and the ACM certificates reside in different accounts,
|
|
52
|
-
* then permissions cannot be used to enable automatic renewals. Instead,
|
|
53
|
-
* the ACM certificate owner must set up a resource-based policy to enable
|
|
54
|
-
* cross-account issuance and renewals. For more information, see
|
|
55
|
-
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
|
|
56
|
-
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
57
|
-
* </li>
|
|
58
|
-
* </ul>
|
|
30
|
+
* <p>Revokes permissions on a private CA 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. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.</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 listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</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>
|
|
59
31
|
* @example
|
|
60
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
61
33
|
* ```javascript
|
|
@@ -80,8 +52,7 @@ declare const DeletePermissionCommand_base: {
|
|
|
80
52
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
81
53
|
*
|
|
82
54
|
* @throws {@link InvalidArnException} (client fault)
|
|
83
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
84
|
-
* resource.</p>
|
|
55
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
85
56
|
*
|
|
86
57
|
* @throws {@link InvalidStateException} (client fault)
|
|
87
58
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -90,8 +61,7 @@ declare const DeletePermissionCommand_base: {
|
|
|
90
61
|
* <p>The request has failed for an unspecified reason.</p>
|
|
91
62
|
*
|
|
92
63
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
94
|
-
* cannot be found.</p>
|
|
64
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
95
65
|
*
|
|
96
66
|
* @throws {@link ACMPCAServiceException}
|
|
97
67
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,41 +27,7 @@ declare const DeletePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
|
|
31
|
-
* access that the policy has granted. If there is no policy attached to the private CA,
|
|
32
|
-
* this action will return successful.</p>
|
|
33
|
-
* <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),
|
|
34
|
-
* the CA will be removed from all shares in which it was included. </p>
|
|
35
|
-
* <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you
|
|
36
|
-
* delete the policy. </p>
|
|
37
|
-
* <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>
|
|
38
|
-
* <p class="title">
|
|
39
|
-
* <b>About Policies</b>
|
|
40
|
-
* </p>
|
|
41
|
-
* <ul>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
44
|
-
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
45
|
-
* 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>
|
|
46
|
-
* </li>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
49
|
-
* signed by a CA in another account.</p>
|
|
50
|
-
* </li>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>For ACM to manage automatic renewal of these certificates,
|
|
53
|
-
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
54
|
-
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
55
|
-
* Amazon Web Services Private CA policy. For more information, see
|
|
56
|
-
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
57
|
-
* Service Linked Role with ACM</a>.</p>
|
|
58
|
-
* </li>
|
|
59
|
-
* <li>
|
|
60
|
-
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
61
|
-
* see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
62
|
-
* Access</a>.</p>
|
|
63
|
-
* </li>
|
|
64
|
-
* </ul>
|
|
30
|
+
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.</p> <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included. </p> <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. </p> <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> <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>
|
|
65
31
|
* @example
|
|
66
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
67
33
|
* ```javascript
|
|
@@ -87,23 +53,19 @@ declare const DeletePolicyCommand_base: {
|
|
|
87
53
|
* <p>A previous update to your private CA is still ongoing.</p>
|
|
88
54
|
*
|
|
89
55
|
* @throws {@link InvalidArnException} (client fault)
|
|
90
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
91
|
-
* resource.</p>
|
|
56
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
92
57
|
*
|
|
93
58
|
* @throws {@link InvalidStateException} (client fault)
|
|
94
59
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
95
60
|
*
|
|
96
61
|
* @throws {@link LockoutPreventedException} (client fault)
|
|
97
|
-
* <p>The current action was prevented because it would lock the caller out from performing
|
|
98
|
-
* subsequent actions. Verify that the specified parameters would not result in the caller
|
|
99
|
-
* being denied access to the resource. </p>
|
|
62
|
+
* <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>
|
|
100
63
|
*
|
|
101
64
|
* @throws {@link RequestFailedException} (client fault)
|
|
102
65
|
* <p>The request has failed for an unspecified reason.</p>
|
|
103
66
|
*
|
|
104
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
105
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
106
|
-
* cannot be found.</p>
|
|
68
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
107
69
|
*
|
|
108
70
|
* @throws {@link ACMPCAServiceException}
|
|
109
71
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,10 +27,7 @@ declare const DescribeCertificateAuthorityAuditReportCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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
|
|
31
|
-
* every time the certificate authority (CA) private key is used. The private key is used
|
|
32
|
-
* when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the
|
|
33
|
-
* <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> action. </p>
|
|
30
|
+
* <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 every time the certificate authority (CA) private key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> action. </p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -62,12 +59,10 @@ declare const DescribeCertificateAuthorityAuditReportCommand_base: {
|
|
|
62
59
|
* <p>One or more of the specified arguments was not valid.</p>
|
|
63
60
|
*
|
|
64
61
|
* @throws {@link InvalidArnException} (client fault)
|
|
65
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
66
|
-
* resource.</p>
|
|
62
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
67
63
|
*
|
|
68
64
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
70
|
-
* cannot be found.</p>
|
|
65
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
71
66
|
*
|
|
72
67
|
* @throws {@link ACMPCAServiceException}
|
|
73
68
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,47 +27,7 @@ declare const DescribeCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists information about your private certificate authority (CA) or one that has been
|
|
31
|
-
* shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
|
|
32
|
-
* The output contains the status of your CA. This can be any of the following: </p>
|
|
33
|
-
* <ul>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>
|
|
36
|
-
* <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
|
|
37
|
-
* authority.</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use
|
|
42
|
-
* your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your
|
|
43
|
-
* private CA CSR and then import it into Amazon Web Services Private CA. </p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>
|
|
47
|
-
* <code>ACTIVE</code> - Your private CA is active.</p>
|
|
48
|
-
* </li>
|
|
49
|
-
* <li>
|
|
50
|
-
* <p>
|
|
51
|
-
* <code>DISABLED</code> - Your private CA has been disabled.</p>
|
|
52
|
-
* </li>
|
|
53
|
-
* <li>
|
|
54
|
-
* <p>
|
|
55
|
-
* <code>EXPIRED</code> - Your private CA certificate has expired.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <code>FAILED</code> - Your private CA has failed. Your CA can fail because of
|
|
60
|
-
* problems such a network outage or back-end Amazon Web Services failure or other errors. A
|
|
61
|
-
* failed CA can never return to the pending state. You must create a new CA.
|
|
62
|
-
* </p>
|
|
63
|
-
* </li>
|
|
64
|
-
* <li>
|
|
65
|
-
* <p>
|
|
66
|
-
* <code>DELETED</code> - Your private CA is within the restoration period, after
|
|
67
|
-
* which it is permanently deleted. The length of time remaining in the CA's
|
|
68
|
-
* restoration period is also included in this action's output.</p>
|
|
69
|
-
* </li>
|
|
70
|
-
* </ul>
|
|
30
|
+
* <p>Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate authority.</p> </li> <li> <p> <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p> </li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> <li> <p> <code>DELETED</code> - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.</p> </li> </ul>
|
|
71
31
|
* @example
|
|
72
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
73
33
|
* ```javascript
|
|
@@ -208,12 +168,10 @@ declare const DescribeCertificateAuthorityCommand_base: {
|
|
|
208
168
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
209
169
|
*
|
|
210
170
|
* @throws {@link InvalidArnException} (client fault)
|
|
211
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
212
|
-
* resource.</p>
|
|
171
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
213
172
|
*
|
|
214
173
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
215
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
216
|
-
* cannot be found.</p>
|
|
174
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
217
175
|
*
|
|
218
176
|
* @throws {@link ACMPCAServiceException}
|
|
219
177
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,10 +27,7 @@ declare const GetCertificateAuthorityCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the certificate and certificate chain for your private certificate authority
|
|
31
|
-
* (CA) or one that has been shared with you. Both the certificate and the chain are base64
|
|
32
|
-
* PEM-encoded. The chain does not include the CA certificate. Each certificate in the
|
|
33
|
-
* chain signs the one before it. </p>
|
|
30
|
+
* <p>Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. </p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -56,15 +53,13 @@ declare const GetCertificateAuthorityCertificateCommand_base: {
|
|
|
56
53
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
57
54
|
*
|
|
58
55
|
* @throws {@link InvalidArnException} (client fault)
|
|
59
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
60
|
-
* resource.</p>
|
|
56
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
61
57
|
*
|
|
62
58
|
* @throws {@link InvalidStateException} (client fault)
|
|
63
59
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
64
60
|
*
|
|
65
61
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
67
|
-
* cannot be found.</p>
|
|
62
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
68
63
|
*
|
|
69
64
|
* @throws {@link ACMPCAServiceException}
|
|
70
65
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,11 +27,7 @@ declare const GetCertificateAuthorityCsrCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the certificate signing request (CSR) for your private certificate authority
|
|
31
|
-
* (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
|
|
32
|
-
* or on-premises root or subordinate CA. Then import the signed certificate back into
|
|
33
|
-
* 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
|
|
34
|
-
* base64 PEM-encoded string. </p>
|
|
30
|
+
* <p>Retrieves the certificate signing request (CSR) for your private certificate authority (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 or on-premises root or subordinate CA. Then import the signed certificate back into 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 base64 PEM-encoded string. </p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -56,8 +52,7 @@ declare const GetCertificateAuthorityCsrCommand_base: {
|
|
|
56
52
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
57
53
|
*
|
|
58
54
|
* @throws {@link InvalidArnException} (client fault)
|
|
59
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
60
|
-
* resource.</p>
|
|
55
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
61
56
|
*
|
|
62
57
|
* @throws {@link InvalidStateException} (client fault)
|
|
63
58
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
@@ -69,8 +64,7 @@ declare const GetCertificateAuthorityCsrCommand_base: {
|
|
|
69
64
|
* <p>Your request is already in progress.</p>
|
|
70
65
|
*
|
|
71
66
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
73
|
-
* cannot be found.</p>
|
|
67
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
74
68
|
*
|
|
75
69
|
* @throws {@link ACMPCAServiceException}
|
|
76
70
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|