acm.d.ts
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 {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class ACM extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: ACM.Types.ClientConfiguration) 14 config: Config & ACM.Types.ClientConfiguration; 15 /** 16 * Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services 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. 17 */ 18 addTagsToCertificate(params: ACM.Types.AddTagsToCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 19 /** 20 * Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services 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. 21 */ 22 addTagsToCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 23 /** 24 * Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list 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 Amazon Web Services services integrated with ACM. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed. 25 */ 26 deleteCertificate(params: ACM.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 27 /** 28 * Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list 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 Amazon Web Services services integrated with ACM. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed. 29 */ 30 deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 31 /** 32 * Returns detailed metadata about the specified ACM certificate. 33 */ 34 describeCertificate(params: ACM.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>; 35 /** 36 * Returns detailed metadata about the specified ACM certificate. 37 */ 38 describeCertificate(callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>; 39 /** 40 * Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate. 41 */ 42 exportCertificate(params: ACM.Types.ExportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ExportCertificateResponse) => void): Request<ACM.Types.ExportCertificateResponse, AWSError>; 43 /** 44 * Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate. 45 */ 46 exportCertificate(callback?: (err: AWSError, data: ACM.Types.ExportCertificateResponse) => void): Request<ACM.Types.ExportCertificateResponse, AWSError>; 47 /** 48 * Returns the account configuration options associated with an Amazon Web Services account. 49 */ 50 getAccountConfiguration(callback?: (err: AWSError, data: ACM.Types.GetAccountConfigurationResponse) => void): Request<ACM.Types.GetAccountConfigurationResponse, AWSError>; 51 /** 52 * Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields. 53 */ 54 getCertificate(params: ACM.Types.GetCertificateRequest, callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request<ACM.Types.GetCertificateResponse, AWSError>; 55 /** 56 * Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields. 57 */ 58 getCertificate(callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request<ACM.Types.GetCertificateResponse, AWSError>; 59 /** 60 * Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Amazon Web Services Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). If the certificate you are importing is not self-signed, you must enter its certificate chain. If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain. The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate. 61 */ 62 importCertificate(params: ACM.Types.ImportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request<ACM.Types.ImportCertificateResponse, AWSError>; 63 /** 64 * Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Amazon Web Services Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). If the certificate you are importing is not self-signed, you must enter its certificate chain. If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain. The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate. 65 */ 66 importCertificate(callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request<ACM.Types.ImportCertificateResponse, AWSError>; 67 /** 68 * Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters. 69 */ 70 listCertificates(params: ACM.Types.ListCertificatesRequest, callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request<ACM.Types.ListCertificatesResponse, AWSError>; 71 /** 72 * Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters. 73 */ 74 listCertificates(callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request<ACM.Types.ListCertificatesResponse, AWSError>; 75 /** 76 * Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (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. 77 */ 78 listTagsForCertificate(params: ACM.Types.ListTagsForCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request<ACM.Types.ListTagsForCertificateResponse, AWSError>; 79 /** 80 * Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (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. 81 */ 82 listTagsForCertificate(callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request<ACM.Types.ListTagsForCertificateResponse, AWSError>; 83 /** 84 * Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration. 85 */ 86 putAccountConfiguration(params: ACM.Types.PutAccountConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 87 /** 88 * Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration. 89 */ 90 putAccountConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 91 /** 92 * 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. 93 */ 94 removeTagsFromCertificate(params: ACM.Types.RemoveTagsFromCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 95 /** 96 * 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. 97 */ 98 removeTagsFromCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 99 /** 100 * Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide. 101 */ 102 renewCertificate(params: ACM.Types.RenewCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 103 /** 104 * Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide. 105 */ 106 renewCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 107 /** 108 * Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. ACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2RFC 6125 specification of the certificate validation process. first checks for a subject alternative name, and, if it finds one, ignores the common name (CN) 109 */ 110 requestCertificate(params: ACM.Types.RequestCertificateRequest, callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request<ACM.Types.RequestCertificateResponse, AWSError>; 111 /** 112 * Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. ACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2RFC 6125 specification of the certificate validation process. first checks for a subject alternative name, and, if it finds one, ignores the common name (CN) 113 */ 114 requestCertificate(callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request<ACM.Types.RequestCertificateResponse, AWSError>; 115 /** 116 * 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. For more information about setting up your contact email addresses, see Configure Email for your Domain. 117 */ 118 resendValidationEmail(params: ACM.Types.ResendValidationEmailRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 119 /** 120 * 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. For more information about setting up your contact email addresses, see Configure Email for your Domain. 121 */ 122 resendValidationEmail(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 123 /** 124 * Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging. 125 */ 126 updateCertificateOptions(params: ACM.Types.UpdateCertificateOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 127 /** 128 * Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging. 129 */ 130 updateCertificateOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 131 /** 132 * Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificateoperation every 60 seconds (at most 40 times). 133 */ 134 waitFor(state: "certificateValidated", params: ACM.Types.DescribeCertificateRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>; 135 /** 136 * Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificateoperation every 60 seconds (at most 40 times). 137 */ 138 waitFor(state: "certificateValidated", callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>; 139 } 140 declare namespace ACM { 141 export interface AddTagsToCertificateRequest { 142 /** 143 * 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). 144 */ 145 CertificateArn: Arn; 146 /** 147 * The key-value pair that defines the tag. The tag value is optional. 148 */ 149 Tags: TagList; 150 } 151 export type Arn = string; 152 export type CertificateBody = string; 153 export type CertificateBodyBlob = Buffer|Uint8Array|Blob|string; 154 export type CertificateChain = string; 155 export type CertificateChainBlob = Buffer|Uint8Array|Blob|string; 156 export interface CertificateDetail { 157 /** 158 * The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. 159 */ 160 CertificateArn?: Arn; 161 /** 162 * The fully qualified domain name for the certificate, such as www.example.com or example.com. 163 */ 164 DomainName?: DomainNameString; 165 /** 166 * 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. 167 */ 168 SubjectAlternativeNames?: DomainList; 169 /** 170 * Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED. 171 */ 172 DomainValidationOptions?: DomainValidationList; 173 /** 174 * The serial number of the certificate. 175 */ 176 Serial?: String; 177 /** 178 * The name of the entity that is associated with the public key contained in the certificate. 179 */ 180 Subject?: String; 181 /** 182 * The name of the certificate authority that issued and signed the certificate. 183 */ 184 Issuer?: String; 185 /** 186 * The time at which the certificate was requested. 187 */ 188 CreatedAt?: TStamp; 189 /** 190 * The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED. 191 */ 192 IssuedAt?: TStamp; 193 /** 194 * The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED. 195 */ 196 ImportedAt?: TStamp; 197 /** 198 * The status of the certificate. 199 */ 200 Status?: CertificateStatus; 201 /** 202 * The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED. 203 */ 204 RevokedAt?: TStamp; 205 /** 206 * The reason the certificate was revoked. This value exists only when the certificate status is REVOKED. 207 */ 208 RevocationReason?: RevocationReason; 209 /** 210 * The time before which the certificate is not valid. 211 */ 212 NotBefore?: TStamp; 213 /** 214 * The time after which the certificate is not valid. 215 */ 216 NotAfter?: TStamp; 217 /** 218 * The algorithm that was used to generate the public-private key pair. 219 */ 220 KeyAlgorithm?: KeyAlgorithm; 221 /** 222 * The algorithm that was used to sign the certificate. 223 */ 224 SignatureAlgorithm?: String; 225 /** 226 * 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. 227 */ 228 InUseBy?: InUseList; 229 /** 230 * 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 Amazon Web Services Certificate Manager User Guide. 231 */ 232 FailureReason?: FailureReason; 233 /** 234 * 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 Amazon Web Services Certificate Manager User Guide. 235 */ 236 Type?: CertificateType; 237 /** 238 * Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED. 239 */ 240 RenewalSummary?: RenewalSummary; 241 /** 242 * 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. 243 */ 244 KeyUsages?: KeyUsageList; 245 /** 246 * 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). 247 */ 248 ExtendedKeyUsages?: ExtendedKeyUsageList; 249 /** 250 * The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 251 */ 252 CertificateAuthorityArn?: Arn; 253 /** 254 * Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command. 255 */ 256 RenewalEligibility?: RenewalEligibility; 257 /** 258 * 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. 259 */ 260 Options?: CertificateOptions; 261 } 262 export interface CertificateOptions { 263 /** 264 * You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED. 265 */ 266 CertificateTransparencyLoggingPreference?: CertificateTransparencyLoggingPreference; 267 } 268 export type CertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|string; 269 export type CertificateStatuses = CertificateStatus[]; 270 export interface CertificateSummary { 271 /** 272 * 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). 273 */ 274 CertificateArn?: Arn; 275 /** 276 * Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate. 277 */ 278 DomainName?: DomainNameString; 279 } 280 export type CertificateSummaryList = CertificateSummary[]; 281 export type CertificateTransparencyLoggingPreference = "ENABLED"|"DISABLED"|string; 282 export type CertificateType = "IMPORTED"|"AMAZON_ISSUED"|"PRIVATE"|string; 283 export interface DeleteCertificateRequest { 284 /** 285 * 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). 286 */ 287 CertificateArn: Arn; 288 } 289 export interface DescribeCertificateRequest { 290 /** 291 * The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs). 292 */ 293 CertificateArn: Arn; 294 } 295 export interface DescribeCertificateResponse { 296 /** 297 * Metadata about an ACM certificate. 298 */ 299 Certificate?: CertificateDetail; 300 } 301 export type DomainList = DomainNameString[]; 302 export type DomainNameString = string; 303 export type DomainStatus = "PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string; 304 export interface DomainValidation { 305 /** 306 * A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com. 307 */ 308 DomainName: DomainNameString; 309 /** 310 * A list of email addresses that ACM used to send domain validation emails. 311 */ 312 ValidationEmails?: ValidationEmailList; 313 /** 314 * The domain name that ACM used to send domain validation emails. 315 */ 316 ValidationDomain?: DomainNameString; 317 /** 318 * The validation status of the domain name. This can be one of the following values: PENDING_VALIDATION SUCCESS FAILED 319 */ 320 ValidationStatus?: DomainStatus; 321 /** 322 * Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership. Note: 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 "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used. 323 */ 324 ResourceRecord?: ResourceRecord; 325 /** 326 * Specifies the domain validation method. 327 */ 328 ValidationMethod?: ValidationMethod; 329 } 330 export type DomainValidationList = DomainValidation[]; 331 export interface DomainValidationOption { 332 /** 333 * A fully qualified domain name (FQDN) in the certificate request. 334 */ 335 DomainName: DomainNameString; 336 /** 337 * 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 DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses: admin@example.com administrator@example.com hostmaster@example.com postmaster@example.com webmaster@example.com 338 */ 339 ValidationDomain: DomainNameString; 340 } 341 export type DomainValidationOptionList = DomainValidationOption[]; 342 export interface ExpiryEventsConfiguration { 343 /** 344 * Specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration. 345 */ 346 DaysBeforeExpiry?: PositiveInteger; 347 } 348 export interface ExportCertificateRequest { 349 /** 350 * An Amazon Resource Name (ARN) of the issued certificate. This must be of the form: arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 351 */ 352 CertificateArn: Arn; 353 /** 354 * Passphrase to associate with the encrypted exported private key. 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: openssl rsa -in encrypted_key.pem -out decrypted_key.pem 355 */ 356 Passphrase: PassphraseBlob; 357 } 358 export interface ExportCertificateResponse { 359 /** 360 * The base64 PEM-encoded certificate. 361 */ 362 Certificate?: CertificateBody; 363 /** 364 * The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting. 365 */ 366 CertificateChain?: CertificateChain; 367 /** 368 * 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. 369 */ 370 PrivateKey?: PrivateKey; 371 } 372 export interface ExtendedKeyUsage { 373 /** 374 * The name of an Extended Key Usage value. 375 */ 376 Name?: ExtendedKeyUsageName; 377 /** 378 * 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. 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION) 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION) 1.3.6.1.5.5.7.3.3 (CODE_SIGNING) 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION) 1.3.6.1.5.5.7.3.8 (TIME_STAMPING) 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING) 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM) 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL) 1.3.6.1.5.5.7.3.7 (IPSEC_USER) 379 */ 380 OID?: String; 381 } 382 export type ExtendedKeyUsageFilterList = ExtendedKeyUsageName[]; 383 export type ExtendedKeyUsageList = ExtendedKeyUsage[]; 384 export type ExtendedKeyUsageName = "TLS_WEB_SERVER_AUTHENTICATION"|"TLS_WEB_CLIENT_AUTHENTICATION"|"CODE_SIGNING"|"EMAIL_PROTECTION"|"TIME_STAMPING"|"OCSP_SIGNING"|"IPSEC_END_SYSTEM"|"IPSEC_TUNNEL"|"IPSEC_USER"|"ANY"|"NONE"|"CUSTOM"|string; 385 export type FailureReason = "NO_AVAILABLE_CONTACTS"|"ADDITIONAL_VERIFICATION_REQUIRED"|"DOMAIN_NOT_ALLOWED"|"INVALID_PUBLIC_DOMAIN"|"DOMAIN_VALIDATION_DENIED"|"CAA_ERROR"|"PCA_LIMIT_EXCEEDED"|"PCA_INVALID_ARN"|"PCA_INVALID_STATE"|"PCA_REQUEST_FAILED"|"PCA_NAME_CONSTRAINTS_VALIDATION"|"PCA_RESOURCE_NOT_FOUND"|"PCA_INVALID_ARGS"|"PCA_INVALID_DURATION"|"PCA_ACCESS_DENIED"|"SLR_NOT_FOUND"|"OTHER"|string; 386 export interface Filters { 387 /** 388 * Specify one or more ExtendedKeyUsage extension values. 389 */ 390 extendedKeyUsage?: ExtendedKeyUsageFilterList; 391 /** 392 * Specify one or more KeyUsage extension values. 393 */ 394 keyUsage?: KeyUsageFilterList; 395 /** 396 * Specify one or more algorithms that can be used to generate key pairs. Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates. 397 */ 398 keyTypes?: KeyAlgorithmList; 399 } 400 export interface GetAccountConfigurationResponse { 401 /** 402 * Expiration events configuration options associated with the Amazon Web Services account. 403 */ 404 ExpiryEvents?: ExpiryEventsConfiguration; 405 } 406 export interface GetCertificateRequest { 407 /** 408 * 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). 409 */ 410 CertificateArn: Arn; 411 } 412 export interface GetCertificateResponse { 413 /** 414 * The ACM-issued certificate corresponding to the ARN specified as input. 415 */ 416 Certificate?: CertificateBody; 417 /** 418 * 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. 419 */ 420 CertificateChain?: CertificateChain; 421 } 422 export type IdempotencyToken = string; 423 export interface ImportCertificateRequest { 424 /** 425 * The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field. 426 */ 427 CertificateArn?: Arn; 428 /** 429 * The certificate to import. 430 */ 431 Certificate: CertificateBodyBlob; 432 /** 433 * The private key that matches the public key in the certificate. 434 */ 435 PrivateKey: PrivateKeyBlob; 436 /** 437 * The PEM encoded certificate chain. 438 */ 439 CertificateChain?: CertificateChainBlob; 440 /** 441 * One or more resource tags to associate with the imported certificate. Note: You cannot apply tags when reimporting a certificate. 442 */ 443 Tags?: TagList; 444 } 445 export interface ImportCertificateResponse { 446 /** 447 * The Amazon Resource Name (ARN) of the imported certificate. 448 */ 449 CertificateArn?: Arn; 450 } 451 export type InUseList = String[]; 452 export type KeyAlgorithm = "RSA_1024"|"RSA_2048"|"RSA_3072"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"EC_secp521r1"|string; 453 export type KeyAlgorithmList = KeyAlgorithm[]; 454 export interface KeyUsage { 455 /** 456 * A string value that contains a Key Usage extension name. 457 */ 458 Name?: KeyUsageName; 459 } 460 export type KeyUsageFilterList = KeyUsageName[]; 461 export type KeyUsageList = KeyUsage[]; 462 export type KeyUsageName = "DIGITAL_SIGNATURE"|"NON_REPUDIATION"|"KEY_ENCIPHERMENT"|"DATA_ENCIPHERMENT"|"KEY_AGREEMENT"|"CERTIFICATE_SIGNING"|"CRL_SIGNING"|"ENCIPHER_ONLY"|"DECIPHER_ONLY"|"ANY"|"CUSTOM"|string; 463 export interface ListCertificatesRequest { 464 /** 465 * Filter the certificate list by status value. 466 */ 467 CertificateStatuses?: CertificateStatuses; 468 /** 469 * Filter the certificate list. For more information, see the Filters structure. 470 */ 471 Includes?: Filters; 472 /** 473 * 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. 474 */ 475 NextToken?: NextToken; 476 /** 477 * 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. 478 */ 479 MaxItems?: MaxItems; 480 } 481 export interface ListCertificatesResponse { 482 /** 483 * When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request. 484 */ 485 NextToken?: NextToken; 486 /** 487 * A list of ACM certificates. 488 */ 489 CertificateSummaryList?: CertificateSummaryList; 490 } 491 export interface ListTagsForCertificateRequest { 492 /** 493 * String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs). 494 */ 495 CertificateArn: Arn; 496 } 497 export interface ListTagsForCertificateResponse { 498 /** 499 * The key-value pairs that define the applied tags. 500 */ 501 Tags?: TagList; 502 } 503 export type MaxItems = number; 504 export type NextToken = string; 505 export type PassphraseBlob = Buffer|Uint8Array|Blob|string; 506 export type PositiveInteger = number; 507 export type PrivateKey = string; 508 export type PrivateKeyBlob = Buffer|Uint8Array|Blob|string; 509 export interface PutAccountConfigurationRequest { 510 /** 511 * Specifies expiration events associated with an account. 512 */ 513 ExpiryEvents?: ExpiryEventsConfiguration; 514 /** 515 * Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration 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. 516 */ 517 IdempotencyToken: IdempotencyToken; 518 } 519 export type RecordType = "CNAME"|string; 520 export interface RemoveTagsFromCertificateRequest { 521 /** 522 * 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). 523 */ 524 CertificateArn: Arn; 525 /** 526 * The key-value pair that defines the tag to remove. 527 */ 528 Tags: TagList; 529 } 530 export interface RenewCertificateRequest { 531 /** 532 * String that contains the ARN of the ACM certificate to be renewed. 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). 533 */ 534 CertificateArn: Arn; 535 } 536 export type RenewalEligibility = "ELIGIBLE"|"INELIGIBLE"|string; 537 export type RenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string; 538 export interface RenewalSummary { 539 /** 540 * The status of ACM's managed renewal of the certificate. 541 */ 542 RenewalStatus: RenewalStatus; 543 /** 544 * Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED. 545 */ 546 DomainValidationOptions: DomainValidationList; 547 /** 548 * The reason that a renewal request was unsuccessful. 549 */ 550 RenewalStatusReason?: FailureReason; 551 /** 552 * The time at which the renewal summary was last updated. 553 */ 554 UpdatedAt: TStamp; 555 } 556 export interface RequestCertificateRequest { 557 /** 558 * 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. The first domain name you enter cannot exceed 64 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. 559 */ 560 DomainName: DomainNameString; 561 /** 562 * The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation. 563 */ 564 ValidationMethod?: ValidationMethod; 565 /** 566 * 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. 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 Quotas. 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: (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets. 567 */ 568 SubjectAlternativeNames?: DomainList; 569 /** 570 * 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. 571 */ 572 IdempotencyToken?: IdempotencyToken; 573 /** 574 * The domain name that you want ACM to use to send you emails so that you can validate domain ownership. 575 */ 576 DomainValidationOptions?: DomainValidationOptionList; 577 /** 578 * Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. 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 Opting Out of Certificate Transparency Logging. 579 */ 580 Options?: CertificateOptions; 581 /** 582 * 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 Amazon Web Services Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 583 */ 584 CertificateAuthorityArn?: Arn; 585 /** 586 * One or more resource tags to associate with the certificate. 587 */ 588 Tags?: TagList; 589 } 590 export interface RequestCertificateResponse { 591 /** 592 * 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 593 */ 594 CertificateArn?: Arn; 595 } 596 export interface ResendValidationEmailRequest { 597 /** 598 * 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 599 */ 600 CertificateArn: Arn; 601 /** 602 * The fully qualified domain name (FQDN) of the certificate that needs to be validated. 603 */ 604 Domain: DomainNameString; 605 /** 606 * 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 607 */ 608 ValidationDomain: DomainNameString; 609 } 610 export interface ResourceRecord { 611 /** 612 * The name of the DNS record to create in your domain. This is supplied by ACM. 613 */ 614 Name: String; 615 /** 616 * The type of DNS record. Currently this can be CNAME. 617 */ 618 Type: RecordType; 619 /** 620 * The value of the CNAME record to add to your DNS database. This is supplied by ACM. 621 */ 622 Value: String; 623 } 624 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; 625 export type String = string; 626 export type TStamp = Date; 627 export interface Tag { 628 /** 629 * The key of the tag. 630 */ 631 Key: TagKey; 632 /** 633 * The value of the tag. 634 */ 635 Value?: TagValue; 636 } 637 export type TagKey = string; 638 export type TagList = Tag[]; 639 export type TagValue = string; 640 export interface UpdateCertificateOptionsRequest { 641 /** 642 * ARN of the requested certificate to update. This must be of the form: arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 643 */ 644 CertificateArn: Arn; 645 /** 646 * Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. 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. 647 */ 648 Options: CertificateOptions; 649 } 650 export type ValidationEmailList = String[]; 651 export type ValidationMethod = "EMAIL"|"DNS"|string; 652 /** 653 * 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. 654 */ 655 export type apiVersion = "2015-12-08"|"latest"|string; 656 export interface ClientApiVersions { 657 /** 658 * 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. 659 */ 660 apiVersion?: apiVersion; 661 } 662 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 663 /** 664 * Contains interfaces for use with the ACM client. 665 */ 666 export import Types = ACM; 667 } 668 export = ACM;