@aws-sdk/client-acm 3.830.0 → 3.835.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -4
- package/dist-cjs/index.js +44 -0
- package/dist-es/ACM.js +2 -0
- package/dist-es/commands/RevokeCertificateCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +20 -0
- package/dist-types/ACM.d.ts +8 -3
- package/dist-types/ACMClient.d.ts +4 -5
- package/dist-types/commands/AddTagsToCertificateCommand.d.ts +3 -18
- package/dist-types/commands/DeleteCertificateCommand.d.ts +4 -14
- package/dist-types/commands/DescribeCertificateCommand.d.ts +3 -5
- package/dist-types/commands/ExportCertificateCommand.d.ts +3 -11
- package/dist-types/commands/GetCertificateCommand.d.ts +3 -10
- package/dist-types/commands/ImportCertificateCommand.d.ts +3 -64
- package/dist-types/commands/ListCertificatesCommand.d.ts +4 -5
- package/dist-types/commands/ListTagsForCertificateCommand.d.ts +2 -5
- package/dist-types/commands/PutAccountConfigurationCommand.d.ts +2 -8
- package/dist-types/commands/RemoveTagsFromCertificateCommand.d.ts +3 -10
- package/dist-types/commands/RenewCertificateCommand.d.ts +3 -9
- package/dist-types/commands/RequestCertificateCommand.d.ts +4 -20
- package/dist-types/commands/ResendValidationEmailCommand.d.ts +3 -13
- package/dist-types/commands/RevokeCertificateCommand.d.ts +91 -0
- package/dist-types/commands/UpdateCertificateOptionsCommand.d.ts +3 -6
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/index.d.ts +1 -3
- package/dist-types/models/models_0.d.ts +148 -492
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/ACM.d.ts +17 -0
- package/dist-types/ts3.4/ACMClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/RevokeCertificateCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +4 -1
- package/dist-types/ts3.4/models/models_0.d.ts +16 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +12 -0
- package/package.json +11 -11
|
@@ -34,12 +34,7 @@ export interface Tag {
|
|
|
34
34
|
*/
|
|
35
35
|
export interface AddTagsToCertificateRequest {
|
|
36
36
|
/**
|
|
37
|
-
* <p>String that contains the ARN of the ACM certificate to which the tag is to be applied.
|
|
38
|
-
* This must be of the form:</p>
|
|
39
|
-
* <p>
|
|
40
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
41
|
-
* </p>
|
|
42
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
37
|
+
* <p>String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
43
38
|
* @public
|
|
44
39
|
*/
|
|
45
40
|
CertificateArn: string | undefined;
|
|
@@ -74,8 +69,7 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
74
69
|
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
75
70
|
}
|
|
76
71
|
/**
|
|
77
|
-
* <p>One or both of the values that make up the key-value pair is not valid. For example, you
|
|
78
|
-
* cannot specify a tag value that begins with <code>aws:</code>.</p>
|
|
72
|
+
* <p>One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with <code>aws:</code>.</p>
|
|
79
73
|
* @public
|
|
80
74
|
*/
|
|
81
75
|
export declare class InvalidTagException extends __BaseException {
|
|
@@ -87,8 +81,7 @@ export declare class InvalidTagException extends __BaseException {
|
|
|
87
81
|
constructor(opts: __ExceptionOptionType<InvalidTagException, __BaseException>);
|
|
88
82
|
}
|
|
89
83
|
/**
|
|
90
|
-
* <p>The specified certificate cannot be found in the caller's account or the caller's account
|
|
91
|
-
* cannot be found.</p>
|
|
84
|
+
* <p>The specified certificate cannot be found in the caller's account or the caller's account cannot be found.</p>
|
|
92
85
|
* @public
|
|
93
86
|
*/
|
|
94
87
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -136,8 +129,7 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
136
129
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
137
130
|
}
|
|
138
131
|
/**
|
|
139
|
-
* <p>Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM.
|
|
140
|
-
* This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and the validation method is <code>HTTP</code>.</p>
|
|
132
|
+
* <p>Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and the validation method is <code>HTTP</code>.</p>
|
|
141
133
|
* @public
|
|
142
134
|
*/
|
|
143
135
|
export interface HttpRedirect {
|
|
@@ -164,8 +156,7 @@ export declare const RecordType: {
|
|
|
164
156
|
*/
|
|
165
157
|
export type RecordType = (typeof RecordType)[keyof typeof RecordType];
|
|
166
158
|
/**
|
|
167
|
-
* <p>Contains a DNS record value that you can use to validate ownership or control of a domain.
|
|
168
|
-
* This is used by the <a>DescribeCertificate</a> action. </p>
|
|
159
|
+
* <p>Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the <a>DescribeCertificate</a> action. </p>
|
|
169
160
|
* @public
|
|
170
161
|
*/
|
|
171
162
|
export interface ResourceRecord {
|
|
@@ -180,8 +171,7 @@ export interface ResourceRecord {
|
|
|
180
171
|
*/
|
|
181
172
|
Type: RecordType | undefined;
|
|
182
173
|
/**
|
|
183
|
-
* <p>The value of the CNAME record to add to your DNS database. This is supplied by
|
|
184
|
-
* ACM.</p>
|
|
174
|
+
* <p>The value of the CNAME record to add to your DNS database. This is supplied by ACM.</p>
|
|
185
175
|
* @public
|
|
186
176
|
*/
|
|
187
177
|
Value: string | undefined;
|
|
@@ -218,8 +208,7 @@ export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
|
|
|
218
208
|
*/
|
|
219
209
|
export interface DomainValidation {
|
|
220
210
|
/**
|
|
221
|
-
* <p>A fully qualified domain name (FQDN) in the certificate. For example,
|
|
222
|
-
* <code>www.example.com</code> or <code>example.com</code>. </p>
|
|
211
|
+
* <p>A fully qualified domain name (FQDN) in the certificate. For example, <code>www.example.com</code> or <code>example.com</code>. </p>
|
|
223
212
|
* @public
|
|
224
213
|
*/
|
|
225
214
|
DomainName: string | undefined;
|
|
@@ -234,38 +223,17 @@ export interface DomainValidation {
|
|
|
234
223
|
*/
|
|
235
224
|
ValidationDomain?: string | undefined;
|
|
236
225
|
/**
|
|
237
|
-
* <p>The validation status of the domain name. This can be one of the following values:</p>
|
|
238
|
-
* <ul>
|
|
239
|
-
* <li>
|
|
240
|
-
* <p>
|
|
241
|
-
* <code>PENDING_VALIDATION</code>
|
|
242
|
-
* </p>
|
|
243
|
-
* </li>
|
|
244
|
-
* <li>
|
|
245
|
-
* <p>
|
|
246
|
-
* <code/>SUCCESS</p>
|
|
247
|
-
* </li>
|
|
248
|
-
* <li>
|
|
249
|
-
* <p>
|
|
250
|
-
* <code/>FAILED</p>
|
|
251
|
-
* </li>
|
|
252
|
-
* </ul>
|
|
226
|
+
* <p>The validation status of the domain name. This can be one of the following values:</p> <ul> <li> <p> <code>PENDING_VALIDATION</code> </p> </li> <li> <p> <code/>SUCCESS</p> </li> <li> <p> <code/>FAILED</p> </li> </ul>
|
|
253
227
|
* @public
|
|
254
228
|
*/
|
|
255
229
|
ValidationStatus?: DomainStatus | undefined;
|
|
256
230
|
/**
|
|
257
|
-
* <p>Contains the CNAME record that you add to your DNS database for domain validation. For
|
|
258
|
-
* more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">Use DNS to Validate Domain Ownership</a>.</p>
|
|
259
|
-
* <p>Note: The CNAME information that you need does not include the name of your domain. If you
|
|
260
|
-
* include your domain name in the DNS database CNAME record, validation fails. For example, if
|
|
261
|
-
* the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only
|
|
262
|
-
* "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.</p>
|
|
231
|
+
* <p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">Use DNS to Validate Domain Ownership</a>.</p> <note> <p>The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is <code>_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com</code>, only <code>_a79865eb4cd1a6ab990a45779b4e0b96</code> must be used.</p> </note>
|
|
263
232
|
* @public
|
|
264
233
|
*/
|
|
265
234
|
ResourceRecord?: ResourceRecord | undefined;
|
|
266
235
|
/**
|
|
267
|
-
* <p>Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM.
|
|
268
|
-
* This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and the validation method is <code>HTTP</code>.</p>
|
|
236
|
+
* <p>Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and the validation method is <code>HTTP</code>.</p>
|
|
269
237
|
* @public
|
|
270
238
|
*/
|
|
271
239
|
HttpRedirect?: HttpRedirect | undefined;
|
|
@@ -298,9 +266,7 @@ export declare const ExtendedKeyUsageName: {
|
|
|
298
266
|
*/
|
|
299
267
|
export type ExtendedKeyUsageName = (typeof ExtendedKeyUsageName)[keyof typeof ExtendedKeyUsageName];
|
|
300
268
|
/**
|
|
301
|
-
* <p>The Extended Key Usage X.509 v3 extension defines one or more purposes for which the
|
|
302
|
-
* public key can be used. This is in addition to or in place of the basic purposes specified by
|
|
303
|
-
* the Key Usage extension. </p>
|
|
269
|
+
* <p>The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension. </p>
|
|
304
270
|
* @public
|
|
305
271
|
*/
|
|
306
272
|
export interface ExtendedKeyUsage {
|
|
@@ -310,55 +276,7 @@ export interface ExtendedKeyUsage {
|
|
|
310
276
|
*/
|
|
311
277
|
Name?: ExtendedKeyUsageName | undefined;
|
|
312
278
|
/**
|
|
313
|
-
* <p>An object identifier (OID) for the extension value. OIDs are strings of numbers separated
|
|
314
|
-
* by periods. The following OIDs are defined in RFC 3280 and RFC 5280. </p>
|
|
315
|
-
* <ul>
|
|
316
|
-
* <li>
|
|
317
|
-
* <p>
|
|
318
|
-
* <code>1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)</code>
|
|
319
|
-
* </p>
|
|
320
|
-
* </li>
|
|
321
|
-
* <li>
|
|
322
|
-
* <p>
|
|
323
|
-
* <code>1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)</code>
|
|
324
|
-
* </p>
|
|
325
|
-
* </li>
|
|
326
|
-
* <li>
|
|
327
|
-
* <p>
|
|
328
|
-
* <code>1.3.6.1.5.5.7.3.3 (CODE_SIGNING)</code>
|
|
329
|
-
* </p>
|
|
330
|
-
* </li>
|
|
331
|
-
* <li>
|
|
332
|
-
* <p>
|
|
333
|
-
* <code>1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)</code>
|
|
334
|
-
* </p>
|
|
335
|
-
* </li>
|
|
336
|
-
* <li>
|
|
337
|
-
* <p>
|
|
338
|
-
* <code>1.3.6.1.5.5.7.3.8 (TIME_STAMPING)</code>
|
|
339
|
-
* </p>
|
|
340
|
-
* </li>
|
|
341
|
-
* <li>
|
|
342
|
-
* <p>
|
|
343
|
-
* <code>1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)</code>
|
|
344
|
-
* </p>
|
|
345
|
-
* </li>
|
|
346
|
-
* <li>
|
|
347
|
-
* <p>
|
|
348
|
-
* <code>1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)</code>
|
|
349
|
-
* </p>
|
|
350
|
-
* </li>
|
|
351
|
-
* <li>
|
|
352
|
-
* <p>
|
|
353
|
-
* <code>1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)</code>
|
|
354
|
-
* </p>
|
|
355
|
-
* </li>
|
|
356
|
-
* <li>
|
|
357
|
-
* <p>
|
|
358
|
-
* <code>1.3.6.1.5.5.7.3.7 (IPSEC_USER)</code>
|
|
359
|
-
* </p>
|
|
360
|
-
* </li>
|
|
361
|
-
* </ul>
|
|
279
|
+
* <p>An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. </p> <ul> <li> <p> <code>1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.3 (CODE_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.8 (TIME_STAMPING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.7 (IPSEC_USER)</code> </p> </li> </ul>
|
|
362
280
|
* @public
|
|
363
281
|
*/
|
|
364
282
|
OID?: string | undefined;
|
|
@@ -429,8 +347,7 @@ export declare const KeyUsageName: {
|
|
|
429
347
|
*/
|
|
430
348
|
export type KeyUsageName = (typeof KeyUsageName)[keyof typeof KeyUsageName];
|
|
431
349
|
/**
|
|
432
|
-
* <p>The Key Usage X.509 v3 extension defines the purpose of the public key contained in the
|
|
433
|
-
* certificate.</p>
|
|
350
|
+
* <p>The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.</p>
|
|
434
351
|
* @public
|
|
435
352
|
*/
|
|
436
353
|
export interface KeyUsage {
|
|
@@ -464,22 +381,32 @@ export declare const CertificateTransparencyLoggingPreference: {
|
|
|
464
381
|
*/
|
|
465
382
|
export type CertificateTransparencyLoggingPreference = (typeof CertificateTransparencyLoggingPreference)[keyof typeof CertificateTransparencyLoggingPreference];
|
|
466
383
|
/**
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
384
|
+
* @public
|
|
385
|
+
* @enum
|
|
386
|
+
*/
|
|
387
|
+
export declare const CertificateExport: {
|
|
388
|
+
readonly DISABLED: "DISABLED";
|
|
389
|
+
readonly ENABLED: "ENABLED";
|
|
390
|
+
};
|
|
391
|
+
/**
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export type CertificateExport = (typeof CertificateExport)[keyof typeof CertificateExport];
|
|
395
|
+
/**
|
|
396
|
+
* <p>Structure that contains options for your certificate. You can use this structure to specify whether to opt in to or out of certificate transparency logging and export your certificate. </p> <p>Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency">Certificate Transparency Logging</a>.</p> <p>You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-exportable-certificates.html">Certificate Manager exportable public certificate</a>.</p>
|
|
474
397
|
* @public
|
|
475
398
|
*/
|
|
476
399
|
export interface CertificateOptions {
|
|
477
400
|
/**
|
|
478
|
-
* <p>You can opt out of certificate transparency logging by specifying the
|
|
479
|
-
* <code>DISABLED</code> option. Opt in by specifying <code>ENABLED</code>. </p>
|
|
401
|
+
* <p>You can opt out of certificate transparency logging by specifying the <code>DISABLED</code> option. Opt in by specifying <code>ENABLED</code>. </p>
|
|
480
402
|
* @public
|
|
481
403
|
*/
|
|
482
404
|
CertificateTransparencyLoggingPreference?: CertificateTransparencyLoggingPreference | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* <p>You can opt in to allow the export of your certificates by specifying <code>ENABLED</code>.</p>
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
Export?: CertificateExport | undefined;
|
|
483
410
|
}
|
|
484
411
|
/**
|
|
485
412
|
* @public
|
|
@@ -508,8 +435,7 @@ export declare const RenewalStatus: {
|
|
|
508
435
|
*/
|
|
509
436
|
export type RenewalStatus = (typeof RenewalStatus)[keyof typeof RenewalStatus];
|
|
510
437
|
/**
|
|
511
|
-
* <p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This
|
|
512
|
-
* structure exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
|
|
438
|
+
* <p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This structure exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
|
|
513
439
|
* @public
|
|
514
440
|
*/
|
|
515
441
|
export interface RenewalSummary {
|
|
@@ -519,11 +445,7 @@ export interface RenewalSummary {
|
|
|
519
445
|
*/
|
|
520
446
|
RenewalStatus: RenewalStatus | undefined;
|
|
521
447
|
/**
|
|
522
|
-
* <p>Contains information about the validation of each domain name in the certificate, as it
|
|
523
|
-
* pertains to ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed
|
|
524
|
-
* renewal</a>. This is different from the initial validation that occurs as a result of
|
|
525
|
-
* the <a>RequestCertificate</a> request. This field exists only when the certificate
|
|
526
|
-
* type is <code>AMAZON_ISSUED</code>.</p>
|
|
448
|
+
* <p>Contains information about the validation of each domain name in the certificate, as it pertains to ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a>. This is different from the initial validation that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
|
|
527
449
|
* @public
|
|
528
450
|
*/
|
|
529
451
|
DomainValidationOptions: DomainValidation[] | undefined;
|
|
@@ -590,30 +512,22 @@ export declare const CertificateType: {
|
|
|
590
512
|
*/
|
|
591
513
|
export type CertificateType = (typeof CertificateType)[keyof typeof CertificateType];
|
|
592
514
|
/**
|
|
593
|
-
* <p>Contains metadata about an ACM certificate. This structure is returned in the response
|
|
594
|
-
* to a <a>DescribeCertificate</a> request. </p>
|
|
515
|
+
* <p>Contains metadata about an ACM certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request. </p>
|
|
595
516
|
* @public
|
|
596
517
|
*/
|
|
597
518
|
export interface CertificateDetail {
|
|
598
519
|
/**
|
|
599
|
-
* <p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see
|
|
600
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
|
|
601
|
-
* the <i>Amazon Web Services General Reference</i>.</p>
|
|
520
|
+
* <p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
602
521
|
* @public
|
|
603
522
|
*/
|
|
604
523
|
CertificateArn?: string | undefined;
|
|
605
524
|
/**
|
|
606
|
-
* <p>The fully qualified domain name for the certificate, such as www.example.com or
|
|
607
|
-
* example.com.</p>
|
|
525
|
+
* <p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>
|
|
608
526
|
* @public
|
|
609
527
|
*/
|
|
610
528
|
DomainName?: string | undefined;
|
|
611
529
|
/**
|
|
612
|
-
* <p>One or more domain names (subject alternative names)
|
|
613
|
-
* included in the certificate. This
|
|
614
|
-
* list contains the domain names that are bound to the public key that is contained in the
|
|
615
|
-
* certificate. The subject alternative names include the canonical domain name (CN) of the
|
|
616
|
-
* certificate and additional domain names that can be used to connect to the website. </p>
|
|
530
|
+
* <p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p>
|
|
617
531
|
* @public
|
|
618
532
|
*/
|
|
619
533
|
SubjectAlternativeNames?: string[] | undefined;
|
|
@@ -623,9 +537,7 @@ export interface CertificateDetail {
|
|
|
623
537
|
*/
|
|
624
538
|
ManagedBy?: CertificateManagedBy | undefined;
|
|
625
539
|
/**
|
|
626
|
-
* <p>Contains information about the initial validation of each domain name that occurs as a
|
|
627
|
-
* result of the <a>RequestCertificate</a> request. This field exists only when the
|
|
628
|
-
* certificate type is <code>AMAZON_ISSUED</code>. </p>
|
|
540
|
+
* <p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>
|
|
629
541
|
* @public
|
|
630
542
|
*/
|
|
631
543
|
DomainValidationOptions?: DomainValidation[] | undefined;
|
|
@@ -635,8 +547,7 @@ export interface CertificateDetail {
|
|
|
635
547
|
*/
|
|
636
548
|
Serial?: string | undefined;
|
|
637
549
|
/**
|
|
638
|
-
* <p>The name of the entity that is associated with the public key contained in the
|
|
639
|
-
* certificate.</p>
|
|
550
|
+
* <p>The name of the entity that is associated with the public key contained in the certificate.</p>
|
|
640
551
|
* @public
|
|
641
552
|
*/
|
|
642
553
|
Subject?: string | undefined;
|
|
@@ -651,36 +562,27 @@ export interface CertificateDetail {
|
|
|
651
562
|
*/
|
|
652
563
|
CreatedAt?: Date | undefined;
|
|
653
564
|
/**
|
|
654
|
-
* <p>The time at which the certificate was issued. This value exists only when the certificate
|
|
655
|
-
* type is <code>AMAZON_ISSUED</code>. </p>
|
|
565
|
+
* <p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>
|
|
656
566
|
* @public
|
|
657
567
|
*/
|
|
658
568
|
IssuedAt?: Date | undefined;
|
|
659
569
|
/**
|
|
660
|
-
* <p>The date and time when the certificate was imported. This value exists only when the
|
|
661
|
-
* certificate type is <code>IMPORTED</code>. </p>
|
|
570
|
+
* <p>The date and time when the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>
|
|
662
571
|
* @public
|
|
663
572
|
*/
|
|
664
573
|
ImportedAt?: Date | undefined;
|
|
665
574
|
/**
|
|
666
|
-
* <p>The status of the certificate.</p>
|
|
667
|
-
* <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for
|
|
668
|
-
* any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. ACM makes
|
|
669
|
-
* repeated attempts to validate a certificate for 72 hours and then times out. If a certificate
|
|
670
|
-
* shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with <a href="https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html">Email validation</a>, and
|
|
671
|
-
* try again. If validation succeeds, the certificate enters status ISSUED. </p>
|
|
575
|
+
* <p>The status of the certificate.</p> <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with <a href="https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html">Email validation</a>, and try again. If validation succeeds, the certificate enters status ISSUED. </p>
|
|
672
576
|
* @public
|
|
673
577
|
*/
|
|
674
578
|
Status?: CertificateStatus | undefined;
|
|
675
579
|
/**
|
|
676
|
-
* <p>The time at which the certificate was revoked. This value exists only when the certificate
|
|
677
|
-
* status is <code>REVOKED</code>. </p>
|
|
580
|
+
* <p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>
|
|
678
581
|
* @public
|
|
679
582
|
*/
|
|
680
583
|
RevokedAt?: Date | undefined;
|
|
681
584
|
/**
|
|
682
|
-
* <p>The reason the certificate was revoked. This value exists only when the certificate status
|
|
683
|
-
* is <code>REVOKED</code>. </p>
|
|
585
|
+
* <p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>
|
|
684
586
|
* @public
|
|
685
587
|
*/
|
|
686
588
|
RevocationReason?: RevocationReason | undefined;
|
|
@@ -705,76 +607,53 @@ export interface CertificateDetail {
|
|
|
705
607
|
*/
|
|
706
608
|
SignatureAlgorithm?: string | undefined;
|
|
707
609
|
/**
|
|
708
|
-
* <p>A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can
|
|
709
|
-
* be used by multiple Amazon Web Services resources. </p>
|
|
610
|
+
* <p>A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources. </p>
|
|
710
611
|
* @public
|
|
711
612
|
*/
|
|
712
613
|
InUseBy?: string[] | undefined;
|
|
713
614
|
/**
|
|
714
|
-
* <p>The reason the certificate request failed. This value exists only when the certificate
|
|
715
|
-
* status is <code>FAILED</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed">Certificate Request
|
|
716
|
-
* Failed</a> in the <i>Certificate Manager User Guide</i>. </p>
|
|
615
|
+
* <p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed">Certificate Request Failed</a> in the <i>Certificate Manager User Guide</i>. </p>
|
|
717
616
|
* @public
|
|
718
617
|
*/
|
|
719
618
|
FailureReason?: FailureReason | undefined;
|
|
720
619
|
/**
|
|
721
|
-
* <p>The source of the certificate. For certificates provided by ACM, this value is
|
|
722
|
-
* <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide
|
|
723
|
-
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for
|
|
724
|
-
* imported certificates. For more information about the differences between certificates that
|
|
725
|
-
* you import and those that ACM provides, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing Certificates</a> in the
|
|
726
|
-
* <i>Certificate Manager User Guide</i>. </p>
|
|
620
|
+
* <p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>
|
|
727
621
|
* @public
|
|
728
622
|
*/
|
|
729
623
|
Type?: CertificateType | undefined;
|
|
730
624
|
/**
|
|
731
|
-
* <p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This field
|
|
732
|
-
* exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
|
|
625
|
+
* <p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
|
|
733
626
|
* @public
|
|
734
627
|
*/
|
|
735
628
|
RenewalSummary?: RenewalSummary | undefined;
|
|
736
629
|
/**
|
|
737
|
-
* <p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that
|
|
738
|
-
* identifies the purpose of the public key contained in the certificate. Possible extension
|
|
739
|
-
* values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>
|
|
630
|
+
* <p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>
|
|
740
631
|
* @public
|
|
741
632
|
*/
|
|
742
633
|
KeyUsages?: KeyUsage[] | undefined;
|
|
743
634
|
/**
|
|
744
|
-
* <p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a
|
|
745
|
-
* purpose for which the certificate public key can be used and consists of a name and an object
|
|
746
|
-
* identifier (OID). </p>
|
|
635
|
+
* <p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). </p>
|
|
747
636
|
* @public
|
|
748
637
|
*/
|
|
749
638
|
ExtendedKeyUsages?: ExtendedKeyUsage[] | undefined;
|
|
750
639
|
/**
|
|
751
|
-
* <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the
|
|
752
|
-
* certificate. This has the following format: </p>
|
|
753
|
-
* <p>
|
|
754
|
-
* <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code>
|
|
755
|
-
* </p>
|
|
640
|
+
* <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>
|
|
756
641
|
* @public
|
|
757
642
|
*/
|
|
758
643
|
CertificateAuthorityArn?: string | undefined;
|
|
759
644
|
/**
|
|
760
|
-
* <p>Specifies whether the certificate is eligible for renewal. At this time, only exported
|
|
761
|
-
* private certificates can be renewed with the <a>RenewCertificate</a>
|
|
762
|
-
* command.</p>
|
|
645
|
+
* <p>Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the <a>RenewCertificate</a> command.</p>
|
|
763
646
|
* @public
|
|
764
647
|
*/
|
|
765
648
|
RenewalEligibility?: RenewalEligibility | undefined;
|
|
766
649
|
/**
|
|
767
|
-
* <p>Value that specifies whether to add the certificate to a transparency log. Certificate
|
|
768
|
-
* transparency makes it possible to detect SSL certificates that have been mistakenly or
|
|
769
|
-
* maliciously issued. A browser might respond to certificate that has not been logged by showing
|
|
770
|
-
* an error message. The logs are cryptographically secure. </p>
|
|
650
|
+
* <p>Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure. </p>
|
|
771
651
|
* @public
|
|
772
652
|
*/
|
|
773
653
|
Options?: CertificateOptions | undefined;
|
|
774
654
|
}
|
|
775
655
|
/**
|
|
776
|
-
* <p>You are trying to update a resource or configuration that is already being created or
|
|
777
|
-
* updated. Wait for the previous operation to finish and try again.</p>
|
|
656
|
+
* <p>You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.</p>
|
|
778
657
|
* @public
|
|
779
658
|
*/
|
|
780
659
|
export declare class ConflictException extends __BaseException {
|
|
@@ -790,19 +669,13 @@ export declare class ConflictException extends __BaseException {
|
|
|
790
669
|
*/
|
|
791
670
|
export interface DeleteCertificateRequest {
|
|
792
671
|
/**
|
|
793
|
-
* <p>String that contains the ARN of the ACM certificate to be deleted. This must be of the
|
|
794
|
-
* form:</p>
|
|
795
|
-
* <p>
|
|
796
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
797
|
-
* </p>
|
|
798
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
672
|
+
* <p>String that contains the ARN of the ACM certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
799
673
|
* @public
|
|
800
674
|
*/
|
|
801
675
|
CertificateArn: string | undefined;
|
|
802
676
|
}
|
|
803
677
|
/**
|
|
804
|
-
* <p>The certificate is in use by another Amazon Web Services service in the caller's account. Remove the
|
|
805
|
-
* association and try again.</p>
|
|
678
|
+
* <p>The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.</p>
|
|
806
679
|
* @public
|
|
807
680
|
*/
|
|
808
681
|
export declare class ResourceInUseException extends __BaseException {
|
|
@@ -818,12 +691,7 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
818
691
|
*/
|
|
819
692
|
export interface DescribeCertificateRequest {
|
|
820
693
|
/**
|
|
821
|
-
* <p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following
|
|
822
|
-
* form:</p>
|
|
823
|
-
* <p>
|
|
824
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
825
|
-
* </p>
|
|
826
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
694
|
+
* <p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
827
695
|
* @public
|
|
828
696
|
*/
|
|
829
697
|
CertificateArn: string | undefined;
|
|
@@ -843,24 +711,12 @@ export interface DescribeCertificateResponse {
|
|
|
843
711
|
*/
|
|
844
712
|
export interface ExportCertificateRequest {
|
|
845
713
|
/**
|
|
846
|
-
* <p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p>
|
|
847
|
-
* <p>
|
|
848
|
-
* <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
849
|
-
* </p>
|
|
714
|
+
* <p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code> </p>
|
|
850
715
|
* @public
|
|
851
716
|
*/
|
|
852
717
|
CertificateArn: string | undefined;
|
|
853
718
|
/**
|
|
854
|
-
* <p>Passphrase to associate with the encrypted exported private key. </p>
|
|
855
|
-
* <note>
|
|
856
|
-
* <p>When creating your passphrase, you can use any ASCII character except #, $, or %.</p>
|
|
857
|
-
* </note>
|
|
858
|
-
* <p>If you want to later decrypt the private key, you must have the passphrase. You can use
|
|
859
|
-
* the following OpenSSL command to decrypt a private key. After entering the command, you are
|
|
860
|
-
* prompted for the passphrase.</p>
|
|
861
|
-
* <p>
|
|
862
|
-
* <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code>
|
|
863
|
-
* </p>
|
|
719
|
+
* <p>Passphrase to associate with the encrypted exported private key. </p> <note> <p>When creating your passphrase, you can use any ASCII character except #, $, or %.</p> </note> <p>If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase.</p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>
|
|
864
720
|
* @public
|
|
865
721
|
*/
|
|
866
722
|
Passphrase: Uint8Array | undefined;
|
|
@@ -875,21 +731,18 @@ export interface ExportCertificateResponse {
|
|
|
875
731
|
*/
|
|
876
732
|
Certificate?: string | undefined;
|
|
877
733
|
/**
|
|
878
|
-
* <p>The base64 PEM-encoded certificate chain. This does not include the certificate that you
|
|
879
|
-
* are exporting.</p>
|
|
734
|
+
* <p>The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.</p>
|
|
880
735
|
* @public
|
|
881
736
|
*/
|
|
882
737
|
CertificateChain?: string | undefined;
|
|
883
738
|
/**
|
|
884
|
-
* <p>The encrypted private key associated with the public key in the certificate. The key is
|
|
885
|
-
* output in PKCS #8 format and is base64 PEM-encoded. </p>
|
|
739
|
+
* <p>The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded. </p>
|
|
886
740
|
* @public
|
|
887
741
|
*/
|
|
888
742
|
PrivateKey?: string | undefined;
|
|
889
743
|
}
|
|
890
744
|
/**
|
|
891
|
-
* <p>The certificate request is in process and the certificate in your account has not yet been
|
|
892
|
-
* issued.</p>
|
|
745
|
+
* <p>The certificate request is in process and the certificate in your account has not yet been issued.</p>
|
|
893
746
|
* @public
|
|
894
747
|
*/
|
|
895
748
|
export declare class RequestInProgressException extends __BaseException {
|
|
@@ -906,10 +759,7 @@ export declare class RequestInProgressException extends __BaseException {
|
|
|
906
759
|
*/
|
|
907
760
|
export interface ExpiryEventsConfiguration {
|
|
908
761
|
/**
|
|
909
|
-
* <p>Specifies the number of days prior to certificate expiration when ACM starts generating
|
|
910
|
-
* <code>EventBridge</code> events. ACM sends one event per day per certificate until the
|
|
911
|
-
* certificate expires. By default, accounts receive events starting 45 days before certificate
|
|
912
|
-
* expiration.</p>
|
|
762
|
+
* <p>Specifies the number of days prior to certificate expiration when ACM starts generating <code>EventBridge</code> events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.</p>
|
|
913
763
|
* @public
|
|
914
764
|
*/
|
|
915
765
|
DaysBeforeExpiry?: number | undefined;
|
|
@@ -929,11 +779,7 @@ export interface GetAccountConfigurationResponse {
|
|
|
929
779
|
*/
|
|
930
780
|
export interface GetCertificateRequest {
|
|
931
781
|
/**
|
|
932
|
-
* <p>String that contains a certificate ARN in the following format:</p>
|
|
933
|
-
* <p>
|
|
934
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
935
|
-
* </p>
|
|
936
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
782
|
+
* <p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
937
783
|
* @public
|
|
938
784
|
*/
|
|
939
785
|
CertificateArn: string | undefined;
|
|
@@ -948,9 +794,7 @@ export interface GetCertificateResponse {
|
|
|
948
794
|
*/
|
|
949
795
|
Certificate?: string | undefined;
|
|
950
796
|
/**
|
|
951
|
-
* <p>Certificates forming the requested certificate's chain of trust. The chain consists of the
|
|
952
|
-
* certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.
|
|
953
|
-
* </p>
|
|
797
|
+
* <p>Certificates forming the requested certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. </p>
|
|
954
798
|
* @public
|
|
955
799
|
*/
|
|
956
800
|
CertificateChain?: string | undefined;
|
|
@@ -960,9 +804,7 @@ export interface GetCertificateResponse {
|
|
|
960
804
|
*/
|
|
961
805
|
export interface ImportCertificateRequest {
|
|
962
806
|
/**
|
|
963
|
-
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name
|
|
964
|
-
* (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this
|
|
965
|
-
* field. </p>
|
|
807
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field. </p>
|
|
966
808
|
* @public
|
|
967
809
|
*/
|
|
968
810
|
CertificateArn?: string | undefined;
|
|
@@ -982,8 +824,7 @@ export interface ImportCertificateRequest {
|
|
|
982
824
|
*/
|
|
983
825
|
CertificateChain?: Uint8Array | undefined;
|
|
984
826
|
/**
|
|
985
|
-
* <p>One or more resource tags to associate with the imported certificate. </p>
|
|
986
|
-
* <p>Note: You cannot apply tags when reimporting a certificate.</p>
|
|
827
|
+
* <p>One or more resource tags to associate with the imported certificate. </p> <p>Note: You cannot apply tags when reimporting a certificate.</p>
|
|
987
828
|
* @public
|
|
988
829
|
*/
|
|
989
830
|
Tags?: Tag[] | undefined;
|
|
@@ -993,8 +834,7 @@ export interface ImportCertificateRequest {
|
|
|
993
834
|
*/
|
|
994
835
|
export interface ImportCertificateResponse {
|
|
995
836
|
/**
|
|
996
|
-
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name
|
|
997
|
-
* (ARN)</a> of the imported certificate.</p>
|
|
837
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the imported certificate.</p>
|
|
998
838
|
* @public
|
|
999
839
|
*/
|
|
1000
840
|
CertificateArn?: string | undefined;
|
|
@@ -1012,7 +852,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1012
852
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1013
853
|
}
|
|
1014
854
|
/**
|
|
1015
|
-
* <p>One or more of
|
|
855
|
+
* <p>One or more of request parameters specified is not valid.</p>
|
|
1016
856
|
* @public
|
|
1017
857
|
*/
|
|
1018
858
|
export declare class InvalidArgsException extends __BaseException {
|
|
@@ -1024,8 +864,7 @@ export declare class InvalidArgsException extends __BaseException {
|
|
|
1024
864
|
constructor(opts: __ExceptionOptionType<InvalidArgsException, __BaseException>);
|
|
1025
865
|
}
|
|
1026
866
|
/**
|
|
1027
|
-
* <p>This structure can be used in the <a>ListCertificates</a> action to filter the
|
|
1028
|
-
* output of the certificate list. </p>
|
|
867
|
+
* <p>This structure can be used in the <a>ListCertificates</a> action to filter the output of the certificate list. </p>
|
|
1029
868
|
* @public
|
|
1030
869
|
*/
|
|
1031
870
|
export interface Filters {
|
|
@@ -1040,15 +879,15 @@ export interface Filters {
|
|
|
1040
879
|
*/
|
|
1041
880
|
keyUsage?: KeyUsageName[] | undefined;
|
|
1042
881
|
/**
|
|
1043
|
-
* <p>Specify one or more algorithms that can be used to generate key pairs.</p>
|
|
1044
|
-
* <p>Default filtering returns only <code>RSA_1024</code> and <code>RSA_2048</code>
|
|
1045
|
-
* certificates that have at least one domain. To return other certificate types, provide the
|
|
1046
|
-
* desired type signatures in a comma-separated list. For example, <code>"keyTypes":
|
|
1047
|
-
* ["RSA_2048","RSA_4096"]</code> returns both <code>RSA_2048</code> and <code>RSA_4096</code>
|
|
1048
|
-
* certificates.</p>
|
|
882
|
+
* <p>Specify one or more algorithms that can be used to generate key pairs.</p> <p>Default filtering returns only <code>RSA_1024</code> and <code>RSA_2048</code> certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, <code>"keyTypes": ["RSA_2048","RSA_4096"]</code> returns both <code>RSA_2048</code> and <code>RSA_4096</code> certificates.</p>
|
|
1049
883
|
* @public
|
|
1050
884
|
*/
|
|
1051
885
|
keyTypes?: KeyAlgorithm[] | undefined;
|
|
886
|
+
/**
|
|
887
|
+
* <p>Specify <code>ENABLED</code> or <code>DISABLED</code> to identify certificates that can be exported.</p>
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
exportOption?: CertificateExport | undefined;
|
|
1052
891
|
/**
|
|
1053
892
|
* <p>Identifies the Amazon Web Services service that manages the certificate issued by ACM.</p>
|
|
1054
893
|
* @public
|
|
@@ -1088,98 +927,63 @@ export interface ListCertificatesRequest {
|
|
|
1088
927
|
*/
|
|
1089
928
|
CertificateStatuses?: CertificateStatus[] | undefined;
|
|
1090
929
|
/**
|
|
1091
|
-
* <p>Filter the certificate list. For more information, see the <a>Filters</a>
|
|
1092
|
-
* structure.</p>
|
|
930
|
+
* <p>Filter the certificate list. For more information, see the <a>Filters</a> structure.</p>
|
|
1093
931
|
* @public
|
|
1094
932
|
*/
|
|
1095
933
|
Includes?: Filters | undefined;
|
|
1096
934
|
/**
|
|
1097
|
-
* <p>Use this parameter only when paginating results and only in a subsequent request after you
|
|
1098
|
-
* receive a response with truncated results. Set it to the value of <code>NextToken</code> from
|
|
1099
|
-
* the response you just received.</p>
|
|
935
|
+
* <p>Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the response you just received.</p>
|
|
1100
936
|
* @public
|
|
1101
937
|
*/
|
|
1102
938
|
NextToken?: string | undefined;
|
|
1103
939
|
/**
|
|
1104
|
-
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
1105
|
-
* return in the response. If additional items exist beyond the number you specify, the
|
|
1106
|
-
* <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code>
|
|
1107
|
-
* value in a subsequent request to retrieve additional items.</p>
|
|
940
|
+
* <p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>
|
|
1108
941
|
* @public
|
|
1109
942
|
*/
|
|
1110
943
|
MaxItems?: number | undefined;
|
|
1111
944
|
/**
|
|
1112
|
-
* <p>Specifies the field to sort results by. If you specify <code>SortBy</code>, you must also
|
|
1113
|
-
* specify <code>SortOrder</code>.</p>
|
|
945
|
+
* <p>Specifies the field to sort results by. If you specify <code>SortBy</code>, you must also specify <code>SortOrder</code>.</p>
|
|
1114
946
|
* @public
|
|
1115
947
|
*/
|
|
1116
948
|
SortBy?: SortBy | undefined;
|
|
1117
949
|
/**
|
|
1118
|
-
* <p>Specifies the order of sorted results. If you specify <code>SortOrder</code>, you must
|
|
1119
|
-
* also specify <code>SortBy</code>.</p>
|
|
950
|
+
* <p>Specifies the order of sorted results. If you specify <code>SortOrder</code>, you must also specify <code>SortBy</code>.</p>
|
|
1120
951
|
* @public
|
|
1121
952
|
*/
|
|
1122
953
|
SortOrder?: SortOrder | undefined;
|
|
1123
954
|
}
|
|
1124
955
|
/**
|
|
1125
|
-
* <p>This structure is returned in the response object of <a>ListCertificates</a>
|
|
1126
|
-
* action. </p>
|
|
956
|
+
* <p>This structure is returned in the response object of <a>ListCertificates</a> action. </p>
|
|
1127
957
|
* @public
|
|
1128
958
|
*/
|
|
1129
959
|
export interface CertificateSummary {
|
|
1130
960
|
/**
|
|
1131
|
-
* <p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p>
|
|
1132
|
-
* <p>
|
|
1133
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
1134
|
-
* </p>
|
|
1135
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
961
|
+
* <p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1136
962
|
* @public
|
|
1137
963
|
*/
|
|
1138
964
|
CertificateArn?: string | undefined;
|
|
1139
965
|
/**
|
|
1140
|
-
* <p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the
|
|
1141
|
-
* certificate.</p>
|
|
966
|
+
* <p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>
|
|
1142
967
|
* @public
|
|
1143
968
|
*/
|
|
1144
969
|
DomainName?: string | undefined;
|
|
1145
970
|
/**
|
|
1146
|
-
* <p>One or more domain names (subject alternative names)
|
|
1147
|
-
* included in the certificate. This
|
|
1148
|
-
* list contains the domain names that are bound to the public key that is contained in the
|
|
1149
|
-
* certificate. The subject alternative names include the canonical domain name (CN) of the
|
|
1150
|
-
* certificate and additional domain names that can be used to connect to the website. </p>
|
|
1151
|
-
* <p>When called by <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html">ListCertificates</a>, this parameter will only return the first 100 subject alternative
|
|
1152
|
-
* names included in the certificate. To display the full list of subject alternative names, use
|
|
1153
|
-
* <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html">DescribeCertificate</a>.</p>
|
|
971
|
+
* <p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p> <p>When called by <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html">ListCertificates</a>, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html">DescribeCertificate</a>.</p>
|
|
1154
972
|
* @public
|
|
1155
973
|
*/
|
|
1156
974
|
SubjectAlternativeNameSummaries?: string[] | undefined;
|
|
1157
975
|
/**
|
|
1158
|
-
* <p>When called by <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html">ListCertificates</a>, indicates whether the full list of subject alternative names has
|
|
1159
|
-
* been included in the response. If false, the response includes all of the subject alternative
|
|
1160
|
-
* names included in the certificate. If true, the response only includes the first 100 subject
|
|
1161
|
-
* alternative names included in the certificate. To display the full list of subject alternative
|
|
1162
|
-
* names, use <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html">DescribeCertificate</a>.</p>
|
|
976
|
+
* <p>When called by <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html">ListCertificates</a>, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use <a href="https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html">DescribeCertificate</a>.</p>
|
|
1163
977
|
* @public
|
|
1164
978
|
*/
|
|
1165
979
|
HasAdditionalSubjectAlternativeNames?: boolean | undefined;
|
|
1166
980
|
/**
|
|
1167
|
-
* <p>The status of the certificate.</p>
|
|
1168
|
-
* <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for
|
|
1169
|
-
* any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. ACM makes
|
|
1170
|
-
* repeated attempts to validate a certificate for 72 hours and then times out. If a certificate
|
|
1171
|
-
* shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with <a href="https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html">Email validation</a>, and
|
|
1172
|
-
* try again. If validation succeeds, the certificate enters status ISSUED. </p>
|
|
981
|
+
* <p>The status of the certificate.</p> <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with <a href="https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html">Email validation</a>, and try again. If validation succeeds, the certificate enters status ISSUED. </p>
|
|
1173
982
|
* @public
|
|
1174
983
|
*/
|
|
1175
984
|
Status?: CertificateStatus | undefined;
|
|
1176
985
|
/**
|
|
1177
|
-
* <p>The source of the certificate. For certificates provided by ACM, this value is
|
|
1178
|
-
* <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide
|
|
1179
|
-
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for
|
|
1180
|
-
* imported certificates. For more information about the differences between certificates that
|
|
1181
|
-
* you import and those that ACM provides, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing Certificates</a> in the
|
|
1182
|
-
* <i>Certificate Manager User Guide</i>. </p>
|
|
986
|
+
* <p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>
|
|
1183
987
|
* @public
|
|
1184
988
|
*/
|
|
1185
989
|
Type?: CertificateType | undefined;
|
|
@@ -1189,34 +993,32 @@ export interface CertificateSummary {
|
|
|
1189
993
|
*/
|
|
1190
994
|
KeyAlgorithm?: KeyAlgorithm | undefined;
|
|
1191
995
|
/**
|
|
1192
|
-
* <p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that
|
|
1193
|
-
* identifies the purpose of the public key contained in the certificate. Possible extension
|
|
1194
|
-
* values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>
|
|
996
|
+
* <p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>
|
|
1195
997
|
* @public
|
|
1196
998
|
*/
|
|
1197
999
|
KeyUsages?: KeyUsageName[] | undefined;
|
|
1198
1000
|
/**
|
|
1199
|
-
* <p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a
|
|
1200
|
-
* purpose for which the certificate public key can be used and consists of a name and an object
|
|
1201
|
-
* identifier (OID). </p>
|
|
1001
|
+
* <p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). </p>
|
|
1202
1002
|
* @public
|
|
1203
1003
|
*/
|
|
1204
1004
|
ExtendedKeyUsages?: ExtendedKeyUsageName[] | undefined;
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>Indicates if export is enabled for the certificate.</p>
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
ExportOption?: CertificateExport | undefined;
|
|
1205
1010
|
/**
|
|
1206
1011
|
* <p>Indicates whether the certificate is currently in use by any Amazon Web Services resources.</p>
|
|
1207
1012
|
* @public
|
|
1208
1013
|
*/
|
|
1209
1014
|
InUse?: boolean | undefined;
|
|
1210
1015
|
/**
|
|
1211
|
-
* <p>Indicates whether the certificate has been exported. This value exists only when the
|
|
1212
|
-
* certificate type is <code>PRIVATE</code>.</p>
|
|
1016
|
+
* <p>Indicates whether the certificate has been exported. This value exists only when the certificate type is <code>PRIVATE</code>.</p>
|
|
1213
1017
|
* @public
|
|
1214
1018
|
*/
|
|
1215
1019
|
Exported?: boolean | undefined;
|
|
1216
1020
|
/**
|
|
1217
|
-
* <p>Specifies whether the certificate is eligible for renewal. At this time, only exported
|
|
1218
|
-
* private certificates can be renewed with the <a>RenewCertificate</a>
|
|
1219
|
-
* command.</p>
|
|
1021
|
+
* <p>Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the <a>RenewCertificate</a> command.</p>
|
|
1220
1022
|
* @public
|
|
1221
1023
|
*/
|
|
1222
1024
|
RenewalEligibility?: RenewalEligibility | undefined;
|
|
@@ -1236,20 +1038,17 @@ export interface CertificateSummary {
|
|
|
1236
1038
|
*/
|
|
1237
1039
|
CreatedAt?: Date | undefined;
|
|
1238
1040
|
/**
|
|
1239
|
-
* <p>The time at which the certificate was issued. This value exists only when the certificate
|
|
1240
|
-
* type is <code>AMAZON_ISSUED</code>. </p>
|
|
1041
|
+
* <p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>
|
|
1241
1042
|
* @public
|
|
1242
1043
|
*/
|
|
1243
1044
|
IssuedAt?: Date | undefined;
|
|
1244
1045
|
/**
|
|
1245
|
-
* <p>The date and time when the certificate was imported. This value exists only when the
|
|
1246
|
-
* certificate type is <code>IMPORTED</code>. </p>
|
|
1046
|
+
* <p>The date and time when the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>
|
|
1247
1047
|
* @public
|
|
1248
1048
|
*/
|
|
1249
1049
|
ImportedAt?: Date | undefined;
|
|
1250
1050
|
/**
|
|
1251
|
-
* <p>The time at which the certificate was revoked. This value exists only when the certificate
|
|
1252
|
-
* status is <code>REVOKED</code>. </p>
|
|
1051
|
+
* <p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>
|
|
1253
1052
|
* @public
|
|
1254
1053
|
*/
|
|
1255
1054
|
RevokedAt?: Date | undefined;
|
|
@@ -1264,8 +1063,7 @@ export interface CertificateSummary {
|
|
|
1264
1063
|
*/
|
|
1265
1064
|
export interface ListCertificatesResponse {
|
|
1266
1065
|
/**
|
|
1267
|
-
* <p>When the list is truncated, this value is present and contains the value to use for the
|
|
1268
|
-
* <code>NextToken</code> parameter in a subsequent pagination request.</p>
|
|
1066
|
+
* <p>When the list is truncated, this value is present and contains the value to use for the <code>NextToken</code> parameter in a subsequent pagination request.</p>
|
|
1269
1067
|
* @public
|
|
1270
1068
|
*/
|
|
1271
1069
|
NextToken?: string | undefined;
|
|
@@ -1292,12 +1090,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
1292
1090
|
*/
|
|
1293
1091
|
export interface ListTagsForCertificateRequest {
|
|
1294
1092
|
/**
|
|
1295
|
-
* <p>String that contains the ARN of the ACM certificate for which you want to list the tags.
|
|
1296
|
-
* This must have the following form:</p>
|
|
1297
|
-
* <p>
|
|
1298
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
1299
|
-
* </p>
|
|
1300
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1093
|
+
* <p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1301
1094
|
* @public
|
|
1302
1095
|
*/
|
|
1303
1096
|
CertificateArn: string | undefined;
|
|
@@ -1322,11 +1115,7 @@ export interface PutAccountConfigurationRequest {
|
|
|
1322
1115
|
*/
|
|
1323
1116
|
ExpiryEvents?: ExpiryEventsConfiguration | undefined;
|
|
1324
1117
|
/**
|
|
1325
|
-
* <p>Customer-chosen string used to distinguish between calls to
|
|
1326
|
-
* <code>PutAccountConfiguration</code>. Idempotency tokens time out after one hour. If you
|
|
1327
|
-
* call <code>PutAccountConfiguration</code> multiple times with the same unexpired idempotency
|
|
1328
|
-
* token, ACM treats it as the same request and returns the original result. If you change the
|
|
1329
|
-
* idempotency token for each call, ACM treats each call as a new request.</p>
|
|
1118
|
+
* <p>Customer-chosen string used to distinguish between calls to <code>PutAccountConfiguration</code>. Idempotency tokens time out after one hour. If you call <code>PutAccountConfiguration</code> multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.</p>
|
|
1330
1119
|
* @public
|
|
1331
1120
|
*/
|
|
1332
1121
|
IdempotencyToken: string | undefined;
|
|
@@ -1336,12 +1125,7 @@ export interface PutAccountConfigurationRequest {
|
|
|
1336
1125
|
*/
|
|
1337
1126
|
export interface RemoveTagsFromCertificateRequest {
|
|
1338
1127
|
/**
|
|
1339
|
-
* <p>String that contains the ARN of the ACM Certificate with one or more tags that you want
|
|
1340
|
-
* to remove. This must be of the form:</p>
|
|
1341
|
-
* <p>
|
|
1342
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
1343
|
-
* </p>
|
|
1344
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1128
|
+
* <p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1345
1129
|
* @public
|
|
1346
1130
|
*/
|
|
1347
1131
|
CertificateArn: string | undefined;
|
|
@@ -1356,19 +1140,13 @@ export interface RemoveTagsFromCertificateRequest {
|
|
|
1356
1140
|
*/
|
|
1357
1141
|
export interface RenewCertificateRequest {
|
|
1358
1142
|
/**
|
|
1359
|
-
* <p>String that contains the ARN of the ACM certificate to be renewed. This must be of the
|
|
1360
|
-
* form:</p>
|
|
1361
|
-
* <p>
|
|
1362
|
-
* <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
1363
|
-
* </p>
|
|
1364
|
-
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1143
|
+
* <p>String that contains the ARN of the ACM certificate to be renewed. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
|
|
1365
1144
|
* @public
|
|
1366
1145
|
*/
|
|
1367
1146
|
CertificateArn: string | undefined;
|
|
1368
1147
|
}
|
|
1369
1148
|
/**
|
|
1370
|
-
* <p>One or more values in the <a>DomainValidationOption</a> structure is
|
|
1371
|
-
* incorrect.</p>
|
|
1149
|
+
* <p>One or more values in the <a>DomainValidationOption</a> structure is incorrect.</p>
|
|
1372
1150
|
* @public
|
|
1373
1151
|
*/
|
|
1374
1152
|
export declare class InvalidDomainValidationOptionsException extends __BaseException {
|
|
@@ -1380,8 +1158,7 @@ export declare class InvalidDomainValidationOptionsException extends __BaseExcep
|
|
|
1380
1158
|
constructor(opts: __ExceptionOptionType<InvalidDomainValidationOptionsException, __BaseException>);
|
|
1381
1159
|
}
|
|
1382
1160
|
/**
|
|
1383
|
-
* <p>Contains information about the domain names that you want ACM to use to send you emails
|
|
1384
|
-
* that enable you to validate domain ownership.</p>
|
|
1161
|
+
* <p>Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.</p>
|
|
1385
1162
|
* @public
|
|
1386
1163
|
*/
|
|
1387
1164
|
export interface DomainValidationOption {
|
|
@@ -1391,29 +1168,7 @@ export interface DomainValidationOption {
|
|
|
1391
1168
|
*/
|
|
1392
1169
|
DomainName: string | undefined;
|
|
1393
1170
|
/**
|
|
1394
|
-
* <p>The domain name that you want ACM to use to send you validation emails. This domain name
|
|
1395
|
-
* is the suffix of the email addresses that you want ACM to use. This must be the same as the
|
|
1396
|
-
* <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For
|
|
1397
|
-
* example, if you request a certificate for <code>testing.example.com</code>, you can specify
|
|
1398
|
-
* <code>example.com</code> for this value. In that case, ACM sends domain validation emails
|
|
1399
|
-
* to the following five addresses:</p>
|
|
1400
|
-
* <ul>
|
|
1401
|
-
* <li>
|
|
1402
|
-
* <p>admin@example.com</p>
|
|
1403
|
-
* </li>
|
|
1404
|
-
* <li>
|
|
1405
|
-
* <p>administrator@example.com</p>
|
|
1406
|
-
* </li>
|
|
1407
|
-
* <li>
|
|
1408
|
-
* <p>hostmaster@example.com</p>
|
|
1409
|
-
* </li>
|
|
1410
|
-
* <li>
|
|
1411
|
-
* <p>postmaster@example.com</p>
|
|
1412
|
-
* </li>
|
|
1413
|
-
* <li>
|
|
1414
|
-
* <p>webmaster@example.com</p>
|
|
1415
|
-
* </li>
|
|
1416
|
-
* </ul>
|
|
1171
|
+
* <p>The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you request a certificate for <code>testing.example.com</code>, you can specify <code>example.com</code> for this value. In that case, ACM sends domain validation emails to the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>
|
|
1417
1172
|
* @public
|
|
1418
1173
|
*/
|
|
1419
1174
|
ValidationDomain: string | undefined;
|
|
@@ -1423,87 +1178,37 @@ export interface DomainValidationOption {
|
|
|
1423
1178
|
*/
|
|
1424
1179
|
export interface RequestCertificateRequest {
|
|
1425
1180
|
/**
|
|
1426
|
-
* <p>Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with
|
|
1427
|
-
* an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects
|
|
1428
|
-
* several sites in the same domain. For example, *.example.com protects www.example.com,
|
|
1429
|
-
* site.example.com, and images.example.com. </p>
|
|
1430
|
-
* <p>In compliance with <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC
|
|
1431
|
-
* 5280</a>, the length of the domain name (technically, the Common Name) that you provide
|
|
1432
|
-
* cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative
|
|
1433
|
-
* Name field, which supports names up to 253 octets in length. </p>
|
|
1181
|
+
* <p>Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p>In compliance with <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length. </p>
|
|
1434
1182
|
* @public
|
|
1435
1183
|
*/
|
|
1436
1184
|
DomainName: string | undefined;
|
|
1437
1185
|
/**
|
|
1438
|
-
* <p>The method you want to use if you are requesting a public certificate to validate that you
|
|
1439
|
-
* own or control domain. You can <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">validate with DNS</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">validate with
|
|
1440
|
-
* email</a>. We recommend that you use DNS validation. </p>
|
|
1186
|
+
* <p>The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">validate with DNS</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">validate with email</a>. We recommend that you use DNS validation. </p>
|
|
1441
1187
|
* @public
|
|
1442
1188
|
*/
|
|
1443
1189
|
ValidationMethod?: ValidationMethod | undefined;
|
|
1444
1190
|
/**
|
|
1445
|
-
* <p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM
|
|
1446
|
-
* certificate. For example, add the name www.example.net to a certificate for which the
|
|
1447
|
-
* <code>DomainName</code> field is www.example.com if users can reach your site by using
|
|
1448
|
-
* either name. The maximum number of domain names that you can add to an ACM certificate is
|
|
1449
|
-
* 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must
|
|
1450
|
-
* request a quota increase. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html">Quotas</a>.</p>
|
|
1451
|
-
* <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple
|
|
1452
|
-
* labels separated by periods. No label can be longer than 63 octets. Consider the following
|
|
1453
|
-
* examples: </p>
|
|
1454
|
-
* <ul>
|
|
1455
|
-
* <li>
|
|
1456
|
-
* <p>
|
|
1457
|
-
* <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the
|
|
1458
|
-
* total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p>
|
|
1459
|
-
* </li>
|
|
1460
|
-
* <li>
|
|
1461
|
-
* <p>
|
|
1462
|
-
* <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the
|
|
1463
|
-
* total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63
|
|
1464
|
-
* octets.</p>
|
|
1465
|
-
* </li>
|
|
1466
|
-
* <li>
|
|
1467
|
-
* <p>
|
|
1468
|
-
* <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the
|
|
1469
|
-
* total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p>
|
|
1470
|
-
* </li>
|
|
1471
|
-
* </ul>
|
|
1191
|
+
* <p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html">Quotas</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>
|
|
1472
1192
|
* @public
|
|
1473
1193
|
*/
|
|
1474
1194
|
SubjectAlternativeNames?: string[] | undefined;
|
|
1475
1195
|
/**
|
|
1476
|
-
* <p>Customer chosen string that can be used to distinguish between calls to
|
|
1477
|
-
* <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if
|
|
1478
|
-
* you call <code>RequestCertificate</code> multiple times with the same idempotency token within
|
|
1479
|
-
* one hour, ACM recognizes that you are requesting only one certificate and will issue only
|
|
1480
|
-
* one. If you change the idempotency token for each call, ACM recognizes that you are
|
|
1481
|
-
* requesting multiple certificates.</p>
|
|
1196
|
+
* <p>Customer chosen string that can be used to distinguish between calls to <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>RequestCertificate</code> multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.</p>
|
|
1482
1197
|
* @public
|
|
1483
1198
|
*/
|
|
1484
1199
|
IdempotencyToken?: string | undefined;
|
|
1485
1200
|
/**
|
|
1486
|
-
* <p>The domain name that you want ACM to use to send you emails so that you can validate
|
|
1487
|
-
* domain ownership.</p>
|
|
1201
|
+
* <p>The domain name that you want ACM to use to send you emails so that you can validate domain ownership.</p>
|
|
1488
1202
|
* @public
|
|
1489
1203
|
*/
|
|
1490
1204
|
DomainValidationOptions?: DomainValidationOption[] | undefined;
|
|
1491
1205
|
/**
|
|
1492
|
-
* <p>
|
|
1493
|
-
* certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS
|
|
1494
|
-
* certificates that have been mistakenly or maliciously issued. Certificates that have not been
|
|
1495
|
-
* logged typically produce an error message in a browser. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency">Opting Out of Certificate Transparency Logging</a>.</p>
|
|
1206
|
+
* <p>You can use this parameter to specify whether to add the certificate to a certificate transparency log and export your certificate.</p> <p>Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency">Opting Out of Certificate Transparency Logging</a>.</p> <p>You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-exportable-certificates.html">Certificate Manager exportable public certificate</a>.</p>
|
|
1496
1207
|
* @public
|
|
1497
1208
|
*/
|
|
1498
1209
|
Options?: CertificateOptions | undefined;
|
|
1499
1210
|
/**
|
|
1500
|
-
* <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used
|
|
1501
|
-
* to issue the certificate. If you do not provide an ARN and you are trying to request a private
|
|
1502
|
-
* certificate, ACM will attempt to issue a public certificate. For more information about
|
|
1503
|
-
* private CAs, see the <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html">Amazon Web Services Private Certificate Authority</a> user guide. The ARN must have the following form: </p>
|
|
1504
|
-
* <p>
|
|
1505
|
-
* <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code>
|
|
1506
|
-
* </p>
|
|
1211
|
+
* <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html">Amazon Web Services Private Certificate Authority</a> user guide. The ARN must have the following form: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>
|
|
1507
1212
|
* @public
|
|
1508
1213
|
*/
|
|
1509
1214
|
CertificateAuthorityArn?: string | undefined;
|
|
@@ -1513,42 +1218,7 @@ export interface RequestCertificateRequest {
|
|
|
1513
1218
|
*/
|
|
1514
1219
|
Tags?: Tag[] | undefined;
|
|
1515
1220
|
/**
|
|
1516
|
-
* <p>Specifies the algorithm of the public and private key pair that your certificate uses to
|
|
1517
|
-
* encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital
|
|
1518
|
-
* Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but
|
|
1519
|
-
* with greater computing efficiency. However, ECDSA is not supported by all network clients.
|
|
1520
|
-
* Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size,
|
|
1521
|
-
* while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not
|
|
1522
|
-
* broken. Check the requirements for the Amazon Web Services service where you plan to deploy your
|
|
1523
|
-
* certificate. For more information about selecting an algorithm, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms">Key
|
|
1524
|
-
* algorithms</a>.</p>
|
|
1525
|
-
* <note>
|
|
1526
|
-
* <p>Algorithms supported for an ACM certificate request include: </p>
|
|
1527
|
-
* <ul>
|
|
1528
|
-
* <li>
|
|
1529
|
-
* <p>
|
|
1530
|
-
* <code>RSA_2048</code>
|
|
1531
|
-
* </p>
|
|
1532
|
-
* </li>
|
|
1533
|
-
* <li>
|
|
1534
|
-
* <p>
|
|
1535
|
-
* <code>EC_prime256v1</code>
|
|
1536
|
-
* </p>
|
|
1537
|
-
* </li>
|
|
1538
|
-
* <li>
|
|
1539
|
-
* <p>
|
|
1540
|
-
* <code>EC_secp384r1</code>
|
|
1541
|
-
* </p>
|
|
1542
|
-
* </li>
|
|
1543
|
-
* </ul>
|
|
1544
|
-
* <p>Other listed algorithms are for imported certificates only. </p>
|
|
1545
|
-
* </note>
|
|
1546
|
-
* <note>
|
|
1547
|
-
* <p>When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the
|
|
1548
|
-
* specified signing algorithm family (RSA or ECDSA) must match the algorithm family of
|
|
1549
|
-
* the CA's secret key.</p>
|
|
1550
|
-
* </note>
|
|
1551
|
-
* <p>Default: RSA_2048</p>
|
|
1221
|
+
* <p>Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms">Key algorithms</a>.</p> <note> <p>Algorithms supported for an ACM certificate request include: </p> <ul> <li> <p> <code>RSA_2048</code> </p> </li> <li> <p> <code>EC_prime256v1</code> </p> </li> <li> <p> <code>EC_secp384r1</code> </p> </li> </ul> <p>Other listed algorithms are for imported certificates only. </p> </note> <note> <p>When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.</p> </note> <p>Default: RSA_2048</p>
|
|
1552
1222
|
* @public
|
|
1553
1223
|
*/
|
|
1554
1224
|
KeyAlgorithm?: KeyAlgorithm | undefined;
|
|
@@ -1563,10 +1233,7 @@ export interface RequestCertificateRequest {
|
|
|
1563
1233
|
*/
|
|
1564
1234
|
export interface RequestCertificateResponse {
|
|
1565
1235
|
/**
|
|
1566
|
-
* <p>String that contains the ARN of the issued certificate. This must be of the form:</p>
|
|
1567
|
-
* <p>
|
|
1568
|
-
* <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
1569
|
-
* </p>
|
|
1236
|
+
* <p>String that contains the ARN of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>
|
|
1570
1237
|
* @public
|
|
1571
1238
|
*/
|
|
1572
1239
|
CertificateArn?: string | undefined;
|
|
@@ -1588,68 +1255,57 @@ export declare class InvalidStateException extends __BaseException {
|
|
|
1588
1255
|
*/
|
|
1589
1256
|
export interface ResendValidationEmailRequest {
|
|
1590
1257
|
/**
|
|
1591
|
-
* <p>String that contains the ARN of the requested certificate. The certificate ARN is
|
|
1592
|
-
* generated and returned by the <a>RequestCertificate</a> action as soon as the
|
|
1593
|
-
* request is made. By default, using this parameter causes email to be sent to all top-level
|
|
1594
|
-
* domains you specified in the certificate request. The ARN must be of the form: </p>
|
|
1595
|
-
* <p>
|
|
1596
|
-
* <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code>
|
|
1597
|
-
* </p>
|
|
1258
|
+
* <p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: </p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>
|
|
1598
1259
|
* @public
|
|
1599
1260
|
*/
|
|
1600
1261
|
CertificateArn: string | undefined;
|
|
1601
1262
|
/**
|
|
1602
|
-
* <p>The fully qualified domain name (FQDN) of the certificate that needs to be
|
|
1603
|
-
* validated.</p>
|
|
1263
|
+
* <p>The fully qualified domain name (FQDN) of the certificate that needs to be validated.</p>
|
|
1604
1264
|
* @public
|
|
1605
1265
|
*/
|
|
1606
1266
|
Domain: string | undefined;
|
|
1607
1267
|
/**
|
|
1608
|
-
* <p>The base validation domain that will act as the suffix of the email addresses that are
|
|
1609
|
-
* used to send the emails. This must be the same as the <code>Domain</code> value or a
|
|
1610
|
-
* superdomain of the <code>Domain</code> value. For example, if you requested a certificate for
|
|
1611
|
-
* <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the
|
|
1612
|
-
* domain registrant, technical contact, and administrative contact in WHOIS and the following
|
|
1613
|
-
* five addresses:</p>
|
|
1614
|
-
* <ul>
|
|
1615
|
-
* <li>
|
|
1616
|
-
* <p>admin@subdomain.example.com</p>
|
|
1617
|
-
* </li>
|
|
1618
|
-
* <li>
|
|
1619
|
-
* <p>administrator@subdomain.example.com</p>
|
|
1620
|
-
* </li>
|
|
1621
|
-
* <li>
|
|
1622
|
-
* <p>hostmaster@subdomain.example.com</p>
|
|
1623
|
-
* </li>
|
|
1624
|
-
* <li>
|
|
1625
|
-
* <p>postmaster@subdomain.example.com</p>
|
|
1626
|
-
* </li>
|
|
1627
|
-
* <li>
|
|
1628
|
-
* <p>webmaster@subdomain.example.com</p>
|
|
1629
|
-
* </li>
|
|
1630
|
-
* </ul>
|
|
1268
|
+
* <p>The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>
|
|
1631
1269
|
* @public
|
|
1632
1270
|
*/
|
|
1633
1271
|
ValidationDomain: string | undefined;
|
|
1634
1272
|
}
|
|
1273
|
+
/**
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
export interface RevokeCertificateRequest {
|
|
1277
|
+
/**
|
|
1278
|
+
* <p>The Amazon Resource Name (ARN) of the public or private certificate that will be revoked. The ARN must have the following form: </p> <p> <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code> </p>
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
CertificateArn: string | undefined;
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>Specifies why you revoked the certificate.</p>
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
RevocationReason: RevocationReason | undefined;
|
|
1287
|
+
}
|
|
1288
|
+
/**
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
export interface RevokeCertificateResponse {
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>The Amazon Resource Name (ARN) of the public or private certificate that was revoked.</p>
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
CertificateArn?: string | undefined;
|
|
1297
|
+
}
|
|
1635
1298
|
/**
|
|
1636
1299
|
* @public
|
|
1637
1300
|
*/
|
|
1638
1301
|
export interface UpdateCertificateOptionsRequest {
|
|
1639
1302
|
/**
|
|
1640
|
-
* <p>ARN of the requested certificate to update. This must be of the form:</p>
|
|
1641
|
-
* <p>
|
|
1642
|
-
* <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i>
|
|
1643
|
-
* </code>
|
|
1644
|
-
* </p>
|
|
1303
|
+
* <p>ARN of the requested certificate to update. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>
|
|
1645
1304
|
* @public
|
|
1646
1305
|
*/
|
|
1647
1306
|
CertificateArn: string | undefined;
|
|
1648
1307
|
/**
|
|
1649
|
-
* <p>Use to update the options for your certificate. Currently, you can specify whether to add
|
|
1650
|
-
* your certificate to a transparency log. Certificate transparency makes it possible to detect
|
|
1651
|
-
* SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have
|
|
1652
|
-
* not been logged typically produce an error message in a browser. </p>
|
|
1308
|
+
* <p>Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log or export your certificate. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. </p>
|
|
1653
1309
|
* @public
|
|
1654
1310
|
*/
|
|
1655
1311
|
Options: CertificateOptions | undefined;
|