You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ACM

Inherits:
AWS.Service show all
Identifier:
acm
API Version:
2015-12-08
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Amazon Web Services Certificate Manager User Guide.

Sending a Request Using ACM

var acm = new AWS.ACM();
acm.addTagsToCertificate(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ACM object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var acm = new AWS.ACM({apiVersion: '2015-12-08'});

You can also set the API version globally in AWS.config.apiVersions using the acm service identifier:

AWS.config.apiVersions = {
  acm: '2015-12-08',
  // other service API versions
};

var acm = new AWS.ACM();

Version:

  • 2015-12-08

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

certificateValidated

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.ACM(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ACM object

var acm = new AWS.ACM({apiVersion: '2015-12-08'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.ACM.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.ACM.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ACM.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addTagsToCertificate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the addTagsToCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
acm.addTagsToCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

    • Tags — (Array<map>)

      The key-value pair that defines the tag. The tag value is optional.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCertificate(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

Calling the deleteCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.deleteCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeCertificate(params = {}, callback) ⇒ AWS.Request

Returns detailed metadata about the specified ACM certificate.

Service Reference:

Examples:

Calling the describeCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.describeCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Certificate — (map)

        Metadata about an ACM certificate.

        • CertificateArn — (String)

          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.

        • DomainName — (String)

          The fully qualified domain name for the certificate, such as www.example.com or example.com.

        • SubjectAlternativeNames — (Array<String>)

          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.

        • DomainValidationOptions — (Array<map>)

          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.

          • DomainName — required — (String)

            A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

          • ValidationEmails — (Array<String>)

            A list of email addresses that ACM used to send domain validation emails.

          • ValidationDomain — (String)

            The domain name that ACM used to send domain validation emails.

          • ValidationStatus — (String)

            The validation status of the domain name. This can be one of the following values:

            • PENDING_VALIDATION

            • SUCCESS

            • FAILED

            Possible values include:
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
          • ResourceRecord — (map)

            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.

            • Name — required — (String)

              The name of the DNS record to create in your domain. This is supplied by ACM.

            • Type — required — (String)

              The type of DNS record. Currently this can be CNAME.

              Possible values include:
              • "CNAME"
            • Value — required — (String)

              The value of the CNAME record to add to your DNS database. This is supplied by ACM.

          • ValidationMethod — (String)

            Specifies the domain validation method.

            Possible values include:
            • "EMAIL"
            • "DNS"
        • Serial — (String)

          The serial number of the certificate.

        • Subject — (String)

          The name of the entity that is associated with the public key contained in the certificate.

        • Issuer — (String)

          The name of the certificate authority that issued and signed the certificate.

        • CreatedAt — (Date)

          The time at which the certificate was requested.

        • IssuedAt — (Date)

          The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

        • ImportedAt — (Date)

          The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.

        • Status — (String)

          The status of the certificate.

          Possible values include:
          • "PENDING_VALIDATION"
          • "ISSUED"
          • "INACTIVE"
          • "EXPIRED"
          • "VALIDATION_TIMED_OUT"
          • "REVOKED"
          • "FAILED"
        • RevokedAt — (Date)

          The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

        • RevocationReason — (String)

          The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

          Possible values include:
          • "UNSPECIFIED"
          • "KEY_COMPROMISE"
          • "CA_COMPROMISE"
          • "AFFILIATION_CHANGED"
          • "SUPERCEDED"
          • "CESSATION_OF_OPERATION"
          • "CERTIFICATE_HOLD"
          • "REMOVE_FROM_CRL"
          • "PRIVILEGE_WITHDRAWN"
          • "A_A_COMPROMISE"
        • NotBefore — (Date)

          The time before which the certificate is not valid.

        • NotAfter — (Date)

          The time after which the certificate is not valid.

        • KeyAlgorithm — (String)

          The algorithm that was used to generate the public-private key pair.

          Possible values include:
          • "RSA_1024"
          • "RSA_2048"
          • "RSA_3072"
          • "RSA_4096"
          • "EC_prime256v1"
          • "EC_secp384r1"
          • "EC_secp521r1"
        • SignatureAlgorithm — (String)

          The algorithm that was used to sign the certificate.

        • InUseBy — (Array<String>)

          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.

        • FailureReason — (String)

          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.

          Possible values include:
          • "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"
        • Type — (String)

          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.

          Possible values include:
          • "IMPORTED"
          • "AMAZON_ISSUED"
          • "PRIVATE"
        • RenewalSummary — (map)

          Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

          • RenewalStatus — required — (String)

            The status of ACM's managed renewal of the certificate.

            Possible values include:
            • "PENDING_AUTO_RENEWAL"
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
          • DomainValidationOptions — required — (Array<map>)

            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.

            • DomainName — required — (String)

              A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

            • ValidationEmails — (Array<String>)

              A list of email addresses that ACM used to send domain validation emails.

            • ValidationDomain — (String)

              The domain name that ACM used to send domain validation emails.

            • ValidationStatus — (String)

              The validation status of the domain name. This can be one of the following values:

              • PENDING_VALIDATION

              • SUCCESS

              • FAILED

              Possible values include:
              • "PENDING_VALIDATION"
              • "SUCCESS"
              • "FAILED"
            • ResourceRecord — (map)

              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.

              • Name — required — (String)

                The name of the DNS record to create in your domain. This is supplied by ACM.

              • Type — required — (String)

                The type of DNS record. Currently this can be CNAME.

                Possible values include:
                • "CNAME"
              • Value — required — (String)

                The value of the CNAME record to add to your DNS database. This is supplied by ACM.

            • ValidationMethod — (String)

              Specifies the domain validation method.

              Possible values include:
              • "EMAIL"
              • "DNS"
          • RenewalStatusReason — (String)

            The reason that a renewal request was unsuccessful.

            Possible values include:
            • "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"
          • UpdatedAt — required — (Date)

            The time at which the renewal summary was last updated.

        • KeyUsages — (Array<map>)

          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.

          • Name — (String)

            A string value that contains a Key Usage extension name.

            Possible values include:
            • "DIGITAL_SIGNATURE"
            • "NON_REPUDIATION"
            • "KEY_ENCIPHERMENT"
            • "DATA_ENCIPHERMENT"
            • "KEY_AGREEMENT"
            • "CERTIFICATE_SIGNING"
            • "CRL_SIGNING"
            • "ENCIPHER_ONLY"
            • "DECIPHER_ONLY"
            • "ANY"
            • "CUSTOM"
        • ExtendedKeyUsages — (Array<map>)

          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).

          • Name — (String)

            The name of an Extended Key Usage value.

            Possible values include:
            • "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"
          • OID — (String)

            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)

        • CertificateAuthorityArn — (String)

          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

        • RenewalEligibility — (String)

          Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

          Possible values include:
          • "ELIGIBLE"
          • "INELIGIBLE"
        • Options — (map)

          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.

          • CertificateTransparencyLoggingPreference — (String)

            You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

exportCertificate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the exportCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  Passphrase: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
};
acm.exportCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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

    • Passphrase — (Buffer, Typed Array, Blob, String)

      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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Certificate — (String)

        The base64 PEM-encoded certificate.

      • CertificateChain — (String)

        The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.

      • PrivateKey — (String)

        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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAccountConfiguration(params = {}, callback) ⇒ AWS.Request

Returns the account configuration options associated with an Amazon Web Services account.

Service Reference:

Examples:

Calling the getAccountConfiguration operation

acm.getAccountConfiguration(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExpiryEvents — (map)

        Expiration events configuration options associated with the Amazon Web Services account.

        • DaysBeforeExpiry — (Integer)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCertificate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.getCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Certificate — (String)

        The ACM-issued certificate corresponding to the ARN specified as input.

      • CertificateChain — (String)

        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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

importCertificate(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

Calling the importCertificate operation

var params = {
  Certificate: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  PrivateKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  CertificateArn: 'STRING_VALUE',
  CertificateChain: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
acm.importCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

    • Certificate — (Buffer, Typed Array, Blob, String)

      The certificate to import.

    • PrivateKey — (Buffer, Typed Array, Blob, String)

      The private key that matches the public key in the certificate.

    • CertificateChain — (Buffer, Typed Array, Blob, String)

      The PEM encoded certificate chain.

    • Tags — (Array<map>)

      One or more resource tags to associate with the imported certificate.

      Note: You cannot apply tags when reimporting a certificate.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listCertificates(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listCertificates operation

var params = {
  CertificateStatuses: [
    PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED,
    /* more items */
  ],
  Includes: {
    extendedKeyUsage: [
      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,
      /* more items */
    ],
    keyTypes: [
      RSA_1024 | RSA_2048 | RSA_3072 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1,
      /* more items */
    ],
    keyUsage: [
      DIGITAL_SIGNATURE | NON_REPUDIATION | KEY_ENCIPHERMENT | DATA_ENCIPHERMENT | KEY_AGREEMENT | CERTIFICATE_SIGNING | CRL_SIGNING | ENCIPHER_ONLY | DECIPHER_ONLY | ANY | CUSTOM,
      /* more items */
    ]
  },
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
acm.listCertificates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateStatuses — (Array<String>)

      Filter the certificate list by status value.

    • Includes — (map)

      Filter the certificate list. For more information, see the Filters structure.

      • extendedKeyUsage — (Array<String>)

        Specify one or more ExtendedKeyUsage extension values.

      • keyUsage — (Array<String>)

        Specify one or more KeyUsage extension values.

      • keyTypes — (Array<String>)

        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.

    • NextToken — (String)

      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.

    • MaxItems — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

      • CertificateSummaryList — (Array<map>)

        A list of ACM certificates.

        • CertificateArn — (String)

          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).

        • DomainName — (String)

          Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForCertificate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTagsForCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.listTagsForCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The key-value pairs that define the applied tags.

        • Key — required — (String)

          The key of the tag.

        • Value — (String)

          The value of the tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putAccountConfiguration(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putAccountConfiguration operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  ExpiryEvents: {
    DaysBeforeExpiry: 'NUMBER_VALUE'
  }
};
acm.putAccountConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExpiryEvents — (map)

      Specifies expiration events associated with an account.

      • DaysBeforeExpiry — (Integer)

        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.

    • IdempotencyToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeTagsFromCertificate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the removeTagsFromCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
acm.removeTagsFromCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

    • Tags — (Array<map>)

      The key-value pair that defines the tag to remove.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

renewCertificate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the renewCertificate operation

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.renewCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

requestCertificate(params = {}, callback) ⇒ AWS.Request

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.

Note: 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)

Service Reference:

Examples:

Calling the requestCertificate operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  CertificateAuthorityArn: 'STRING_VALUE',
  DomainValidationOptions: [
    {
      DomainName: 'STRING_VALUE', /* required */
      ValidationDomain: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  IdempotencyToken: 'STRING_VALUE',
  Options: {
    CertificateTransparencyLoggingPreference: ENABLED | DISABLED
  },
  SubjectAlternativeNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  ValidationMethod: EMAIL | DNS
};
acm.requestCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      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.

    • ValidationMethod — (String)

      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.

      Possible values include:
      • "EMAIL"
      • "DNS"
    • SubjectAlternativeNames — (Array<String>)

      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.

    • IdempotencyToken — (String)

      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.

    • DomainValidationOptions — (Array<map>)

      The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

      • DomainName — required — (String)

        A fully qualified domain name (FQDN) in the certificate request.

      • ValidationDomain — required — (String)

        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:

    • Options — (map)

      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.

      • CertificateTransparencyLoggingPreference — (String)

        You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • CertificateAuthorityArn — (String)

      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

    • Tags — (Array<map>)

      One or more resource tags to associate with the certificate.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CertificateArn — (String)

        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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

resendValidationEmail(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the resendValidationEmail operation

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE', /* required */
  ValidationDomain: 'STRING_VALUE' /* required */
};
acm.resendValidationEmail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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

    • Domain — (String)

      The fully qualified domain name (FQDN) of the certificate that needs to be validated.

    • ValidationDomain — (String)

      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:

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateCertificateOptions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateCertificateOptions operation

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  Options: { /* required */
    CertificateTransparencyLoggingPreference: ENABLED | DISABLED
  }
};
acm.updateCertificateOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CertificateArn — (String)

      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

    • Options — (map)

      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.

      • CertificateTransparencyLoggingPreference — (String)

        You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given ACM resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the certificateValidated state

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.waitFor('certificateValidated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

acm.waitFor('certificateValidated', params = {}, [callback]) ⇒ AWS.Request

Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificate() operation every 60 seconds (at most 40 times).

Examples:

Waiting for the certificateValidated state

var params = {
  CertificateArn: 'STRING_VALUE' /* required */
};
acm.waitFor('certificateValidated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • CertificateArn — (String)

      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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Certificate — (map)

        Metadata about an ACM certificate.

        • CertificateArn — (String)

          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.

        • DomainName — (String)

          The fully qualified domain name for the certificate, such as www.example.com or example.com.

        • SubjectAlternativeNames — (Array<String>)

          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.

        • DomainValidationOptions — (Array<map>)

          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.

          • DomainName — required — (String)

            A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

          • ValidationEmails — (Array<String>)

            A list of email addresses that ACM used to send domain validation emails.

          • ValidationDomain — (String)

            The domain name that ACM used to send domain validation emails.

          • ValidationStatus — (String)

            The validation status of the domain name. This can be one of the following values:

            • PENDING_VALIDATION

            • SUCCESS

            • FAILED

            Possible values include:
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
          • ResourceRecord — (map)

            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.

            • Name — required — (String)

              The name of the DNS record to create in your domain. This is supplied by ACM.

            • Type — required — (String)

              The type of DNS record. Currently this can be CNAME.

              Possible values include:
              • "CNAME"
            • Value — required — (String)

              The value of the CNAME record to add to your DNS database. This is supplied by ACM.

          • ValidationMethod — (String)

            Specifies the domain validation method.

            Possible values include:
            • "EMAIL"
            • "DNS"
        • Serial — (String)

          The serial number of the certificate.

        • Subject — (String)

          The name of the entity that is associated with the public key contained in the certificate.

        • Issuer — (String)

          The name of the certificate authority that issued and signed the certificate.

        • CreatedAt — (Date)

          The time at which the certificate was requested.

        • IssuedAt — (Date)

          The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

        • ImportedAt — (Date)

          The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.

        • Status — (String)

          The status of the certificate.

          Possible values include:
          • "PENDING_VALIDATION"
          • "ISSUED"
          • "INACTIVE"
          • "EXPIRED"
          • "VALIDATION_TIMED_OUT"
          • "REVOKED"
          • "FAILED"
        • RevokedAt — (Date)

          The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

        • RevocationReason — (String)

          The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

          Possible values include:
          • "UNSPECIFIED"
          • "KEY_COMPROMISE"
          • "CA_COMPROMISE"
          • "AFFILIATION_CHANGED"
          • "SUPERCEDED"
          • "CESSATION_OF_OPERATION"
          • "CERTIFICATE_HOLD"
          • "REMOVE_FROM_CRL"
          • "PRIVILEGE_WITHDRAWN"
          • "A_A_COMPROMISE"
        • NotBefore — (Date)

          The time before which the certificate is not valid.

        • NotAfter — (Date)

          The time after which the certificate is not valid.

        • KeyAlgorithm — (String)

          The algorithm that was used to generate the public-private key pair.

          Possible values include:
          • "RSA_1024"
          • "RSA_2048"
          • "RSA_3072"
          • "RSA_4096"
          • "EC_prime256v1"
          • "EC_secp384r1"
          • "EC_secp521r1"
        • SignatureAlgorithm — (String)

          The algorithm that was used to sign the certificate.

        • InUseBy — (Array<String>)

          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.

        • FailureReason — (String)

          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.

          Possible values include:
          • "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"
        • Type — (String)

          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.

          Possible values include:
          • "IMPORTED"
          • "AMAZON_ISSUED"
          • "PRIVATE"
        • RenewalSummary — (map)

          Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

          • RenewalStatus — required — (String)

            The status of ACM's managed renewal of the certificate.

            Possible values include:
            • "PENDING_AUTO_RENEWAL"
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
          • DomainValidationOptions — required — (Array<map>)

            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.

            • DomainName — required — (String)

              A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

            • ValidationEmails — (Array<String>)

              A list of email addresses that ACM used to send domain validation emails.

            • ValidationDomain — (String)

              The domain name that ACM used to send domain validation emails.

            • ValidationStatus — (String)

              The validation status of the domain name. This can be one of the following values:

              • PENDING_VALIDATION

              • SUCCESS

              • FAILED

              Possible values include:
              • "PENDING_VALIDATION"
              • "SUCCESS"
              • "FAILED"
            • ResourceRecord — (map)

              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.

              • Name — required — (String)

                The name of the DNS record to create in your domain. This is supplied by ACM.

              • Type — required — (String)

                The type of DNS record. Currently this can be CNAME.

                Possible values include:
                • "CNAME"
              • Value — required — (String)

                The value of the CNAME record to add to your DNS database. This is supplied by ACM.

            • ValidationMethod — (String)

              Specifies the domain validation method.

              Possible values include:
              • "EMAIL"
              • "DNS"
          • RenewalStatusReason — (String)

            The reason that a renewal request was unsuccessful.

            Possible values include:
            • "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"
          • UpdatedAt — required — (Date)

            The time at which the renewal summary was last updated.

        • KeyUsages — (Array<map>)

          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.

          • Name — (String)

            A string value that contains a Key Usage extension name.

            Possible values include:
            • "DIGITAL_SIGNATURE"
            • "NON_REPUDIATION"
            • "KEY_ENCIPHERMENT"
            • "DATA_ENCIPHERMENT"
            • "KEY_AGREEMENT"
            • "CERTIFICATE_SIGNING"
            • "CRL_SIGNING"
            • "ENCIPHER_ONLY"
            • "DECIPHER_ONLY"
            • "ANY"
            • "CUSTOM"
        • ExtendedKeyUsages — (Array<map>)

          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).

          • Name — (String)

            The name of an Extended Key Usage value.

            Possible values include:
            • "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"
          • OID — (String)

            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)

        • CertificateAuthorityArn — (String)

          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

        • RenewalEligibility — (String)

          Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

          Possible values include:
          • "ELIGIBLE"
          • "INELIGIBLE"
        • Options — (map)

          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.

          • CertificateTransparencyLoggingPreference — (String)

            You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

            Possible values include:
            • "ENABLED"
            • "DISABLED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: