Class: AWS.ACM

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.

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 when the certificate was imported. This value exists only when the certificate type is IMPORTED.

      • Status — (String)

        The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

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

• certificateValidated

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.

    Note: When creating your passphrase, you can use any ASCII character except #, $, or %.

    If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase.

    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.

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.

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.

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:

    • CertificateArn — (String)

      The Amazon Resource Name (ARN) of the imported certificate.

Returns:

• (AWS.Request) —

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

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',
  SortBy: CREATED_AT,
  SortOrder: ASCENDING | DESCENDING
};
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.

  • SortBy — (String)

    Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

    Possible values include:
    • "CREATED_AT"
  • SortOrder — (String)

    Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"

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.

      • SubjectAlternativeNameSummaries — (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.

        When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

      • HasAdditionalSubjectAlternativeNames — (Boolean)

        When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

      • Status — (String)

        The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

        Possible values include:
        • "PENDING_VALIDATION"
        • "ISSUED"
        • "INACTIVE"
        • "EXPIRED"
        • "VALIDATION_TIMED_OUT"
        • "REVOKED"
        • "FAILED"
      • 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 Certificate Manager User Guide.

        Possible values include:
        • "IMPORTED"
        • "AMAZON_ISSUED"
        • "PRIVATE"
      • 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"
      • KeyUsages — (Array<String>)

        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.

      • ExtendedKeyUsages — (Array<String>)

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

      • InUse — (Boolean)

        Indicates whether the certificate is currently in use by any Amazon Web Services resources.

      • Exported — (Boolean)

        Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

      • 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"
      • NotBefore — (Date)

        The time before which the certificate is not valid.

      • NotAfter — (Date)

        The time after which the certificate is not valid.

      • 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 when the certificate was imported. This value exists only when the certificate type is IMPORTED.

      • RevokedAt — (Date)

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

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  CertificateAuthorityArn: 'STRING_VALUE',
  DomainValidationOptions: [
    {
      DomainName: 'STRING_VALUE', /* required */
      ValidationDomain: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  IdempotencyToken: 'STRING_VALUE',
  KeyAlgorithm: RSA_1024 | RSA_2048 | RSA_3072 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1,
  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.

    In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

  • 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:

      • admin@example.com

      • administrator@example.com

      • hostmaster@example.com

      • postmaster@example.com

      • webmaster@example.com

  • 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 Private Certificate Authority 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.

  • KeyAlgorithm — (String)

    Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

    Note: Algorithms supported for an ACM certificate request include:

    • RSA_2048
    • EC_prime256v1
    • EC_secp384r1

    Other listed algorithms are for imported certificates only.
    Note: When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

    Default: RSA_2048

    Possible values include:
    • "RSA_1024"
    • "RSA_2048"
    • "RSA_3072"
    • "RSA_4096"
    • "EC_prime256v1"
    • "EC_secp384r1"
    • "EC_secp521r1"

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.

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:

    • admin@subdomain.example.com

    • administrator@subdomain.example.com

    • hostmaster@subdomain.example.com

    • postmaster@subdomain.example.com

    • webmaster@subdomain.example.com

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.

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.

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:

• certificateValidated