@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AcmClient extends AwsClient
builder() method.
You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddTagsToCertificateResponse |
addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest)
Adds one or more tags to an ACM certificate.
|
default AddTagsToCertificateResponse |
addTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> 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(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes a certificate and its associated private key.
|
default DeleteCertificateResponse |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes a certificate and its associated private key.
|
default DescribeCertificateResponse |
describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
Returns detailed metadata about the specified ACM certificate.
|
default DescribeCertificateResponse |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Returns detailed metadata about the specified ACM certificate.
|
default ExportCertificateResponse |
exportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
|
default ExportCertificateResponse |
exportCertificate(ExportCertificateRequest exportCertificateRequest)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
|
default GetAccountConfigurationResponse |
getAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest)
Returns the account configuration options associated with an Amazon Web Services account.
|
default GetAccountConfigurationResponse |
getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest)
Returns the account configuration options associated with an Amazon Web Services account.
|
default GetCertificateResponse |
getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest)
Retrieves an Amazon-issued certificate and its certificate chain.
|
default GetCertificateResponse |
getCertificate(GetCertificateRequest getCertificateRequest)
Retrieves an Amazon-issued certificate and its certificate chain.
|
default ImportCertificateResponse |
importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.
|
default ImportCertificateResponse |
importCertificate(ImportCertificateRequest importCertificateRequest)
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.
|
default ListCertificatesResponse |
listCertificates()
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesResponse |
listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesResponse |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesIterable |
listCertificatesPaginator()
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesIterable |
listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesIterable |
listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default ListTagsForCertificateResponse |
listTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest)
Lists the tags that have been applied to the ACM certificate.
|
default ListTagsForCertificateResponse |
listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest)
Lists the tags that have been applied to the ACM certificate.
|
default PutAccountConfigurationResponse |
putAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest)
Adds or modifies account-level configurations in ACM.
|
default PutAccountConfigurationResponse |
putAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest)
Adds or modifies account-level configurations in ACM.
|
default RemoveTagsFromCertificateResponse |
removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest)
Remove one or more tags from an ACM certificate.
|
default RemoveTagsFromCertificateResponse |
removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest)
Remove one or more tags from an ACM certificate.
|
default RenewCertificateResponse |
renewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest)
Renews an eligible ACM certificate.
|
default RenewCertificateResponse |
renewCertificate(RenewCertificateRequest renewCertificateRequest)
Renews an eligible ACM certificate.
|
default RequestCertificateResponse |
requestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest)
Requests an ACM certificate for use with other Amazon Web Services services.
|
default RequestCertificateResponse |
requestCertificate(RequestCertificateRequest requestCertificateRequest)
Requests an ACM certificate for use with other Amazon Web Services services.
|
default ResendValidationEmailResponse |
resendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest)
Resends the email that requests domain ownership validation.
|
default ResendValidationEmailResponse |
resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest)
Resends the email that requests domain ownership validation.
|
default AcmServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default UpdateCertificateOptionsResponse |
updateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest)
Updates a certificate.
|
default UpdateCertificateOptionsResponse |
updateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest)
Updates a certificate.
|
default AcmWaiter |
waiter()
Create an instance of
AcmWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AddTagsToCertificateResponse addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest) throws ResourceNotFoundException, InvalidArnException, InvalidTagException, TooManyTagsException, TagPolicyException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AcmException
Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your
Amazon Web Services 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 - 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.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.ThrottlingException - The request was denied because it exceeded a quota.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsToCertificateResponse addTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest) throws ResourceNotFoundException, InvalidArnException, InvalidTagException, TooManyTagsException, TagPolicyException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AcmException
Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your
Amazon Web Services 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.
This is a convenience which creates an instance of the AddTagsToCertificateRequest.Builder avoiding the
need to create one manually via AddTagsToCertificateRequest.builder()
addTagsToCertificateRequest - A Consumer that will call methods on
AddTagsToCertificateRequest.Builder to create a request.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.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.ThrottlingException - The request was denied because it exceeded a quota.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws ResourceNotFoundException, ResourceInUseException, AccessDeniedException, ThrottlingException, ConflictException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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 Amazon Web Services services integrated with ACM.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
deleteCertificateRequest - 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 Amazon Web Services service in the caller's account. Remove the
association and try again.AccessDeniedException - You do not have access required to perform this action.ThrottlingException - The request was denied because it exceeded a quota.ConflictException - You are trying to update a resource or configuration that is already being created or updated. Wait for
the previous operation to finish and try again.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCertificateResponse deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) throws ResourceNotFoundException, ResourceInUseException, AccessDeniedException, ThrottlingException, ConflictException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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 Amazon Web Services services integrated with ACM.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
This is a convenience which creates an instance of the DeleteCertificateRequest.Builder avoiding the need
to create one manually via DeleteCertificateRequest.builder()
deleteCertificateRequest - A Consumer that will call methods on
DeleteCertificateRequest.Builder to create a request.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 Amazon Web Services service in the caller's account. Remove the
association and try again.AccessDeniedException - You do not have access required to perform this action.ThrottlingException - The request was denied because it exceeded a quota.ConflictException - You are trying to update a resource or configuration that is already being created or updated. Wait for
the previous operation to finish and try again.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
Returns detailed metadata about the specified ACM certificate.
If you have just created a certificate using the RequestCertificate action, there is a delay of
several seconds before you can retrieve information about it.
describeCertificateRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCertificateResponse describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
Returns detailed metadata about the specified ACM certificate.
If you have just created a certificate using the RequestCertificate action, there is a delay of
several seconds before you can retrieve information about it.
This is a convenience which creates an instance of the DescribeCertificateRequest.Builder avoiding the
need to create one manually via DescribeCertificateRequest.builder()
describeCertificateRequest - A Consumer that will call methods on
DescribeCertificateRequest.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportCertificateResponse exportCertificate(ExportCertificateRequest exportCertificateRequest) throws ResourceNotFoundException, RequestInProgressException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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.
For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.
exportCertificateRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportCertificateResponse exportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest) throws ResourceNotFoundException, RequestInProgressException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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.
For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.
This is a convenience which creates an instance of the ExportCertificateRequest.Builder avoiding the need
to create one manually via ExportCertificateRequest.builder()
exportCertificateRequest - A Consumer that will call methods on
ExportCertificateRequest.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountConfigurationResponse getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest) throws AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, AcmException
Returns the account configuration options associated with an Amazon Web Services account.
getAccountConfigurationRequest - AccessDeniedException - You do not have access required to perform this action.ThrottlingException - The request was denied because it exceeded a quota.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountConfigurationResponse getAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest) throws AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, AcmException
Returns the account configuration options associated with an Amazon Web Services account.
This is a convenience which creates an instance of the GetAccountConfigurationRequest.Builder avoiding
the need to create one manually via GetAccountConfigurationRequest.builder()
getAccountConfigurationRequest - A Consumer that will call methods on
GetAccountConfigurationRequest.Builder to create a
request.AccessDeniedException - You do not have access required to perform this action.ThrottlingException - The request was denied because it exceeded a quota.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCertificateResponse getCertificate(GetCertificateRequest getCertificateRequest) throws ResourceNotFoundException, RequestInProgressException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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.
getCertificateRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCertificateResponse getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest) throws ResourceNotFoundException, RequestInProgressException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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.
This is a convenience which creates an instance of the GetCertificateRequest.Builder avoiding the need to
create one manually via GetCertificateRequest.builder()
getCertificateRequest - A Consumer that will call methods on
GetCertificateRequest.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportCertificateResponse importCertificate(ImportCertificateRequest importCertificateRequest) throws ResourceNotFoundException, LimitExceededException, InvalidTagException, TooManyTagsException, TagPolicyException, InvalidParameterException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
Imports a certificate into 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 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.
The private key must be no larger than 5 KB (5,120 bytes).
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 fileb://. For example, you can specify a certificate
saved in the C:\temp folder as fileb://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.
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificateRequest - ResourceNotFoundException - The specified certificate cannot be found in the caller's account or the caller's account cannot be
found.LimitExceededException - An ACM quota has been exceeded.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.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportCertificateResponse importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) throws ResourceNotFoundException, LimitExceededException, InvalidTagException, TooManyTagsException, TagPolicyException, InvalidParameterException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
Imports a certificate into 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 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.
The private key must be no larger than 5 KB (5,120 bytes).
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 fileb://. For example, you can specify a certificate
saved in the C:\temp folder as fileb://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.
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
This is a convenience which creates an instance of the ImportCertificateRequest.Builder avoiding the need
to create one manually via ImportCertificateRequest.builder()
importCertificateRequest - A Consumer that will call methods on
ImportCertificateRequest.Builder to create a request.ResourceNotFoundException - The specified certificate cannot be found in the caller's account or the caller's account cannot be
found.LimitExceededException - An ACM quota has been exceeded.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.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException
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.
listCertificatesRequest - InvalidArgsException - One or more of of request parameters specified is not valid.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCertificatesResponse listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException
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.
This is a convenience which creates an instance of the ListCertificatesRequest.Builder avoiding the need
to create one manually via ListCertificatesRequest.builder()
listCertificatesRequest - A Consumer that will call methods on
ListCertificatesRequest.Builder to create a request.InvalidArgsException - One or more of of request parameters specified is not valid.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCertificatesResponse listCertificates() throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException
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.
InvalidArgsException - One or more of of request parameters specified is not valid.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistCertificates(ListCertificatesRequest),
AWS API
Documentationdefault ListCertificatesIterable listCertificatesPaginator() throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException
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.
This is a variant of listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
for (software.amazon.awssdk.services.acm.model.ListCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest) operation.
InvalidArgsException - One or more of of request parameters specified is not valid.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistCertificatesPaginator(ListCertificatesRequest),
AWS API
Documentationdefault ListCertificatesIterable listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException
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.
This is a variant of listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
for (software.amazon.awssdk.services.acm.model.ListCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest) operation.
listCertificatesRequest - InvalidArgsException - One or more of of request parameters specified is not valid.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCertificatesIterable listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws InvalidArgsException, ValidationException, AwsServiceException, SdkClientException, AcmException
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.
This is a variant of listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
for (software.amazon.awssdk.services.acm.model.ListCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.acm.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest) operation.
This is a convenience which creates an instance of the ListCertificatesRequest.Builder avoiding the need
to create one manually via ListCertificatesRequest.builder()
listCertificatesRequest - A Consumer that will call methods on
ListCertificatesRequest.Builder to create a request.InvalidArgsException - One or more of of request parameters specified is not valid.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForCertificateResponse listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, 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.
listTagsForCertificateRequest - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForCertificateResponse listTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListTagsForCertificateRequest.Builder avoiding the
need to create one manually via ListTagsForCertificateRequest.builder()
listTagsForCertificateRequest - A Consumer that will call methods on
ListTagsForCertificateRequest.Builder to create a
request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccountConfigurationResponse putAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest) throws ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, AcmException
Adds or modifies account-level configurations in ACM.
The supported configuration option is DaysBeforeExpiry. This option specifies the number of days
prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event
per day per certificate until the certificate expires. By default, accounts receive events starting 45 days
before certificate expiration.
putAccountConfigurationRequest - ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.ThrottlingException - The request was denied because it exceeded a quota.AccessDeniedException - You do not have access required to perform this action.ConflictException - You are trying to update a resource or configuration that is already being created or updated. Wait for
the previous operation to finish and try again.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccountConfigurationResponse putAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest) throws ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, AcmException
Adds or modifies account-level configurations in ACM.
The supported configuration option is DaysBeforeExpiry. This option specifies the number of days
prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event
per day per certificate until the certificate expires. By default, accounts receive events starting 45 days
before certificate expiration.
This is a convenience which creates an instance of the PutAccountConfigurationRequest.Builder avoiding
the need to create one manually via PutAccountConfigurationRequest.builder()
putAccountConfigurationRequest - A Consumer that will call methods on
PutAccountConfigurationRequest.Builder to create a
request.ValidationException - The supplied input failed to satisfy constraints of an Amazon Web Services service.ThrottlingException - The request was denied because it exceeded a quota.AccessDeniedException - You do not have access required to perform this action.ConflictException - You are trying to update a resource or configuration that is already being created or updated. Wait for
the previous operation to finish and try again.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromCertificateResponse removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest) throws ResourceNotFoundException, InvalidArnException, InvalidTagException, TagPolicyException, InvalidParameterException, ThrottlingException, AwsServiceException, 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.
removeTagsFromCertificateRequest - 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:.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.ThrottlingException - The request was denied because it exceeded a quota.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromCertificateResponse removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest) throws ResourceNotFoundException, InvalidArnException, InvalidTagException, TagPolicyException, InvalidParameterException, ThrottlingException, AwsServiceException, 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.
This is a convenience which creates an instance of the RemoveTagsFromCertificateRequest.Builder avoiding
the need to create one manually via RemoveTagsFromCertificateRequest.builder()
removeTagsFromCertificateRequest - A Consumer that will call methods on
RemoveTagsFromCertificateRequest.Builder to create a
request.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:.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.ThrottlingException - The request was denied because it exceeded a quota.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RenewCertificateResponse renewCertificate(RenewCertificateRequest renewCertificateRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA 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 - 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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RenewCertificateResponse renewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA 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.
This is a convenience which creates an instance of the RenewCertificateRequest.Builder avoiding the need
to create one manually via RenewCertificateRequest.builder()
renewCertificateRequest - A Consumer that will call methods on
RenewCertificateRequest.Builder to create a request.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RequestCertificateResponse requestCertificate(RequestCertificateRequest requestCertificateRequest) throws LimitExceededException, InvalidDomainValidationOptionsException, InvalidArnException, InvalidTagException, TooManyTagsException, TagPolicyException, InvalidParameterException, AwsServiceException, SdkClientException, AcmException
Requests an ACM certificate for use with other Amazon Web Services 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.
ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).
After successful completion of the RequestCertificate action, there is a delay of several seconds
before you can retrieve information about the new certificate.
requestCertificateRequest - LimitExceededException - An ACM quota has been exceeded.InvalidDomainValidationOptionsException - One or more values in the DomainValidationOption structure is incorrect.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.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RequestCertificateResponse requestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest) throws LimitExceededException, InvalidDomainValidationOptionsException, InvalidArnException, InvalidTagException, TooManyTagsException, TagPolicyException, InvalidParameterException, AwsServiceException, SdkClientException, AcmException
Requests an ACM certificate for use with other Amazon Web Services 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.
ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).
After successful completion of the RequestCertificate action, there is a delay of several seconds
before you can retrieve information about the new certificate.
This is a convenience which creates an instance of the RequestCertificateRequest.Builder avoiding the
need to create one manually via RequestCertificateRequest.builder()
requestCertificateRequest - A Consumer that will call methods on
RequestCertificateRequest.Builder to create a request.LimitExceededException - An ACM quota has been exceeded.InvalidDomainValidationOptionsException - One or more values in the DomainValidationOption structure is incorrect.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.TagPolicyException - A specified tag did not comply with an existing tag policy and was rejected.InvalidParameterException - An input parameter was invalid.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResendValidationEmailResponse resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest) throws ResourceNotFoundException, InvalidStateException, InvalidArnException, InvalidDomainValidationOptionsException, AwsServiceException, 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.
resendValidationEmailRequest - 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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResendValidationEmailResponse resendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest) throws ResourceNotFoundException, InvalidStateException, InvalidArnException, InvalidDomainValidationOptionsException, AwsServiceException, 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.
This is a convenience which creates an instance of the ResendValidationEmailRequest.Builder avoiding the
need to create one manually via ResendValidationEmailRequest.builder()
resendValidationEmailRequest - A Consumer that will call methods on
ResendValidationEmailRequest.Builder to create a
request.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.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.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCertificateOptionsResponse updateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest) throws ResourceNotFoundException, LimitExceededException, InvalidStateException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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 - ResourceNotFoundException - The specified certificate cannot be found in the caller's account or the caller's account cannot be
found.LimitExceededException - An ACM quota has been exceeded.InvalidStateException - Processing has reached an invalid state.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCertificateOptionsResponse updateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest) throws ResourceNotFoundException, LimitExceededException, InvalidStateException, InvalidArnException, AwsServiceException, SdkClientException, AcmException
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.
This is a convenience which creates an instance of the UpdateCertificateOptionsRequest.Builder avoiding
the need to create one manually via UpdateCertificateOptionsRequest.builder()
updateCertificateOptionsRequest - A Consumer that will call methods on
UpdateCertificateOptionsRequest.Builder to create a
request.ResourceNotFoundException - The specified certificate cannot be found in the caller's account or the caller's account cannot be
found.LimitExceededException - An ACM quota has been exceeded.InvalidStateException - Processing has reached an invalid state.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AcmWaiter waiter()
AcmWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
AcmWaiterstatic AcmClient create()
AcmClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AcmClientBuilder builder()
AcmClient.static ServiceMetadata serviceMetadata()
default AcmServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.