@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AcmAsyncClient 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 CompletableFuture<AddTagsToCertificateResponse> |
addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest)
Adds one or more tags to an ACM certificate.
|
default CompletableFuture<AddTagsToCertificateResponse> |
addTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest)
Adds one or more tags to an ACM certificate.
|
static AcmAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
AcmAsyncClient. |
static AcmAsyncClient |
create()
Create a
AcmAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes a certificate and its associated private key.
|
default CompletableFuture<DeleteCertificateResponse> |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes a certificate and its associated private key.
|
default CompletableFuture<DescribeCertificateResponse> |
describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
Returns detailed metadata about the specified ACM certificate.
|
default CompletableFuture<DescribeCertificateResponse> |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Returns detailed metadata about the specified ACM certificate.
|
default CompletableFuture<ExportCertificateResponse> |
exportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
|
default CompletableFuture<ExportCertificateResponse> |
exportCertificate(ExportCertificateRequest exportCertificateRequest)
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
|
default CompletableFuture<GetAccountConfigurationResponse> |
getAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest)
Returns the account configuration options associated with an Amazon Web Services account.
|
default CompletableFuture<GetAccountConfigurationResponse> |
getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest)
Returns the account configuration options associated with an Amazon Web Services account.
|
default CompletableFuture<GetCertificateResponse> |
getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest)
Retrieves an Amazon-issued certificate and its certificate chain.
|
default CompletableFuture<GetCertificateResponse> |
getCertificate(GetCertificateRequest getCertificateRequest)
Retrieves an Amazon-issued certificate and its certificate chain.
|
default CompletableFuture<ImportCertificateResponse> |
importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.
|
default CompletableFuture<ImportCertificateResponse> |
importCertificate(ImportCertificateRequest importCertificateRequest)
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.
|
default CompletableFuture<ListCertificatesResponse> |
listCertificates()
Retrieves a list of certificate ARNs and domain names.
|
default CompletableFuture<ListCertificatesResponse> |
listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default CompletableFuture<ListCertificatesResponse> |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesPublisher |
listCertificatesPaginator()
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesPublisher |
listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default ListCertificatesPublisher |
listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)
Retrieves a list of certificate ARNs and domain names.
|
default CompletableFuture<ListTagsForCertificateResponse> |
listTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest)
Lists the tags that have been applied to the ACM certificate.
|
default CompletableFuture<ListTagsForCertificateResponse> |
listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest)
Lists the tags that have been applied to the ACM certificate.
|
default CompletableFuture<PutAccountConfigurationResponse> |
putAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest)
Adds or modifies account-level configurations in ACM.
|
default CompletableFuture<PutAccountConfigurationResponse> |
putAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest)
Adds or modifies account-level configurations in ACM.
|
default CompletableFuture<RemoveTagsFromCertificateResponse> |
removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest)
Remove one or more tags from an ACM certificate.
|
default CompletableFuture<RemoveTagsFromCertificateResponse> |
removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest)
Remove one or more tags from an ACM certificate.
|
default CompletableFuture<RenewCertificateResponse> |
renewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest)
Renews an eligible ACM certificate.
|
default CompletableFuture<RenewCertificateResponse> |
renewCertificate(RenewCertificateRequest renewCertificateRequest)
Renews an eligible ACM certificate.
|
default CompletableFuture<RequestCertificateResponse> |
requestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest)
Requests an ACM certificate for use with other Amazon Web Services services.
|
default CompletableFuture<RequestCertificateResponse> |
requestCertificate(RequestCertificateRequest requestCertificateRequest)
Requests an ACM certificate for use with other Amazon Web Services services.
|
default CompletableFuture<ResendValidationEmailResponse> |
resendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest)
Resends the email that requests domain ownership validation.
|
default CompletableFuture<ResendValidationEmailResponse> |
resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest)
Resends the email that requests domain ownership validation.
|
default AcmServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<UpdateCertificateOptionsResponse> |
updateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest)
Updates a certificate.
|
default CompletableFuture<UpdateCertificateOptionsResponse> |
updateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest)
Updates a certificate.
|
default AcmAsyncWaiter |
waiter()
Create an instance of
AcmAsyncWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AddTagsToCertificateResponse> addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest)
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 - aws:.default CompletableFuture<AddTagsToCertificateResponse> addTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest)
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.aws:.default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
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 - default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
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.default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest)
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 - default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
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.default CompletableFuture<ExportCertificateResponse> exportCertificate(ExportCertificateRequest exportCertificateRequest)
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 - default CompletableFuture<ExportCertificateResponse> exportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest)
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.default CompletableFuture<GetAccountConfigurationResponse> getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest)
Returns the account configuration options associated with an Amazon Web Services account.
getAccountConfigurationRequest - default CompletableFuture<GetAccountConfigurationResponse> getAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest)
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.default CompletableFuture<GetCertificateResponse> getCertificate(GetCertificateRequest getCertificateRequest)
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 - default CompletableFuture<GetCertificateResponse> getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest)
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.default CompletableFuture<ImportCertificateResponse> importCertificate(ImportCertificateRequest importCertificateRequest)
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 - aws:.default CompletableFuture<ImportCertificateResponse> importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest)
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.aws:.default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest)
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 - default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
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.default CompletableFuture<ListCertificatesResponse> listCertificates()
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.
default ListCertificatesPublisher listCertificatesPaginator()
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.acm.model.ListCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.acm.model.ListCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.acm.model.ListCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListTagsForCertificateResponse> listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest)
Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
listTagsForCertificateRequest - default CompletableFuture<ListTagsForCertificateResponse> listTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest)
Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
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.default CompletableFuture<PutAccountConfigurationResponse> putAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest)
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 - default CompletableFuture<PutAccountConfigurationResponse> putAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest)
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.default CompletableFuture<RemoveTagsFromCertificateResponse> removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest)
Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
removeTagsFromCertificateRequest - aws:.default CompletableFuture<RemoveTagsFromCertificateResponse> removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest)
Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
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.aws:.default CompletableFuture<RenewCertificateResponse> renewCertificate(RenewCertificateRequest renewCertificateRequest)
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 - default CompletableFuture<RenewCertificateResponse> renewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest)
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.default CompletableFuture<RequestCertificateResponse> requestCertificate(RequestCertificateRequest requestCertificateRequest)
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 - aws:.default CompletableFuture<RequestCertificateResponse> requestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest)
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.aws:.default CompletableFuture<ResendValidationEmailResponse> resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest)
Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
resendValidationEmailRequest - default CompletableFuture<ResendValidationEmailResponse> resendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest)
Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
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.default CompletableFuture<UpdateCertificateOptionsResponse> updateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest)
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 - default CompletableFuture<UpdateCertificateOptionsResponse> updateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest)
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.default AcmAsyncWaiter waiter()
AcmAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
AcmAsyncWaiterdefault AcmServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic AcmAsyncClient create()
AcmAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AcmAsyncClientBuilder builder()
AcmAsyncClient.Copyright © 2023. All rights reserved.