@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCertificateManagerAsync extends AWSCertificateManager
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCertificateManagerAsync instead.
Welcome to the AWS Certificate Manager (ACM) API documentation.
You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .
ENDPOINT_PREFIXaddTagsToCertificate, deleteCertificate, describeCertificate, exportCertificate, getCachedResponseMetadata, getCertificate, importCertificate, listCertificates, listTagsForCertificate, removeTagsFromCertificate, renewCertificate, requestCertificate, resendValidationEmail, setEndpoint, setRegion, shutdown, updateCertificateOptions, waitersFuture<AddTagsToCertificateResult> addTagsToCertificateAsync(AddTagsToCertificateRequest addTagsToCertificateRequest)
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.
You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
addTagsToCertificateRequest - Future<AddTagsToCertificateResult> addTagsToCertificateAsync(AddTagsToCertificateRequest addTagsToCertificateRequest, AsyncHandler<AddTagsToCertificateRequest,AddTagsToCertificateResult> asyncHandler)
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.
You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
addTagsToCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest)
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.
You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
deleteCertificateRequest - Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResult> asyncHandler)
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.
You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
deleteCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest)
Returns detailed metadata about the specified ACM certificate.
describeCertificateRequest - Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
Returns detailed metadata about the specified ACM certificate.
describeCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ExportCertificateResult> exportCertificateAsync(ExportCertificateRequest exportCertificateRequest)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.
openssl rsa -in encrypted_key.pem -out decrypted_key.pem
exportCertificateRequest - Future<ExportCertificateResult> exportCertificateAsync(ExportCertificateRequest exportCertificateRequest, AsyncHandler<ExportCertificateRequest,ExportCertificateResult> asyncHandler)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.
openssl rsa -in encrypted_key.pem -out decrypted_key.pem
exportCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCertificateResult> getCertificateAsync(GetCertificateRequest getCertificateRequest)
Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.
getCertificateRequest - Future<GetCertificateResult> getCertificateAsync(GetCertificateRequest getCertificateRequest, AsyncHandler<GetCertificateRequest,GetCertificateResult> asyncHandler)
Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.
getCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest importCertificateRequest)
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.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
If the certificate you are importing is not self-signed, you must enter its certificate chain.
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before and Not After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn argument. Include this argument only when you
want to replace a previously imported certificate.
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the
private key by their file names preceded by file://. For example, you can specify a certificate
saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are
making an HTTP or HTTPS Query request, include these arguments as BLOBs.
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificateRequest - Future<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest importCertificateRequest, AsyncHandler<ImportCertificateRequest,ImportCertificateResult> asyncHandler)
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.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
If the certificate you are importing is not self-signed, you must enter its certificate chain.
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before and Not After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn argument. Include this argument only when you
want to replace a previously imported certificate.
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the
private key by their file names preceded by file://. For example, you can specify a certificate
saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are
making an HTTP or HTTPS Query request, include these arguments as BLOBs.
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest listCertificatesRequest)
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.
listCertificatesRequest - Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest listCertificatesRequest, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
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.
listCertificatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForCertificateResult> listTagsForCertificateAsync(ListTagsForCertificateRequest listTagsForCertificateRequest)
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.
listTagsForCertificateRequest - Future<ListTagsForCertificateResult> listTagsForCertificateAsync(ListTagsForCertificateRequest listTagsForCertificateRequest, AsyncHandler<ListTagsForCertificateRequest,ListTagsForCertificateResult> asyncHandler)
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.
listTagsForCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveTagsFromCertificateResult> removeTagsFromCertificateAsync(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest)
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.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
removeTagsFromCertificateRequest - Future<RemoveTagsFromCertificateResult> removeTagsFromCertificateAsync(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest, AsyncHandler<RemoveTagsFromCertificateRequest,RemoveTagsFromCertificateResult> asyncHandler)
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.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
removeTagsFromCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RenewCertificateResult> renewCertificateAsync(RenewCertificateRequest renewCertificateRequest)
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.
renewCertificateRequest - Future<RenewCertificateResult> renewCertificateAsync(RenewCertificateRequest renewCertificateRequest, AsyncHandler<RenewCertificateRequest,RenewCertificateResult> asyncHandler)
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.
renewCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RequestCertificateResult> requestCertificateAsync(RequestCertificateRequest requestCertificateRequest)
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.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
requestCertificateRequest - Future<RequestCertificateResult> requestCertificateAsync(RequestCertificateRequest requestCertificateRequest, AsyncHandler<RequestCertificateRequest,RequestCertificateResult> asyncHandler)
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.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
requestCertificateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResendValidationEmailResult> resendValidationEmailAsync(ResendValidationEmailRequest resendValidationEmailRequest)
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.
resendValidationEmailRequest - Future<ResendValidationEmailResult> resendValidationEmailAsync(ResendValidationEmailRequest resendValidationEmailRequest, AsyncHandler<ResendValidationEmailRequest,ResendValidationEmailResult> asyncHandler)
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.
resendValidationEmailRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateCertificateOptionsResult> updateCertificateOptionsAsync(UpdateCertificateOptionsRequest updateCertificateOptionsRequest)
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.
updateCertificateOptionsRequest - Future<UpdateCertificateOptionsResult> updateCertificateOptionsAsync(UpdateCertificateOptionsRequest updateCertificateOptionsRequest, AsyncHandler<UpdateCertificateOptionsRequest,UpdateCertificateOptionsResult> asyncHandler)
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.
updateCertificateOptionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.