ACMPCA class

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

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

Constructors

ACMPCA({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createCertificateAuthority({required CertificateAuthorityConfiguration certificateAuthorityConfiguration, required CertificateAuthorityType certificateAuthorityType, String? idempotencyToken, RevocationConfiguration? revocationConfiguration, List<Tag>? tags}) → Future<CreateCertificateAuthorityResponse>
Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
createCertificateAuthorityAuditReport({required AuditReportResponseFormat auditReportResponseFormat, required String certificateAuthorityArn, required String s3BucketName}) → Future<CreateCertificateAuthorityAuditReportResponse>
Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key. ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
createPermission({required List<ActionType> actions, required String certificateAuthorityArn, required String principal, String? sourceAccount}) → Future<void>
Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.
deleteCertificateAuthority({required String certificateAuthorityArn, int? permanentDeletionTimeInDays}) → Future<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. 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.
deletePermission({required String certificateAuthorityArn, required String principal, String? sourceAccount}) → Future<void>
Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).
deletePolicy({required String resourceArn}) → Future<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.
describeCertificateAuthority({required String certificateAuthorityArn}) → Future<DescribeCertificateAuthorityResponse>
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:
describeCertificateAuthorityAuditReport({required String auditReportId, required String certificateAuthorityArn}) → Future<DescribeCertificateAuthorityAuditReportResponse>
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
getCertificate({required String certificateArn, required String certificateAuthorityArn}) → Future<GetCertificateResponse>
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.
getCertificateAuthorityCertificate({required String certificateAuthorityArn}) → Future<GetCertificateAuthorityCertificateResponse>
Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
getCertificateAuthorityCsr({required String certificateAuthorityArn}) → Future<GetCertificateAuthorityCsrResponse>
Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
getPolicy({required String resourceArn}) → Future<GetPolicyResponse>
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.
importCertificateAuthorityCertificate({required Uint8List certificate, required String certificateAuthorityArn, Uint8List? certificateChain}) → Future<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:
issueCertificate({required String certificateAuthorityArn, required Uint8List csr, required SigningAlgorithm signingAlgorithm, required Validity validity, String? idempotencyToken, String? templateArn}) → Future<IssueCertificateResponse>
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.
listCertificateAuthorities({int? maxResults, String? nextToken, ResourceOwner? resourceOwner}) → Future<ListCertificateAuthoritiesResponse>
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
listPermissions({required String certificateAuthorityArn, int? maxResults, String? nextToken}) → Future<ListPermissionsResponse>
List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).
listTags({required String certificateAuthorityArn, int? maxResults, String? nextToken}) → Future<ListTagsResponse>
Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putPolicy({required String policy, required String resourceArn}) → Future<void>
Attaches a resource-based policy to a private CA.
restoreCertificateAuthority({required String certificateAuthorityArn}) → Future<void>
Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.
revokeCertificate({required String certificateAuthorityArn, required String certificateSerial, required RevocationReason revocationReason}) → Future<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. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
tagCertificateAuthority({required String certificateAuthorityArn, required List<Tag> tags}) → Future<void>
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.
toString() → String
A string representation of this object.
inherited
untagCertificateAuthority({required String certificateAuthorityArn, required List<Tag> tags}) → Future<void>
Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.
updateCertificateAuthority({required String certificateAuthorityArn, RevocationConfiguration? revocationConfiguration, CertificateAuthorityStatus? status}) → Future<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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited