AbstractAWSCertificateManager (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.certificatemanager.AbstractAWSCertificateManager

All Implemented Interfaces:

AWSCertificateManager

Direct Known Subclasses:

AbstractAWSCertificateManagerAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCertificateManager
extends Object
implements AWSCertificateManager
```
Abstract implementation of AWSCertificateManager. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.certificatemanager.AWSCertificateManager
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddTagsToCertificateResult`	`addTagsToCertificate(AddTagsToCertificateRequest request)` Adds one or more tags to an ACM Certificate.
`DeleteCertificateResult`	`deleteCertificate(DeleteCertificateRequest request)` Deletes an ACM Certificate and its associated private key.
`DescribeCertificateResult`	`describeCertificate(DescribeCertificateRequest request)` Returns detailed metadata about the specified ACM Certificate.
`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 an ACM Certificate and certificate chain for the certificate specified by an ARN.
`ImportCertificateResult`	`importCertificate(ImportCertificateRequest request)` Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
`ListCertificatesResult`	`listCertificates(ListCertificatesRequest request)` Retrieves a list of ACM Certificates and the domain name for each.
`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.
`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`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://acm.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSCertificateManager.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSCertificateManager
    
    Overrides the default endpoint for this client ("https://acm.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "acm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://acm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSCertificateManager
    
    Parameters:
    
    endpoint - The endpoint (ex: "acm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://acm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSCertificateManager
    
    An alternative to AWSCertificateManager.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSCertificateManager
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTagsToCertificate
```
public AddTagsToCertificateResult addTagsToCertificate(AddTagsToCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    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.
    
    Specified by:
    
    addTagsToCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the AddTagsToCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCertificate
```
public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by other AWS services.
    
    You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
    
    Specified by:
    
    deleteCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the DeleteCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCertificate
```
public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Returns detailed metadata about the specified ACM Certificate.
    
    Specified by:
    
    describeCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the DescribeCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCertificate
```
public GetCertificateResult getCertificate(GetCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the ACM Certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.
    
    Specified by:
    
    getCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the GetCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importCertificate
```
public ImportCertificateResult importCertificate(ImportCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
    
    ACM does not provide managed renewal for certificates that you import.
    
    For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
    
    To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.
    
    The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide.
    
    To import a new certificate, omit the CertificateArn field. Include this field only when you want to replace a previously imported certificate.
    
    When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, chain, and private key parameters as file names preceded by file://. For example, you can specify a certificate saved in the C:\temp folder as C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these parameters as BLOBs.
    
    This operation returns the Amazon Resource Name (ARN) of the imported certificate.
    
    Specified by:
    
    importCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the ImportCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCertificates
```
public ListCertificatesResult listCertificates(ListCertificatesRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
    
    Specified by:
    
    listCertificates in interface AWSCertificateManager
    
    Returns:
    
    Result of the ListCertificates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForCertificate
```
public ListTagsForCertificateResult listTagsForCertificate(ListTagsForCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    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.
    
    Specified by:
    
    listTagsForCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the ListTagsForCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTagsFromCertificate
```
public RemoveTagsFromCertificateResult removeTagsFromCertificate(RemoveTagsFromCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    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.
    
    Specified by:
    
    removeTagsFromCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the RemoveTagsFromCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - requestCertificate
```
public RequestCertificateResult requestCertificate(RequestCertificateRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter if users can reach your site by using other names.
    
    For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the DomainName you enter or the optional ValidationDomain parameter. For more information, see Validate Domain Ownership.
    
    After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.
    
    Specified by:
    
    requestCertificate in interface AWSCertificateManager
    
    Returns:
    
    Result of the RequestCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resendValidationEmail
```
public ResendValidationEmailResult resendValidationEmail(ResendValidationEmailRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    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.
    
    Specified by:
    
    resendValidationEmail in interface AWSCertificateManager
    
    Returns:
    
    Result of the ResendValidationEmail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCertificateManager
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCertificateManager
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCertificateManager
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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 a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCertificateManager
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSCertificateManager

Field Summary

Fields inherited from interface com.amazonaws.services.certificatemanager.AWSCertificateManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addTagsToCertificate

deleteCertificate

describeCertificate

getCertificate

importCertificate

listCertificates

listTagsForCertificate

removeTagsFromCertificate

requestCertificate

resendValidationEmail

shutdown

getCachedResponseMetadata