Package software.amazon.awssdk.services.acm

Interface ACMClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ACMClient
extends AutoCloseable

Service client for accessing ACM. This can be created using the static builder() method. AWS Certificate Manager

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 .

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddTagsToCertificateResponse	addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest)	Adds one or more tags to an ACM Certificate.
static ACMClientBuilder	builder()	Create a builder that can be used to configure and create a ACMClient.
static ACMClient	create()	Create a ACMClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteCertificateResponse	deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)	Deletes an ACM Certificate and its associated private key.
default DescribeCertificateResponse	describeCertificate(DescribeCertificateRequest describeCertificateRequest)	Returns detailed metadata about the specified ACM Certificate.
default GetCertificateResponse	getCertificate(GetCertificateRequest getCertificateRequest)	Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN.
default ImportCertificateResponse	importCertificate(ImportCertificateRequest importCertificateRequest)	Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
default ListCertificatesResponse	listCertificates(ListCertificatesRequest listCertificatesRequest)	Retrieves a list of ACM Certificates and the domain name for each.
default ListTagsForCertificateResponse	listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest)	Lists the tags that have been applied to the ACM Certificate.
default RemoveTagsFromCertificateResponse	removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest)	Remove one or more tags from an ACM Certificate.
default RequestCertificateResponse	requestCertificate(RequestCertificateRequest requestCertificateRequest)	Requests an ACM Certificate for use with other AWS services.
default ResendValidationEmailResponse	resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest)	Resends the email that requests domain ownership validation.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ACMClient create()

Create a ACMClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ACMClientBuilder builder()

Create a builder that can be used to configure and create a ACMClient.

addTagsToCertificate

default AddTagsToCertificateResponse addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest)
                                                   throws ResourceNotFoundException,
                                                          InvalidArnException,
                                                          InvalidTagException,
                                                          TooManyTagsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          ACMException

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.

Parameters:

addTagsToCertificateRequest -

Returns:

Result of the AddTagsToCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidTagException - One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

TooManyTagsException - The request contains too many tags. Try the request again with fewer tags.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteCertificate

default DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
                                             throws ResourceNotFoundException,
                                                    ResourceInUseException,
                                                    InvalidArnException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    ACMException

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.

Parameters:

deleteCertificateRequest -

Returns:

Result of the DeleteCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

ResourceInUseException - The certificate is in use by another AWS service in the caller's account. Remove the association and try again.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeCertificate

default DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidArnException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        ACMException

Returns detailed metadata about the specified ACM Certificate.

Parameters:

describeCertificateRequest -

Returns:

Result of the DescribeCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getCertificate

default GetCertificateResponse getCertificate(GetCertificateRequest getCertificateRequest)
                                       throws ResourceNotFoundException,
                                              RequestInProgressException,
                                              InvalidArnException,
                                              SdkBaseException,
                                              SdkClientException,
                                              ACMException

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 root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. 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.

Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.

Parameters:

getCertificateRequest -

Returns:

Result of the GetCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

RequestInProgressException - The certificate request is in process and the certificate in your account has not yet been issued.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

importCertificate

default ImportCertificateResponse importCertificate(ImportCertificateRequest importCertificateRequest)
                                             throws ResourceNotFoundException,
                                                    LimitExceededException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    ACMException

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.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Parameters:

importCertificateRequest -

Returns:

Result of the ImportCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

LimitExceededException - An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the Limits topic.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listCertificates

default ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest)
                                           throws SdkBaseException,
                                                  SdkClientException,
                                                  ACMException

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.

Parameters:

listCertificatesRequest -

Returns:

Result of the ListCertificates operation returned by the service.

Throws:

SdkBaseException

SdkClientException

ACMException

See Also:

AWS API Documentation

listTagsForCertificate

default ListTagsForCertificateResponse listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest)
                                                       throws ResourceNotFoundException,
                                                              InvalidArnException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              ACMException

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.

Parameters:

listTagsForCertificateRequest -

Returns:

Result of the ListTagsForCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

removeTagsFromCertificate

default RemoveTagsFromCertificateResponse removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest)
                                                             throws ResourceNotFoundException,
                                                                    InvalidArnException,
                                                                    InvalidTagException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    ACMException

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.

Parameters:

removeTagsFromCertificateRequest -

Returns:

Result of the RemoveTagsFromCertificate operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidTagException - One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

requestCertificate

default RequestCertificateResponse requestCertificate(RequestCertificateRequest requestCertificateRequest)
                                               throws LimitExceededException,
                                                      InvalidDomainValidationOptionsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      ACMException

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. You can also specify additional FQDNs 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. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.

Parameters:

requestCertificateRequest -

Returns:

Result of the RequestCertificate operation returned by the service.

Throws:

LimitExceededException - An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the Limits topic.

InvalidDomainValidationOptionsException - One or more values in the DomainValidationOption structure is incorrect.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

resendValidationEmail

default ResendValidationEmailResponse resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest)
                                                     throws ResourceNotFoundException,
                                                            InvalidStateException,
                                                            InvalidArnException,
                                                            InvalidDomainValidationOptionsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            ACMException

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.

Parameters:

resendValidationEmailRequest -

Returns:

Result of the ResendValidationEmail operation returned by the service.

Throws:

ResourceNotFoundException - The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

InvalidStateException - Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidDomainValidationOptionsException - One or more values in the DomainValidationOption structure is incorrect.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ACMException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()