acm.d.ts (32090B)
1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare class ACM extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: ACM.Types.ClientConfiguration)
13 config: Config & ACM.Types.ClientConfiguration;
14 /**
15 * Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM Certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
16 */
17 addTagsToCertificate(params: ACM.Types.AddTagsToCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
18 /**
19 * Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM Certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
20 */
21 addTagsToCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
22 /**
23 * Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by other AWS services. You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
24 */
25 deleteCertificate(params: ACM.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
26 /**
27 * Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by other AWS services. You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
28 */
29 deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
30 /**
31 * Returns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).
32 */
33 describeCertificate(params: ACM.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>;
34 /**
35 * Returns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).
36 */
37 describeCertificate(callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>;
38 /**
39 * Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL. Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.
40 */
41 getCertificate(params: ACM.Types.GetCertificateRequest, callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request<ACM.Types.GetCertificateResponse, AWSError>;
42 /**
43 * Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL. Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.
44 */
45 getCertificate(callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request<ACM.Types.GetCertificateResponse, AWSError>;
46 /**
47 * Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services. ACM does not provide managed renewal for certificates that you import. For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide. To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate. The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide. To import a new certificate, omit the CertificateArn field. Include this field only when you want to replace a previously imported certificate. This operation returns the Amazon Resource Name (ARN) of the imported certificate.
48 */
49 importCertificate(params: ACM.Types.ImportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request<ACM.Types.ImportCertificateResponse, AWSError>;
50 /**
51 * Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services. ACM does not provide managed renewal for certificates that you import. For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide. To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate. The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide. To import a new certificate, omit the CertificateArn field. Include this field only when you want to replace a previously imported certificate. This operation returns the Amazon Resource Name (ARN) of the imported certificate.
52 */
53 importCertificate(callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request<ACM.Types.ImportCertificateResponse, AWSError>;
54 /**
55 * Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
56 */
57 listCertificates(params: ACM.Types.ListCertificatesRequest, callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request<ACM.Types.ListCertificatesResponse, AWSError>;
58 /**
59 * Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
60 */
61 listCertificates(callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request<ACM.Types.ListCertificatesResponse, AWSError>;
62 /**
63 * Lists the tags that have been applied to the ACM Certificate. Use the certificate ARN to specify the certificate. To add a tag to an ACM Certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
64 */
65 listTagsForCertificate(params: ACM.Types.ListTagsForCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request<ACM.Types.ListTagsForCertificateResponse, AWSError>;
66 /**
67 * Lists the tags that have been applied to the ACM Certificate. Use the certificate ARN to specify the certificate. To add a tag to an ACM Certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
68 */
69 listTagsForCertificate(callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request<ACM.Types.ListTagsForCertificateResponse, AWSError>;
70 /**
71 * Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM Certificate, use the ListTagsForCertificate action.
72 */
73 removeTagsFromCertificate(params: ACM.Types.RemoveTagsFromCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74 /**
75 * Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM Certificate, use the ListTagsForCertificate action.
76 */
77 removeTagsFromCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.
80 */
81 requestCertificate(params: ACM.Types.RequestCertificateRequest, callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request<ACM.Types.RequestCertificateResponse, AWSError>;
82 /**
83 * Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.
84 */
85 requestCertificate(callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request<ACM.Types.RequestCertificateResponse, AWSError>;
86 /**
87 * Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate.
88 */
89 resendValidationEmail(params: ACM.Types.ResendValidationEmailRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90 /**
91 * Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate.
92 */
93 resendValidationEmail(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
94 }
95 declare namespace ACM.Types {
96 export interface AddTagsToCertificateRequest {
97 /**
98 * String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
99 */
100 CertificateArn: Arn;
101 /**
102 * The key-value pair that defines the tag. The tag value is optional.
103 */
104 Tags: TagList;
105 }
106 export type Arn = string;
107 export type CertificateBody = string;
108 export type CertificateBodyBlob = Buffer|Uint8Array|Blob|string;
109 export type CertificateChain = string;
110 export type CertificateChainBlob = Buffer|Uint8Array|Blob|string;
111 export interface CertificateDetail {
112 /**
113 * The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
114 */
115 CertificateArn?: Arn;
116 /**
117 * The fully qualified domain name for the certificate, such as www.example.com or example.com.
118 */
119 DomainName?: DomainNameString;
120 /**
121 * 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.
122 */
123 SubjectAlternativeNames?: DomainList;
124 /**
125 * Contains information about the email address or addresses used for domain validation. This field exists only when the certificate type is AMAZON_ISSUED.
126 */
127 DomainValidationOptions?: DomainValidationList;
128 /**
129 * The serial number of the certificate.
130 */
131 Serial?: String;
132 /**
133 * The name of the entity that is associated with the public key contained in the certificate.
134 */
135 Subject?: String;
136 /**
137 * The name of the certificate authority that issued and signed the certificate.
138 */
139 Issuer?: String;
140 /**
141 * The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.
142 */
143 CreatedAt?: TStamp;
144 /**
145 * The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
146 */
147 IssuedAt?: TStamp;
148 /**
149 * The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.
150 */
151 ImportedAt?: TStamp;
152 /**
153 * The status of the certificate.
154 */
155 Status?: CertificateStatus;
156 /**
157 * The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
158 */
159 RevokedAt?: TStamp;
160 /**
161 * The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
162 */
163 RevocationReason?: RevocationReason;
164 /**
165 * The time before which the certificate is not valid.
166 */
167 NotBefore?: TStamp;
168 /**
169 * The time after which the certificate is not valid.
170 */
171 NotAfter?: TStamp;
172 /**
173 * The algorithm that was used to generate the key pair (the public and private key).
174 */
175 KeyAlgorithm?: KeyAlgorithm;
176 /**
177 * The algorithm that was used to sign the certificate.
178 */
179 SignatureAlgorithm?: String;
180 /**
181 * A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
182 */
183 InUseBy?: InUseList;
184 /**
185 * The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide.
186 */
187 FailureReason?: FailureReason;
188 /**
189 * The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
190 */
191 Type?: CertificateType;
192 }
193 export type CertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|string;
194 export type CertificateStatuses = CertificateStatus[];
195 export interface CertificateSummary {
196 /**
197 * Amazon Resource Name (ARN) of the certificate. This is of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
198 */
199 CertificateArn?: Arn;
200 /**
201 * Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
202 */
203 DomainName?: DomainNameString;
204 }
205 export type CertificateSummaryList = CertificateSummary[];
206 export type CertificateType = "IMPORTED"|"AMAZON_ISSUED"|string;
207 export interface DeleteCertificateRequest {
208 /**
209 * String that contains the ARN of the ACM Certificate to be deleted. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
210 */
211 CertificateArn: Arn;
212 }
213 export interface DescribeCertificateRequest {
214 /**
215 * String that contains an ACM Certificate ARN. The ARN must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
216 */
217 CertificateArn: Arn;
218 }
219 export interface DescribeCertificateResponse {
220 /**
221 * Contains a CertificateDetail structure that lists the fields of an ACM Certificate.
222 */
223 Certificate?: CertificateDetail;
224 }
225 export type DomainList = DomainNameString[];
226 export type DomainNameString = string;
227 export interface DomainValidation {
228 /**
229 * Fully Qualified Domain Name (FQDN) of the form www.example.com or example.com.
230 */
231 DomainName: DomainNameString;
232 /**
233 * A list of contact address for the domain registrant.
234 */
235 ValidationEmails?: ValidationEmailList;
236 /**
237 * The base validation domain that acts as the suffix of the email addresses that are used to send the emails.
238 */
239 ValidationDomain?: DomainNameString;
240 }
241 export type DomainValidationList = DomainValidation[];
242 export interface DomainValidationOption {
243 /**
244 * Fully Qualified Domain Name (FQDN) of the certificate being requested.
245 */
246 DomainName: DomainNameString;
247 /**
248 * The domain to which validation email is sent. This is the base validation domain that will act as the suffix of the email addresses. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS for the base domain and the following five addresses: admin@subdomain.example.com administrator@subdomain.example.com hostmaster@subdomain.example.com postmaster@subdomain.example.com webmaster@subdomain.example.com
249 */
250 ValidationDomain: DomainNameString;
251 }
252 export type DomainValidationOptionList = DomainValidationOption[];
253 export type FailureReason = "NO_AVAILABLE_CONTACTS"|"ADDITIONAL_VERIFICATION_REQUIRED"|"DOMAIN_NOT_ALLOWED"|"INVALID_PUBLIC_DOMAIN"|"OTHER"|string;
254 export interface GetCertificateRequest {
255 /**
256 * String that contains a certificate ARN in the following format: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
257 */
258 CertificateArn: Arn;
259 }
260 export interface GetCertificateResponse {
261 /**
262 * String that contains the ACM Certificate represented by the ARN specified at input.
263 */
264 Certificate?: CertificateBody;
265 /**
266 * The certificate chain that contains the root certificate issued by the certificate authority (CA).
267 */
268 CertificateChain?: CertificateChain;
269 }
270 export type IdempotencyToken = string;
271 export interface ImportCertificateRequest {
272 /**
273 * The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
274 */
275 CertificateArn?: Arn;
276 /**
277 * The certificate to import. It must meet the following requirements: Must be PEM-encoded. Must contain a 1024-bit or 2048-bit RSA public key. Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's NotBefore date) or after it expires (the certificate's NotAfter date).
278 */
279 Certificate: CertificateBodyBlob;
280 /**
281 * The private key that matches the public key in the certificate. It must meet the following requirements: Must be PEM-encoded. Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.
282 */
283 PrivateKey: PrivateKeyBlob;
284 /**
285 * The certificate chain. It must be PEM-encoded.
286 */
287 CertificateChain?: CertificateChainBlob;
288 }
289 export interface ImportCertificateResponse {
290 /**
291 * The Amazon Resource Name (ARN) of the imported certificate.
292 */
293 CertificateArn?: Arn;
294 }
295 export type InUseList = String[];
296 export type KeyAlgorithm = "RSA_2048"|"RSA_1024"|"EC_prime256v1"|string;
297 export interface ListCertificatesRequest {
298 /**
299 * The status or statuses on which to filter the list of ACM Certificates.
300 */
301 CertificateStatuses?: CertificateStatuses;
302 /**
303 * 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 NextToken from the response you just received.
304 */
305 NextToken?: NextToken;
306 /**
307 * 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 NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
308 */
309 MaxItems?: MaxItems;
310 }
311 export interface ListCertificatesResponse {
312 /**
313 * When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.
314 */
315 NextToken?: NextToken;
316 /**
317 * A list of ACM Certificates.
318 */
319 CertificateSummaryList?: CertificateSummaryList;
320 }
321 export interface ListTagsForCertificateRequest {
322 /**
323 * String that contains the ARN of the ACM Certificate for which you want to list the tags. This must be of the form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
324 */
325 CertificateArn: Arn;
326 }
327 export interface ListTagsForCertificateResponse {
328 /**
329 * The key-value pairs that define the applied tags.
330 */
331 Tags?: TagList;
332 }
333 export type MaxItems = number;
334 export type NextToken = string;
335 export type PrivateKeyBlob = Buffer|Uint8Array|Blob|string;
336 export interface RemoveTagsFromCertificateRequest {
337 /**
338 * 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: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
339 */
340 CertificateArn: Arn;
341 /**
342 * The key-value pair that defines the tag to remove.
343 */
344 Tags: TagList;
345 }
346 export interface RequestCertificateRequest {
347 /**
348 * Fully qualified domain name (FQDN), such as www.example.com, of the site 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.
349 */
350 DomainName: DomainNameString;
351 /**
352 * 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 DomainName field is www.example.com if users can reach your site by using either name.
353 */
354 SubjectAlternativeNames?: DomainList;
355 /**
356 * Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate 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.
357 */
358 IdempotencyToken?: IdempotencyToken;
359 /**
360 * 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 Domain value or a superdomain of the Domain value. For example, if you requested a certificate for test.example.com and specify DomainValidationOptions of example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses: admin@example.com administrator@example.com hostmaster@example.com postmaster@example.com webmaster@example.com
361 */
362 DomainValidationOptions?: DomainValidationOptionList;
363 }
364 export interface RequestCertificateResponse {
365 /**
366 * String that contains the ARN of the issued certificate. This must be of the form: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
367 */
368 CertificateArn?: Arn;
369 }
370 export interface ResendValidationEmailRequest {
371 /**
372 * String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate 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: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
373 */
374 CertificateArn: Arn;
375 /**
376 * The Fully Qualified Domain Name (FQDN) of the certificate that needs to be validated.
377 */
378 Domain: DomainNameString;
379 /**
380 * 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 Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses: admin@subdomain.example.com administrator@subdomain.example.com hostmaster@subdomain.example.com postmaster@subdomain.example.com webmaster@subdomain.example.com
381 */
382 ValidationDomain: DomainNameString;
383 }
384 export type RevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CA_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERCEDED"|"CESSATION_OF_OPERATION"|"CERTIFICATE_HOLD"|"REMOVE_FROM_CRL"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"|string;
385 export type String = string;
386 export type TStamp = Date;
387 export interface Tag {
388 /**
389 * The key of the tag.
390 */
391 Key: TagKey;
392 /**
393 * The value of the tag.
394 */
395 Value?: TagValue;
396 }
397 export type TagKey = string;
398 export type TagList = Tag[];
399 export type TagValue = string;
400 export type ValidationEmailList = String[];
401 /**
402 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
403 */
404 export type apiVersion = "2015-12-08"|"latest"|string;
405 export interface ClientApiVersions {
406 /**
407 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
408 */
409 apiVersion?: apiVersion;
410 }
411 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
412 }
413 export = ACM;