Class: AWS.ACMPCA

Inherits:
AWS.Service show all
Identifier:
acmpca
API Version:
2017-08-22
Defined in:
(unknown)

Overview

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

Service Description

This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.

The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

Note: Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA in the ACM Private CA user guide.

Sending a Request Using ACMPCA

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

Locking the API Version

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

var acmpca = new AWS.ACMPCA({apiVersion: '2017-08-22'});

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

AWS.config.apiVersions = {
  acmpca: '2017-08-22',
  // other service API versions
};

var acmpca = new AWS.ACMPCA();

Version:

  • 2017-08-22

Waiter Resource States

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

certificateAuthorityCSRCreated, certificateIssued, auditReportCreated

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a ACMPCA object

var acmpca = new AWS.ACMPCA({apiVersion: '2017-08-22'});

Options Hash (options):

  • params (map)

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

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.

Service Reference:

Examples:

Calling the createCertificateAuthority operation

var params = {
  CertificateAuthorityConfiguration: { /* required */
    KeyAlgorithm: RSA_2048 | RSA_4096 | EC_prime256v1 | EC_secp384r1, /* required */
    SigningAlgorithm: SHA256WITHECDSA | SHA384WITHECDSA | SHA512WITHECDSA | SHA256WITHRSA | SHA384WITHRSA | SHA512WITHRSA, /* required */
    Subject: { /* required */
      CommonName: 'STRING_VALUE',
      Country: 'STRING_VALUE',
      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'
    }
  },
  CertificateAuthorityType: ROOT | SUBORDINATE, /* required */
  IdempotencyToken: 'STRING_VALUE',
  RevocationConfiguration: {
    CrlConfiguration: {
      Enabled: true || false, /* required */
      CustomCname: 'STRING_VALUE',
      ExpirationInDays: 'NUMBER_VALUE',
      S3BucketName: 'STRING_VALUE'
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
acmpca.createCertificateAuthority(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: {})
    • CertificateAuthorityConfiguration — (map)

      Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

      • KeyAlgorithmrequired — (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"
      • SigningAlgorithmrequired — (String)

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

        Possible values include:
        • "SHA256WITHECDSA"
        • "SHA384WITHECDSA"
        • "SHA512WITHECDSA"
        • "SHA256WITHRSA"
        • "SHA384WITHRSA"
        • "SHA512WITHRSA"
      • Subjectrequired — (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)

          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.

    • RevocationConfiguration — (map)

      Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.

      • CrlConfiguration — (map)

        Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.

        • Enabledrequired — (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)

          Number of days until a certificate expires.

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

        • 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 action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

    • CertificateAuthorityType — (String)

      The type of the certificate authority.

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

      Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.

    • Tags — (Array<map>)

      Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with

      IAM to manage permissions, see Controlling Access Using IAM Tags.

      • Keyrequired — (String)

        Key (name) of the tag.

      • Value — (String)

        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:

      • CertificateAuthorityArn — (String)

        If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:

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

Returns:

  • (AWS.Request)

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

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

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

Examples:

Calling the createCertificateAuthorityAuditReport operation

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.

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

Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.

At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission action and listed with the ListPermissions action.

Service Reference:

Examples:

Calling the createPermission operation

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

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

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Note: Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

Service Reference:

Examples:

Calling the deleteCertificateAuthority operation

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.

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

Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action.

Service Reference:

Examples:

Calling the deletePermission operation

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

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

Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

  • CREATING - ACM Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

  • FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

  • DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

Service Reference:

Examples:

Calling the describeCertificateAuthority operation

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 .

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

          • KeyAlgorithmrequired — (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"
          • SigningAlgorithmrequired — (String)

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

            Possible values include:
            • "SHA256WITHECDSA"
            • "SHA384WITHECDSA"
            • "SHA512WITHECDSA"
            • "SHA256WITHRSA"
            • "SHA384WITHRSA"
            • "SHA512WITHRSA"
          • Subjectrequired — (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)

              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.

        • RevocationConfiguration — (map)

          Information about the 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.

            • Enabledrequired — (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)

              Number of days until a certificate expires.

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

            • 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 action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

        • RestorableUntil — (Date)

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

Returns:

  • (AWS.Request)

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

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

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

Examples:

Calling the describeCertificateAuthorityAuditReport operation

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:

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

Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.

Service Reference:

Examples:

Calling the getCertificate operation

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

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

Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

Examples:

Calling the getCertificateAuthorityCertificate operation

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 on-premises 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.

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

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.

Service Reference:

Examples:

Calling the getCertificateAuthorityCsr operation

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:

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

Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:

  1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

  3. Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or a commercial CA..

  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

  • You cannot import a non-self-signed certificate for use as a root CA.

  • You cannot import a self-signed certificate for use as a subordinate CA.

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

  • The chain must be PEM-encoded.

Examples:

Calling the importCertificateAuthorityCertificate operation

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

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

Uses your private certificate authority (CA) to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

Note: You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.

Service Reference:

Examples:

Calling the issueCertificate operation

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, /* required */
  Validity: { /* required */
    Type: END_DATE | ABSOLUTE | DAYS | MONTHS | YEARS, /* required */
    Value: 'NUMBER_VALUE' /* required */
  },
  IdempotencyToken: 'STRING_VALUE',
  TemplateArn: 'STRING_VALUE'
};
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: {})
    • 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. 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 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

    • SigningAlgorithm — (String)

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

      Possible values include:
      • "SHA256WITHECDSA"
      • "SHA384WITHECDSA"
      • "SHA512WITHECDSA"
      • "SHA256WITHRSA"
      • "SHA384WITHRSA"
      • "SHA512WITHRSA"
    • TemplateArn — (String)

      Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

      The following service-owned TemplateArn values are supported by ACM Private CA:

      • arn:aws:acm-pca:::template/EndEntityCertificate/V1

      • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

      • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

      • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

      • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

      • arn:aws:acm-pca:::template/RootCACertificate/V1

      For more information, see Using Templates.

    • Validity — (map)

      The type of the validity period.

      • Valuerequired — (Integer)

        Time period.

      • Typerequired — (String)

        Specifies whether the Value parameter represents days, months, or years.

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

      Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA 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.

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

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

Service Reference:

Examples:

Calling the listCertificateAuthorities operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
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: {})
    • 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.

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

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:

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

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

          • KeyAlgorithmrequired — (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"
          • SigningAlgorithmrequired — (String)

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

            Possible values include:
            • "SHA256WITHECDSA"
            • "SHA384WITHECDSA"
            • "SHA512WITHECDSA"
            • "SHA256WITHRSA"
            • "SHA384WITHRSA"
            • "SHA512WITHRSA"
          • Subjectrequired — (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)

              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.

        • RevocationConfiguration — (map)

          Information about the 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.

            • Enabledrequired — (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)

              Number of days until a certificate expires.

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

            • 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 action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

        • RestorableUntil — (Date)

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

      • NextToken — (String)

        When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Returns:

  • (AWS.Request)

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

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

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

Service Reference:

Examples:

Calling the listPermissions operation

var params = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
acmpca.listPermissions(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 to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

    • NextToken — (String)

      When paginating results, use this parameter 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.

    • MaxResults — (Integer)

      When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Permissions — (Array<map>)

        Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.

        • CertificateAuthorityArn — (String)

          The Amazon Resource Number (ARN) of the private CA from which the permission was issued.

        • CreatedAt — (Date)

          The time at which the permission was created.

        • Principal — (String)

          The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.

        • SourceAccount — (String)

          The ID of the account that assigned the permission.

        • Actions — (Array<String>)

          The private CA actions that can be performed by the designated AWS service.

        • Policy — (String)

          The name of the policy that is associated with the permission.

      • NextToken — (String)

        When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Returns:

  • (AWS.Request)

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

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

Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
acmpca.listTags(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

    • 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 NextToken from the response you just received.

    • MaxResults — (Integer)

      Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Tags — (Array<map>)

        The tags associated with your private CA.

        • Keyrequired — (String)

          Key (name) of the tag.

        • Value — (String)

          Value of the tag.

      • NextToken — (String)

        When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

Returns:

  • (AWS.Request)

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

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

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.

Service Reference:

Examples:

Calling the restoreCertificateAuthority operation

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

Returns:

  • (AWS.Request)

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

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

Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

Note: You cannot revoke a root CA self-signed certificate.

Service Reference:

Examples:

Calling the revokeCertificate operation

var params = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  CertificateSerial: 'STRING_VALUE', /* required */
  RevocationReason: UNSPECIFIED | KEY_COMPROMISE | CERTIFICATE_AUTHORITY_COMPROMISE | AFFILIATION_CHANGED | SUPERSEDED | CESSATION_OF_OPERATION | PRIVILEGE_WITHDRAWN | A_A_COMPROMISE /* required */
};
acmpca.revokeCertificate(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)

      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

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

    • CertificateSerial — (String)

      Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

      openssl x509 -in file_path -text -noout

      You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.

    • RevocationReason — (String)

      Specifies why you revoked the certificate.

      Possible values include:
      • "UNSPECIFIED"
      • "KEY_COMPROMISE"
      • "CERTIFICATE_AUTHORITY_COMPROMISE"
      • "AFFILIATION_CHANGED"
      • "SUPERSEDED"
      • "CESSATION_OF_OPERATION"
      • "PRIVILEGE_WITHDRAWN"
      • "A_A_COMPROMISE"

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.

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

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.

Service Reference:

Examples:

Calling the tagCertificateAuthority operation

var params = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
acmpca.tagCertificateAuthority(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

    • Tags — (Array<map>)

      List of tags to be associated with the CA.

      • Keyrequired — (String)

        Key (name) of the tag.

      • Value — (String)

        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.

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

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.

Service Reference:

Examples:

Calling the untagCertificateAuthority operation

var params = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
acmpca.untagCertificateAuthority(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

    • Tags — (Array<map>)

      List of tags to be removed from the CA.

      • Keyrequired — (String)

        Key (name) of the tag.

      • Value — (String)

        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.

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

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Service Reference:

Examples:

Calling the updateCertificateAuthority operation

var params = {
  CertificateAuthorityArn: 'STRING_VALUE', /* required */
  RevocationConfiguration: {
    CrlConfiguration: {
      Enabled: true || false, /* required */
      CustomCname: 'STRING_VALUE',
      ExpirationInDays: 'NUMBER_VALUE',
      S3BucketName: 'STRING_VALUE'
    }
  },
  Status: CREATING | PENDING_CERTIFICATE | ACTIVE | DELETED | DISABLED | EXPIRED | FAILED
};
acmpca.updateCertificateAuthority(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)

      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

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

    • RevocationConfiguration — (map)

      Revocation information for your private CA.

      • CrlConfiguration — (map)

        Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.

        • Enabledrequired — (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)

          Number of days until a certificate expires.

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

        • 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 action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

    • Status — (String)

      Status of your private CA.

      Possible values include:
      • "CREATING"
      • "PENDING_CERTIFICATE"
      • "ACTIVE"
      • "DELETED"
      • "DISABLED"
      • "EXPIRED"
      • "FAILED"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

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

Examples:

Waiting for the certificateAuthorityCSRCreated state

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

Parameters:

  • state (String)

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

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

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

Callback (callback):

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

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

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

Returns:

  • (AWS.Request)

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

Waiter Resource States:

Waiter Resource Details

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

Waits for the certificateAuthorityCSRCreated state by periodically calling the underlying ACMPCA.getCertificateAuthorityCsr() operation every 3 seconds (at most 60 times).

Examples:

Waiting for the certificateAuthorityCSRCreated state

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

Parameters:

  • params (Object)
    • 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.

See Also:

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

Waits for the certificateIssued state by periodically calling the underlying ACMPCA.getCertificate() operation every 3 seconds (at most 60 times).

Examples:

Waiting for the certificateIssued state

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

Parameters:

  • params (Object)
    • 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 on-premises 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.

See Also:

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

Waits for the auditReportCreated state by periodically calling the underlying ACMPCA.describeCertificateAuthorityAuditReport() operation every 3 seconds (at most 60 times).

Examples:

Waiting for the auditReportCreated state

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

Parameters:

  • params (Object)
    • 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.

See Also: