@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
|
@@ -8,133 +8,133 @@ export interface ImportCertificateAuthorityCertificateCommandInput extends Impor
|
|
|
8
8
|
export interface ImportCertificateAuthorityCertificateCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Imports a signed private CA certificate into
|
|
12
|
-
* are using a chain of trust whose root is located outside
|
|
11
|
+
* <p>Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you
|
|
12
|
+
* are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call
|
|
13
13
|
* this action, the following preparations must in place:</p>
|
|
14
|
-
*
|
|
14
|
+
* <ol>
|
|
15
15
|
* <li>
|
|
16
|
-
*
|
|
16
|
+
* <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
|
|
17
17
|
* plan to back with the imported certificate.</p>
|
|
18
|
-
*
|
|
18
|
+
* </li>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a> action to generate a certificate signing
|
|
21
21
|
* request (CSR).</p>
|
|
22
|
-
*
|
|
22
|
+
* </li>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
24
|
+
* <p>Sign the CSR using a root or intermediate CA hosted by either an on-premises
|
|
25
25
|
* PKI hierarchy or by a commercial CA.</p>
|
|
26
|
-
*
|
|
26
|
+
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>Create a certificate chain and copy the signed certificate and the certificate
|
|
29
29
|
* chain to your working directory.</p>
|
|
30
|
-
*
|
|
30
|
+
* </li>
|
|
31
31
|
* </ol>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <p>Amazon Web Services Private CA supports three scenarios for installing a CA certificate:</p>
|
|
33
|
+
* <ul>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* <p>Installing a certificate for a root CA hosted by Amazon Web Services Private CA.</p>
|
|
36
|
+
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
38
|
+
* <p>Installing a subordinate CA certificate whose parent authority is hosted by
|
|
39
|
+
* Amazon Web Services Private CA.</p>
|
|
40
|
+
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
42
|
+
* <p>Installing a subordinate CA certificate whose parent authority is externally
|
|
43
43
|
* hosted.</p>
|
|
44
|
-
*
|
|
44
|
+
* </li>
|
|
45
45
|
* </ul>
|
|
46
|
-
*
|
|
47
|
-
*
|
|
46
|
+
* <p>The following additional requirements apply when you import a CA certificate.</p>
|
|
47
|
+
* <ul>
|
|
48
48
|
* <li>
|
|
49
|
-
*
|
|
50
|
-
*
|
|
49
|
+
* <p>Only a self-signed certificate can be imported as a root CA.</p>
|
|
50
|
+
* </li>
|
|
51
51
|
* <li>
|
|
52
|
-
*
|
|
53
|
-
*
|
|
52
|
+
* <p>A self-signed certificate cannot be imported as a subordinate CA.</p>
|
|
53
|
+
* </li>
|
|
54
54
|
* <li>
|
|
55
|
-
*
|
|
55
|
+
* <p>Your certificate chain must not include the private CA certificate that you
|
|
56
56
|
* are importing.</p>
|
|
57
|
-
*
|
|
57
|
+
* </li>
|
|
58
58
|
* <li>
|
|
59
|
-
*
|
|
59
|
+
* <p>Your root CA must be the last certificate in your chain. The subordinate
|
|
60
60
|
* certificate, if any, that your root CA signed must be next to last. The
|
|
61
61
|
* subordinate certificate signed by the preceding subordinate CA must come next,
|
|
62
62
|
* and so on until your chain is built. </p>
|
|
63
|
-
*
|
|
63
|
+
* </li>
|
|
64
64
|
* <li>
|
|
65
|
-
*
|
|
66
|
-
*
|
|
65
|
+
* <p>The chain must be PEM-encoded.</p>
|
|
66
|
+
* </li>
|
|
67
67
|
* <li>
|
|
68
|
-
*
|
|
69
|
-
*
|
|
68
|
+
* <p>The maximum allowed size of a certificate is 32 KB.</p>
|
|
69
|
+
* </li>
|
|
70
70
|
* <li>
|
|
71
|
-
*
|
|
72
|
-
*
|
|
71
|
+
* <p>The maximum allowed size of a certificate chain is 2 MB.</p>
|
|
72
|
+
* </li>
|
|
73
73
|
* </ul>
|
|
74
|
-
*
|
|
74
|
+
* <p>
|
|
75
75
|
* <i>Enforcement of Critical Constraints</i>
|
|
76
76
|
* </p>
|
|
77
|
-
*
|
|
77
|
+
* <p>Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA
|
|
78
78
|
* certificate or chain.</p>
|
|
79
|
-
*
|
|
79
|
+
* <ul>
|
|
80
80
|
* <li>
|
|
81
|
-
*
|
|
82
|
-
*
|
|
81
|
+
* <p>Basic constraints (<i>must</i> be marked critical)</p>
|
|
82
|
+
* </li>
|
|
83
83
|
* <li>
|
|
84
|
-
*
|
|
85
|
-
*
|
|
84
|
+
* <p>Subject alternative names</p>
|
|
85
|
+
* </li>
|
|
86
86
|
* <li>
|
|
87
|
-
*
|
|
88
|
-
*
|
|
87
|
+
* <p>Key usage</p>
|
|
88
|
+
* </li>
|
|
89
89
|
* <li>
|
|
90
|
-
*
|
|
91
|
-
*
|
|
90
|
+
* <p>Extended key usage</p>
|
|
91
|
+
* </li>
|
|
92
92
|
* <li>
|
|
93
|
-
*
|
|
94
|
-
*
|
|
93
|
+
* <p>Authority key identifier</p>
|
|
94
|
+
* </li>
|
|
95
95
|
* <li>
|
|
96
|
-
*
|
|
97
|
-
*
|
|
96
|
+
* <p>Subject key identifier</p>
|
|
97
|
+
* </li>
|
|
98
98
|
* <li>
|
|
99
|
-
*
|
|
100
|
-
*
|
|
99
|
+
* <p>Issuer alternative name</p>
|
|
100
|
+
* </li>
|
|
101
101
|
* <li>
|
|
102
|
-
*
|
|
103
|
-
*
|
|
102
|
+
* <p>Subject directory attributes</p>
|
|
103
|
+
* </li>
|
|
104
104
|
* <li>
|
|
105
|
-
*
|
|
106
|
-
*
|
|
105
|
+
* <p>Subject information access</p>
|
|
106
|
+
* </li>
|
|
107
107
|
* <li>
|
|
108
|
-
*
|
|
109
|
-
*
|
|
108
|
+
* <p>Certificate policies</p>
|
|
109
|
+
* </li>
|
|
110
110
|
* <li>
|
|
111
|
-
*
|
|
112
|
-
*
|
|
111
|
+
* <p>Policy mappings</p>
|
|
112
|
+
* </li>
|
|
113
113
|
* <li>
|
|
114
|
-
*
|
|
115
|
-
*
|
|
114
|
+
* <p>Inhibit anyPolicy</p>
|
|
115
|
+
* </li>
|
|
116
116
|
* </ul>
|
|
117
|
-
*
|
|
117
|
+
* <p>Amazon Web Services Private CA rejects the following extensions when they are marked critical in an
|
|
118
118
|
* imported CA certificate or chain.</p>
|
|
119
|
-
*
|
|
119
|
+
* <ul>
|
|
120
120
|
* <li>
|
|
121
|
-
*
|
|
122
|
-
*
|
|
121
|
+
* <p>Name constraints</p>
|
|
122
|
+
* </li>
|
|
123
123
|
* <li>
|
|
124
|
-
*
|
|
125
|
-
*
|
|
124
|
+
* <p>Policy constraints</p>
|
|
125
|
+
* </li>
|
|
126
126
|
* <li>
|
|
127
|
-
*
|
|
128
|
-
*
|
|
127
|
+
* <p>CRL distribution points</p>
|
|
128
|
+
* </li>
|
|
129
129
|
* <li>
|
|
130
|
-
*
|
|
131
|
-
*
|
|
130
|
+
* <p>Authority information access</p>
|
|
131
|
+
* </li>
|
|
132
132
|
* <li>
|
|
133
|
-
*
|
|
134
|
-
*
|
|
133
|
+
* <p>Freshest CRL</p>
|
|
134
|
+
* </li>
|
|
135
135
|
* <li>
|
|
136
|
-
*
|
|
137
|
-
*
|
|
136
|
+
* <p>Any other extension</p>
|
|
137
|
+
* </li>
|
|
138
138
|
* </ul>
|
|
139
139
|
* @example
|
|
140
140
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,12 +10,12 @@ export interface IssueCertificateCommandOutput extends IssueCertificateResponse,
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Uses your private certificate authority (CA), or one that has been shared with you, to
|
|
12
12
|
* issue a client certificate. This action returns the Amazon Resource Name (ARN) of the
|
|
13
|
-
* certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/
|
|
13
|
+
* 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
|
|
14
14
|
* specifying the ARN. </p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* certificates that you issue by using
|
|
18
|
-
*
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the
|
|
17
|
+
* certificates that you issue by using Amazon Web Services Private CA.</p>
|
|
18
|
+
* </note>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface ListCertificateAuthoritiesCommandInput extends ListCertificateA
|
|
|
8
8
|
export interface ListCertificateAuthoritiesCommandOutput extends ListCertificateAuthoritiesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/
|
|
11
|
+
* <p>Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -10,31 +10,31 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service
|
|
12
12
|
* principal (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. </p>
|
|
15
|
-
*
|
|
16
|
-
* revoked with the <a href="https://docs.aws.amazon.com/
|
|
17
|
-
*
|
|
15
|
+
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
|
|
16
|
+
* revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
|
|
17
|
+
* <p class="title">
|
|
18
18
|
* <b>About Permissions</b>
|
|
19
19
|
* </p>
|
|
20
20
|
* <ul>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>If the private CA and the certificates it issues reside in the same
|
|
23
23
|
* account, you can use <code>CreatePermission</code> to grant permissions for ACM to
|
|
24
24
|
* carry out automatic certificate renewals.</p>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>For automatic certificate renewal to succeed, the ACM service principal
|
|
28
28
|
* needs permissions to create, retrieve, and list certificates.</p>
|
|
29
|
-
*
|
|
29
|
+
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>If the private CA and the ACM certificates reside in different accounts,
|
|
32
32
|
* then permissions cannot be used to enable automatic renewals. Instead,
|
|
33
33
|
* the ACM certificate owner must set up a resource-based policy to enable
|
|
34
34
|
* cross-account issuance and renewals. For more information, see
|
|
35
|
-
* <a href="https://docs.aws.amazon.com/
|
|
36
|
-
* Based Policy with
|
|
37
|
-
*
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource
|
|
36
|
+
* Based Policy with Amazon Web Services Private CA</a>.</p>
|
|
37
|
+
* </li>
|
|
38
38
|
* </ul>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,8 +10,8 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the tags, if any, that are associated with your private CA or one that has been
|
|
12
12
|
* shared with you. Tags are labels that you can use to identify and organize your CAs.
|
|
13
|
-
* Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/
|
|
14
|
-
* action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/
|
|
13
|
+
* 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>
|
|
14
|
+
* 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>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -9,36 +9,36 @@ export interface PutPolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Attaches a resource-based policy to a private CA. </p>
|
|
12
|
-
*
|
|
13
|
-
* Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/
|
|
12
|
+
* <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access
|
|
13
|
+
* 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
|
|
14
14
|
* Access</a>.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <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>
|
|
16
|
+
* <p class="title">
|
|
17
17
|
* <b>About Policies</b>
|
|
18
18
|
* </p>
|
|
19
19
|
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
|
|
22
22
|
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
|
|
23
|
-
* see <a href="https://docs.aws.amazon.com/
|
|
24
|
-
*
|
|
23
|
+
* 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>
|
|
24
|
+
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
|
|
27
27
|
* signed by a CA in another account.</p>
|
|
28
|
-
*
|
|
28
|
+
* </li>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>For ACM to manage automatic renewal of these certificates,
|
|
31
31
|
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
|
|
32
32
|
* the ACM service to assume the identity of the user, subject to confirmation against the
|
|
33
|
-
*
|
|
33
|
+
* Amazon Web Services Private CA policy. For more information, see
|
|
34
34
|
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
|
|
35
35
|
* Service Linked Role with ACM</a>.</p>
|
|
36
|
-
*
|
|
36
|
+
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
39
|
-
* see <a href="https://docs.aws.amazon.com/
|
|
38
|
+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
|
|
39
|
+
* see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
|
|
40
40
|
* Access</a>.</p>
|
|
41
|
-
*
|
|
41
|
+
* </li>
|
|
42
42
|
* </ul>
|
|
43
43
|
* @example
|
|
44
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,14 +9,14 @@ export interface RestoreCertificateAuthorityCommandOutput extends __MetadataBear
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
|
|
12
|
-
* 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/
|
|
12
|
+
* 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.
|
|
13
13
|
* If you did not specify a <b>PermanentDeletionTimeInDays</b>
|
|
14
14
|
* value, by default you can restore the CA at any time in a 30 day period. You can check
|
|
15
15
|
* the time remaining in the restoration period of a private CA in the <code>DELETED</code>
|
|
16
|
-
* state by calling the <a href="https://docs.aws.amazon.com/
|
|
16
|
+
* 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
|
|
17
17
|
* its pre-deletion status when the <b>RestoreCertificateAuthority</b> action returns. To change its status to
|
|
18
|
-
* <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/
|
|
19
|
-
* <code>PENDING_CERTIFICATE</code> state at deletion, you must use the <a href="https://docs.aws.amazon.com/
|
|
18
|
+
* <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
|
|
19
|
+
* <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
|
|
20
20
|
* authority into the private CA before it can be activated. You cannot restore a CA after
|
|
21
21
|
* the restoration period has ended.</p>
|
|
22
22
|
* @example
|
|
@@ -8,26 +8,26 @@ export interface RevokeCertificateCommandInput extends RevokeCertificateRequest
|
|
|
8
8
|
export interface RevokeCertificateCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Revokes a certificate that was issued inside
|
|
11
|
+
* <p>Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate
|
|
12
12
|
* revocation list (CRL) when you create or update your private CA, information about the
|
|
13
|
-
* revoked certificates will be included in the CRL.
|
|
13
|
+
* revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3
|
|
14
14
|
* bucket that you specify. A CRL is typically updated approximately 30 minutes after a
|
|
15
|
-
* certificate is revoked. If for any reason the CRL update fails,
|
|
15
|
+
* certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts
|
|
16
16
|
* makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms
|
|
17
17
|
* for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For
|
|
18
|
-
* more information, see <a href="https://docs.aws.amazon.com/
|
|
19
|
-
*
|
|
20
|
-
*
|
|
18
|
+
* more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported CloudWatch Metrics</a>.</p>
|
|
19
|
+
* <note>
|
|
20
|
+
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
21
21
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
22
22
|
* does not have permission to write to the bucket, then an exception is
|
|
23
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/
|
|
23
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
24
24
|
* policies for CRLs in Amazon S3</a>.</p>
|
|
25
25
|
* </note>
|
|
26
|
-
*
|
|
27
|
-
* information, see <a href="https://docs.aws.amazon.com/
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
26
|
+
* <p>Amazon Web Services Private CA also writes revocation information to the audit report. For more
|
|
27
|
+
* information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>You cannot revoke a root CA self-signed certificate.</p>
|
|
30
|
+
* </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -14,8 +14,15 @@ export interface TagCertificateAuthorityCommandOutput extends __MetadataBearer {
|
|
|
14
14
|
* by using a key-value pair. You can apply a tag to just one private CA if you want to
|
|
15
15
|
* identify a specific characteristic of that CA, or you can apply the same tag to multiple
|
|
16
16
|
* private CAs if you want to filter for a common relationship among those CAs. To remove
|
|
17
|
-
* one or more tags, use the <a href="https://docs.aws.amazon.com/
|
|
17
|
+
* one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are
|
|
18
18
|
* associated with your CA. </p>
|
|
19
|
+
* <note>
|
|
20
|
+
* <p>To attach tags to a private CA during the creation procedure, a CA administrator
|
|
21
|
+
* must first associate an inline IAM policy with the
|
|
22
|
+
* <code>CreateCertificateAuthority</code> action and explicitly allow tagging. For
|
|
23
|
+
* more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching tags to a CA
|
|
24
|
+
* at the time of creation</a>.</p>
|
|
25
|
+
* </note>
|
|
19
26
|
* @example
|
|
20
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
28
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface UntagCertificateAuthorityCommandOutput extends __MetadataBearer
|
|
|
11
11
|
* <p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If
|
|
12
12
|
* you do not specify the value portion of the tag when calling this action, the tag will
|
|
13
13
|
* be removed regardless of value. If you specify a value, the tag is removed only if it is
|
|
14
|
-
* associated with the specified value. To add tags to a private CA, use the <a href="https://docs.aws.amazon.com/
|
|
14
|
+
* associated with the specified value. To add tags to a private CA, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are
|
|
15
15
|
* associated with your CA. </p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,11 +12,11 @@ export interface UpdateCertificateAuthorityCommandOutput extends __MetadataBeare
|
|
|
12
12
|
* private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you
|
|
13
13
|
* can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or
|
|
14
14
|
* make a CA that is in the <code>DISABLED</code> state active again.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
17
17
|
* the S3 bucket that you specify. If the IAM principal making the call
|
|
18
18
|
* does not have permission to write to the bucket, then an exception is
|
|
19
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/
|
|
19
|
+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
20
20
|
* policies for CRLs in Amazon S3</a>.</p>
|
|
21
21
|
* </note>
|
|
22
22
|
* @example
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|