Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ACMPCA

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

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each ACM Private CA API operation has a quota that determines the number of times the operation can be called per second. ACM Private CA throttles API requests at different rates depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, ACM Private CA returns a ThrottlingException error. ACM Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of ACMPCAClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

createCertificateAuthority

  • Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), 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 OCSP configuration can optionally specify a custom URL for the OCSP responder. 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.

    ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns Promise<CreateCertificateAuthorityCommandOutput>

  • Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), 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 OCSP configuration can optionally specify a custom URL for the OCSP responder. 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.

    ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

  • Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), 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 OCSP configuration can optionally specify a custom URL for the OCSP responder. 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.

    ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

  • Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), 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 OCSP configuration can optionally specify a custom URL for the OCSP responder. 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.

    ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    • args: CreateCertificateAuthorityCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateCertificateAuthorityCommandOutput>

  • Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), 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 OCSP configuration can optionally specify a custom URL for the OCSP responder. 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.

    ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

  • Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), 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 OCSP configuration can optionally specify a custom URL for the OCSP responder. 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.

    ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

createCertificateAuthorityAuditReport

createPermission

  • Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns Promise<CreatePermissionCommandOutput>

  • Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    • args: CreatePermissionCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreatePermissionCommandOutput>

  • Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

deleteCertificateAuthority

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

    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.

    Parameters

    Returns Promise<DeleteCertificateAuthorityCommandOutput>

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

    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.

    Parameters

    Returns void

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

    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.

    Parameters

    Returns void

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

    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.

    Parameters

    • args: DeleteCertificateAuthorityCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteCertificateAuthorityCommandOutput>

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

    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.

    Parameters

    Returns void

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

    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.

    Parameters

    Returns void

deletePermission

  • Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

    Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns Promise<DeletePermissionCommandOutput>

  • Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

    Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

    Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

    Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    • args: DeletePermissionCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeletePermissionCommandOutput>

  • Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

    Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

    Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

deletePolicy

  • Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

    If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

    The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

    The current policy can be shown with GetPolicy and updated with PutPolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns Promise<DeletePolicyCommandOutput>

  • Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

    If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

    The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

    The current policy can be shown with GetPolicy and updated with PutPolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

    If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

    The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

    The current policy can be shown with GetPolicy and updated with PutPolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

    If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

    The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

    The current policy can be shown with GetPolicy and updated with PutPolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    • args: DeletePolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeletePolicyCommandOutput>

  • Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

    If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

    The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

    The current policy can be shown with GetPolicy and updated with PutPolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

    If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

    The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

    The current policy can be shown with GetPolicy and updated with PutPolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

describeCertificateAuthority

  • Lists information about your private certificate authority (CA) or one that has been shared with you. 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 back-end Amazon Web Services 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.

    Parameters

    Returns Promise<DescribeCertificateAuthorityCommandOutput>

  • Lists information about your private certificate authority (CA) or one that has been shared with you. 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 back-end Amazon Web Services 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.

    Parameters

    Returns void

  • Lists information about your private certificate authority (CA) or one that has been shared with you. 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 back-end Amazon Web Services 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.

    Parameters

    Returns void

  • Lists information about your private certificate authority (CA) or one that has been shared with you. 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 back-end Amazon Web Services 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.

    Parameters

    • args: DescribeCertificateAuthorityCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeCertificateAuthorityCommandOutput>

  • Lists information about your private certificate authority (CA) or one that has been shared with you. 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 back-end Amazon Web Services 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.

    Parameters

    Returns void

  • Lists information about your private certificate authority (CA) or one that has been shared with you. 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 back-end Amazon Web Services 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.

    Parameters

    Returns void

describeCertificateAuthorityAuditReport

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getCertificate

  • Retrieves a certificate from your private CA or one that has been shared with you. 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.

    Parameters

    Returns Promise<GetCertificateCommandOutput>

  • Retrieves a certificate from your private CA or one that has been shared with you. 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.

    Parameters

    Returns void

  • Retrieves a certificate from your private CA or one that has been shared with you. 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.

    Parameters

    Returns void

  • Retrieves a certificate from your private CA or one that has been shared with you. 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.

    Parameters

    • args: GetCertificateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetCertificateCommandOutput>

  • Retrieves a certificate from your private CA or one that has been shared with you. 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.

    Parameters

    Returns void

  • Retrieves a certificate from your private CA or one that has been shared with you. 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.

    Parameters

    Returns void

getCertificateAuthorityCertificate

getCertificateAuthorityCsr

getPolicy

  • Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

    The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns Promise<GetPolicyCommandOutput>

  • Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

    The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

    The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

    The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    • args: GetPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetPolicyCommandOutput>

  • Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

    The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

    The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

importCertificateAuthorityCertificate

  • 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 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 by either an on-premises PKI hierarchy or by a commercial CA.

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

    ACM Private CA supports three scenarios for installing a CA certificate:

    • Installing a certificate for a root CA hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is externally hosted.

    The following additional requirements apply when you import a CA certificate.

    • Only a self-signed certificate can be imported as a root CA.

    • A self-signed certificate cannot be imported as a subordinate CA.

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

    • Your root CA 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.

    • The maximum allowed size of a certificate is 32 KB.

    • The maximum allowed size of a certificate chain is 2 MB.

    Enforcement of Critical Constraints

    ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

    • Basic constraints (must be marked critical)

    • Subject alternative names

    • Key usage

    • Extended key usage

    • Authority key identifier

    • Subject key identifier

    • Issuer alternative name

    • Subject directory attributes

    • Subject information access

    • Certificate policies

    • Policy mappings

    • Inhibit anyPolicy

    ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

    • Name constraints

    • Policy constraints

    • CRL distribution points

    • Authority information access

    • Freshest CRL

    • Any other extension

    Parameters

    Returns Promise<ImportCertificateAuthorityCertificateCommandOutput>

  • 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 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 by either an on-premises PKI hierarchy or by a commercial CA.

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

    ACM Private CA supports three scenarios for installing a CA certificate:

    • Installing a certificate for a root CA hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is externally hosted.

    The following additional requirements apply when you import a CA certificate.

    • Only a self-signed certificate can be imported as a root CA.

    • A self-signed certificate cannot be imported as a subordinate CA.

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

    • Your root CA 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.

    • The maximum allowed size of a certificate is 32 KB.

    • The maximum allowed size of a certificate chain is 2 MB.

    Enforcement of Critical Constraints

    ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

    • Basic constraints (must be marked critical)

    • Subject alternative names

    • Key usage

    • Extended key usage

    • Authority key identifier

    • Subject key identifier

    • Issuer alternative name

    • Subject directory attributes

    • Subject information access

    • Certificate policies

    • Policy mappings

    • Inhibit anyPolicy

    ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

    • Name constraints

    • Policy constraints

    • CRL distribution points

    • Authority information access

    • Freshest CRL

    • Any other extension

    Parameters

    Returns void

  • 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 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 by either an on-premises PKI hierarchy or by a commercial CA.

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

    ACM Private CA supports three scenarios for installing a CA certificate:

    • Installing a certificate for a root CA hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is externally hosted.

    The following additional requirements apply when you import a CA certificate.

    • Only a self-signed certificate can be imported as a root CA.

    • A self-signed certificate cannot be imported as a subordinate CA.

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

    • Your root CA 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.

    • The maximum allowed size of a certificate is 32 KB.

    • The maximum allowed size of a certificate chain is 2 MB.

    Enforcement of Critical Constraints

    ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

    • Basic constraints (must be marked critical)

    • Subject alternative names

    • Key usage

    • Extended key usage

    • Authority key identifier

    • Subject key identifier

    • Issuer alternative name

    • Subject directory attributes

    • Subject information access

    • Certificate policies

    • Policy mappings

    • Inhibit anyPolicy

    ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

    • Name constraints

    • Policy constraints

    • CRL distribution points

    • Authority information access

    • Freshest CRL

    • Any other extension

    Parameters

    Returns void

  • 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 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 by either an on-premises PKI hierarchy or by a commercial CA.

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

    ACM Private CA supports three scenarios for installing a CA certificate:

    • Installing a certificate for a root CA hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is externally hosted.

    The following additional requirements apply when you import a CA certificate.

    • Only a self-signed certificate can be imported as a root CA.

    • A self-signed certificate cannot be imported as a subordinate CA.

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

    • Your root CA 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.

    • The maximum allowed size of a certificate is 32 KB.

    • The maximum allowed size of a certificate chain is 2 MB.

    Enforcement of Critical Constraints

    ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

    • Basic constraints (must be marked critical)

    • Subject alternative names

    • Key usage

    • Extended key usage

    • Authority key identifier

    • Subject key identifier

    • Issuer alternative name

    • Subject directory attributes

    • Subject information access

    • Certificate policies

    • Policy mappings

    • Inhibit anyPolicy

    ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

    • Name constraints

    • Policy constraints

    • CRL distribution points

    • Authority information access

    • Freshest CRL

    • Any other extension

    Parameters

    • args: ImportCertificateAuthorityCertificateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ImportCertificateAuthorityCertificateCommandOutput>

  • 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 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 by either an on-premises PKI hierarchy or by a commercial CA.

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

    ACM Private CA supports three scenarios for installing a CA certificate:

    • Installing a certificate for a root CA hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is externally hosted.

    The following additional requirements apply when you import a CA certificate.

    • Only a self-signed certificate can be imported as a root CA.

    • A self-signed certificate cannot be imported as a subordinate CA.

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

    • Your root CA 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.

    • The maximum allowed size of a certificate is 32 KB.

    • The maximum allowed size of a certificate chain is 2 MB.

    Enforcement of Critical Constraints

    ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

    • Basic constraints (must be marked critical)

    • Subject alternative names

    • Key usage

    • Extended key usage

    • Authority key identifier

    • Subject key identifier

    • Issuer alternative name

    • Subject directory attributes

    • Subject information access

    • Certificate policies

    • Policy mappings

    • Inhibit anyPolicy

    ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

    • Name constraints

    • Policy constraints

    • CRL distribution points

    • Authority information access

    • Freshest CRL

    • Any other extension

    Parameters

    Returns void

  • 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 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 by either an on-premises PKI hierarchy or by a commercial CA.

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

    ACM Private CA supports three scenarios for installing a CA certificate:

    • Installing a certificate for a root CA hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.

    • Installing a subordinate CA certificate whose parent authority is externally hosted.

    The following additional requirements apply when you import a CA certificate.

    • Only a self-signed certificate can be imported as a root CA.

    • A self-signed certificate cannot be imported as a subordinate CA.

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

    • Your root CA 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.

    • The maximum allowed size of a certificate is 32 KB.

    • The maximum allowed size of a certificate chain is 2 MB.

    Enforcement of Critical Constraints

    ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

    • Basic constraints (must be marked critical)

    • Subject alternative names

    • Key usage

    • Extended key usage

    • Authority key identifier

    • Subject key identifier

    • Issuer alternative name

    • Subject directory attributes

    • Subject information access

    • Certificate policies

    • Policy mappings

    • Inhibit anyPolicy

    ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

    • Name constraints

    • Policy constraints

    • CRL distribution points

    • Authority information access

    • Freshest CRL

    • Any other extension

    Parameters

    Returns void

issueCertificate

  • Uses your private certificate authority (CA), or one that has been shared with you, 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.

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

    Parameters

    Returns Promise<IssueCertificateCommandOutput>

  • Uses your private certificate authority (CA), or one that has been shared with you, 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.

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

    Parameters

    Returns void

  • Uses your private certificate authority (CA), or one that has been shared with you, 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.

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

    Parameters

    Returns void

  • Uses your private certificate authority (CA), or one that has been shared with you, 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.

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

    Parameters

    • args: IssueCertificateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<IssueCertificateCommandOutput>

  • Uses your private certificate authority (CA), or one that has been shared with you, 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.

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

    Parameters

    Returns void

  • Uses your private certificate authority (CA), or one that has been shared with you, 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.

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

    Parameters

    Returns void

listCertificateAuthorities

listPermissions

  • List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns Promise<ListPermissionsCommandOutput>

  • List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    • args: ListPermissionsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListPermissionsCommandOutput>

  • List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

  • List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

    These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

    Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

    About Permissions

    • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

    • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

    • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

    Parameters

    Returns void

listTags

putPolicy

  • Attaches a resource-based policy to a private CA.

    A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

    The policy can be displayed with GetPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns Promise<PutPolicyCommandOutput>

  • Attaches a resource-based policy to a private CA.

    A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

    The policy can be displayed with GetPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Attaches a resource-based policy to a private CA.

    A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

    The policy can be displayed with GetPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Attaches a resource-based policy to a private CA.

    A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

    The policy can be displayed with GetPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    • args: PutPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutPolicyCommandOutput>

  • Attaches a resource-based policy to a private CA.

    A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

    The policy can be displayed with GetPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

  • Attaches a resource-based policy to a private CA.

    A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

    The policy can be displayed with GetPolicy and removed with DeletePolicy.

    About Policies

    • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.

    • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

    • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.

    • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

    Parameters

    Returns void

restoreCertificateAuthority

revokeCertificate

  • 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

    You cannot revoke a root CA self-signed certificate.

    Parameters

    Returns Promise<RevokeCertificateCommandOutput>

  • 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

    You cannot revoke a root CA self-signed certificate.

    Parameters

    Returns void

  • 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

    You cannot revoke a root CA self-signed certificate.

    Parameters

    Returns void

  • 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

    You cannot revoke a root CA self-signed certificate.

    Parameters

    • args: RevokeCertificateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<RevokeCertificateCommandOutput>

  • 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

    You cannot revoke a root CA self-signed certificate.

    Parameters

    Returns void

  • 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

    You cannot revoke a root CA self-signed certificate.

    Parameters

    Returns void

send

tagCertificateAuthority

  • Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the 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.

    Parameters

    Returns Promise<TagCertificateAuthorityCommandOutput>

  • Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the 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.

    Parameters

    Returns void

  • Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the 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.

    Parameters

    Returns void

  • Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the 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.

    Parameters

    • args: TagCertificateAuthorityCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<TagCertificateAuthorityCommandOutput>

  • Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the 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.

    Parameters

    Returns void

  • Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the 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.

    Parameters

    Returns void

untagCertificateAuthority

updateCertificateAuthority

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

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns Promise<UpdateCertificateAuthorityCommandOutput>

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

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

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

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

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

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    • args: UpdateCertificateAuthorityCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UpdateCertificateAuthorityCommandOutput>

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

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void

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

    Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

    Parameters

    Returns void