@aws-sdk/client-acm-pca 3.245.0 → 3.252.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/ACMPCA.d.ts +249 -242
- package/dist-types/ACMPCAClient.d.ts +7 -7
- package/dist-types/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +9 -9
- package/dist-types/commands/CreateCertificateAuthorityCommand.d.ts +6 -6
- package/dist-types/commands/CreatePermissionCommand.d.ts +11 -11
- package/dist-types/commands/DeleteCertificateAuthorityCommand.d.ts +11 -11
- package/dist-types/commands/DeletePermissionCommand.d.ts +12 -12
- package/dist-types/commands/DeletePolicyCommand.d.ts +15 -15
- package/dist-types/commands/DescribeCertificateAuthorityAuditReportCommand.d.ts +3 -3
- package/dist-types/commands/DescribeCertificateAuthorityCommand.d.ts +18 -18
- package/dist-types/commands/GetCertificateAuthorityCsrCommand.d.ts +2 -2
- package/dist-types/commands/GetCertificateCommand.d.ts +2 -2
- package/dist-types/commands/GetPolicyCommand.d.ts +13 -13
- package/dist-types/commands/ImportCertificateAuthorityCertificateCommand.d.ts +77 -77
- package/dist-types/commands/IssueCertificateCommand.d.ts +5 -5
- package/dist-types/commands/ListCertificateAuthoritiesCommand.d.ts +1 -1
- package/dist-types/commands/ListPermissionsCommand.d.ts +12 -12
- package/dist-types/commands/ListTagsCommand.d.ts +2 -2
- package/dist-types/commands/PutPolicyCommand.d.ts +15 -15
- package/dist-types/commands/RestoreCertificateAuthorityCommand.d.ts +4 -4
- package/dist-types/commands/RevokeCertificateCommand.d.ts +12 -12
- package/dist-types/commands/TagCertificateAuthorityCommand.d.ts +8 -1
- package/dist-types/commands/UntagCertificateAuthorityCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCertificateAuthorityCommand.d.ts +3 -3
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +301 -238
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +4 -4
|
@@ -146,20 +146,20 @@ declare type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
|
|
|
146
146
|
export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
* <p>This is the <i>Private Certificate Authority
|
|
149
|
+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
150
150
|
* syntax, and usage examples for each of the actions and data types involved in creating
|
|
151
151
|
* and managing a private certificate authority (CA) for your organization.</p>
|
|
152
|
-
*
|
|
152
|
+
* <p>The documentation for each action shows the API request parameters and the JSON
|
|
153
153
|
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
154
154
|
* tailored to the programming language or platform that you prefer. For more information,
|
|
155
155
|
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
156
|
-
*
|
|
157
|
-
* operation can be called per second.
|
|
158
|
-
* depending on the operation. Throttling means that
|
|
156
|
+
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
157
|
+
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
158
|
+
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
159
159
|
* request because the request exceeds the operation's quota for the number of requests per
|
|
160
|
-
* second. When a request is throttled,
|
|
160
|
+
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
|
|
161
161
|
* rate for APIs. </p>
|
|
162
|
-
*
|
|
162
|
+
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
163
163
|
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
164
164
|
* console.</p>
|
|
165
165
|
*/
|
|
@@ -9,21 +9,21 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput extends Crea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an audit report that lists every time that your CA private key is used. The
|
|
12
|
-
* report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/
|
|
12
|
+
* report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
|
|
13
13
|
* the private key. </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
16
16
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
17
17
|
* does not have permission to write to the bucket, then an exception is
|
|
18
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/
|
|
18
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
19
19
|
* policies for CRLs in Amazon S3</a>.</p>
|
|
20
20
|
* </note>
|
|
21
|
-
*
|
|
22
|
-
* For more information, see <a href="https://docs.aws.amazon.com/
|
|
21
|
+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
22
|
+
* For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
|
|
23
23
|
* Reports</a>.</p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
24
|
+
* <note>
|
|
25
|
+
* <p>You can generate a maximum of one report every 30 minutes.</p>
|
|
26
|
+
* </note>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -19,16 +19,16 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica
|
|
|
19
19
|
* CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
|
|
20
20
|
* bucket that is included in certificates issued by the CA. If successful, this action
|
|
21
21
|
* returns the Amazon Resource Name (ARN) of the CA.</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* CRLs</a>.</p>
|
|
25
|
-
* <note>
|
|
26
|
-
* <p>Both PCA and the IAM principal must have permission to write to
|
|
22
|
+
* <note>
|
|
23
|
+
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
27
24
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
28
25
|
* does not have permission to write to the bucket, then an exception is
|
|
29
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/
|
|
26
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
30
27
|
* policies for CRLs in Amazon S3</a>.</p>
|
|
31
28
|
* </note>
|
|
29
|
+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
30
|
+
* For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
|
|
31
|
+
* CRLs</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -11,29 +11,29 @@ export interface CreatePermissionCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
|
|
12
12
|
* principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
|
|
13
13
|
* renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
|
|
14
|
-
*
|
|
15
|
-
* revoke them with the <a href="https://docs.aws.amazon.com/
|
|
16
|
-
*
|
|
14
|
+
* <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
|
|
15
|
+
* revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
|
|
16
|
+
* <p class="title">
|
|
17
17
|
* <b>About Permissions</b>
|
|
18
18
|
* </p>
|
|
19
19
|
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>If the private CA and the certificates it issues reside in the same
|
|
22
22
|
* account, you can use <code>CreatePermission</code> to grant permissions for ACM to
|
|
23
23
|
* carry out automatic certificate renewals.</p>
|
|
24
|
-
*
|
|
24
|
+
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>For automatic certificate renewal to succeed, the ACM service principal
|
|
27
27
|
* needs permissions to create, retrieve, and list certificates.</p>
|
|
28
|
-
*
|
|
28
|
+
* </li>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>If the private CA and the ACM certificates reside in different accounts,
|
|
31
31
|
* then permissions cannot be used to enable automatic renewals. Instead,
|
|
32
32
|
* the ACM certificate owner must set up a resource-based policy to enable
|
|
33
33
|
* cross-account issuance and renewals. For more information, see
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/
|
|
35
|
-
* Based Policy with
|
|
36
|
-
*
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
|
|
35
|
+
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
36
|
+
* </li>
|
|
37
37
|
* </ul>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,24 +10,24 @@ export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBeare
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource
|
|
12
12
|
* Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
|
|
13
|
-
* the <a href="https://docs.aws.amazon.com/
|
|
14
|
-
*
|
|
15
|
-
*
|
|
13
|
+
* the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p>
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>Deleting a CA will invalidate other CAs and certificates below it in your CA
|
|
16
16
|
* hierarchy.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* To do this, call the <a href="https://docs.aws.amazon.com/
|
|
20
|
-
*
|
|
17
|
+
* </note>
|
|
18
|
+
* <p>Before you can delete a CA that you have created and activated, you must disable it.
|
|
19
|
+
* 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>
|
|
20
|
+
* <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
|
|
21
21
|
* the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
|
|
22
|
-
* been created but you haven't yet imported the signed certificate into
|
|
22
|
+
* been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
|
|
23
23
|
* is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
|
|
24
|
-
*
|
|
24
|
+
* <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
|
|
25
25
|
* <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
|
|
26
26
|
* period has passed. By default, if you do not set the
|
|
27
27
|
* <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for 30
|
|
28
|
-
* days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/
|
|
28
|
+
* 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
|
|
29
29
|
* restoration window of a private CA in the <code>DELETED</code> state. To restore an
|
|
30
|
-
* eligible CA, call the <a href="https://docs.aws.amazon.com/
|
|
30
|
+
* eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a> action.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -10,32 +10,32 @@ export interface DeletePermissionCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
|
|
12
12
|
* (acm.amazonaws.com). </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
|
|
14
14
|
* same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer
|
|
15
15
|
* renew the affected certificates automatically.</p>
|
|
16
|
-
*
|
|
17
|
-
* listed with the <a href="https://docs.aws.amazon.com/
|
|
18
|
-
*
|
|
16
|
+
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
|
|
17
|
+
* listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p>
|
|
18
|
+
* <p class="title">
|
|
19
19
|
* <b>About Permissions</b>
|
|
20
20
|
* </p>
|
|
21
21
|
* <ul>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>If the private CA and the certificates it issues reside in the same
|
|
24
24
|
* account, you can use <code>CreatePermission</code> to grant permissions for ACM to
|
|
25
25
|
* carry out automatic certificate renewals.</p>
|
|
26
|
-
*
|
|
26
|
+
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>For automatic certificate renewal to succeed, the ACM service principal
|
|
29
29
|
* needs permissions to create, retrieve, and list certificates.</p>
|
|
30
|
-
*
|
|
30
|
+
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>If the private CA and the ACM certificates reside in different accounts,
|
|
33
33
|
* then permissions cannot be used to enable automatic renewals. Instead,
|
|
34
34
|
* the ACM certificate owner must set up a resource-based policy to enable
|
|
35
35
|
* cross-account issuance and renewals. For more information, see
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/
|
|
37
|
-
* Based Policy with
|
|
38
|
-
*
|
|
36
|
+
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
|
|
37
|
+
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
38
|
+
* </li>
|
|
39
39
|
* </ul>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,37 +11,37 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
|
|
12
12
|
* access that the policy has granted. If there is no policy attached to the private CA,
|
|
13
13
|
* this action will return successful.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),
|
|
15
15
|
* the CA will be removed from all shares in which it was included. </p>
|
|
16
|
-
*
|
|
16
|
+
* <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you
|
|
17
17
|
* delete the policy. </p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <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>
|
|
19
|
+
* <p class="title">
|
|
20
20
|
* <b>About Policies</b>
|
|
21
21
|
* </p>
|
|
22
22
|
* <ul>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
24
|
+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
25
25
|
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
26
|
-
* see <a href="https://docs.aws.amazon.com/
|
|
27
|
-
*
|
|
26
|
+
* 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>
|
|
27
|
+
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
30
30
|
* signed by a CA in another account.</p>
|
|
31
|
-
*
|
|
31
|
+
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>For ACM to manage automatic renewal of these certificates,
|
|
34
34
|
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
35
35
|
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
36
|
-
*
|
|
36
|
+
* Amazon Web Services Private CA policy. For more information, see
|
|
37
37
|
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
38
38
|
* Service Linked Role with ACM</a>.</p>
|
|
39
|
-
*
|
|
39
|
+
* </li>
|
|
40
40
|
* <li>
|
|
41
|
-
*
|
|
42
|
-
* see <a href="https://docs.aws.amazon.com/
|
|
41
|
+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
42
|
+
* see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
43
43
|
* Access</a>.</p>
|
|
44
|
-
*
|
|
44
|
+
* </li>
|
|
45
45
|
* </ul>
|
|
46
46
|
* @example
|
|
47
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,10 +8,10 @@ export interface DescribeCertificateAuthorityAuditReportCommandInput extends Des
|
|
|
8
8
|
export interface DescribeCertificateAuthorityAuditReportCommandOutput extends DescribeCertificateAuthorityAuditReportResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/
|
|
11
|
+
* <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
|
|
12
12
|
* every time the certificate authority (CA) private key is used. The private key is used
|
|
13
|
-
* when you call the <a href="https://docs.aws.amazon.com/
|
|
14
|
-
* <a href="https://docs.aws.amazon.com/
|
|
13
|
+
* when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the
|
|
14
|
+
* <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> action. </p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -11,43 +11,43 @@ export interface DescribeCertificateAuthorityCommandOutput extends DescribeCerti
|
|
|
11
11
|
* <p>Lists information about your private certificate authority (CA) or one that has been
|
|
12
12
|
* shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
|
|
13
13
|
* The output contains the status of your CA. This can be any of the following: </p>
|
|
14
|
-
*
|
|
14
|
+
* <ul>
|
|
15
15
|
* <li>
|
|
16
|
-
*
|
|
17
|
-
* <code>CREATING</code> -
|
|
16
|
+
* <p>
|
|
17
|
+
* <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
|
|
18
18
|
* authority.</p>
|
|
19
|
-
*
|
|
19
|
+
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>
|
|
22
22
|
* <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use
|
|
23
|
-
* your
|
|
24
|
-
* private CA CSR and then import it into
|
|
25
|
-
*
|
|
23
|
+
* your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your
|
|
24
|
+
* private CA CSR and then import it into Amazon Web Services Private CA. </p>
|
|
25
|
+
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>
|
|
28
28
|
* <code>ACTIVE</code> - Your private CA is active.</p>
|
|
29
|
-
*
|
|
29
|
+
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <code>DISABLED</code> - Your private CA has been disabled.</p>
|
|
33
|
-
*
|
|
33
|
+
* </li>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
35
|
+
* <p>
|
|
36
36
|
* <code>EXPIRED</code> - Your private CA certificate has expired.</p>
|
|
37
|
-
*
|
|
37
|
+
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>
|
|
40
40
|
* <code>FAILED</code> - Your private CA has failed. Your CA can fail because of
|
|
41
41
|
* problems such a network outage or back-end Amazon Web Services failure or other errors. A
|
|
42
42
|
* failed CA can never return to the pending state. You must create a new CA.
|
|
43
43
|
* </p>
|
|
44
|
-
*
|
|
44
|
+
* </li>
|
|
45
45
|
* <li>
|
|
46
|
-
*
|
|
46
|
+
* <p>
|
|
47
47
|
* <code>DELETED</code> - Your private CA is within the restoration period, after
|
|
48
48
|
* which it is permanently deleted. The length of time remaining in the CA's
|
|
49
49
|
* restoration period is also included in this action's output.</p>
|
|
50
|
-
*
|
|
50
|
+
* </li>
|
|
51
51
|
* </ul>
|
|
52
52
|
* @example
|
|
53
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,9 +9,9 @@ export interface GetCertificateAuthorityCsrCommandOutput extends GetCertificateA
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the certificate signing request (CSR) for your private certificate authority
|
|
12
|
-
* (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/
|
|
12
|
+
* (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
|
|
13
13
|
* or on-premises root or subordinate CA. Then import the signed certificate back into
|
|
14
|
-
*
|
|
14
|
+
* 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
|
|
15
15
|
* base64 PEM-encoded string. </p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,11 +9,11 @@ export interface GetCertificateCommandOutput extends GetCertificateResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves a certificate from your private CA or one that has been shared with you. The
|
|
12
|
-
* ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/
|
|
12
|
+
* 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
|
|
13
13
|
* must specify both the ARN of your private CA and the ARN of the issued certificate when
|
|
14
14
|
* calling the <b>GetCertificate</b> action. You can retrieve the
|
|
15
15
|
* certificate if it is in the <b>ISSUED</b> state. You can call
|
|
16
|
-
* the <a href="https://docs.aws.amazon.com/
|
|
16
|
+
* the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action to create a report that
|
|
17
17
|
* contains information about all of the certificates issued and revoked by your private
|
|
18
18
|
* CA. </p>
|
|
19
19
|
* @example
|
|
@@ -11,33 +11,33 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea
|
|
|
11
11
|
* <p>Retrieves the resource-based policy attached to a private CA. If either the private CA
|
|
12
12
|
* resource or the policy cannot be found, this action returns a
|
|
13
13
|
* <code>ResourceNotFoundException</code>. </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <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>
|
|
15
|
+
* <p class="title">
|
|
16
16
|
* <b>About Policies</b>
|
|
17
17
|
* </p>
|
|
18
18
|
* <ul>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
21
21
|
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
22
|
-
* see <a href="https://docs.aws.amazon.com/
|
|
23
|
-
*
|
|
22
|
+
* 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>
|
|
23
|
+
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
26
26
|
* signed by a CA in another account.</p>
|
|
27
|
-
*
|
|
27
|
+
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>For ACM to manage automatic renewal of these certificates,
|
|
30
30
|
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
31
31
|
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
32
|
-
*
|
|
32
|
+
* Amazon Web Services Private CA policy. For more information, see
|
|
33
33
|
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
34
34
|
* Service Linked Role with ACM</a>.</p>
|
|
35
|
-
*
|
|
35
|
+
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
*
|
|
38
|
-
* see <a href="https://docs.aws.amazon.com/
|
|
37
|
+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
38
|
+
* see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
39
39
|
* Access</a>.</p>
|
|
40
|
-
*
|
|
40
|
+
* </li>
|
|
41
41
|
* </ul>
|
|
42
42
|
* @example
|
|
43
43
|
* Use a bare-bones client and the command you need to make an API call.
|