com.amazonaws.services.acmpca.AWSACMPCAAsync Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.acmpca;
import javax.annotation.Generated;
import com.amazonaws.services.acmpca.model.*;
/**
* Interface for accessing ACM-PCA asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.acmpca.AbstractAWSACMPCAAsync} instead.
*
*
*
* You can use the ACM PCA API to create a private certificate authority (CA). You must first call the
* CreateCertificateAuthority operation. If successful, the operation returns an Amazon Resource Name (ARN) for
* your private CA. Use this ARN as input to the GetCertificateAuthorityCsr operation to retrieve the certificate
* signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your
* on-premises PKI hierarchy, and call the ImportCertificateAuthorityCertificate to import your signed private CA
* certificate into ACM PCA.
*
*
* Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client
* computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization.
* Call the IssueCertificate operation to issue a certificate. Call the RevokeCertificate operation to
* revoke a certificate.
*
*
*
* Certificates issued by your private CA can be trusted only within your organization, not publicly.
*
*
*
* Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To
* create a CRL, you must specify a RevocationConfiguration object when you call the
* CreateCertificateAuthority operation. ACM PCA writes the CRL to an S3 bucket that you specify. You must
* specify a bucket policy that grants ACM PCA write permission.
*
*
* You can also call the CreateCertificateAuthorityAuditReport to create an optional audit report, which
* enumerates all of the issued, valid, expired, and revoked certificates from the CA.
*
*
*
* Each ACM PCA API operation has a throttling limit which determines the number of times the operation can be called
* per second. For more information, see API Rate Limits in ACM
* PCA in the ACM PCA user guide.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSACMPCAAsync extends AWSACMPCA {
/**
*
* Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation
* configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the
* algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to
* sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL
* expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a
* CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this operation
* returns the Amazon Resource Name (ARN) of the CA.
*
*
* @param createCertificateAuthorityRequest
* @return A Java Future containing the result of the CreateCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsync.CreateCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future createCertificateAuthorityAsync(
CreateCertificateAuthorityRequest createCertificateAuthorityRequest);
/**
*
* Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation
* configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the
* algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to
* sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL
* expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a
* CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this operation
* returns the Amazon Resource Name (ARN) of the CA.
*
*
* @param createCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsyncHandler.CreateCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future createCertificateAuthorityAsync(
CreateCertificateAuthorityRequest createCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon
* S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the
* private key. You can generate a new report every 30 minutes.
*
*
* @param createCertificateAuthorityAuditReportRequest
* @return A Java Future containing the result of the CreateCertificateAuthorityAuditReport operation returned by
* the service.
* @sample AWSACMPCAAsync.CreateCertificateAuthorityAuditReport
* @see AWS API Documentation
*/
java.util.concurrent.Future createCertificateAuthorityAuditReportAsync(
CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest);
/**
*
* Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon
* S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the
* private key. You can generate a new report every 30 minutes.
*
*
* @param createCertificateAuthorityAuditReportRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateCertificateAuthorityAuditReport operation returned by
* the service.
* @sample AWSACMPCAAsyncHandler.CreateCertificateAuthorityAuditReport
* @see AWS API Documentation
*/
java.util.concurrent.Future createCertificateAuthorityAuditReportAsync(
CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Assigns permissions from a private CA to a designated AWS service. Services are specified by their service
* principals and can be given permission to create and retrieve certificates on a private CA. Services can also be
* given permission to list the active permissions that the private CA has granted. For ACM to automatically renew
* your private CA's certificates, you must assign all possible permissions from the CA to the ACM service
* principal.
*
*
* At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked
* with the DeletePermission operation and listed with the ListPermissions operation.
*
*
* @param createPermissionRequest
* @return A Java Future containing the result of the CreatePermission operation returned by the service.
* @sample AWSACMPCAAsync.CreatePermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPermissionAsync(CreatePermissionRequest createPermissionRequest);
/**
*
* Assigns permissions from a private CA to a designated AWS service. Services are specified by their service
* principals and can be given permission to create and retrieve certificates on a private CA. Services can also be
* given permission to list the active permissions that the private CA has granted. For ACM to automatically renew
* your private CA's certificates, you must assign all possible permissions from the CA to the ACM service
* principal.
*
*
* At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked
* with the DeletePermission operation and listed with the ListPermissions operation.
*
*
* @param createPermissionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreatePermission operation returned by the service.
* @sample AWSACMPCAAsyncHandler.CreatePermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPermissionAsync(CreatePermissionRequest createPermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA
* that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before
* you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the
* CertificateAuthorityStatus parameter to DISABLED.
*
*
* Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the
* CertificateAuthority is CREATING). You can also delete it if the CA has been created but you
* haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA.
*
*
* If the CA is in one of the previously mentioned states and you call DeleteCertificateAuthority, the CA's
* status changes to DELETED. However, the CA won't be permanently deleted until the restoration period
* has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains
* restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority
* operation returns the time remaining in the restoration window of a Private CA in the DELETED state.
* To restore an eligible CA, call the RestoreCertificateAuthority operation.
*
*
* @param deleteCertificateAuthorityRequest
* @return A Java Future containing the result of the DeleteCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsync.DeleteCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteCertificateAuthorityAsync(
DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest);
/**
*
* Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA
* that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before
* you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the
* CertificateAuthorityStatus parameter to DISABLED.
*
*
* Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the
* CertificateAuthority is CREATING). You can also delete it if the CA has been created but you
* haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA.
*
*
* If the CA is in one of the previously mentioned states and you call DeleteCertificateAuthority, the CA's
* status changes to DELETED. However, the CA won't be permanently deleted until the restoration period
* has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains
* restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority
* operation returns the time remaining in the restoration window of a Private CA in the DELETED state.
* To restore an eligible CA, call the RestoreCertificateAuthority operation.
*
*
* @param deleteCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsyncHandler.DeleteCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteCertificateAuthorityAsync(
DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the
* CreatePermission operation and listed with the ListPermissions operation.
*
*
* @param deletePermissionRequest
* @return A Java Future containing the result of the DeletePermission operation returned by the service.
* @sample AWSACMPCAAsync.DeletePermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deletePermissionAsync(DeletePermissionRequest deletePermissionRequest);
/**
*
* Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the
* CreatePermission operation and listed with the ListPermissions operation.
*
*
* @param deletePermissionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeletePermission operation returned by the service.
* @sample AWSACMPCAAsyncHandler.DeletePermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deletePermissionAsync(DeletePermissionRequest deletePermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN
* (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
*
*
* -
*
* CREATING - ACM PCA is creating your private certificate authority.
*
*
* -
*
* PENDING_CERTIFICATE - The certificate is pending. You must use your on-premises root or subordinate
* CA to sign your private CA CSR and then import it into PCA.
*
*
* -
*
* ACTIVE - Your private CA is active.
*
*
* -
*
* DISABLED - Your private CA has been disabled.
*
*
* -
*
* EXPIRED - Your private CA certificate has expired.
*
*
* -
*
* FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or
* backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
*
*
* -
*
* DELETED - Your private CA is within the restoration period, after which it is permanently deleted.
* The length of time remaining in the CA's restoration period is also included in this operation's output.
*
*
*
*
* @param describeCertificateAuthorityRequest
* @return A Java Future containing the result of the DescribeCertificateAuthority operation returned by the
* service.
* @sample AWSACMPCAAsync.DescribeCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future describeCertificateAuthorityAsync(
DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest);
/**
*
* Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN
* (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
*
*
* -
*
* CREATING - ACM PCA is creating your private certificate authority.
*
*
* -
*
* PENDING_CERTIFICATE - The certificate is pending. You must use your on-premises root or subordinate
* CA to sign your private CA CSR and then import it into PCA.
*
*
* -
*
* ACTIVE - Your private CA is active.
*
*
* -
*
* DISABLED - Your private CA has been disabled.
*
*
* -
*
* EXPIRED - Your private CA certificate has expired.
*
*
* -
*
* FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or
* backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
*
*
* -
*
* DELETED - Your private CA is within the restoration period, after which it is permanently deleted.
* The length of time remaining in the CA's restoration period is also included in this operation's output.
*
*
*
*
* @param describeCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeCertificateAuthority operation returned by the
* service.
* @sample AWSACMPCAAsyncHandler.DescribeCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future describeCertificateAuthorityAsync(
DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists information about a specific audit report created by calling the
* CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate
* authority (CA) private key is used. The private key is used when you call the IssueCertificate operation
* or the RevokeCertificate operation.
*
*
* @param describeCertificateAuthorityAuditReportRequest
* @return A Java Future containing the result of the DescribeCertificateAuthorityAuditReport operation returned by
* the service.
* @sample AWSACMPCAAsync.DescribeCertificateAuthorityAuditReport
* @see AWS API Documentation
*/
java.util.concurrent.Future describeCertificateAuthorityAuditReportAsync(
DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest);
/**
*
* Lists information about a specific audit report created by calling the
* CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate
* authority (CA) private key is used. The private key is used when you call the IssueCertificate operation
* or the RevokeCertificate operation.
*
*
* @param describeCertificateAuthorityAuditReportRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeCertificateAuthorityAuditReport operation returned by
* the service.
* @sample AWSACMPCAAsyncHandler.DescribeCertificateAuthorityAuditReport
* @see AWS API Documentation
*/
java.util.concurrent.Future describeCertificateAuthorityAuditReportAsync(
DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the
* IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued
* certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the
* ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report
* that contains information about all of the certificates issued and revoked by your private CA.
*
*
* @param getCertificateRequest
* @return A Java Future containing the result of the GetCertificate operation returned by the service.
* @sample AWSACMPCAAsync.GetCertificate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCertificateAsync(GetCertificateRequest getCertificateRequest);
/**
*
* Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the
* IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued
* certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the
* ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report
* that contains information about all of the certificates issued and revoked by your private CA.
*
*
* @param getCertificateRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetCertificate operation returned by the service.
* @sample AWSACMPCAAsyncHandler.GetCertificate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getCertificateAsync(GetCertificateRequest getCertificateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate
* and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the
* chain signs the one before it.
*
*
* @param getCertificateAuthorityCertificateRequest
* @return A Java Future containing the result of the GetCertificateAuthorityCertificate operation returned by the
* service.
* @sample AWSACMPCAAsync.GetCertificateAuthorityCertificate
* @see AWS API Documentation
*/
java.util.concurrent.Future getCertificateAuthorityCertificateAsync(
GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest);
/**
*
* Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate
* and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the
* chain signs the one before it.
*
*
* @param getCertificateAuthorityCertificateRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetCertificateAuthorityCertificate operation returned by the
* service.
* @sample AWSACMPCAAsyncHandler.GetCertificateAuthorityCertificate
* @see AWS API Documentation
*/
java.util.concurrent.Future getCertificateAuthorityCertificateAsync(
GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created
* when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509
* infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into
* ACM PCA by calling the ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64
* PEM-encoded string.
*
*
* @param getCertificateAuthorityCsrRequest
* @return A Java Future containing the result of the GetCertificateAuthorityCsr operation returned by the service.
* @sample AWSACMPCAAsync.GetCertificateAuthorityCsr
* @see AWS API Documentation
*/
java.util.concurrent.Future getCertificateAuthorityCsrAsync(
GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest);
/**
*
* Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created
* when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509
* infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into
* ACM PCA by calling the ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64
* PEM-encoded string.
*
*
* @param getCertificateAuthorityCsrRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetCertificateAuthorityCsr operation returned by the service.
* @sample AWSACMPCAAsyncHandler.GetCertificateAuthorityCsr
* @see AWS API Documentation
*/
java.util.concurrent.Future getCertificateAuthorityCsrAsync(
GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the
* private certificate authority by calling the CreateCertificateAuthority operation. You must then generate
* a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to
* your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate
* chain and copy the signed certificate and the certificate chain to your working directory.
*
*
*
* Your certificate chain must not include the private CA certificate that you are importing.
*
*
*
* Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any,
* that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA
* must come next, and so on until your chain is built.
*
*
*
* The chain must be PEM-encoded.
*
*
*
* @param importCertificateAuthorityCertificateRequest
* @return A Java Future containing the result of the ImportCertificateAuthorityCertificate operation returned by
* the service.
* @sample AWSACMPCAAsync.ImportCertificateAuthorityCertificate
* @see AWS API Documentation
*/
java.util.concurrent.Future importCertificateAuthorityCertificateAsync(
ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest);
/**
*
* Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the
* private certificate authority by calling the CreateCertificateAuthority operation. You must then generate
* a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to
* your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate
* chain and copy the signed certificate and the certificate chain to your working directory.
*
*
*
* Your certificate chain must not include the private CA certificate that you are importing.
*
*
*
* Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any,
* that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA
* must come next, and so on until your chain is built.
*
*
*
* The chain must be PEM-encoded.
*
*
*
* @param importCertificateAuthorityCertificateRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ImportCertificateAuthorityCertificate operation returned by
* the service.
* @sample AWSACMPCAAsyncHandler.ImportCertificateAuthorityCertificate
* @see AWS API Documentation
*/
java.util.concurrent.Future importCertificateAuthorityCertificateAsync(
ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon
* Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate
* operation and specifying the ARN.
*
*
*
* You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that
* you issue by using ACM PCA.
*
*
*
* @param issueCertificateRequest
* @return A Java Future containing the result of the IssueCertificate operation returned by the service.
* @sample AWSACMPCAAsync.IssueCertificate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future issueCertificateAsync(IssueCertificateRequest issueCertificateRequest);
/**
*
* Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon
* Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate
* operation and specifying the ARN.
*
*
*
* You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that
* you issue by using ACM PCA.
*
*
*
* @param issueCertificateRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the IssueCertificate operation returned by the service.
* @sample AWSACMPCAAsyncHandler.IssueCertificate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future issueCertificateAsync(IssueCertificateRequest issueCertificateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the private certificate authorities that you created by using the CreateCertificateAuthority
* operation.
*
*
* @param listCertificateAuthoritiesRequest
* @return A Java Future containing the result of the ListCertificateAuthorities operation returned by the service.
* @sample AWSACMPCAAsync.ListCertificateAuthorities
* @see AWS API Documentation
*/
java.util.concurrent.Future listCertificateAuthoritiesAsync(
ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest);
/**
*
* Lists the private certificate authorities that you created by using the CreateCertificateAuthority
* operation.
*
*
* @param listCertificateAuthoritiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListCertificateAuthorities operation returned by the service.
* @sample AWSACMPCAAsyncHandler.ListCertificateAuthorities
* @see AWS API Documentation
*/
java.util.concurrent.Future listCertificateAuthoritiesAsync(
ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the
* CreatePermission operation and revoked with the DeletePermission operation.
*
*
* @param listPermissionsRequest
* @return A Java Future containing the result of the ListPermissions operation returned by the service.
* @sample AWSACMPCAAsync.ListPermissions
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listPermissionsAsync(ListPermissionsRequest listPermissionsRequest);
/**
*
* Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the
* CreatePermission operation and revoked with the DeletePermission operation.
*
*
* @param listPermissionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListPermissions operation returned by the service.
* @sample AWSACMPCAAsyncHandler.ListPermissions
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listPermissionsAsync(ListPermissionsRequest listPermissionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify
* and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority
* operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.
*
*
* @param listTagsRequest
* @return A Java Future containing the result of the ListTags operation returned by the service.
* @sample AWSACMPCAAsync.ListTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsAsync(ListTagsRequest listTagsRequest);
/**
*
* Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify
* and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority
* operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.
*
*
* @param listTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTags operation returned by the service.
* @sample AWSACMPCAAsyncHandler.ListTags
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsAsync(ListTagsRequest listTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the
* period that you defined in the PermanentDeletionTimeInDays parameter of the
* DeleteCertificateAuthority operation. Currently, you can specify 7 to 30 days. If you did not specify a
* PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You
* can check the time remaining in the restoration period of a private CA in the DELETED state by
* calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a
* restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To
* change its status to ACTIVE, call the UpdateCertificateAuthority operation. If the private CA
* was in the PENDING_CERTIFICATE state at deletion, you must use the
* ImportCertificateAuthorityCertificate operation to import a certificate authority into the private CA
* before it can be activated. You cannot restore a CA after the restoration period has ended.
*
*
* @param restoreCertificateAuthorityRequest
* @return A Java Future containing the result of the RestoreCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsync.RestoreCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future restoreCertificateAuthorityAsync(
RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest);
/**
*
* Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the
* period that you defined in the PermanentDeletionTimeInDays parameter of the
* DeleteCertificateAuthority operation. Currently, you can specify 7 to 30 days. If you did not specify a
* PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You
* can check the time remaining in the restoration period of a private CA in the DELETED state by
* calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a
* restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To
* change its status to ACTIVE, call the UpdateCertificateAuthority operation. If the private CA
* was in the PENDING_CERTIFICATE state at deletion, you must use the
* ImportCertificateAuthorityCertificate operation to import a certificate authority into the private CA
* before it can be activated. You cannot restore a CA after the restoration period has ended.
*
*
* @param restoreCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RestoreCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsyncHandler.RestoreCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future restoreCertificateAuthorityAsync(
RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Revokes a certificate that you issued by calling the IssueCertificate operation. If you enable a
* certificate revocation list (CRL) when you create or update your private CA, information about the revoked
* certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more
* information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation
* information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
*
*
* @param revokeCertificateRequest
* @return A Java Future containing the result of the RevokeCertificate operation returned by the service.
* @sample AWSACMPCAAsync.RevokeCertificate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future revokeCertificateAsync(RevokeCertificateRequest revokeCertificateRequest);
/**
*
* Revokes a certificate that you issued by calling the IssueCertificate operation. If you enable a
* certificate revocation list (CRL) when you create or update your private CA, information about the revoked
* certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more
* information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation
* information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
*
*
* @param revokeCertificateRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RevokeCertificate operation returned by the service.
* @sample AWSACMPCAAsyncHandler.RevokeCertificate
* @see AWS API
* Documentation
*/
java.util.concurrent.Future revokeCertificateAsync(RevokeCertificateRequest revokeCertificateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds one or more tags to your private CA. 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 private CA 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 private CA if
* you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs
* if you want to filter for a common relationship among those CAs. To remove one or more tags, use the
* UntagCertificateAuthority operation. Call the ListTags operation to see what tags are associated
* with your CA.
*
*
* @param tagCertificateAuthorityRequest
* @return A Java Future containing the result of the TagCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsync.TagCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future tagCertificateAuthorityAsync(TagCertificateAuthorityRequest tagCertificateAuthorityRequest);
/**
*
* Adds one or more tags to your private CA. 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 private CA 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 private CA if
* you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs
* if you want to filter for a common relationship among those CAs. To remove one or more tags, use the
* UntagCertificateAuthority operation. Call the ListTags operation to see what tags are associated
* with your CA.
*
*
* @param tagCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsyncHandler.TagCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future tagCertificateAuthorityAsync(TagCertificateAuthorityRequest tagCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value
* portion of the tag when calling this operation, 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 private CA, use the
* TagCertificateAuthority. Call the ListTags operation to see what tags are associated with your CA.
*
*
* @param untagCertificateAuthorityRequest
* @return A Java Future containing the result of the UntagCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsync.UntagCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future untagCertificateAuthorityAsync(
UntagCertificateAuthorityRequest untagCertificateAuthorityRequest);
/**
*
* Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value
* portion of the tag when calling this operation, 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 private CA, use the
* TagCertificateAuthority. Call the ListTags operation to see what tags are associated with your CA.
*
*
* @param untagCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsyncHandler.UntagCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future untagCertificateAuthorityAsync(
UntagCertificateAuthorityRequest untagCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the
* ACTIVE or DISABLED state before you can update it. You can disable a private CA that is
* in the ACTIVE state or make a CA that is in the DISABLED state active again.
*
*
* @param updateCertificateAuthorityRequest
* @return A Java Future containing the result of the UpdateCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsync.UpdateCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future updateCertificateAuthorityAsync(
UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest);
/**
*
* Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the
* ACTIVE or DISABLED state before you can update it. You can disable a private CA that is
* in the ACTIVE state or make a CA that is in the DISABLED state active again.
*
*
* @param updateCertificateAuthorityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateCertificateAuthority operation returned by the service.
* @sample AWSACMPCAAsyncHandler.UpdateCertificateAuthority
* @see AWS API Documentation
*/
java.util.concurrent.Future updateCertificateAuthorityAsync(
UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}