@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_PREFIX
addTagsToCertificate, deleteCertificate, describeCertificate, getCachedResponseMetadata, getCertificate, importCertificate, listCertificates, listTagsForCertificate, removeTagsFromCertificate, requestCertificate, resendValidationEmail, setEndpoint, setRegion, shutdown
Future<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 an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates 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 other AWS services.
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 an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates 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 other AWS services.
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<GetCertificateResult> getCertificateAsync(GetCertificateRequest getCertificateRequest)
Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the ACM 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 chain to see the individual certificate fields, you can use OpenSSL.
getCertificateRequest
- Future<GetCertificateResult> getCertificateAsync(GetCertificateRequest getCertificateRequest, AsyncHandler<GetCertificateRequest,GetCertificateResult> asyncHandler)
Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the ACM 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 chain to see the individual certificate 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 an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
ACM does not provide managed renewal for certificates that you import.
For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.
The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide.
To import a new certificate, omit the CertificateArn
field. Include this field only when you want to
replace a previously imported certificate.
When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, chain, and
private key parameters as file names preceded by file://
. For example, you can specify a certificate
saved in the C:\temp
folder as C:\temp\certificate_to_import.pem
. If you are making an
HTTP or HTTPS Query request, include these parameters as BLOBs.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificateRequest
- Future<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest importCertificateRequest, AsyncHandler<ImportCertificateRequest,ImportCertificateResult> asyncHandler)
Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
ACM does not provide managed renewal for certificates that you import.
For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.
The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide.
To import a new certificate, omit the CertificateArn
field. Include this field only when you want to
replace a previously imported certificate.
When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, chain, and
private key parameters as file names preceded by file://
. For example, you can specify a certificate
saved in the C:\temp
folder as C:\temp\certificate_to_import.pem
. If you are making an
HTTP or HTTPS Query request, include these parameters as BLOBs.
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 ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
listCertificatesRequest
- Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest listCertificatesRequest, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
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<RequestCertificateResult> requestCertificateAsync(RequestCertificateRequest requestCertificateRequest)
Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the
fully qualified domain name (FQDN) for your site in the DomainName
parameter. You can also specify
additional FQDNs in the SubjectAlternativeNames
parameter if users can reach your site by using
other names.
For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate.
Email is sent to three registered contact addresses in the WHOIS database and to five common system
administration addresses formed from the DomainName
you enter or the optional
ValidationDomain
parameter. For more information, see Validate Domain Ownership.
After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.
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 the
fully qualified domain name (FQDN) for your site in the DomainName
parameter. You can also specify
additional FQDNs in the SubjectAlternativeNames
parameter if users can reach your site by using
other names.
For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate.
Email is sent to three registered contact addresses in the WHOIS database and to five common system
administration addresses formed from the DomainName
you enter or the optional
ValidationDomain
parameter. For more information, see Validate Domain Ownership.
After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.