ACM class

Welcome to the AWS Certificate Manager (ACM) API documentation.

Constructors

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

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addTagsToCertificate({required String certificateArn, required List<Tag> tags}) → Future<void>

Adds one or more tags to an ACM certificate. 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 certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

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.

deleteCertificate({required String certificateArn}) → Future<void>

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

describeCertificate({required String certificateArn}) → Future<DescribeCertificateResponse>

Returns detailed metadata about the specified ACM certificate.

exportCertificate({required String certificateArn, required Uint8List passphrase}) → Future<ExportCertificateResponse>

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

getCertificate({required String certificateArn}) → Future<GetCertificateResponse>

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

importCertificate({required Uint8List certificate, required Uint8List privateKey, String? certificateArn, Uint8List? certificateChain, List<Tag>? tags}) → Future<ImportCertificateResponse>

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide. Note the following guidelines when importing third party certificates:

listCertificates({List<CertificateStatus>? certificateStatuses, Filters? includes, int? maxItems, String? nextToken}) → Future<ListCertificatesResponse>

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

listTagsForCertificate({required String certificateArn}) → Future<ListTagsForCertificateResponse>

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeTagsFromCertificate({required String certificateArn, required List<Tag> tags}) → Future<void>

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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.

renewCertificate({required String certificateArn}) → Future<void>

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

requestCertificate({required String domainName, String? certificateAuthorityArn, List<DomainValidationOption>? domainValidationOptions, String? idempotencyToken, CertificateOptions? options, List<String>? subjectAlternativeNames, List<Tag>? tags, ValidationMethod? validationMethod}) → Future<RequestCertificateResponse>

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

resendValidationEmail({required String certificateArn, required String domain, required String validationDomain}) → Future<void>

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

toString() → String

A string representation of this object.

inherited

updateCertificateOptions({required String certificateArn, required CertificateOptions options}) → Future<void>

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

Operators

operator ==(Object other) → bool

The equality operator.

inherited