@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCertificateManagerClient extends AmazonWebServiceClient implements AWSCertificateManager
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 .
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSCertificateManagerClient()
Deprecated.
|
AWSCertificateManagerClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSCertificateManagerClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSCertificateManagerClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSCertificateManagerClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCertificateManagerClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCertificateManagerClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSCertificateManagerClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToCertificateResult |
addTagsToCertificate(AddTagsToCertificateRequest request)
Adds one or more tags to an ACM certificate.
|
static AWSCertificateManagerClientBuilder |
builder() |
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest request)
Deletes a certificate and its associated private key.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest request)
Returns detailed metadata about the specified ACM certificate.
|
ExportCertificateResult |
exportCertificate(ExportCertificateRequest request)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCertificateResult |
getCertificate(GetCertificateRequest request)
Retrieves a certificate specified by an ARN and its certificate chain .
|
ImportCertificateResult |
importCertificate(ImportCertificateRequest request)
Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest request)
Retrieves a list of certificate ARNs and domain names.
|
ListTagsForCertificateResult |
listTagsForCertificate(ListTagsForCertificateRequest request)
Lists the tags that have been applied to the ACM certificate.
|
RemoveTagsFromCertificateResult |
removeTagsFromCertificate(RemoveTagsFromCertificateRequest request)
Remove one or more tags from an ACM certificate.
|
RenewCertificateResult |
renewCertificate(RenewCertificateRequest request)
Renews an eligable ACM certificate.
|
RequestCertificateResult |
requestCertificate(RequestCertificateRequest request)
Requests an ACM certificate for use with other AWS services.
|
ResendValidationEmailResult |
resendValidationEmail(ResendValidationEmailRequest request)
Resends the email that requests domain ownership validation.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
UpdateCertificateOptionsResult |
updateCertificateOptions(UpdateCertificateOptionsRequest request)
Updates a certificate.
|
AWSCertificateManagerWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AWSCertificateManagerClient()
AWSCertificateManagerClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSCertificateManagerClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to ACM (ex: proxy settings, retry
counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSCertificateManagerClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSCertificateManagerClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSCertificateManagerClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to ACM (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSCertificateManagerClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSCertificateManagerClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to ACM (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSCertificateManagerClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to ACM (ex: proxy settings, retry
counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSCertificateManagerClientBuilder builder()
public AddTagsToCertificateResult addTagsToCertificate(AddTagsToCertificateRequest request)
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.
addTagsToCertificate
in interface AWSCertificateManager
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.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.
You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
deleteCertificate
in interface AWSCertificateManager
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 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.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
Returns detailed metadata about the specified ACM certificate.
describeCertificate
in interface AWSCertificateManager
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.public ExportCertificateResult exportCertificate(ExportCertificateRequest request)
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.
exportCertificate
in interface AWSCertificateManager
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.public GetCertificateResult getCertificate(GetCertificateRequest request)
Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.
getCertificate
in interface AWSCertificateManager
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.public ImportCertificateResult importCertificate(ImportCertificateRequest request)
Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
If the certificate you are importing is not self-signed, you must enter its certificate chain.
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before
and Not After
certificate fields.
The Issuer
field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn
argument. Include this argument only when you
want to replace a previously imported certifica
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the
private key by their file names preceded by file://
. For example, you can specify a certificate
saved in the C:\temp
folder as file://C:\temp\certificate_to_import.pem
. If you are
making an HTTP or HTTPS Query request, include these arguments as BLOBs.
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
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.
importCertificate
in interface AWSCertificateManager
importCertificateRequest
- 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.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.public ListCertificatesResult listCertificates(ListCertificatesRequest request)
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.
listCertificates
in interface AWSCertificateManager
listCertificatesRequest
- InvalidArgsException
- One or more of of request parameters specified is not valid.public ListTagsForCertificateResult listTagsForCertificate(ListTagsForCertificateRequest request)
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.
listTagsForCertificate
in interface AWSCertificateManager
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.public RemoveTagsFromCertificateResult removeTagsFromCertificate(RemoveTagsFromCertificateRequest request)
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.
removeTagsFromCertificate
in interface AWSCertificateManager
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.public RenewCertificateResult renewCertificate(RenewCertificateRequest request)
Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
renewCertificate
in interface AWSCertificateManager
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.public RequestCertificateResult requestCertificate(RequestCertificateRequest request)
Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a
fully qualified domain name (FQDN) in the DomainName
parameter. You can also specify additional
FQDNs in the SubjectAlternativeNames
parameter.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
requestCertificate
in interface AWSCertificateManager
requestCertificateRequest
- LimitExceededException
- An ACM limit 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.public ResendValidationEmailResult resendValidationEmail(ResendValidationEmailRequest request)
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.
resendValidationEmail
in interface AWSCertificateManager
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.public UpdateCertificateOptionsResult updateCertificateOptions(UpdateCertificateOptionsRequest request)
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.
updateCertificateOptions
in interface AWSCertificateManager
updateCertificateOptionsRequest
- 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.InvalidStateException
- Processing has reached an invalid state.InvalidArnException
- The requested Amazon Resource Name (ARN) does not refer to an existing resource.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSCertificateManager
request
- The originally executed requestpublic AWSCertificateManagerWaiters waiters()
waiters
in interface AWSCertificateManager
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSCertificateManager
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.