@aws-sdk/client-acm-pca 3.529.1 → 3.535.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/dist-types/ACMPCA.d.ts +2 -1
- package/dist-types/ACMPCAClient.d.ts +1 -1
- package/dist-types/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +2 -1
- package/dist-types/commands/CreateCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/commands/CreatePermissionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/commands/DeletePermissionCommand.d.ts +2 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCertificateAuthorityAuditReportCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/commands/GetCertificateAuthorityCertificateCommand.d.ts +2 -1
- package/dist-types/commands/GetCertificateAuthorityCsrCommand.d.ts +2 -1
- package/dist-types/commands/GetCertificateCommand.d.ts +2 -1
- package/dist-types/commands/GetPolicyCommand.d.ts +2 -1
- package/dist-types/commands/ImportCertificateAuthorityCertificateCommand.d.ts +4 -3
- package/dist-types/commands/IssueCertificateCommand.d.ts +3 -2
- package/dist-types/commands/ListCertificateAuthoritiesCommand.d.ts +2 -1
- package/dist-types/commands/ListPermissionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsCommand.d.ts +2 -1
- package/dist-types/commands/PutPolicyCommand.d.ts +2 -1
- package/dist-types/commands/RestoreCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/commands/RevokeCertificateCommand.d.ts +2 -1
- package/dist-types/commands/TagCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/commands/UntagCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCertificateAuthorityCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +227 -227
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/ACMPCA.d.ts +1 -0
- package/dist-types/ts3.4/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCertificateAuthorityAuditReportCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCertificateAuthorityCertificateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCertificateAuthorityCsrCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCertificateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportCertificateAuthorityCertificateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/IssueCertificateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCertificateAuthoritiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RevokeCertificateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCertificateAuthorityCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +41 -41
|
@@ -1,117 +1,116 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ACMPCAServiceException as __BaseException } from "./ACMPCAServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Defines the X.500 relative distinguished name (RDN).</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface CustomAttribute {
|
|
8
8
|
/**
|
|
9
|
-
* @public
|
|
10
9
|
* <p>Specifies the object identifier (OID) of the attribute type of the relative
|
|
11
10
|
* distinguished name (RDN).</p>
|
|
11
|
+
* @public
|
|
12
12
|
*/
|
|
13
13
|
ObjectIdentifier: string | undefined;
|
|
14
14
|
/**
|
|
15
|
-
* @public
|
|
16
15
|
* <p></p>
|
|
17
16
|
* <p>Specifies the attribute value of relative distinguished name (RDN).</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
Value: string | undefined;
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>Contains information about the certificate subject. The <code>Subject</code> field in
|
|
24
23
|
* the certificate identifies the entity that owns or controls the public key in the
|
|
25
24
|
* certificate. The entity can be a user, computer, device, or service. The <code>Subject
|
|
26
25
|
* </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
|
|
27
26
|
* distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
export interface ASN1Subject {
|
|
30
30
|
/**
|
|
31
|
-
* @public
|
|
32
31
|
* <p>Two-digit code that specifies the country in which the certificate subject
|
|
33
32
|
* located.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
Country?: string;
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>Legal name of the organization with which the certificate subject is affiliated.
|
|
39
38
|
* </p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
Organization?: string;
|
|
42
42
|
/**
|
|
43
|
-
* @public
|
|
44
43
|
* <p>A subdivision or unit of the organization (such as sales or finance) with which the
|
|
45
44
|
* certificate subject is affiliated.</p>
|
|
45
|
+
* @public
|
|
46
46
|
*/
|
|
47
47
|
OrganizationalUnit?: string;
|
|
48
48
|
/**
|
|
49
|
-
* @public
|
|
50
49
|
* <p>Disambiguating information for the certificate subject.</p>
|
|
50
|
+
* @public
|
|
51
51
|
*/
|
|
52
52
|
DistinguishedNameQualifier?: string;
|
|
53
53
|
/**
|
|
54
|
-
* @public
|
|
55
54
|
* <p>State in which the subject of the certificate is located.</p>
|
|
55
|
+
* @public
|
|
56
56
|
*/
|
|
57
57
|
State?: string;
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>For CA and end-entity certificates in a private PKI, the common name (CN) can be any
|
|
61
60
|
* string within the length limit. </p>
|
|
62
61
|
* <p>Note: In publicly trusted certificates, the common name must be a fully qualified
|
|
63
62
|
* domain name (FQDN) associated with the certificate subject.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
CommonName?: string;
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>The certificate serial number.</p>
|
|
68
|
+
* @public
|
|
69
69
|
*/
|
|
70
70
|
SerialNumber?: string;
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>The locality (such as a city or town) in which the certificate subject is
|
|
74
73
|
* located.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
Locality?: string;
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the
|
|
80
79
|
* certificate subject.</p>
|
|
80
|
+
* @public
|
|
81
81
|
*/
|
|
82
82
|
Title?: string;
|
|
83
83
|
/**
|
|
84
|
-
* @public
|
|
85
84
|
* <p>Family name. In the US and the UK, for example, the surname of an individual is
|
|
86
85
|
* ordered last. In Asian cultures the surname is typically ordered first.</p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
Surname?: string;
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>First name.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
GivenName?: string;
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>Concatenation that typically contains the first letter of the <b>GivenName</b>, the first letter of the middle name if one exists, and the
|
|
97
96
|
* first letter of the <b>Surname</b>.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
Initials?: string;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>Typically a shortened version of a longer <b>GivenName</b>.
|
|
103
102
|
* For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,
|
|
104
103
|
* Liz, or Eliza.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
Pseudonym?: string;
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>Typically a qualifier appended to the name of an individual. Examples include Jr. for
|
|
110
109
|
* junior, Sr. for senior, and III for third.</p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
GenerationQualifier?: string;
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p></p>
|
|
116
115
|
* <p>Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of
|
|
117
116
|
* which consists of an object identifier (OID) and a value. For more information, see
|
|
@@ -119,96 +118,97 @@ export interface ASN1Subject {
|
|
|
119
118
|
* <note>
|
|
120
119
|
* <p>Custom attributes cannot be used in combination with standard attributes.</p>
|
|
121
120
|
* </note>
|
|
121
|
+
* @public
|
|
122
122
|
*/
|
|
123
123
|
CustomAttributes?: CustomAttribute[];
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>Describes an Electronic Data Interchange (EDI) entity as described in as defined in
|
|
128
127
|
* <a href="https://datatracker.ietf.org/doc/html/rfc5280">Subject Alternative
|
|
129
128
|
* Name</a> in RFC 5280.</p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
export interface EdiPartyName {
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>Specifies the party name.</p>
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
PartyName: string | undefined;
|
|
137
137
|
/**
|
|
138
|
-
* @public
|
|
139
138
|
* <p>Specifies the name assigner.</p>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
NameAssigner?: string;
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>Defines a custom ASN.1 X.400 <code>GeneralName</code> using an object identifier (OID)
|
|
146
145
|
* and value. The OID must satisfy the regular expression shown below. For more
|
|
147
146
|
* information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
|
|
148
147
|
* (OID)</a>.</p>
|
|
148
|
+
* @public
|
|
149
149
|
*/
|
|
150
150
|
export interface OtherName {
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>Specifies an OID. </p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
TypeId: string | undefined;
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>Specifies an OID value.</p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
Value: string | undefined;
|
|
161
161
|
}
|
|
162
162
|
/**
|
|
163
|
-
* @public
|
|
164
163
|
* <p>Describes an ASN.1 X.400 <code>GeneralName</code> as defined in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>. Only one of
|
|
165
164
|
* the following naming options should be provided. Providing more than one option results
|
|
166
165
|
* in an <code>InvalidArgsException</code> error.</p>
|
|
166
|
+
* @public
|
|
167
167
|
*/
|
|
168
168
|
export interface GeneralName {
|
|
169
169
|
/**
|
|
170
|
-
* @public
|
|
171
170
|
* <p>Represents <code>GeneralName</code> using an <code>OtherName</code> object.</p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
OtherName?: OtherName;
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>Represents <code>GeneralName</code> as an <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a> email
|
|
177
176
|
* address.</p>
|
|
177
|
+
* @public
|
|
178
178
|
*/
|
|
179
179
|
Rfc822Name?: string;
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>Represents <code>GeneralName</code> as a DNS name.</p>
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
DnsName?: string;
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>Contains information about the certificate subject. The <code>Subject</code> field in
|
|
188
187
|
* the certificate identifies the entity that owns or controls the public key in the
|
|
189
188
|
* certificate. The entity can be a user, computer, device, or service. The <code>Subject
|
|
190
189
|
* </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
|
|
191
190
|
* distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
|
|
191
|
+
* @public
|
|
192
192
|
*/
|
|
193
193
|
DirectoryName?: ASN1Subject;
|
|
194
194
|
/**
|
|
195
|
-
* @public
|
|
196
195
|
* <p>Represents <code>GeneralName</code> as an <code>EdiPartyName</code> object.</p>
|
|
196
|
+
* @public
|
|
197
197
|
*/
|
|
198
198
|
EdiPartyName?: EdiPartyName;
|
|
199
199
|
/**
|
|
200
|
-
* @public
|
|
201
200
|
* <p>Represents <code>GeneralName</code> as a URI.</p>
|
|
201
|
+
* @public
|
|
202
202
|
*/
|
|
203
203
|
UniformResourceIdentifier?: string;
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>Represents <code>GeneralName</code> as an IPv4 or IPv6 address.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
IpAddress?: string;
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p> Represents <code>GeneralName</code> as an object identifier (OID).</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
RegisteredId?: string;
|
|
214
214
|
}
|
|
@@ -226,112 +226,112 @@ export declare const AccessMethodType: {
|
|
|
226
226
|
*/
|
|
227
227
|
export type AccessMethodType = (typeof AccessMethodType)[keyof typeof AccessMethodType];
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <p>Describes the type and format of extension access. Only one of
|
|
231
230
|
* <code>CustomObjectIdentifier</code> or <code>AccessMethodType</code> may be
|
|
232
231
|
* provided. Providing both results in <code>InvalidArgsException</code>.</p>
|
|
232
|
+
* @public
|
|
233
233
|
*/
|
|
234
234
|
export interface AccessMethod {
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>An object identifier (OID) specifying the <code>AccessMethod</code>. The OID must
|
|
238
237
|
* satisfy the regular expression shown below. For more information, see NIST's definition
|
|
239
238
|
* of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
|
|
240
239
|
* (OID)</a>.</p>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
CustomObjectIdentifier?: string;
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>Specifies the <code>AccessMethod</code>.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
AccessMethodType?: AccessMethodType;
|
|
248
248
|
}
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>Provides access information used by the <code>authorityInfoAccess</code> and
|
|
252
251
|
* <code>subjectInfoAccess</code> extensions described in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
export interface AccessDescription {
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>The type and format of <code>AccessDescription</code> information.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
AccessMethod: AccessMethod | undefined;
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>The location of <code>AccessDescription</code> information.</p>
|
|
262
|
+
* @public
|
|
263
263
|
*/
|
|
264
264
|
AccessLocation: GeneralName | undefined;
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>Defines one or more purposes for which the key contained in the certificate can be
|
|
269
268
|
* used. Default value for each option is false.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
export interface KeyUsage {
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p> Key can be used for digital signing.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
DigitalSignature?: boolean;
|
|
277
277
|
/**
|
|
278
|
-
* @public
|
|
279
278
|
* <p>Key can be used for non-repudiation.</p>
|
|
279
|
+
* @public
|
|
280
280
|
*/
|
|
281
281
|
NonRepudiation?: boolean;
|
|
282
282
|
/**
|
|
283
|
-
* @public
|
|
284
283
|
* <p>Key can be used to encipher data.</p>
|
|
284
|
+
* @public
|
|
285
285
|
*/
|
|
286
286
|
KeyEncipherment?: boolean;
|
|
287
287
|
/**
|
|
288
|
-
* @public
|
|
289
288
|
* <p>Key can be used to decipher data.</p>
|
|
289
|
+
* @public
|
|
290
290
|
*/
|
|
291
291
|
DataEncipherment?: boolean;
|
|
292
292
|
/**
|
|
293
|
-
* @public
|
|
294
293
|
* <p>Key can be used in a key-agreement protocol.</p>
|
|
294
|
+
* @public
|
|
295
295
|
*/
|
|
296
296
|
KeyAgreement?: boolean;
|
|
297
297
|
/**
|
|
298
|
-
* @public
|
|
299
298
|
* <p>Key can be used to sign certificates.</p>
|
|
299
|
+
* @public
|
|
300
300
|
*/
|
|
301
301
|
KeyCertSign?: boolean;
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>Key can be used to sign CRLs.</p>
|
|
304
|
+
* @public
|
|
305
305
|
*/
|
|
306
306
|
CRLSign?: boolean;
|
|
307
307
|
/**
|
|
308
|
-
* @public
|
|
309
308
|
* <p>Key can be used only to encipher data.</p>
|
|
309
|
+
* @public
|
|
310
310
|
*/
|
|
311
311
|
EncipherOnly?: boolean;
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>Key can be used only to decipher data.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
DecipherOnly?: boolean;
|
|
317
317
|
}
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <p>Describes the certificate extensions to be added to the certificate signing request
|
|
321
320
|
* (CSR).</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
export interface CsrExtensions {
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>Indicates the purpose of the certificate and of the key contained in the
|
|
327
326
|
* certificate.</p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
KeyUsage?: KeyUsage;
|
|
330
330
|
/**
|
|
331
|
-
* @public
|
|
332
331
|
* <p>For CA certificates, provides a path to additional information pertaining to the CA,
|
|
333
332
|
* such as revocation and policy. For more information, see <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2">Subject
|
|
334
333
|
* Information Access</a> in RFC 5280.</p>
|
|
334
|
+
* @public
|
|
335
335
|
*/
|
|
336
336
|
SubjectInformationAccess?: AccessDescription[];
|
|
337
337
|
}
|
|
@@ -366,38 +366,38 @@ export declare const SigningAlgorithm: {
|
|
|
366
366
|
*/
|
|
367
367
|
export type SigningAlgorithm = (typeof SigningAlgorithm)[keyof typeof SigningAlgorithm];
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>Contains configuration information for your private certificate authority (CA). This
|
|
371
370
|
* includes information about the class of public key algorithm and the key pair that your
|
|
372
371
|
* private CA creates when it issues a certificate. It also includes the signature
|
|
373
372
|
* algorithm that it uses when issuing certificates, and its X.500 distinguished name. You
|
|
374
373
|
* must specify this information when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. </p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
export interface CertificateAuthorityConfiguration {
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>Type of the public key algorithm and size, in bits, of the key pair that your CA
|
|
380
379
|
* creates when it issues a certificate. When you create a subordinate CA, you must use a
|
|
381
380
|
* key algorithm supported by the parent CA.</p>
|
|
381
|
+
* @public
|
|
382
382
|
*/
|
|
383
383
|
KeyAlgorithm: KeyAlgorithm | undefined;
|
|
384
384
|
/**
|
|
385
|
-
* @public
|
|
386
385
|
* <p>Name of the algorithm your private CA uses to sign certificate requests.</p>
|
|
387
386
|
* <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
|
|
388
387
|
* used to sign certificates when they are issued.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
SigningAlgorithm: SigningAlgorithm | undefined;
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>Structure that contains X.500 distinguished name information for your private
|
|
394
393
|
* CA.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
Subject: ASN1Subject | undefined;
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p>Specifies information to be added to the extension section of the certificate signing
|
|
400
399
|
* request (CSR).</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
CsrExtensions?: CsrExtensions;
|
|
403
403
|
}
|
|
@@ -426,20 +426,20 @@ export declare const KeyStorageSecurityStandard: {
|
|
|
426
426
|
*/
|
|
427
427
|
export type KeyStorageSecurityStandard = (typeof KeyStorageSecurityStandard)[keyof typeof KeyStorageSecurityStandard];
|
|
428
428
|
/**
|
|
429
|
-
* @public
|
|
430
429
|
* <p>Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension
|
|
431
430
|
* contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension
|
|
432
431
|
* omitted or not in certificates issued by your CA, you can set the <b>OmitExtension</b> parameter.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
export interface CrlDistributionPointExtensionConfiguration {
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p>Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to <code>true</code>, then the CDP extension will
|
|
438
437
|
* not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.</p>
|
|
439
438
|
* <note>
|
|
440
439
|
* <p>Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger</p>
|
|
441
440
|
* <p>This configuration cannot be enabled with a custom CNAME set.</p>
|
|
442
441
|
* </note>
|
|
442
|
+
* @public
|
|
443
443
|
*/
|
|
444
444
|
OmitExtension: boolean | undefined;
|
|
445
445
|
}
|
|
@@ -456,7 +456,6 @@ export declare const S3ObjectAcl: {
|
|
|
456
456
|
*/
|
|
457
457
|
export type S3ObjectAcl = (typeof S3ObjectAcl)[keyof typeof S3ObjectAcl];
|
|
458
458
|
/**
|
|
459
|
-
* @public
|
|
460
459
|
* <p>Contains configuration information for a certificate revocation list (CRL). Your
|
|
461
460
|
* private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You
|
|
462
461
|
* can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA
|
|
@@ -571,23 +570,23 @@ export type S3ObjectAcl = (typeof S3ObjectAcl)[keyof typeof S3ObjectAcl];
|
|
|
571
570
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html">Planning a certificate revocation list
|
|
572
571
|
* (CRL)</a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i>
|
|
573
572
|
* </p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
export interface CrlConfiguration {
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
|
|
579
578
|
* You can use this value to enable certificate revocation for a new CA when you call the
|
|
580
579
|
* <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action or for an existing CA when you call the
|
|
581
580
|
* <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action. </p>
|
|
581
|
+
* @public
|
|
582
582
|
*/
|
|
583
583
|
Enabled: boolean | undefined;
|
|
584
584
|
/**
|
|
585
|
-
* @public
|
|
586
585
|
* <p>Validity period of the CRL in days.</p>
|
|
586
|
+
* @public
|
|
587
587
|
*/
|
|
588
588
|
ExpirationInDays?: number;
|
|
589
589
|
/**
|
|
590
|
-
* @public
|
|
591
590
|
* <p>Name inserted into the certificate <b>CRL Distribution
|
|
592
591
|
* Points</b> extension that enables the use of an alias for the CRL
|
|
593
592
|
* distribution point. Use this value if you don't want the name of your S3 bucket to be
|
|
@@ -597,10 +596,10 @@ export interface CrlConfiguration {
|
|
|
597
596
|
* use of special characters in URIs. Additionally, the value of the CNAME must not
|
|
598
597
|
* include a protocol prefix such as "http://" or "https://".</p>
|
|
599
598
|
* </note>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
CustomCname?: string;
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
|
|
605
604
|
* <b>CustomCname</b> argument, the name of your S3 bucket
|
|
606
605
|
* is placed into the <b>CRL Distribution Points</b> extension of
|
|
@@ -610,10 +609,10 @@ export interface CrlConfiguration {
|
|
|
610
609
|
* <p>The <code>S3BucketName</code> parameter must conform to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">S3
|
|
611
610
|
* bucket naming rules</a>.</p>
|
|
612
611
|
* </note>
|
|
612
|
+
* @public
|
|
613
613
|
*/
|
|
614
614
|
S3BucketName?: string;
|
|
615
615
|
/**
|
|
616
|
-
* @public
|
|
617
616
|
* <p>Determines whether the CRL will be publicly readable or privately held in the CRL
|
|
618
617
|
* Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public
|
|
619
618
|
* internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket
|
|
@@ -629,30 +628,30 @@ export interface CrlConfiguration {
|
|
|
629
628
|
* value.</p>
|
|
630
629
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa">Blocking public access to the S3
|
|
631
630
|
* bucket</a>.</p>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
S3ObjectAcl?: S3ObjectAcl;
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
CrlDistributionPointExtensionConfiguration?: CrlDistributionPointExtensionConfiguration;
|
|
639
639
|
}
|
|
640
640
|
/**
|
|
641
|
-
* @public
|
|
642
641
|
* <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP)
|
|
643
642
|
* for validating certificate revocation status.</p>
|
|
644
643
|
* <p>When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
645
644
|
* to reflect the new status.</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
export interface OcspConfiguration {
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
|
|
651
650
|
* certificate revocation status.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
Enabled: boolean | undefined;
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by
|
|
657
656
|
* the Online Certificate Status Protocol (OCSP). A customer can alternatively use this
|
|
658
657
|
* object to define a CNAME specifying a customized OCSP domain.</p>
|
|
@@ -663,11 +662,11 @@ export interface OcspConfiguration {
|
|
|
663
662
|
* </note>
|
|
664
663
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/ocsp-customize.html">Customizing Online Certificate Status Protocol
|
|
665
664
|
* (OCSP) </a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i>.</p>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
OcspCustomCname?: string;
|
|
668
668
|
}
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>Certificate revocation information used by the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA)
|
|
672
671
|
* can configure Online Certificate Status Protocol (OCSP) support and/or maintain a
|
|
673
672
|
* certificate revocation list (CRL). OCSP returns validation information about
|
|
@@ -675,40 +674,41 @@ export interface OcspConfiguration {
|
|
|
675
674
|
* revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html">Setting up a
|
|
676
675
|
* certificate revocation method</a> in the <i>Amazon Web Services Private Certificate Authority User
|
|
677
676
|
* Guide</i>.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
export interface RevocationConfiguration {
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your
|
|
683
682
|
* private CA. A CRL is typically updated approximately 30 minutes after a certificate
|
|
684
683
|
* is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts
|
|
685
684
|
* every 15 minutes.</p>
|
|
685
|
+
* @public
|
|
686
686
|
*/
|
|
687
687
|
CrlConfiguration?: CrlConfiguration;
|
|
688
688
|
/**
|
|
689
|
-
* @public
|
|
690
689
|
* <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained
|
|
691
690
|
* by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
692
691
|
* to reflect the new status.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
OcspConfiguration?: OcspConfiguration;
|
|
695
695
|
}
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>Tags are labels that you can use to identify and organize your private CAs. Each tag
|
|
699
698
|
* consists of a key and an optional value. You can associate up to 50 tags with a private
|
|
700
699
|
* CA. To add one or more tags to a private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
|
|
701
700
|
* action. To remove a tag, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. </p>
|
|
701
|
+
* @public
|
|
702
702
|
*/
|
|
703
703
|
export interface Tag {
|
|
704
704
|
/**
|
|
705
|
-
* @public
|
|
706
705
|
* <p>Key (name) of the tag.</p>
|
|
706
|
+
* @public
|
|
707
707
|
*/
|
|
708
708
|
Key: string | undefined;
|
|
709
709
|
/**
|
|
710
|
-
* @public
|
|
711
710
|
* <p>Value of the tag.</p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
Value?: string;
|
|
714
714
|
}
|
|
@@ -729,13 +729,12 @@ export type CertificateAuthorityUsageMode = (typeof CertificateAuthorityUsageMod
|
|
|
729
729
|
*/
|
|
730
730
|
export interface CreateCertificateAuthorityRequest {
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>Name and bit size of the private key algorithm, the name of the signing algorithm, and
|
|
734
733
|
* X.500 certificate subject information.</p>
|
|
734
|
+
* @public
|
|
735
735
|
*/
|
|
736
736
|
CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support, to
|
|
740
739
|
* enable a certificate revocation list (CRL), to enable both, or to enable neither. The
|
|
741
740
|
* default is for both certificate validation mechanisms to be disabled. </p>
|
|
@@ -765,15 +764,15 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
765
764
|
* </note>
|
|
766
765
|
* <p> For more information, see the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a>
|
|
767
766
|
* types.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
RevocationConfiguration?: RevocationConfiguration;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>The type of the certificate authority.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
CertificateAuthorityType: CertificateAuthorityType | undefined;
|
|
775
775
|
/**
|
|
776
|
-
* @public
|
|
777
776
|
* <p>Custom string that can be used to distinguish between calls to the <b>CreateCertificateAuthority</b> action. Idempotency tokens for
|
|
778
777
|
* <b>CreateCertificateAuthority</b> time out after five
|
|
779
778
|
* minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency
|
|
@@ -781,10 +780,10 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
781
780
|
* certificate authority and will issue only one. If you change the idempotency token for
|
|
782
781
|
* each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate
|
|
783
782
|
* authorities.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
IdempotencyToken?: string;
|
|
786
786
|
/**
|
|
787
|
-
* @public
|
|
788
787
|
* <p>Specifies a cryptographic key management compliance standard used for handling CA
|
|
789
788
|
* keys.</p>
|
|
790
789
|
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
|
|
@@ -797,22 +796,23 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
797
796
|
* <p>For information about security standard support in various Regions, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys">Storage
|
|
798
797
|
* and security compliance of Amazon Web Services Private CA private keys</a>.</p>
|
|
799
798
|
* </note>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
KeyStorageSecurityStandard?: KeyStorageSecurityStandard;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>Key-value pairs that will be attached to the new private CA. You can associate up to
|
|
805
804
|
* 50 tags with a private CA. For information using tags with IAM to manage permissions,
|
|
806
805
|
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>.</p>
|
|
806
|
+
* @public
|
|
807
807
|
*/
|
|
808
808
|
Tags?: Tag[];
|
|
809
809
|
/**
|
|
810
|
-
* @public
|
|
811
810
|
* <p>Specifies whether the CA issues general-purpose certificates that typically require a
|
|
812
811
|
* revocation mechanism, or short-lived certificates that may optionally omit revocation
|
|
813
812
|
* because they expire quickly. Short-lived certificate validity is limited to seven
|
|
814
813
|
* days.</p>
|
|
815
814
|
* <p>The default value is GENERAL_PURPOSE.</p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
UsageMode?: CertificateAuthorityUsageMode;
|
|
818
818
|
}
|
|
@@ -821,19 +821,19 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
821
821
|
*/
|
|
822
822
|
export interface CreateCertificateAuthorityResponse {
|
|
823
823
|
/**
|
|
824
|
-
* @public
|
|
825
824
|
* <p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This
|
|
826
825
|
* is of the form: </p>
|
|
827
826
|
* <p>
|
|
828
827
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
829
828
|
* </code>.
|
|
830
829
|
* </p>
|
|
830
|
+
* @public
|
|
831
831
|
*/
|
|
832
832
|
CertificateAuthorityArn?: string;
|
|
833
833
|
}
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>One or more of the specified arguments was not valid.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
export declare class InvalidArgsException extends __BaseException {
|
|
839
839
|
readonly name: "InvalidArgsException";
|
|
@@ -844,9 +844,9 @@ export declare class InvalidArgsException extends __BaseException {
|
|
|
844
844
|
constructor(opts: __ExceptionOptionType<InvalidArgsException, __BaseException>);
|
|
845
845
|
}
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>The resource policy is invalid or is missing a required statement. For general
|
|
849
848
|
* 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>
|
|
849
|
+
* @public
|
|
850
850
|
*/
|
|
851
851
|
export declare class InvalidPolicyException extends __BaseException {
|
|
852
852
|
readonly name: "InvalidPolicyException";
|
|
@@ -857,9 +857,9 @@ export declare class InvalidPolicyException extends __BaseException {
|
|
|
857
857
|
constructor(opts: __ExceptionOptionType<InvalidPolicyException, __BaseException>);
|
|
858
858
|
}
|
|
859
859
|
/**
|
|
860
|
-
* @public
|
|
861
860
|
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the
|
|
862
861
|
* message field.</p>
|
|
862
|
+
* @public
|
|
863
863
|
*/
|
|
864
864
|
export declare class InvalidTagException extends __BaseException {
|
|
865
865
|
readonly name: "InvalidTagException";
|
|
@@ -870,9 +870,9 @@ export declare class InvalidTagException extends __BaseException {
|
|
|
870
870
|
constructor(opts: __ExceptionOptionType<InvalidTagException, __BaseException>);
|
|
871
871
|
}
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
|
|
875
874
|
* the quota that was exceeded.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
export declare class LimitExceededException extends __BaseException {
|
|
878
878
|
readonly name: "LimitExceededException";
|
|
@@ -899,21 +899,21 @@ export type AuditReportResponseFormat = (typeof AuditReportResponseFormat)[keyof
|
|
|
899
899
|
*/
|
|
900
900
|
export interface CreateCertificateAuthorityAuditReportRequest {
|
|
901
901
|
/**
|
|
902
|
-
* @public
|
|
903
902
|
* <p>The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p>
|
|
904
903
|
* <p>
|
|
905
904
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
906
905
|
* </code>.</p>
|
|
906
|
+
* @public
|
|
907
907
|
*/
|
|
908
908
|
CertificateAuthorityArn: string | undefined;
|
|
909
909
|
/**
|
|
910
|
-
* @public
|
|
911
910
|
* <p>The name of the S3 bucket that will contain the audit report.</p>
|
|
911
|
+
* @public
|
|
912
912
|
*/
|
|
913
913
|
S3BucketName: string | undefined;
|
|
914
914
|
/**
|
|
915
|
-
* @public
|
|
916
915
|
* <p>The format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>
|
|
916
|
+
* @public
|
|
917
917
|
*/
|
|
918
918
|
AuditReportResponseFormat: AuditReportResponseFormat | undefined;
|
|
919
919
|
}
|
|
@@ -922,21 +922,21 @@ export interface CreateCertificateAuthorityAuditReportRequest {
|
|
|
922
922
|
*/
|
|
923
923
|
export interface CreateCertificateAuthorityAuditReportResponse {
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>An alphanumeric string that contains a report identifier.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
AuditReportId?: string;
|
|
929
929
|
/**
|
|
930
|
-
* @public
|
|
931
930
|
* <p>The <b>key</b> that uniquely identifies the report file in
|
|
932
931
|
* your S3 bucket.</p>
|
|
932
|
+
* @public
|
|
933
933
|
*/
|
|
934
934
|
S3Key?: string;
|
|
935
935
|
}
|
|
936
936
|
/**
|
|
937
|
-
* @public
|
|
938
937
|
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
939
938
|
* resource.</p>
|
|
939
|
+
* @public
|
|
940
940
|
*/
|
|
941
941
|
export declare class InvalidArnException extends __BaseException {
|
|
942
942
|
readonly name: "InvalidArnException";
|
|
@@ -947,8 +947,8 @@ export declare class InvalidArnException extends __BaseException {
|
|
|
947
947
|
constructor(opts: __ExceptionOptionType<InvalidArnException, __BaseException>);
|
|
948
948
|
}
|
|
949
949
|
/**
|
|
950
|
-
* @public
|
|
951
950
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
export declare class InvalidStateException extends __BaseException {
|
|
954
954
|
readonly name: "InvalidStateException";
|
|
@@ -959,8 +959,8 @@ export declare class InvalidStateException extends __BaseException {
|
|
|
959
959
|
constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
|
|
960
960
|
}
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The request has failed for an unspecified reason.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
export declare class RequestFailedException extends __BaseException {
|
|
966
966
|
readonly name: "RequestFailedException";
|
|
@@ -971,8 +971,8 @@ export declare class RequestFailedException extends __BaseException {
|
|
|
971
971
|
constructor(opts: __ExceptionOptionType<RequestFailedException, __BaseException>);
|
|
972
972
|
}
|
|
973
973
|
/**
|
|
974
|
-
* @public
|
|
975
974
|
* <p>Your request is already in progress.</p>
|
|
975
|
+
* @public
|
|
976
976
|
*/
|
|
977
977
|
export declare class RequestInProgressException extends __BaseException {
|
|
978
978
|
readonly name: "RequestInProgressException";
|
|
@@ -983,9 +983,9 @@ export declare class RequestInProgressException extends __BaseException {
|
|
|
983
983
|
constructor(opts: __ExceptionOptionType<RequestInProgressException, __BaseException>);
|
|
984
984
|
}
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
988
987
|
* cannot be found.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
991
991
|
readonly name: "ResourceNotFoundException";
|
|
@@ -1013,37 +1013,37 @@ export type ActionType = (typeof ActionType)[keyof typeof ActionType];
|
|
|
1013
1013
|
*/
|
|
1014
1014
|
export interface CreatePermissionRequest {
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the
|
|
1018
1017
|
* ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
|
|
1019
1018
|
* <p>
|
|
1020
1019
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1021
1020
|
* </code>.
|
|
1022
1021
|
* </p>
|
|
1022
|
+
* @public
|
|
1023
1023
|
*/
|
|
1024
1024
|
CertificateAuthorityArn: string | undefined;
|
|
1025
1025
|
/**
|
|
1026
|
-
* @public
|
|
1027
1026
|
* <p>The Amazon Web Services service or identity that receives the permission. At this time, the only
|
|
1028
1027
|
* valid principal is <code>acm.amazonaws.com</code>.</p>
|
|
1028
|
+
* @public
|
|
1029
1029
|
*/
|
|
1030
1030
|
Principal: string | undefined;
|
|
1031
1031
|
/**
|
|
1032
|
-
* @public
|
|
1033
1032
|
* <p>The ID of the calling account.</p>
|
|
1033
|
+
* @public
|
|
1034
1034
|
*/
|
|
1035
1035
|
SourceAccount?: string;
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <p>The actions that the specified Amazon Web Services service principal can use. These include
|
|
1039
1038
|
* <code>IssueCertificate</code>, <code>GetCertificate</code>, and
|
|
1040
1039
|
* <code>ListPermissions</code>.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
Actions: ActionType[] | undefined;
|
|
1043
1043
|
}
|
|
1044
1044
|
/**
|
|
1045
|
-
* @public
|
|
1046
1045
|
* <p>The designated permission has already been given to the user.</p>
|
|
1046
|
+
* @public
|
|
1047
1047
|
*/
|
|
1048
1048
|
export declare class PermissionAlreadyExistsException extends __BaseException {
|
|
1049
1049
|
readonly name: "PermissionAlreadyExistsException";
|
|
@@ -1054,8 +1054,8 @@ export declare class PermissionAlreadyExistsException extends __BaseException {
|
|
|
1054
1054
|
constructor(opts: __ExceptionOptionType<PermissionAlreadyExistsException, __BaseException>);
|
|
1055
1055
|
}
|
|
1056
1056
|
/**
|
|
1057
|
-
* @public
|
|
1058
1057
|
* <p>A previous update to your private CA is still ongoing.</p>
|
|
1058
|
+
* @public
|
|
1059
1059
|
*/
|
|
1060
1060
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
1061
1061
|
readonly name: "ConcurrentModificationException";
|
|
@@ -1070,18 +1070,18 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
export interface DeleteCertificateAuthorityRequest {
|
|
1072
1072
|
/**
|
|
1073
|
-
* @public
|
|
1074
1073
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must have the following form: </p>
|
|
1075
1074
|
* <p>
|
|
1076
1075
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1077
1076
|
* </code>.
|
|
1078
1077
|
* </p>
|
|
1078
|
+
* @public
|
|
1079
1079
|
*/
|
|
1080
1080
|
CertificateAuthorityArn: string | undefined;
|
|
1081
1081
|
/**
|
|
1082
|
-
* @public
|
|
1083
1082
|
* <p>The number of days to make a CA restorable after it has been deleted. This can be
|
|
1084
1083
|
* anywhere from 7 to 30 days, with 30 being the default.</p>
|
|
1084
|
+
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
PermanentDeletionTimeInDays?: number;
|
|
1087
1087
|
}
|
|
@@ -1090,25 +1090,25 @@ export interface DeleteCertificateAuthorityRequest {
|
|
|
1090
1090
|
*/
|
|
1091
1091
|
export interface DeletePermissionRequest {
|
|
1092
1092
|
/**
|
|
1093
|
-
* @public
|
|
1094
1093
|
* <p>The Amazon Resource Number (ARN) of the private CA that issued the permissions. You
|
|
1095
1094
|
* can find the CA's ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
|
|
1096
1095
|
* <p>
|
|
1097
1096
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1098
1097
|
* </code>.
|
|
1099
1098
|
* </p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
CertificateAuthorityArn: string | undefined;
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The Amazon Web Services service or identity that will have its CA permissions revoked. At this time,
|
|
1105
1104
|
* the only valid service principal is <code>acm.amazonaws.com</code>
|
|
1106
1105
|
* </p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
Principal: string | undefined;
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>The Amazon Web Services account that calls this action.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
SourceAccount?: string;
|
|
1114
1114
|
}
|
|
@@ -1117,19 +1117,19 @@ export interface DeletePermissionRequest {
|
|
|
1117
1117
|
*/
|
|
1118
1118
|
export interface DeletePolicyRequest {
|
|
1119
1119
|
/**
|
|
1120
|
-
* @public
|
|
1121
1120
|
* <p>The Amazon Resource Number (ARN) of the private CA that will have its policy deleted.
|
|
1122
1121
|
* You can find the CA's ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. The ARN value must have the form
|
|
1123
1122
|
* <code>arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab</code>.
|
|
1124
1123
|
* </p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
ResourceArn: string | undefined;
|
|
1127
1127
|
}
|
|
1128
1128
|
/**
|
|
1129
|
-
* @public
|
|
1130
1129
|
* <p>The current action was prevented because it would lock the caller out from performing
|
|
1131
1130
|
* subsequent actions. Verify that the specified parameters would not result in the caller
|
|
1132
1131
|
* being denied access to the resource. </p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
export declare class LockoutPreventedException extends __BaseException {
|
|
1135
1135
|
readonly name: "LockoutPreventedException";
|
|
@@ -1144,12 +1144,12 @@ export declare class LockoutPreventedException extends __BaseException {
|
|
|
1144
1144
|
*/
|
|
1145
1145
|
export interface DescribeCertificateAuthorityRequest {
|
|
1146
1146
|
/**
|
|
1147
|
-
* @public
|
|
1148
1147
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
|
|
1149
1148
|
* <p>
|
|
1150
1149
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1151
1150
|
* </code>.
|
|
1152
1151
|
* </p>
|
|
1152
|
+
* @public
|
|
1153
1153
|
*/
|
|
1154
1154
|
CertificateAuthorityArn: string | undefined;
|
|
1155
1155
|
}
|
|
@@ -1184,7 +1184,6 @@ export declare const CertificateAuthorityStatus: {
|
|
|
1184
1184
|
*/
|
|
1185
1185
|
export type CertificateAuthorityStatus = (typeof CertificateAuthorityStatus)[keyof typeof CertificateAuthorityStatus];
|
|
1186
1186
|
/**
|
|
1187
|
-
* @public
|
|
1188
1187
|
* <p>Contains information about your private certificate authority (CA). Your private CA
|
|
1189
1188
|
* can issue and revoke X.509 digital certificates. Digital certificates verify that the
|
|
1190
1189
|
* entity named in the certificate <b>Subject</b> field owns or
|
|
@@ -1194,80 +1193,80 @@ export type CertificateAuthorityStatus = (typeof CertificateAuthorityStatus)[key
|
|
|
1194
1193
|
* certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or
|
|
1195
1194
|
* on-premises root or subordinate CA certificate. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action to import the signed
|
|
1196
1195
|
* certificate into Certificate Manager (ACM). </p>
|
|
1196
|
+
* @public
|
|
1197
1197
|
*/
|
|
1198
1198
|
export interface CertificateAuthority {
|
|
1199
1199
|
/**
|
|
1200
|
-
* @public
|
|
1201
1200
|
* <p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is
|
|
1202
1201
|
* <code>
|
|
1203
1202
|
* <i>12345678-1234-1234-1234-123456789012</i>
|
|
1204
1203
|
* </code>.</p>
|
|
1204
|
+
* @public
|
|
1205
1205
|
*/
|
|
1206
1206
|
Arn?: string;
|
|
1207
1207
|
/**
|
|
1208
|
-
* @public
|
|
1209
1208
|
* <p>The Amazon Web Services account ID that owns the certificate authority.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
OwnerAccount?: string;
|
|
1212
1212
|
/**
|
|
1213
|
-
* @public
|
|
1214
1213
|
* <p>Date and time at which your private CA was created.</p>
|
|
1214
|
+
* @public
|
|
1215
1215
|
*/
|
|
1216
1216
|
CreatedAt?: Date;
|
|
1217
1217
|
/**
|
|
1218
|
-
* @public
|
|
1219
1218
|
* <p>Date and time at which your private CA was last updated.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
LastStateChangeAt?: Date;
|
|
1222
1222
|
/**
|
|
1223
|
-
* @public
|
|
1224
1223
|
* <p>Type of your private CA.</p>
|
|
1224
|
+
* @public
|
|
1225
1225
|
*/
|
|
1226
1226
|
Type?: CertificateAuthorityType;
|
|
1227
1227
|
/**
|
|
1228
|
-
* @public
|
|
1229
1228
|
* <p>Serial number of your private CA.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
Serial?: string;
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>Status of your private CA.</p>
|
|
1234
|
+
* @public
|
|
1235
1235
|
*/
|
|
1236
1236
|
Status?: CertificateAuthorityStatus;
|
|
1237
1237
|
/**
|
|
1238
|
-
* @public
|
|
1239
1238
|
* <p>Date and time before which your private CA certificate is not valid.</p>
|
|
1239
|
+
* @public
|
|
1240
1240
|
*/
|
|
1241
1241
|
NotBefore?: Date;
|
|
1242
1242
|
/**
|
|
1243
|
-
* @public
|
|
1244
1243
|
* <p>Date and time after which your private CA certificate is not valid.</p>
|
|
1244
|
+
* @public
|
|
1245
1245
|
*/
|
|
1246
1246
|
NotAfter?: Date;
|
|
1247
1247
|
/**
|
|
1248
|
-
* @public
|
|
1249
1248
|
* <p>Reason the request to create your private CA failed.</p>
|
|
1249
|
+
* @public
|
|
1250
1250
|
*/
|
|
1251
1251
|
FailureReason?: FailureReason;
|
|
1252
1252
|
/**
|
|
1253
|
-
* @public
|
|
1254
1253
|
* <p>Your private CA configuration.</p>
|
|
1254
|
+
* @public
|
|
1255
1255
|
*/
|
|
1256
1256
|
CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration;
|
|
1257
1257
|
/**
|
|
1258
|
-
* @public
|
|
1259
1258
|
* <p>Information about the Online Certificate Status Protocol (OCSP) configuration or
|
|
1260
1259
|
* certificate revocation list (CRL) created and maintained by your private CA. </p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
RevocationConfiguration?: RevocationConfiguration;
|
|
1263
1263
|
/**
|
|
1264
|
-
* @public
|
|
1265
1264
|
* <p>The period during which a deleted CA can be restored. For more information, see the
|
|
1266
1265
|
* <code>PermanentDeletionTimeInDays</code> parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html">DeleteCertificateAuthorityRequest</a> action. </p>
|
|
1266
|
+
* @public
|
|
1267
1267
|
*/
|
|
1268
1268
|
RestorableUntil?: Date;
|
|
1269
1269
|
/**
|
|
1270
|
-
* @public
|
|
1271
1270
|
* <p>Defines a cryptographic key management compliance standard used for handling CA keys. </p>
|
|
1272
1271
|
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
|
|
1273
1272
|
* <p>Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must
|
|
@@ -1275,15 +1274,16 @@ export interface CertificateAuthority {
|
|
|
1275
1274
|
* Specifying a different value (or no value) results in an
|
|
1276
1275
|
* <code>InvalidArgsException</code> with the message "A certificate authority cannot
|
|
1277
1276
|
* be created in this region with the specified security standard."</p>
|
|
1277
|
+
* @public
|
|
1278
1278
|
*/
|
|
1279
1279
|
KeyStorageSecurityStandard?: KeyStorageSecurityStandard;
|
|
1280
1280
|
/**
|
|
1281
|
-
* @public
|
|
1282
1281
|
* <p>Specifies whether the CA issues general-purpose certificates that typically require a
|
|
1283
1282
|
* revocation mechanism, or short-lived certificates that may optionally omit revocation
|
|
1284
1283
|
* because they expire quickly. Short-lived certificate validity is limited to seven
|
|
1285
1284
|
* days.</p>
|
|
1286
1285
|
* <p>The default value is GENERAL_PURPOSE.</p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
UsageMode?: CertificateAuthorityUsageMode;
|
|
1289
1289
|
}
|
|
@@ -1292,9 +1292,9 @@ export interface CertificateAuthority {
|
|
|
1292
1292
|
*/
|
|
1293
1293
|
export interface DescribeCertificateAuthorityResponse {
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>A <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html">CertificateAuthority</a> structure that contains information about your private
|
|
1297
1296
|
* CA.</p>
|
|
1297
|
+
* @public
|
|
1298
1298
|
*/
|
|
1299
1299
|
CertificateAuthority?: CertificateAuthority;
|
|
1300
1300
|
}
|
|
@@ -1303,17 +1303,17 @@ export interface DescribeCertificateAuthorityResponse {
|
|
|
1303
1303
|
*/
|
|
1304
1304
|
export interface DescribeCertificateAuthorityAuditReportRequest {
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p>
|
|
1308
1307
|
* <p>
|
|
1309
1308
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1310
1309
|
* </code>.
|
|
1311
1310
|
* </p>
|
|
1311
|
+
* @public
|
|
1312
1312
|
*/
|
|
1313
1313
|
CertificateAuthorityArn: string | undefined;
|
|
1314
1314
|
/**
|
|
1315
|
-
* @public
|
|
1316
1315
|
* <p>The report ID returned by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action.</p>
|
|
1316
|
+
* @public
|
|
1317
1317
|
*/
|
|
1318
1318
|
AuditReportId: string | undefined;
|
|
1319
1319
|
}
|
|
@@ -1335,24 +1335,24 @@ export type AuditReportStatus = (typeof AuditReportStatus)[keyof typeof AuditRep
|
|
|
1335
1335
|
*/
|
|
1336
1336
|
export interface DescribeCertificateAuthorityAuditReportResponse {
|
|
1337
1337
|
/**
|
|
1338
|
-
* @public
|
|
1339
1338
|
* <p>Specifies whether report creation is in progress, has succeeded, or has failed.</p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
AuditReportStatus?: AuditReportStatus;
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>Name of the S3 bucket that contains the report.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
S3BucketName?: string;
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>S3 <b>key</b> that uniquely identifies the report file in
|
|
1350
1349
|
* your S3 bucket.</p>
|
|
1350
|
+
* @public
|
|
1351
1351
|
*/
|
|
1352
1352
|
S3Key?: string;
|
|
1353
1353
|
/**
|
|
1354
|
-
* @public
|
|
1355
1354
|
* <p>The date and time at which the report was created.</p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
CreatedAt?: Date;
|
|
1358
1358
|
}
|
|
@@ -1361,22 +1361,22 @@ export interface DescribeCertificateAuthorityAuditReportResponse {
|
|
|
1361
1361
|
*/
|
|
1362
1362
|
export interface GetCertificateRequest {
|
|
1363
1363
|
/**
|
|
1364
|
-
* @public
|
|
1365
1364
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
|
|
1366
1365
|
* <p>
|
|
1367
1366
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1368
1367
|
* </code>.
|
|
1369
1368
|
* </p>
|
|
1369
|
+
* @public
|
|
1370
1370
|
*/
|
|
1371
1371
|
CertificateAuthorityArn: string | undefined;
|
|
1372
1372
|
/**
|
|
1373
|
-
* @public
|
|
1374
1373
|
* <p>The ARN of the issued certificate. The ARN contains the certificate serial number and
|
|
1375
1374
|
* must be in the following form: </p>
|
|
1376
1375
|
* <p>
|
|
1377
1376
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i>
|
|
1378
1377
|
* </code>
|
|
1379
1378
|
* </p>
|
|
1379
|
+
* @public
|
|
1380
1380
|
*/
|
|
1381
1381
|
CertificateArn: string | undefined;
|
|
1382
1382
|
}
|
|
@@ -1385,15 +1385,15 @@ export interface GetCertificateRequest {
|
|
|
1385
1385
|
*/
|
|
1386
1386
|
export interface GetCertificateResponse {
|
|
1387
1387
|
/**
|
|
1388
|
-
* @public
|
|
1389
1388
|
* <p>The base64 PEM-encoded certificate specified by the <code>CertificateArn</code>
|
|
1390
1389
|
* parameter.</p>
|
|
1390
|
+
* @public
|
|
1391
1391
|
*/
|
|
1392
1392
|
Certificate?: string;
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The base64 PEM-encoded certificate chain that chains up to the root CA certificate
|
|
1396
1395
|
* that you used to sign your private CA certificate. </p>
|
|
1396
|
+
* @public
|
|
1397
1397
|
*/
|
|
1398
1398
|
CertificateChain?: string;
|
|
1399
1399
|
}
|
|
@@ -1402,12 +1402,12 @@ export interface GetCertificateResponse {
|
|
|
1402
1402
|
*/
|
|
1403
1403
|
export interface GetCertificateAuthorityCertificateRequest {
|
|
1404
1404
|
/**
|
|
1405
|
-
* @public
|
|
1406
1405
|
* <p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p>
|
|
1407
1406
|
* <p>
|
|
1408
1407
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1409
1408
|
* </code>.
|
|
1410
1409
|
* </p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
CertificateAuthorityArn: string | undefined;
|
|
1413
1413
|
}
|
|
@@ -1416,16 +1416,16 @@ export interface GetCertificateAuthorityCertificateRequest {
|
|
|
1416
1416
|
*/
|
|
1417
1417
|
export interface GetCertificateAuthorityCertificateResponse {
|
|
1418
1418
|
/**
|
|
1419
|
-
* @public
|
|
1420
1419
|
* <p>Base64-encoded certificate authority (CA) certificate.</p>
|
|
1420
|
+
* @public
|
|
1421
1421
|
*/
|
|
1422
1422
|
Certificate?: string;
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>Base64-encoded certificate chain that includes any intermediate certificates and
|
|
1426
1425
|
* chains up to root certificate that you used to sign your private CA certificate. The
|
|
1427
1426
|
* chain does not include your private CA certificate. If this is a root CA, the value will
|
|
1428
1427
|
* be null.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
CertificateChain?: string;
|
|
1431
1431
|
}
|
|
@@ -1434,12 +1434,12 @@ export interface GetCertificateAuthorityCertificateResponse {
|
|
|
1434
1434
|
*/
|
|
1435
1435
|
export interface GetCertificateAuthorityCsrRequest {
|
|
1436
1436
|
/**
|
|
1437
|
-
* @public
|
|
1438
1437
|
* <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
|
|
1439
1438
|
* <p>
|
|
1440
1439
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1441
1440
|
* </code>
|
|
1442
1441
|
* </p>
|
|
1442
|
+
* @public
|
|
1443
1443
|
*/
|
|
1444
1444
|
CertificateAuthorityArn: string | undefined;
|
|
1445
1445
|
}
|
|
@@ -1448,9 +1448,9 @@ export interface GetCertificateAuthorityCsrRequest {
|
|
|
1448
1448
|
*/
|
|
1449
1449
|
export interface GetCertificateAuthorityCsrResponse {
|
|
1450
1450
|
/**
|
|
1451
|
-
* @public
|
|
1452
1451
|
* <p>The base64 PEM-encoded certificate signing request (CSR) for your private CA
|
|
1453
1452
|
* certificate.</p>
|
|
1453
|
+
* @public
|
|
1454
1454
|
*/
|
|
1455
1455
|
Csr?: string;
|
|
1456
1456
|
}
|
|
@@ -1459,11 +1459,11 @@ export interface GetCertificateAuthorityCsrResponse {
|
|
|
1459
1459
|
*/
|
|
1460
1460
|
export interface GetPolicyRequest {
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>The Amazon Resource Number (ARN) of the private CA that will have its policy
|
|
1464
1463
|
* retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.
|
|
1465
1464
|
*
|
|
1466
1465
|
* </p>
|
|
1466
|
+
* @public
|
|
1467
1467
|
*/
|
|
1468
1468
|
ResourceArn: string | undefined;
|
|
1469
1469
|
}
|
|
@@ -1472,15 +1472,15 @@ export interface GetPolicyRequest {
|
|
|
1472
1472
|
*/
|
|
1473
1473
|
export interface GetPolicyResponse {
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>The policy attached to the private CA as a JSON document.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
Policy?: string;
|
|
1479
1479
|
}
|
|
1480
1480
|
/**
|
|
1481
|
-
* @public
|
|
1482
1481
|
* <p>The certificate authority certificate you are importing does not comply with
|
|
1483
1482
|
* conditions specified in the certificate that signed it.</p>
|
|
1483
|
+
* @public
|
|
1484
1484
|
*/
|
|
1485
1485
|
export declare class CertificateMismatchException extends __BaseException {
|
|
1486
1486
|
readonly name: "CertificateMismatchException";
|
|
@@ -1495,34 +1495,34 @@ export declare class CertificateMismatchException extends __BaseException {
|
|
|
1495
1495
|
*/
|
|
1496
1496
|
export interface ImportCertificateAuthorityCertificateRequest {
|
|
1497
1497
|
/**
|
|
1498
|
-
* @public
|
|
1499
1498
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
|
|
1500
1499
|
* <p>
|
|
1501
1500
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1502
1501
|
* </code>
|
|
1503
1502
|
* </p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
CertificateAuthorityArn: string | undefined;
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>The PEM-encoded certificate for a private CA. This may be a self-signed certificate in
|
|
1509
1508
|
* the case of a root CA, or it may be signed by another CA that you control.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
Certificate: Uint8Array | undefined;
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>A PEM-encoded file that contains all of your certificates, other than the certificate
|
|
1515
1514
|
* you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises
|
|
1516
1515
|
* root certificate is the last in the chain, and each certificate in the chain signs the
|
|
1517
1516
|
* one preceding. </p>
|
|
1518
1517
|
* <p>This parameter must be supplied when you import a subordinate CA. When you import a
|
|
1519
1518
|
* root CA, there is no chain.</p>
|
|
1519
|
+
* @public
|
|
1520
1520
|
*/
|
|
1521
1521
|
CertificateChain?: Uint8Array;
|
|
1522
1522
|
}
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>The request action cannot be performed or is prohibited.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
export declare class InvalidRequestException extends __BaseException {
|
|
1528
1528
|
readonly name: "InvalidRequestException";
|
|
@@ -1533,8 +1533,8 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
1533
1533
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
1534
1534
|
}
|
|
1535
1535
|
/**
|
|
1536
|
-
* @public
|
|
1537
1536
|
* <p>One or more fields in the certificate are invalid.</p>
|
|
1537
|
+
* @public
|
|
1538
1538
|
*/
|
|
1539
1539
|
export declare class MalformedCertificateException extends __BaseException {
|
|
1540
1540
|
readonly name: "MalformedCertificateException";
|
|
@@ -1556,84 +1556,84 @@ export declare const PolicyQualifierId: {
|
|
|
1556
1556
|
*/
|
|
1557
1557
|
export type PolicyQualifierId = (typeof PolicyQualifierId)[keyof typeof PolicyQualifierId];
|
|
1558
1558
|
/**
|
|
1559
|
-
* @public
|
|
1560
1559
|
* <p>Defines a <code>PolicyInformation</code> qualifier. Amazon Web Services Private CA supports the <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4">certification
|
|
1561
1560
|
* practice statement (CPS) qualifier</a> defined in RFC 5280. </p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
export interface Qualifier {
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>Contains a pointer to a certification practice statement (CPS) published by the
|
|
1567
1566
|
* CA.</p>
|
|
1567
|
+
* @public
|
|
1568
1568
|
*/
|
|
1569
1569
|
CpsUri: string | undefined;
|
|
1570
1570
|
}
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>Modifies the <code>CertPolicyId</code> of a <code>PolicyInformation</code> object with
|
|
1574
1573
|
* a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS)
|
|
1575
1574
|
* qualifier.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
export interface PolicyQualifierInfo {
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>Identifies the qualifier modifying a <code>CertPolicyId</code>.</p>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
PolicyQualifierId: PolicyQualifierId | undefined;
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier
|
|
1586
1585
|
* in this field.</p>
|
|
1586
|
+
* @public
|
|
1587
1587
|
*/
|
|
1588
1588
|
Qualifier: Qualifier | undefined;
|
|
1589
1589
|
}
|
|
1590
1590
|
/**
|
|
1591
|
-
* @public
|
|
1592
1591
|
* <p>Defines the X.509 <code>CertificatePolicies</code> extension.</p>
|
|
1592
|
+
* @public
|
|
1593
1593
|
*/
|
|
1594
1594
|
export interface PolicyInformation {
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <p>Specifies the object identifier (OID) of the certificate policy under which the
|
|
1598
1597
|
* certificate was issued. For more information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
|
|
1599
1598
|
* (OID)</a>.</p>
|
|
1599
|
+
* @public
|
|
1600
1600
|
*/
|
|
1601
1601
|
CertPolicyId: string | undefined;
|
|
1602
1602
|
/**
|
|
1603
|
-
* @public
|
|
1604
1603
|
* <p>Modifies the given <code>CertPolicyId</code> with a qualifier. Amazon Web Services Private CA supports the
|
|
1605
1604
|
* certification practice statement (CPS) qualifier.</p>
|
|
1605
|
+
* @public
|
|
1606
1606
|
*/
|
|
1607
1607
|
PolicyQualifiers?: PolicyQualifierInfo[];
|
|
1608
1608
|
}
|
|
1609
1609
|
/**
|
|
1610
|
-
* @public
|
|
1611
1610
|
* <p></p>
|
|
1612
1611
|
* <p>Specifies the X.509 extension information for a certificate.</p>
|
|
1613
1612
|
* <p>Extensions present in <code>CustomExtensions</code> follow the
|
|
1614
1613
|
* <code>ApiPassthrough</code>
|
|
1615
1614
|
* <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations">template
|
|
1616
1615
|
* rules</a>. </p>
|
|
1616
|
+
* @public
|
|
1617
1617
|
*/
|
|
1618
1618
|
export interface CustomExtension {
|
|
1619
1619
|
/**
|
|
1620
|
-
* @public
|
|
1621
1620
|
* <p></p>
|
|
1622
1621
|
* <p>Specifies the object identifier (OID) of the X.509 extension. For more information,
|
|
1623
1622
|
* see the <a href="https://oidref.com/2.5.29">Global OID reference database.</a>
|
|
1624
1623
|
* </p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
ObjectIdentifier: string | undefined;
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p></p>
|
|
1630
1629
|
* <p>Specifies the base64-encoded value of the X.509 extension.</p>
|
|
1630
|
+
* @public
|
|
1631
1631
|
*/
|
|
1632
1632
|
Value: string | undefined;
|
|
1633
1633
|
/**
|
|
1634
|
-
* @public
|
|
1635
1634
|
* <p></p>
|
|
1636
1635
|
* <p>Specifies the critical flag of the X.509 extension.</p>
|
|
1636
|
+
* @public
|
|
1637
1637
|
*/
|
|
1638
1638
|
Critical?: boolean;
|
|
1639
1639
|
}
|
|
@@ -1657,31 +1657,30 @@ export declare const ExtendedKeyUsageType: {
|
|
|
1657
1657
|
*/
|
|
1658
1658
|
export type ExtendedKeyUsageType = (typeof ExtendedKeyUsageType)[keyof typeof ExtendedKeyUsageType];
|
|
1659
1659
|
/**
|
|
1660
|
-
* @public
|
|
1661
1660
|
* <p>Specifies additional purposes for which the certified public key may be used other
|
|
1662
1661
|
* than basic purposes indicated in the <code>KeyUsage</code> extension.</p>
|
|
1662
|
+
* @public
|
|
1663
1663
|
*/
|
|
1664
1664
|
export interface ExtendedKeyUsage {
|
|
1665
1665
|
/**
|
|
1666
|
-
* @public
|
|
1667
1666
|
* <p>Specifies a standard <code>ExtendedKeyUsage</code> as defined as in <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12">RFC
|
|
1668
1667
|
* 5280</a>.</p>
|
|
1668
|
+
* @public
|
|
1669
1669
|
*/
|
|
1670
1670
|
ExtendedKeyUsageType?: ExtendedKeyUsageType;
|
|
1671
1671
|
/**
|
|
1672
|
-
* @public
|
|
1673
1672
|
* <p>Specifies a custom <code>ExtendedKeyUsage</code> with an object identifier
|
|
1674
1673
|
* (OID).</p>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
ExtendedKeyUsageObjectIdentifier?: string;
|
|
1677
1677
|
}
|
|
1678
1678
|
/**
|
|
1679
|
-
* @public
|
|
1680
1679
|
* <p>Contains X.509 extension information for a certificate.</p>
|
|
1680
|
+
* @public
|
|
1681
1681
|
*/
|
|
1682
1682
|
export interface Extensions {
|
|
1683
1683
|
/**
|
|
1684
|
-
* @public
|
|
1685
1684
|
* <p>Contains a sequence of one or more policy information terms, each of which consists of
|
|
1686
1685
|
* an object identifier (OID) and optional qualifiers. For more information, see NIST's
|
|
1687
1686
|
* definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object
|
|
@@ -1690,60 +1689,61 @@ export interface Extensions {
|
|
|
1690
1689
|
* certificate was issued and the purposes for which it may be used. In a CA certificate,
|
|
1691
1690
|
* these terms limit the set of policies for certification paths that include this
|
|
1692
1691
|
* certificate.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
CertificatePolicies?: PolicyInformation[];
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>Specifies additional purposes for which the certified public key may be used other
|
|
1698
1697
|
* than basic purposes indicated in the <code>KeyUsage</code> extension.</p>
|
|
1698
|
+
* @public
|
|
1699
1699
|
*/
|
|
1700
1700
|
ExtendedKeyUsage?: ExtendedKeyUsage[];
|
|
1701
1701
|
/**
|
|
1702
|
-
* @public
|
|
1703
1702
|
* <p>Defines one or more purposes for which the key contained in the certificate can be
|
|
1704
1703
|
* used. Default value for each option is false.</p>
|
|
1704
|
+
* @public
|
|
1705
1705
|
*/
|
|
1706
1706
|
KeyUsage?: KeyUsage;
|
|
1707
1707
|
/**
|
|
1708
|
-
* @public
|
|
1709
1708
|
* <p>The subject alternative name extension allows identities to be bound to the subject of
|
|
1710
1709
|
* the certificate. These identities may be included in addition to or in place of the
|
|
1711
1710
|
* identity in the subject field of the certificate.</p>
|
|
1711
|
+
* @public
|
|
1712
1712
|
*/
|
|
1713
1713
|
SubjectAlternativeNames?: GeneralName[];
|
|
1714
1714
|
/**
|
|
1715
|
-
* @public
|
|
1716
1715
|
* <p></p>
|
|
1717
1716
|
* <p>Contains a sequence of one or more X.509 extensions, each of which consists of an
|
|
1718
1717
|
* object identifier (OID), a base64-encoded value, and the critical flag. For more
|
|
1719
1718
|
* information, see the <a href="https://oidref.com/2.5.29">Global OID reference
|
|
1720
1719
|
* database.</a>
|
|
1721
1720
|
* </p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
CustomExtensions?: CustomExtension[];
|
|
1724
1724
|
}
|
|
1725
1725
|
/**
|
|
1726
|
-
* @public
|
|
1727
1726
|
* <p>Contains X.509 certificate information to be placed in an issued certificate. An
|
|
1728
1727
|
* <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must
|
|
1729
1728
|
* be selected, or else this parameter is ignored. </p>
|
|
1730
1729
|
* <p>If conflicting or duplicate certificate information is supplied from other sources,
|
|
1731
1730
|
* Amazon Web Services Private CA applies <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations">order of
|
|
1732
1731
|
* operation rules</a> to determine what information is used.</p>
|
|
1732
|
+
* @public
|
|
1733
1733
|
*/
|
|
1734
1734
|
export interface ApiPassthrough {
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>Specifies X.509 extension information for a certificate.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
Extensions?: Extensions;
|
|
1740
1740
|
/**
|
|
1741
|
-
* @public
|
|
1742
1741
|
* <p>Contains information about the certificate subject. The <code>Subject</code> field in
|
|
1743
1742
|
* the certificate identifies the entity that owns or controls the public key in the
|
|
1744
1743
|
* certificate. The entity can be a user, computer, device, or service. The <code>Subject
|
|
1745
1744
|
* </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
|
|
1746
1745
|
* distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
Subject?: ASN1Subject;
|
|
1749
1749
|
}
|
|
@@ -1763,7 +1763,6 @@ export declare const ValidityPeriodType: {
|
|
|
1763
1763
|
*/
|
|
1764
1764
|
export type ValidityPeriodType = (typeof ValidityPeriodType)[keyof typeof ValidityPeriodType];
|
|
1765
1765
|
/**
|
|
1766
|
-
* @public
|
|
1767
1766
|
* <p>Validity specifies the period of time during which a certificate is valid. Validity
|
|
1768
1767
|
* can be expressed as an explicit date and time when the validity of a certificate starts
|
|
1769
1768
|
* or expires, or as a span of time after issuance, stated in days, months, or years. For
|
|
@@ -1774,15 +1773,15 @@ export type ValidityPeriodType = (typeof ValidityPeriodType)[keyof typeof Validi
|
|
|
1774
1773
|
* certificate's validity period. The optional parameter
|
|
1775
1774
|
* <code>IssueCertificate</code>:<code>ValidityNotBefore</code> specifies a customized
|
|
1776
1775
|
* starting time for the validity period.</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
export interface Validity {
|
|
1779
1779
|
/**
|
|
1780
|
-
* @public
|
|
1781
1780
|
* <p>A long integer interpreted according to the value of <code>Type</code>, below.</p>
|
|
1781
|
+
* @public
|
|
1782
1782
|
*/
|
|
1783
1783
|
Value: number | undefined;
|
|
1784
1784
|
/**
|
|
1785
|
-
* @public
|
|
1786
1785
|
* <p>Determines how <i>Amazon Web Services Private CA</i> interprets the <code>Value</code>
|
|
1787
1786
|
* parameter, an integer. Supported validity types include those listed below. Type
|
|
1788
1787
|
* definitions with values include a sample input value and the resulting output. </p>
|
|
@@ -1827,6 +1826,7 @@ export interface Validity {
|
|
|
1827
1826
|
* <p>The minimum validity duration for a certificate using relative time
|
|
1828
1827
|
* (<code>DAYS</code>) is one day. The minimum validity for a certificate using absolute
|
|
1829
1828
|
* time (<code>ABSOLUTE</code> or <code>END_DATE</code>) is one second.</p>
|
|
1829
|
+
* @public
|
|
1830
1830
|
*/
|
|
1831
1831
|
Type: ValidityPeriodType | undefined;
|
|
1832
1832
|
}
|
|
@@ -1835,7 +1835,6 @@ export interface Validity {
|
|
|
1835
1835
|
*/
|
|
1836
1836
|
export interface IssueCertificateRequest {
|
|
1837
1837
|
/**
|
|
1838
|
-
* @public
|
|
1839
1838
|
* <p>Specifies X.509 certificate information to be included in the issued certificate. An
|
|
1840
1839
|
* <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must
|
|
1841
1840
|
* be selected, or else this parameter is ignored. For more information about using these
|
|
@@ -1843,19 +1842,19 @@ export interface IssueCertificateRequest {
|
|
|
1843
1842
|
* <p>If conflicting or duplicate certificate information is supplied during certificate
|
|
1844
1843
|
* issuance, Amazon Web Services Private CA applies <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations">order of
|
|
1845
1844
|
* operation rules</a> to determine what information is used.</p>
|
|
1845
|
+
* @public
|
|
1846
1846
|
*/
|
|
1847
1847
|
ApiPassthrough?: ApiPassthrough;
|
|
1848
1848
|
/**
|
|
1849
|
-
* @public
|
|
1850
1849
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form:</p>
|
|
1851
1850
|
* <p>
|
|
1852
1851
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1853
1852
|
* </code>
|
|
1854
1853
|
* </p>
|
|
1854
|
+
* @public
|
|
1855
1855
|
*/
|
|
1856
1856
|
CertificateAuthorityArn: string | undefined;
|
|
1857
1857
|
/**
|
|
1858
|
-
* @public
|
|
1859
1858
|
* <p>The certificate signing request (CSR) for the certificate you want to issue. As an
|
|
1860
1859
|
* example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA
|
|
1861
1860
|
* private key. </p>
|
|
@@ -1874,10 +1873,10 @@ export interface IssueCertificateRequest {
|
|
|
1874
1873
|
* <p>Note: A CSR must provide either a <i>subject name</i> or a
|
|
1875
1874
|
* <i>subject alternative name</i> or the request will be rejected.
|
|
1876
1875
|
* </p>
|
|
1876
|
+
* @public
|
|
1877
1877
|
*/
|
|
1878
1878
|
Csr: Uint8Array | undefined;
|
|
1879
1879
|
/**
|
|
1880
|
-
* @public
|
|
1881
1880
|
* <p>The name of the algorithm that will be used to sign the certificate to be issued. </p>
|
|
1882
1881
|
* <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
|
|
1883
1882
|
* used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>
|
|
@@ -1885,10 +1884,10 @@ export interface IssueCertificateRequest {
|
|
|
1885
1884
|
* <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm
|
|
1886
1885
|
* family of the CA's secret key.</p>
|
|
1887
1886
|
* </note>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
SigningAlgorithm: SigningAlgorithm | undefined;
|
|
1890
1890
|
/**
|
|
1891
|
-
* @public
|
|
1892
1891
|
* <p>Specifies a custom configuration template to use when issuing a certificate. If this
|
|
1893
1892
|
* parameter is not provided, Amazon Web Services Private CA defaults to the
|
|
1894
1893
|
* <code>EndEntityCertificate/V1</code> template. For CA certificates, you should
|
|
@@ -1900,10 +1899,10 @@ export interface IssueCertificateRequest {
|
|
|
1900
1899
|
* limit set by its parents in the CA hierarchy.</p>
|
|
1901
1900
|
* <p>For a list of <code>TemplateArn</code> values supported by Amazon Web Services Private CA, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html">Understanding Certificate
|
|
1902
1901
|
* Templates</a>.</p>
|
|
1902
|
+
* @public
|
|
1903
1903
|
*/
|
|
1904
1904
|
TemplateArn?: string;
|
|
1905
1905
|
/**
|
|
1906
|
-
* @public
|
|
1907
1906
|
* <p>Information describing the end of the validity period of the certificate. This
|
|
1908
1907
|
* parameter sets the “Not After” date for the certificate.</p>
|
|
1909
1908
|
* <p>Certificate validity is the period of time during which a certificate is valid.
|
|
@@ -1917,10 +1916,10 @@ export interface IssueCertificateRequest {
|
|
|
1917
1916
|
* value.</p>
|
|
1918
1917
|
* <p>The end of the validity period configured on a certificate must not exceed the limit
|
|
1919
1918
|
* set on its parents in the CA hierarchy.</p>
|
|
1919
|
+
* @public
|
|
1920
1920
|
*/
|
|
1921
1921
|
Validity: Validity | undefined;
|
|
1922
1922
|
/**
|
|
1923
|
-
* @public
|
|
1924
1923
|
* <p>Information describing the start of the validity period of the certificate. This
|
|
1925
1924
|
* parameter sets the “Not Before" date for the certificate.</p>
|
|
1926
1925
|
* <p>By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the
|
|
@@ -1934,15 +1933,16 @@ export interface IssueCertificateRequest {
|
|
|
1934
1933
|
* see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_Validity.html">Validity</a> in
|
|
1935
1934
|
* this API reference and <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5">Validity</a>
|
|
1936
1935
|
* in RFC 5280.</p>
|
|
1936
|
+
* @public
|
|
1937
1937
|
*/
|
|
1938
1938
|
ValidityNotBefore?: Validity;
|
|
1939
1939
|
/**
|
|
1940
|
-
* @public
|
|
1941
1940
|
* <p>Alphanumeric string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens for <b>IssueCertificate</b> time out after five minutes. Therefore, if
|
|
1942
1941
|
* you call <b>IssueCertificate</b> multiple times with the same
|
|
1943
1942
|
* idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting
|
|
1944
1943
|
* only one certificate and will issue only one. If you change the idempotency token for
|
|
1945
1944
|
* each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>
|
|
1945
|
+
* @public
|
|
1946
1946
|
*/
|
|
1947
1947
|
IdempotencyToken?: string;
|
|
1948
1948
|
}
|
|
@@ -1951,19 +1951,19 @@ export interface IssueCertificateRequest {
|
|
|
1951
1951
|
*/
|
|
1952
1952
|
export interface IssueCertificateResponse {
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial
|
|
1956
1955
|
* number. This is of the form:</p>
|
|
1957
1956
|
* <p>
|
|
1958
1957
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i>
|
|
1959
1958
|
* </code>
|
|
1960
1959
|
* </p>
|
|
1960
|
+
* @public
|
|
1961
1961
|
*/
|
|
1962
1962
|
CertificateArn?: string;
|
|
1963
1963
|
}
|
|
1964
1964
|
/**
|
|
1965
|
-
* @public
|
|
1966
1965
|
* <p>The certificate signing request is invalid.</p>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
export declare class MalformedCSRException extends __BaseException {
|
|
1969
1969
|
readonly name: "MalformedCSRException";
|
|
@@ -1974,9 +1974,9 @@ export declare class MalformedCSRException extends __BaseException {
|
|
|
1974
1974
|
constructor(opts: __ExceptionOptionType<MalformedCSRException, __BaseException>);
|
|
1975
1975
|
}
|
|
1976
1976
|
/**
|
|
1977
|
-
* @public
|
|
1978
1977
|
* <p>The token specified in the <code>NextToken</code> argument is not valid. Use the token
|
|
1979
1978
|
* returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.</p>
|
|
1979
|
+
* @public
|
|
1980
1980
|
*/
|
|
1981
1981
|
export declare class InvalidNextTokenException extends __BaseException {
|
|
1982
1982
|
readonly name: "InvalidNextTokenException";
|
|
@@ -2003,26 +2003,26 @@ export type ResourceOwner = (typeof ResourceOwner)[keyof typeof ResourceOwner];
|
|
|
2003
2003
|
*/
|
|
2004
2004
|
export interface ListCertificateAuthoritiesRequest {
|
|
2005
2005
|
/**
|
|
2006
|
-
* @public
|
|
2007
2006
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2008
2007
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2009
2008
|
* parameter from the response you just received.</p>
|
|
2009
|
+
* @public
|
|
2010
2010
|
*/
|
|
2011
2011
|
NextToken?: string;
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
2015
2014
|
* return in the response on each page. If additional items exist beyond the number you
|
|
2016
2015
|
* specify, the <code>NextToken</code> element is sent in the response. Use this
|
|
2017
2016
|
* <code>NextToken</code> value in a subsequent request to retrieve additional
|
|
2018
2017
|
* items.</p>
|
|
2019
2018
|
* <p>Although the maximum value is 1000, the action only returns a maximum of 100 items.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
MaxResults?: number;
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p>Use this parameter to filter the returned set of certificate authorities based on
|
|
2025
2024
|
* their owner. The default is SELF.</p>
|
|
2025
|
+
* @public
|
|
2026
2026
|
*/
|
|
2027
2027
|
ResourceOwner?: ResourceOwner;
|
|
2028
2028
|
}
|
|
@@ -2031,14 +2031,14 @@ export interface ListCertificateAuthoritiesRequest {
|
|
|
2031
2031
|
*/
|
|
2032
2032
|
export interface ListCertificateAuthoritiesResponse {
|
|
2033
2033
|
/**
|
|
2034
|
-
* @public
|
|
2035
2034
|
* <p>Summary information about each certificate authority you have created.</p>
|
|
2035
|
+
* @public
|
|
2036
2036
|
*/
|
|
2037
2037
|
CertificateAuthorities?: CertificateAuthority[];
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>When the list is truncated, this value is present and should be used for the
|
|
2041
2040
|
* <code>NextToken</code> parameter in a subsequent pagination request.</p>
|
|
2041
|
+
* @public
|
|
2042
2042
|
*/
|
|
2043
2043
|
NextToken?: string;
|
|
2044
2044
|
}
|
|
@@ -2047,31 +2047,30 @@ export interface ListCertificateAuthoritiesResponse {
|
|
|
2047
2047
|
*/
|
|
2048
2048
|
export interface ListPermissionsRequest {
|
|
2049
2049
|
/**
|
|
2050
|
-
* @public
|
|
2051
2050
|
* <p>The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by
|
|
2052
2051
|
* calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must be of the form:
|
|
2053
2052
|
* <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code>
|
|
2054
2053
|
* You can get a private CA's ARN by running the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action.</p>
|
|
2054
|
+
* @public
|
|
2055
2055
|
*/
|
|
2056
2056
|
CertificateAuthorityArn: string | undefined;
|
|
2057
2057
|
/**
|
|
2058
|
-
* @public
|
|
2059
2058
|
* <p>When paginating results, use this parameter in a subsequent request after you receive
|
|
2060
2059
|
* a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
NextToken?: string;
|
|
2063
2063
|
/**
|
|
2064
|
-
* @public
|
|
2065
2064
|
* <p>When paginating results, use this parameter to specify the maximum number of items to
|
|
2066
2065
|
* return in the response. If additional items exist beyond the number you specify, the
|
|
2067
2066
|
* <b>NextToken</b> element is sent in the response. Use this
|
|
2068
2067
|
* <b>NextToken</b> value in a subsequent request to retrieve
|
|
2069
2068
|
* additional items.</p>
|
|
2069
|
+
* @public
|
|
2070
2070
|
*/
|
|
2071
2071
|
MaxResults?: number;
|
|
2072
2072
|
}
|
|
2073
2073
|
/**
|
|
2074
|
-
* @public
|
|
2075
2074
|
* <p>Permissions designate which private CA actions can be performed by an Amazon Web Services service or
|
|
2076
2075
|
* entity. In order for ACM to automatically renew private certificates, you must give
|
|
2077
2076
|
* the ACM service principal all available permissions (<code>IssueCertificate</code>,
|
|
@@ -2079,38 +2078,39 @@ export interface ListPermissionsRequest {
|
|
|
2079
2078
|
* assigned with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action,
|
|
2080
2079
|
* removed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action, and
|
|
2081
2080
|
* listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action.</p>
|
|
2081
|
+
* @public
|
|
2082
2082
|
*/
|
|
2083
2083
|
export interface Permission {
|
|
2084
2084
|
/**
|
|
2085
|
-
* @public
|
|
2086
2085
|
* <p>The Amazon Resource Number (ARN) of the private CA from which the permission was
|
|
2087
2086
|
* issued.</p>
|
|
2087
|
+
* @public
|
|
2088
2088
|
*/
|
|
2089
2089
|
CertificateAuthorityArn?: string;
|
|
2090
2090
|
/**
|
|
2091
|
-
* @public
|
|
2092
2091
|
* <p>The time at which the permission was created.</p>
|
|
2092
|
+
* @public
|
|
2093
2093
|
*/
|
|
2094
2094
|
CreatedAt?: Date;
|
|
2095
2095
|
/**
|
|
2096
|
-
* @public
|
|
2097
2096
|
* <p>The Amazon Web Services service or entity that holds the permission. At this time, the only valid
|
|
2098
2097
|
* principal is <code>acm.amazonaws.com</code>.</p>
|
|
2098
|
+
* @public
|
|
2099
2099
|
*/
|
|
2100
2100
|
Principal?: string;
|
|
2101
2101
|
/**
|
|
2102
|
-
* @public
|
|
2103
2102
|
* <p>The ID of the account that assigned the permission.</p>
|
|
2103
|
+
* @public
|
|
2104
2104
|
*/
|
|
2105
2105
|
SourceAccount?: string;
|
|
2106
2106
|
/**
|
|
2107
|
-
* @public
|
|
2108
2107
|
* <p>The private CA actions that can be performed by the designated Amazon Web Services service.</p>
|
|
2108
|
+
* @public
|
|
2109
2109
|
*/
|
|
2110
2110
|
Actions?: ActionType[];
|
|
2111
2111
|
/**
|
|
2112
|
-
* @public
|
|
2113
2112
|
* <p>The name of the policy that is associated with the permission.</p>
|
|
2113
|
+
* @public
|
|
2114
2114
|
*/
|
|
2115
2115
|
Policy?: string;
|
|
2116
2116
|
}
|
|
@@ -2119,15 +2119,15 @@ export interface Permission {
|
|
|
2119
2119
|
*/
|
|
2120
2120
|
export interface ListPermissionsResponse {
|
|
2121
2121
|
/**
|
|
2122
|
-
* @public
|
|
2123
2122
|
* <p>Summary information about each permission assigned by the specified private CA,
|
|
2124
2123
|
* including the action enabled, the policy provided, and the time of creation.</p>
|
|
2124
|
+
* @public
|
|
2125
2125
|
*/
|
|
2126
2126
|
Permissions?: Permission[];
|
|
2127
2127
|
/**
|
|
2128
|
-
* @public
|
|
2129
2128
|
* <p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request.
|
|
2130
2129
|
* </p>
|
|
2130
|
+
* @public
|
|
2131
2131
|
*/
|
|
2132
2132
|
NextToken?: string;
|
|
2133
2133
|
}
|
|
@@ -2136,27 +2136,27 @@ export interface ListPermissionsResponse {
|
|
|
2136
2136
|
*/
|
|
2137
2137
|
export interface ListTagsRequest {
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
|
|
2141
2140
|
* <p>
|
|
2142
2141
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
2143
2142
|
* </code>
|
|
2144
2143
|
* </p>
|
|
2144
|
+
* @public
|
|
2145
2145
|
*/
|
|
2146
2146
|
CertificateAuthorityArn: string | undefined;
|
|
2147
2147
|
/**
|
|
2148
|
-
* @public
|
|
2149
2148
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2150
2149
|
* response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>
|
|
2150
|
+
* @public
|
|
2151
2151
|
*/
|
|
2152
2152
|
NextToken?: string;
|
|
2153
2153
|
/**
|
|
2154
|
-
* @public
|
|
2155
2154
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
2156
2155
|
* return in the response. If additional items exist beyond the number you specify, the
|
|
2157
2156
|
* <b>NextToken</b> element is sent in the response. Use this
|
|
2158
2157
|
* <b>NextToken</b> value in a subsequent request to retrieve
|
|
2159
2158
|
* additional items.</p>
|
|
2159
|
+
* @public
|
|
2160
2160
|
*/
|
|
2161
2161
|
MaxResults?: number;
|
|
2162
2162
|
}
|
|
@@ -2165,14 +2165,14 @@ export interface ListTagsRequest {
|
|
|
2165
2165
|
*/
|
|
2166
2166
|
export interface ListTagsResponse {
|
|
2167
2167
|
/**
|
|
2168
|
-
* @public
|
|
2169
2168
|
* <p>The tags associated with your private CA.</p>
|
|
2169
|
+
* @public
|
|
2170
2170
|
*/
|
|
2171
2171
|
Tags?: Tag[];
|
|
2172
2172
|
/**
|
|
2173
|
-
* @public
|
|
2174
2173
|
* <p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request.
|
|
2175
2174
|
* </p>
|
|
2175
|
+
* @public
|
|
2176
2176
|
*/
|
|
2177
2177
|
NextToken?: string;
|
|
2178
2178
|
}
|
|
@@ -2181,19 +2181,19 @@ export interface ListTagsResponse {
|
|
|
2181
2181
|
*/
|
|
2182
2182
|
export interface PutPolicyRequest {
|
|
2183
2183
|
/**
|
|
2184
|
-
* @public
|
|
2185
2184
|
* <p>The Amazon Resource Number (ARN) of the private CA to associate with the policy. The
|
|
2186
2185
|
* ARN of the CA can be found by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action.</p>
|
|
2187
2186
|
* <p></p>
|
|
2187
|
+
* @public
|
|
2188
2188
|
*/
|
|
2189
2189
|
ResourceArn: string | undefined;
|
|
2190
2190
|
/**
|
|
2191
|
-
* @public
|
|
2192
2191
|
* <p>The path and file name of a JSON-formatted IAM policy to attach to the specified
|
|
2193
2192
|
* private CA resource. If this policy does not contain all required statements or if it
|
|
2194
2193
|
* includes any statement that is not allowed, the <code>PutPolicy</code> action returns an
|
|
2195
2194
|
* <code>InvalidPolicyException</code>. For information about IAM policy and
|
|
2196
2195
|
* 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>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
Policy: string | undefined;
|
|
2199
2199
|
}
|
|
@@ -2202,18 +2202,18 @@ export interface PutPolicyRequest {
|
|
|
2202
2202
|
*/
|
|
2203
2203
|
export interface RestoreCertificateAuthorityRequest {
|
|
2204
2204
|
/**
|
|
2205
|
-
* @public
|
|
2206
2205
|
* <p>The Amazon Resource Name (ARN) that was returned when you called the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. This must be of the form: </p>
|
|
2207
2206
|
* <p>
|
|
2208
2207
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
2209
2208
|
* </code>
|
|
2210
2209
|
* </p>
|
|
2210
|
+
* @public
|
|
2211
2211
|
*/
|
|
2212
2212
|
CertificateAuthorityArn: string | undefined;
|
|
2213
2213
|
}
|
|
2214
2214
|
/**
|
|
2215
|
-
* @public
|
|
2216
2215
|
* <p>Your request has already been completed.</p>
|
|
2216
|
+
* @public
|
|
2217
2217
|
*/
|
|
2218
2218
|
export declare class RequestAlreadyProcessedException extends __BaseException {
|
|
2219
2219
|
readonly name: "RequestAlreadyProcessedException";
|
|
@@ -2246,17 +2246,16 @@ export type RevocationReason = (typeof RevocationReason)[keyof typeof Revocation
|
|
|
2246
2246
|
*/
|
|
2247
2247
|
export interface RevokeCertificateRequest {
|
|
2248
2248
|
/**
|
|
2249
|
-
* @public
|
|
2250
2249
|
* <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be
|
|
2251
2250
|
* revoked. This must be of the form:</p>
|
|
2252
2251
|
* <p>
|
|
2253
2252
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
2254
2253
|
* </code>
|
|
2255
2254
|
* </p>
|
|
2255
|
+
* @public
|
|
2256
2256
|
*/
|
|
2257
2257
|
CertificateAuthorityArn: string | undefined;
|
|
2258
2258
|
/**
|
|
2259
|
-
* @public
|
|
2260
2259
|
* <p>Serial number of the certificate to be revoked. This must be in hexadecimal format.
|
|
2261
2260
|
* You can retrieve the serial number by calling <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> with the Amazon
|
|
2262
2261
|
* Resource Name (ARN) of the certificate you want and the ARN of your private CA. The
|
|
@@ -2268,11 +2267,12 @@ export interface RevokeCertificateRequest {
|
|
|
2268
2267
|
* </p>
|
|
2269
2268
|
* <p>You can also copy the serial number from the console or use the <a href="https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html">DescribeCertificate</a> action in the <i>Certificate Manager API
|
|
2270
2269
|
* Reference</i>. </p>
|
|
2270
|
+
* @public
|
|
2271
2271
|
*/
|
|
2272
2272
|
CertificateSerial: string | undefined;
|
|
2273
2273
|
/**
|
|
2274
|
-
* @public
|
|
2275
2274
|
* <p>Specifies why you revoked the certificate.</p>
|
|
2275
|
+
* @public
|
|
2276
2276
|
*/
|
|
2277
2277
|
RevocationReason: RevocationReason | undefined;
|
|
2278
2278
|
}
|
|
@@ -2281,24 +2281,24 @@ export interface RevokeCertificateRequest {
|
|
|
2281
2281
|
*/
|
|
2282
2282
|
export interface TagCertificateAuthorityRequest {
|
|
2283
2283
|
/**
|
|
2284
|
-
* @public
|
|
2285
2284
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
|
|
2286
2285
|
* <p>
|
|
2287
2286
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
2288
2287
|
* </code>
|
|
2289
2288
|
* </p>
|
|
2289
|
+
* @public
|
|
2290
2290
|
*/
|
|
2291
2291
|
CertificateAuthorityArn: string | undefined;
|
|
2292
2292
|
/**
|
|
2293
|
-
* @public
|
|
2294
2293
|
* <p>List of tags to be associated with the CA.</p>
|
|
2294
|
+
* @public
|
|
2295
2295
|
*/
|
|
2296
2296
|
Tags: Tag[] | undefined;
|
|
2297
2297
|
}
|
|
2298
2298
|
/**
|
|
2299
|
-
* @public
|
|
2300
2299
|
* <p>You can associate up to 50 tags with a private CA. Exception information is contained
|
|
2301
2300
|
* in the exception message field.</p>
|
|
2301
|
+
* @public
|
|
2302
2302
|
*/
|
|
2303
2303
|
export declare class TooManyTagsException extends __BaseException {
|
|
2304
2304
|
readonly name: "TooManyTagsException";
|
|
@@ -2313,17 +2313,17 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
2313
2313
|
*/
|
|
2314
2314
|
export interface UntagCertificateAuthorityRequest {
|
|
2315
2315
|
/**
|
|
2316
|
-
* @public
|
|
2317
2316
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form: </p>
|
|
2318
2317
|
* <p>
|
|
2319
2318
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
2320
2319
|
* </code>
|
|
2321
2320
|
* </p>
|
|
2321
|
+
* @public
|
|
2322
2322
|
*/
|
|
2323
2323
|
CertificateAuthorityArn: string | undefined;
|
|
2324
2324
|
/**
|
|
2325
|
-
* @public
|
|
2326
2325
|
* <p>List of tags to be removed from the CA.</p>
|
|
2326
|
+
* @public
|
|
2327
2327
|
*/
|
|
2328
2328
|
Tags: Tag[] | undefined;
|
|
2329
2329
|
}
|
|
@@ -2332,17 +2332,16 @@ export interface UntagCertificateAuthorityRequest {
|
|
|
2332
2332
|
*/
|
|
2333
2333
|
export interface UpdateCertificateAuthorityRequest {
|
|
2334
2334
|
/**
|
|
2335
|
-
* @public
|
|
2336
2335
|
* <p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be
|
|
2337
2336
|
* revoked. This must be of the form:</p>
|
|
2338
2337
|
* <p>
|
|
2339
2338
|
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
|
|
2340
2339
|
* </code>
|
|
2341
2340
|
* </p>
|
|
2341
|
+
* @public
|
|
2342
2342
|
*/
|
|
2343
2343
|
CertificateAuthorityArn: string | undefined;
|
|
2344
2344
|
/**
|
|
2345
|
-
* @public
|
|
2346
2345
|
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support, to
|
|
2347
2346
|
* enable a certificate revocation list (CRL), to enable both, or to enable neither. If
|
|
2348
2347
|
* this parameter is not supplied, existing capibilites remain unchanged. For more
|
|
@@ -2371,11 +2370,12 @@ export interface UpdateCertificateAuthorityRequest {
|
|
|
2371
2370
|
* </li>
|
|
2372
2371
|
* </ul>
|
|
2373
2372
|
* </note>
|
|
2373
|
+
* @public
|
|
2374
2374
|
*/
|
|
2375
2375
|
RevocationConfiguration?: RevocationConfiguration;
|
|
2376
2376
|
/**
|
|
2377
|
-
* @public
|
|
2378
2377
|
* <p>Status of your private CA.</p>
|
|
2378
|
+
* @public
|
|
2379
2379
|
*/
|
|
2380
2380
|
Status?: CertificateAuthorityStatus;
|
|
2381
2381
|
}
|