Class: AWS.ACMPCA

var params = {
  AuditReportResponseFormat: JSON | CSV, /* required */
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  S3BucketName: 'STRING_VALUE' /* required */
};
acmpca.createCertificateAuthorityAuditReport(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • S3BucketName — (String)

    The name of the S3 bucket that will contain the audit report.

  • AuditReportResponseFormat — (String)

    The format in which to create the report. This can be either JSON or CSV.

    Possible values include:
    • "JSON"
    • "CSV"

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:

    • AuditReportId — (String)

      An alphanumeric string that contains a report identifier.

    • S3Key — (String)

      The key that uniquely identifies the report file in your S3 bucket.

Returns:

• (AWS.Request) —

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

var params = {
  Actions: [ /* required */
    IssueCertificate | GetCertificate | ListPermissions,
    /* more items */
  ],
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  Principal: 'STRING_VALUE', /* required */
  SourceAccount: 'STRING_VALUE'
};
acmpca.createPermission(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • Principal — (String)

    The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

  • SourceAccount — (String)

    The ID of the calling account.

  • Actions — (Array<String>)

    The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

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 = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  PermanentDeletionTimeInDays: 'NUMBER_VALUE'
};
acmpca.deleteCertificateAuthority(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • PermanentDeletionTimeInDays — (Integer)

    The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

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 = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  Principal: 'STRING_VALUE', /* required */
  SourceAccount: 'STRING_VALUE'
};
acmpca.deletePermission(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • Principal — (String)

    The Amazon Web Services service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

  • SourceAccount — (String)

    The Amazon Web Services account that calls this action.

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 = {
  ResourceArn: 'STRING_VALUE' /* required */
};
acmpca.deletePolicy(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

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 = {
  CertificateAuthorityArn: 'STRING_VALUE' /* required */
};
acmpca.describeCertificateAuthority(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

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:

    • CertificateAuthority — (map)

      A CertificateAuthority structure that contains information about your private CA.

      • Arn — (String)

        Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .

      • OwnerAccount — (String)

        The Amazon Web Services account ID that owns the certificate authority.

      • CreatedAt — (Date)

        Date and time at which your private CA was created.

      • LastStateChangeAt — (Date)

        Date and time at which your private CA was last updated.

      • Type — (String)

        Type of your private CA.

        Possible values include:
        • "ROOT"
        • "SUBORDINATE"
      • Serial — (String)

        Serial number of your private CA.

      • Status — (String)

        Status of your private CA.

        Possible values include:
        • "CREATING"
        • "PENDING_CERTIFICATE"
        • "ACTIVE"
        • "DELETED"
        • "DISABLED"
        • "EXPIRED"
        • "FAILED"
      • NotBefore — (Date)

        Date and time before which your private CA certificate is not valid.

      • NotAfter — (Date)

        Date and time after which your private CA certificate is not valid.

      • FailureReason — (String)

        Reason the request to create your private CA failed.

        Possible values include:
        • "REQUEST_TIMED_OUT"
        • "UNSUPPORTED_ALGORITHM"
        • "OTHER"
      • CertificateAuthorityConfiguration — (map)

        Your private CA configuration.

        • KeyAlgorithm — required — (String)

          Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

          Possible values include:
          • "RSA_2048"
          • "RSA_4096"
          • "EC_prime256v1"
          • "EC_secp384r1"
          • "SM2"
        • SigningAlgorithm — required — (String)

          Name of the algorithm your private CA uses to sign certificate requests.

          This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

          Possible values include:
          • "SHA256WITHECDSA"
          • "SHA384WITHECDSA"
          • "SHA512WITHECDSA"
          • "SHA256WITHRSA"
          • "SHA384WITHRSA"
          • "SHA512WITHRSA"
          • "SM3WITHSM2"
        • Subject — required — (map)

          Structure that contains X.500 distinguished name information for your private CA.

          • Country — (String)

            Two-digit code that specifies the country in which the certificate subject located.

          • Organization — (String)

            Legal name of the organization with which the certificate subject is affiliated.

          • OrganizationalUnit — (String)

            A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

          • DistinguishedNameQualifier — (String)

            Disambiguating information for the certificate subject.

          • State — (String)

            State in which the subject of the certificate is located.

          • CommonName — (String)

            For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

            Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

          • SerialNumber — (String)

            The certificate serial number.

          • Locality — (String)

            The locality (such as a city or town) in which the certificate subject is located.

          • Title — (String)

            A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

          • Surname — (String)

            Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

          • GivenName — (String)

            First name.

          • Initials — (String)

            Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

          • Pseudonym — (String)

            Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

          • GenerationQualifier — (String)

            Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

          • CustomAttributes — (Array<map>)

            Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

            Note: Custom attributes cannot be used in combination with standard attributes.
            • ObjectIdentifier — required — (String)

              Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

            • Value — required — (String)

              Specifies the attribute value of relative distinguished name (RDN).

        • CsrExtensions — (map)

          Specifies information to be added to the extension section of the certificate signing request (CSR).

          • KeyUsage — (map)

            Indicates the purpose of the certificate and of the key contained in the certificate.

            • DigitalSignature — (Boolean)

              Key can be used for digital signing.

            • NonRepudiation — (Boolean)

              Key can be used for non-repudiation.

            • KeyEncipherment — (Boolean)

              Key can be used to encipher data.

            • DataEncipherment — (Boolean)

              Key can be used to decipher data.

            • KeyAgreement — (Boolean)

              Key can be used in a key-agreement protocol.

            • KeyCertSign — (Boolean)

              Key can be used to sign certificates.

            • CRLSign — (Boolean)

              Key can be used to sign CRLs.

            • EncipherOnly — (Boolean)

              Key can be used only to encipher data.

            • DecipherOnly — (Boolean)

              Key can be used only to decipher data.

          • SubjectInformationAccess — (Array<map>)

            For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.

            • AccessMethod — required — (map)

              The type and format of AccessDescription information.

              • CustomObjectIdentifier — (String)

                An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).

              • AccessMethodType — (String)

                Specifies the AccessMethod.

                Possible values include:
                • "CA_REPOSITORY"
                • "RESOURCE_PKI_MANIFEST"
                • "RESOURCE_PKI_NOTIFY"
            • AccessLocation — required — (map)

              The location of AccessDescription information.

              • OtherName — (map)

                Represents GeneralName using an OtherName object.

                • TypeId — required — (String)

                  Specifies an OID.

                • Value — required — (String)

                  Specifies an OID value.

              • Rfc822Name — (String)

                Represents GeneralName as an RFC 822 email address.

              • DnsName — (String)

                Represents GeneralName as a DNS name.

              • DirectoryName — (map)

                Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

                • Country — (String)

                  Two-digit code that specifies the country in which the certificate subject located.

                • Organization — (String)

                  Legal name of the organization with which the certificate subject is affiliated.

                • OrganizationalUnit — (String)

                  A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

                • DistinguishedNameQualifier — (String)

                  Disambiguating information for the certificate subject.

                • State — (String)

                  State in which the subject of the certificate is located.

                • CommonName — (String)

                  For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

                  Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

                • SerialNumber — (String)

                  The certificate serial number.

                • Locality — (String)

                  The locality (such as a city or town) in which the certificate subject is located.

                • Title — (String)

                  A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

                • Surname — (String)

                  Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

                • GivenName — (String)

                  First name.

                • Initials — (String)

                  Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

                • Pseudonym — (String)

                  Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

                • GenerationQualifier — (String)

                  Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

                • CustomAttributes — (Array<map>)

                  Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

                  Note: Custom attributes cannot be used in combination with standard attributes.
                  • ObjectIdentifier — required — (String)

                    Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

                  • Value — required — (String)

                    Specifies the attribute value of relative distinguished name (RDN).

              • EdiPartyName — (map)

                Represents GeneralName as an EdiPartyName object.

                • PartyName — required — (String)

                  Specifies the party name.

                • NameAssigner — (String)

                  Specifies the name assigner.

              • UniformResourceIdentifier — (String)

                Represents GeneralName as a URI.

              • IpAddress — (String)

                Represents GeneralName as an IPv4 or IPv6 address.

              • RegisteredId — (String)

                Represents GeneralName as an object identifier (OID).

      • RevocationConfiguration — (map)

        Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

        • CrlConfiguration — (map)

          Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.

          • Enabled — required — (Boolean)

            Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.

          • ExpirationInDays — (Integer)

            Validity period of the CRL in days.

          • CustomCname — (String)

            Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.

            Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
          • S3BucketName — (String)

            Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.

            Note: The S3BucketName parameter must conform to the S3 bucket naming rules.
          • S3ObjectAcl — (String)

            Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

            If no value is specified, the default is PUBLIC_READ.

            Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

            For more information, see Blocking public access to the S3 bucket.

            Possible values include:
            • "PUBLIC_READ"
            • "BUCKET_OWNER_FULL_CONTROL"
          • CrlDistributionPointExtensionConfiguration — (map)

            Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.

            • OmitExtension — required — (Boolean)

              Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.

              Note: Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger This configuration cannot be enabled with a custom CNAME set.
        • OcspConfiguration — (map)

          Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.

          • Enabled — required — (Boolean)

            Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

          • OcspCustomCname — (String)

            By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

            Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

            For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.

      • RestorableUntil — (Date)

        The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

      • KeyStorageSecurityStandard — (String)

        Defines a cryptographic key management compliance standard used for handling CA keys.

        Default: FIPS_140_2_LEVEL_3_OR_HIGHER

        Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

        Possible values include:
        • "FIPS_140_2_LEVEL_2_OR_HIGHER"
        • "FIPS_140_2_LEVEL_3_OR_HIGHER"
        • "CCPC_LEVEL_1_OR_HIGHER"
      • UsageMode — (String)

        Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

        The default value is GENERAL_PURPOSE.

        Possible values include:
        • "GENERAL_PURPOSE"
        • "SHORT_LIVED_CERTIFICATE"

Returns:

• (AWS.Request) —

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

var params = {
  AuditReportId: 'STRING_VALUE', /* required */
  CertificateAuthorityArn: 'STRING_VALUE' /* required */
};
acmpca.describeCertificateAuthorityAuditReport(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) of the private CA. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • AuditReportId — (String)

    The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

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:

    • AuditReportStatus — (String)

      Specifies whether report creation is in progress, has succeeded, or has failed.

      Possible values include:
      • "CREATING"
      • "SUCCESS"
      • "FAILED"
    • S3BucketName — (String)

      Name of the S3 bucket that contains the report.

    • S3Key — (String)

      S3 key that uniquely identifies the report file in your S3 bucket.

    • CreatedAt — (Date)

      The date and time at which the report was created.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• auditReportCreated

var params = {
  CertificateArn: 'STRING_VALUE', /* required */
  CertificateAuthorityArn: 'STRING_VALUE' /* required */
};
acmpca.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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • CertificateArn — (String)

    The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245

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 specified by the CertificateArn parameter.

    • CertificateChain — (String)

      The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• certificateIssued

var params = {
  CertificateAuthorityArn: 'STRING_VALUE' /* required */
};
acmpca.getCertificateAuthorityCertificate(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) of your private CA. This is of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

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)

      Base64-encoded certificate authority (CA) certificate.

    • CertificateChain — (String)

      Base64-encoded certificate chain that includes any intermediate certificates and chains up to root certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null.

Returns:

• (AWS.Request) —

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

var params = {
  CertificateAuthorityArn: 'STRING_VALUE' /* required */
};
acmpca.getCertificateAuthorityCsr(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

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:

    • Csr — (String)

      The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• certificateAuthorityCSRCreated

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
acmpca.getPolicy(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

     </p> 

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:

    • Policy — (String)

      The policy attached to the private CA as a JSON document.

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 */
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  CertificateChain: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
};
acmpca.importCertificateAuthorityCertificate(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: {}) —
  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

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

    The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

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

    A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

    This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

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 = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  Csr: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  SigningAlgorithm: SHA256WITHECDSA | SHA384WITHECDSA | SHA512WITHECDSA | SHA256WITHRSA | SHA384WITHRSA | SHA512WITHRSA | SM3WITHSM2, /* required */
  Validity: { /* required */
    Type: END_DATE | ABSOLUTE | DAYS | MONTHS | YEARS, /* required */
    Value: 'NUMBER_VALUE' /* required */
  },
  ApiPassthrough: {
    Extensions: {
      CertificatePolicies: [
        {
          CertPolicyId: 'STRING_VALUE', /* required */
          PolicyQualifiers: [
            {
              PolicyQualifierId: CPS, /* required */
              Qualifier: { /* required */
                CpsUri: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      CustomExtensions: [
        {
          ObjectIdentifier: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE', /* required */
          Critical: true || false
        },
        /* more items */
      ],
      ExtendedKeyUsage: [
        {
          ExtendedKeyUsageObjectIdentifier: 'STRING_VALUE',
          ExtendedKeyUsageType: SERVER_AUTH | CLIENT_AUTH | CODE_SIGNING | EMAIL_PROTECTION | TIME_STAMPING | OCSP_SIGNING | SMART_CARD_LOGIN | DOCUMENT_SIGNING | CERTIFICATE_TRANSPARENCY
        },
        /* more items */
      ],
      KeyUsage: {
        CRLSign: true || false,
        DataEncipherment: true || false,
        DecipherOnly: true || false,
        DigitalSignature: true || false,
        EncipherOnly: true || false,
        KeyAgreement: true || false,
        KeyCertSign: true || false,
        KeyEncipherment: true || false,
        NonRepudiation: true || false
      },
      SubjectAlternativeNames: [
        {
          DirectoryName: {
            CommonName: 'STRING_VALUE',
            Country: 'STRING_VALUE',
            CustomAttributes: [
              {
                ObjectIdentifier: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            DistinguishedNameQualifier: 'STRING_VALUE',
            GenerationQualifier: 'STRING_VALUE',
            GivenName: 'STRING_VALUE',
            Initials: 'STRING_VALUE',
            Locality: 'STRING_VALUE',
            Organization: 'STRING_VALUE',
            OrganizationalUnit: 'STRING_VALUE',
            Pseudonym: 'STRING_VALUE',
            SerialNumber: 'STRING_VALUE',
            State: 'STRING_VALUE',
            Surname: 'STRING_VALUE',
            Title: 'STRING_VALUE'
          },
          DnsName: 'STRING_VALUE',
          EdiPartyName: {
            PartyName: 'STRING_VALUE', /* required */
            NameAssigner: 'STRING_VALUE'
          },
          IpAddress: 'STRING_VALUE',
          OtherName: {
            TypeId: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          RegisteredId: 'STRING_VALUE',
          Rfc822Name: 'STRING_VALUE',
          UniformResourceIdentifier: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    Subject: {
      CommonName: 'STRING_VALUE',
      Country: 'STRING_VALUE',
      CustomAttributes: [
        {
          ObjectIdentifier: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      DistinguishedNameQualifier: 'STRING_VALUE',
      GenerationQualifier: 'STRING_VALUE',
      GivenName: 'STRING_VALUE',
      Initials: 'STRING_VALUE',
      Locality: 'STRING_VALUE',
      Organization: 'STRING_VALUE',
      OrganizationalUnit: 'STRING_VALUE',
      Pseudonym: 'STRING_VALUE',
      SerialNumber: 'STRING_VALUE',
      State: 'STRING_VALUE',
      Surname: 'STRING_VALUE',
      Title: 'STRING_VALUE'
    }
  },
  IdempotencyToken: 'STRING_VALUE',
  TemplateArn: 'STRING_VALUE',
  ValidityNotBefore: {
    Type: END_DATE | ABSOLUTE | DAYS | MONTHS | YEARS, /* required */
    Value: 'NUMBER_VALUE' /* required */
  }
};
acmpca.issueCertificate(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: {}) —
  • ApiPassthrough — (map)

    Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.

    If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

    • Extensions — (map)

      Specifies X.509 extension information for a certificate.

      • CertificatePolicies — (Array<map>)

        Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).

        In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.

        • CertPolicyId — required — (String)

          Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).

        • PolicyQualifiers — (Array<map>)

          Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.

          • PolicyQualifierId — required — (String)

            Identifies the qualifier modifying a CertPolicyId.

            Possible values include:
            • "CPS"
          • Qualifier — required — (map)

            Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field.

            • CpsUri — required — (String)

              Contains a pointer to a certification practice statement (CPS) published by the CA.

      • ExtendedKeyUsage — (Array<map>)

        Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

        • ExtendedKeyUsageType — (String)

          Specifies a standard ExtendedKeyUsage as defined as in RFC 5280.

          Possible values include:
          • "SERVER_AUTH"
          • "CLIENT_AUTH"
          • "CODE_SIGNING"
          • "EMAIL_PROTECTION"
          • "TIME_STAMPING"
          • "OCSP_SIGNING"
          • "SMART_CARD_LOGIN"
          • "DOCUMENT_SIGNING"
          • "CERTIFICATE_TRANSPARENCY"
        • ExtendedKeyUsageObjectIdentifier — (String)

          Specifies a custom ExtendedKeyUsage with an object identifier (OID).

      • KeyUsage — (map)

        Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.

        • DigitalSignature — (Boolean)

          Key can be used for digital signing.

        • NonRepudiation — (Boolean)

          Key can be used for non-repudiation.

        • KeyEncipherment — (Boolean)

          Key can be used to encipher data.

        • DataEncipherment — (Boolean)

          Key can be used to decipher data.

        • KeyAgreement — (Boolean)

          Key can be used in a key-agreement protocol.

        • KeyCertSign — (Boolean)

          Key can be used to sign certificates.

        • CRLSign — (Boolean)

          Key can be used to sign CRLs.

        • EncipherOnly — (Boolean)

          Key can be used only to encipher data.

        • DecipherOnly — (Boolean)

          Key can be used only to decipher data.

      • SubjectAlternativeNames — (Array<map>)

        The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.

        • OtherName — (map)

          Represents GeneralName using an OtherName object.

          • TypeId — required — (String)

            Specifies an OID.

          • Value — required — (String)

            Specifies an OID value.

        • Rfc822Name — (String)

          Represents GeneralName as an RFC 822 email address.

        • DnsName — (String)

          Represents GeneralName as a DNS name.

        • DirectoryName — (map)

          Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

          • Country — (String)

            Two-digit code that specifies the country in which the certificate subject located.

          • Organization — (String)

            Legal name of the organization with which the certificate subject is affiliated.

          • OrganizationalUnit — (String)

            A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

          • DistinguishedNameQualifier — (String)

            Disambiguating information for the certificate subject.

          • State — (String)

            State in which the subject of the certificate is located.

          • CommonName — (String)

            For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

            Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

          • SerialNumber — (String)

            The certificate serial number.

          • Locality — (String)

            The locality (such as a city or town) in which the certificate subject is located.

          • Title — (String)

            A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

          • Surname — (String)

            Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

          • GivenName — (String)

            First name.

          • Initials — (String)

            Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

          • Pseudonym — (String)

            Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

          • GenerationQualifier — (String)

            Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

          • CustomAttributes — (Array<map>)

            Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

            Note: Custom attributes cannot be used in combination with standard attributes.
            • ObjectIdentifier — required — (String)

              Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

            • Value — required — (String)

              Specifies the attribute value of relative distinguished name (RDN).

        • EdiPartyName — (map)

          Represents GeneralName as an EdiPartyName object.

          • PartyName — required — (String)

            Specifies the party name.

          • NameAssigner — (String)

            Specifies the name assigner.

        • UniformResourceIdentifier — (String)

          Represents GeneralName as a URI.

        • IpAddress — (String)

          Represents GeneralName as an IPv4 or IPv6 address.

        • RegisteredId — (String)

          Represents GeneralName as an object identifier (OID).

      • CustomExtensions — (Array<map>)

        Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.

        • ObjectIdentifier — required — (String)

          Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database.

        • Value — required — (String)

          Specifies the base64-encoded value of the X.509 extension.

        • Critical — (Boolean)

          Specifies the critical flag of the X.509 extension.

    • Subject — (map)

      Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

      • Country — (String)

        Two-digit code that specifies the country in which the certificate subject located.

      • Organization — (String)

        Legal name of the organization with which the certificate subject is affiliated.

      • OrganizationalUnit — (String)

        A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

      • DistinguishedNameQualifier — (String)

        Disambiguating information for the certificate subject.

      • State — (String)

        State in which the subject of the certificate is located.

      • CommonName — (String)

        For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

        Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

      • SerialNumber — (String)

        The certificate serial number.

      • Locality — (String)

        The locality (such as a city or town) in which the certificate subject is located.

      • Title — (String)

        A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

      • Surname — (String)

        Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

      • GivenName — (String)

        First name.

      • Initials — (String)

        Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

      • Pseudonym — (String)

        Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

      • GenerationQualifier — (String)

        Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

      • CustomAttributes — (Array<map>)

        Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

        Note: Custom attributes cannot be used in combination with standard attributes.
        • ObjectIdentifier — required — (String)

          Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

        • Value — required — (String)

          Specifies the attribute value of relative distinguished name (RDN).

  • CertificateAuthorityArn — (String)

    The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

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

    The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

    openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

    If you have a configuration file, you can then use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

    openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

    Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

  • SigningAlgorithm — (String)

    The name of the algorithm that will be used to sign the certificate to be issued.

    This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.

    Note: The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
    Possible values include:
    • "SHA256WITHECDSA"
    • "SHA384WITHECDSA"
    • "SHA512WITHECDSA"
    • "SHA256WITHRSA"
    • "SHA384WITHRSA"
    • "SHA512WITHRSA"
    • "SM3WITHSM2"
  • TemplateArn — (String)

    Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

    Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

    For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.

  • Validity — (map)

    Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

    Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

    This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

    The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.

    • Value — required — (Integer)

      A long integer interpreted according to the value of Type, below.

    • Type — required — (String)

      Determines how Amazon Web Services Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.

      END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.

      • Sample input value: 491231235959 (UTCTime format)

      • Output expiration date/time: 12/31/2049 23:59:59

      ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.

      • Sample input value: 2524608000

      • Output expiration date/time: 01/01/2050 00:00:00

      DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.

      Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

      • Sample input value: 90

      • Output expiration date: 01/10/2020 12:34:54 UTC

      The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.

      Possible values include:
      • "END_DATE"
      • "ABSOLUTE"
      • "DAYS"
      • "MONTHS"
      • "YEARS"
  • ValidityNotBefore — (map)

    Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.

    By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

    Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

    The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

    • Value — required — (Integer)

      A long integer interpreted according to the value of Type, below.

    • Type — required — (String)

      Determines how Amazon Web Services Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.

      END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.

      • Sample input value: 491231235959 (UTCTime format)

      • Output expiration date/time: 12/31/2049 23:59:59

      ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.

      • Sample input value: 2524608000

      • Output expiration date/time: 01/01/2050 00:00:00

      DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.

      Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

      • Sample input value: 90

      • Output expiration date: 01/10/2020 12:34:54 UTC

      The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.

      Possible values include:
      • "END_DATE"
      • "ABSOLUTE"
      • "DAYS"
      • "MONTHS"
      • "YEARS"
  • IdempotencyToken — (String)

    Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if you call IssueCertificate multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.

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 issued certificate and the certificate serial number. This is of the form:

      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceOwner: SELF | OTHER_ACCOUNTS
};
acmpca.listCertificateAuthorities(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: {}) —
  • MaxResults — (Integer)

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. 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.

    Although the maximum value is 1000, the action only returns a maximum of 100 items.

  • NextToken — (String)

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

  • ResourceOwner — (String)

    Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.

    Possible values include:
    • "SELF"
    • "OTHER_ACCOUNTS"

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 should be used for the NextToken parameter in a subsequent pagination request.

    • CertificateAuthorities — (Array<map>)

      Summary information about each certificate authority you have created.

      • Arn — (String)

        Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .

      • OwnerAccount — (String)

        The Amazon Web Services account ID that owns the certificate authority.

      • CreatedAt — (Date)

        Date and time at which your private CA was created.

      • LastStateChangeAt — (Date)

        Date and time at which your private CA was last updated.

      • Type — (String)

        Type of your private CA.

        Possible values include:
        • "ROOT"
        • "SUBORDINATE"
      • Serial — (String)

        Serial number of your private CA.

      • Status — (String)

        Status of your private CA.

        Possible values include:
        • "CREATING"
        • "PENDING_CERTIFICATE"
        • "ACTIVE"
        • "DELETED"
        • "DISABLED"
        • "EXPIRED"
        • "FAILED"
      • NotBefore — (Date)

        Date and time before which your private CA certificate is not valid.

      • NotAfter — (Date)

        Date and time after which your private CA certificate is not valid.

      • FailureReason — (String)

        Reason the request to create your private CA failed.

        Possible values include:
        • "REQUEST_TIMED_OUT"
        • "UNSUPPORTED_ALGORITHM"
        • "OTHER"
      • CertificateAuthorityConfiguration — (map)

        Your private CA configuration.

        • KeyAlgorithm — required — (String)

          Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

          Possible values include:
          • "RSA_2048"
          • "RSA_4096"
          • "EC_prime256v1"
          • "EC_secp384r1"
          • "SM2"
        • SigningAlgorithm — required — (String)

          Name of the algorithm your private CA uses to sign certificate requests.

          This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

          Possible values include:
          • "SHA256WITHECDSA"
          • "SHA384WITHECDSA"
          • "SHA512WITHECDSA"
          • "SHA256WITHRSA"
          • "SHA384WITHRSA"
          • "SHA512WITHRSA"
          • "SM3WITHSM2"
        • Subject — required — (map)

          Structure that contains X.500 distinguished name information for your private CA.

          • Country — (String)

            Two-digit code that specifies the country in which the certificate subject located.

          • Organization — (String)

            Legal name of the organization with which the certificate subject is affiliated.

          • OrganizationalUnit — (String)

            A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

          • DistinguishedNameQualifier — (String)

            Disambiguating information for the certificate subject.

          • State — (String)

            State in which the subject of the certificate is located.

          • CommonName — (String)

            For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

            Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

          • SerialNumber — (String)

            The certificate serial number.

          • Locality — (String)

            The locality (such as a city or town) in which the certificate subject is located.

          • Title — (String)

            A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

          • Surname — (String)

            Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

          • GivenName — (String)

            First name.

          • Initials — (String)

            Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

          • Pseudonym — (String)

            Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

          • GenerationQualifier — (String)

            Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

          • CustomAttributes — (Array<map>)

            Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

            Note: Custom attributes cannot be used in combination with standard attributes.
            • ObjectIdentifier — required — (String)

              Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

            • Value — required — (String)

              Specifies the attribute value of relative distinguished name (RDN).

        • CsrExtensions — (map)

          Specifies information to be added to the extension section of the certificate signing request (CSR).

          • KeyUsage — (map)

            Indicates the purpose of the certificate and of the key contained in the certificate.

            • DigitalSignature — (Boolean)

              Key can be used for digital signing.

            • NonRepudiation — (Boolean)

              Key can be used for non-repudiation.

            • KeyEncipherment — (Boolean)

              Key can be used to encipher data.

            • DataEncipherment — (Boolean)

              Key can be used to decipher data.

            • KeyAgreement — (Boolean)

              Key can be used in a key-agreement protocol.

            • KeyCertSign — (Boolean)

              Key can be used to sign certificates.

            • CRLSign — (Boolean)

              Key can be used to sign CRLs.

            • EncipherOnly — (Boolean)

              Key can be used only to encipher data.

            • DecipherOnly — (Boolean)

              Key can be used only to decipher data.

          • SubjectInformationAccess — (Array<map>)

            For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.

            • AccessMethod — required — (map)

              The type and format of AccessDescription information.

              • CustomObjectIdentifier — (String)

                An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).

              • AccessMethodType — (String)

                Specifies the AccessMethod.

                Possible values include:
                • "CA_REPOSITORY"
                • "RESOURCE_PKI_MANIFEST"
                • "RESOURCE_PKI_NOTIFY"
            • AccessLocation — required — (map)

              The location of AccessDescription information.

              • OtherName — (map)

                Represents GeneralName using an OtherName object.

                • TypeId — required — (String)

                  Specifies an OID.

                • Value — required — (String)

                  Specifies an OID value.

              • Rfc822Name — (String)

                Represents GeneralName as an RFC 822 email address.

              • DnsName — (String)

                Represents GeneralName as a DNS name.

              • DirectoryName — (map)

                Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

                • Country — (String)

                  Two-digit code that specifies the country in which the certificate subject located.

                • Organization — (String)

                  Legal name of the organization with which the certificate subject is affiliated.

                • OrganizationalUnit — (String)

                  A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

                • DistinguishedNameQualifier — (String)

                  Disambiguating information for the certificate subject.

                • State — (String)

                  State in which the subject of the certificate is located.

                • CommonName — (String)

                  For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

                  Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

                • SerialNumber — (String)

                  The certificate serial number.

                • Locality — (String)

                  The locality (such as a city or town) in which the certificate subject is located.

                • Title — (String)

                  A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

                • Surname — (String)

                  Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

                • GivenName — (String)

                  First name.

                • Initials — (String)

                  Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

                • Pseudonym — (String)

                  Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

                • GenerationQualifier — (String)

                  Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

                • CustomAttributes — (Array<map>)

                  Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

                  Note: Custom attributes cannot be used in combination with standard attributes.
                  • ObjectIdentifier — required — (String)

                    Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

                  • Value — required — (String)

                    Specifies the attribute value of relative distinguished name (RDN).

              • EdiPartyName — (map)

                Represents GeneralName as an EdiPartyName object.

                • PartyName — required — (String)

                  Specifies the party name.

                • NameAssigner — (String)

                  Specifies the name assigner.

              • UniformResourceIdentifier — (String)

                Represents GeneralName as a URI.

              • IpAddress — (String)

                Represents GeneralName as an IPv4 or IPv6 address.

              • RegisteredId — (String)

                Represents GeneralName as an object identifier (OID).

      • RevocationConfiguration — (map)

        Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

        • CrlConfiguration — (map)

          Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.

          • Enabled — required — (Boolean)

            Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.

          • ExpirationInDays — (Integer)

            Validity period of the CRL in days.

          • CustomCname — (String)

            Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.

            Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
          • S3BucketName — (String)

            Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.

            Note: The S3BucketName parameter must conform to the S3 bucket naming rules.
          • S3ObjectAcl — (String)

            Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

            If no value is specified, the default is PUBLIC_READ.

            Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

            For more information, see Blocking public access to the S3 bucket.

            Possible values include:
            • "PUBLIC_READ"
            • "BUCKET_OWNER_FULL_CONTROL"
          • CrlDistributionPointExtensionConfiguration — (map)

            Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.

            • OmitExtension — required — (Boolean)

              Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.

              Note: Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger This configuration cannot be enabled with a custom CNAME set.
        • OcspConfiguration — (map)

          Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.

          • Enabled — required — (Boolean)

            Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

          • OcspCustomCname — (String)

            By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

            Note: The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".

            For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.

      • RestorableUntil — (Date)

        The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

      • KeyStorageSecurityStandard — (String)

        Defines a cryptographic key management compliance standard used for handling CA keys.

        Default: FIPS_140_2_LEVEL_3_OR_HIGHER

        Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

        Possible values include:
        • "FIPS_140_2_LEVEL_2_OR_HIGHER"
        • "FIPS_140_2_LEVEL_3_OR_HIGHER"
        • "CCPC_LEVEL_1_OR_HIGHER"
      • UsageMode — (String)

        Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

        The default value is GENERAL_PURPOSE.

        Possible values include:
        • "GENERAL_PURPOSE"
        • "SHORT_LIVED_CERTIFICATE"

Returns:

• (AWS.Request) —

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