/* * Copyright 2018-2023 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 org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.acmpca.AWSACMPCAClientBuilder; import com.amazonaws.services.acmpca.waiters.AWSACMPCAWaiters; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.acmpca.model.*; import com.amazonaws.services.acmpca.model.transform.*; /** * Client for accessing ACM-PCA. All service calls made using this client are blocking, and will not return until the * service call completes. *

*

* This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, * and usage examples for each of the actions and data types involved in creating and managing a private certificate * authority (CA) for your organization. *

*

* The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use * one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that * you prefer. For more information, see Amazon Web Services SDKs. *

*

* Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can * be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the * operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the * request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web * Services Private CA returns a ThrottlingException error. * Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. *

*

* To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into * your Amazon Web Services account and visit the Service * Quotas console. *

*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSACMPCAClient extends AmazonWebServiceClient implements AWSACMPCA { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSACMPCA.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "acm-pca"; private volatile AWSACMPCAWaiters waiters; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConcurrentModificationException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.ConcurrentModificationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidRequestException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidRequestExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidArgsException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidArgsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidArnException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidArnExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MalformedCSRException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.MalformedCSRExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("RequestInProgressException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.RequestInProgressExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LockoutPreventedException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.LockoutPreventedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidStateException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidStateExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("PermissionAlreadyExistsException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.PermissionAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("RequestAlreadyProcessedException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.RequestAlreadyProcessedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidNextTokenException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidNextTokenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.LimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidTagException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidTagExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("CertificateMismatchException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.CertificateMismatchExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TooManyTagsException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.TooManyTagsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidPolicyException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.InvalidPolicyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MalformedCertificateException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.MalformedCertificateExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("RequestFailedException").withExceptionUnmarshaller( com.amazonaws.services.acmpca.model.transform.RequestFailedExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.acmpca.model.AWSACMPCAException.class)); public static AWSACMPCAClientBuilder builder() { return AWSACMPCAClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on ACM-PCA using the specified parameters. * *

* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSACMPCAClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on ACM-PCA using the specified parameters. * *

* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSACMPCAClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("acm-pca.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/acmpca/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/acmpca/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *

* Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an * optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), * the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. 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, and X.500 subject information. The OCSP configuration can optionally specify a custom * URL for the OCSP responder. The CRL 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 action returns the Amazon Resource Name (ARN) of * the CA. *

* *

* Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you * specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception * is thrown. For more information, see Access policies for * CRLs in Amazon S3. *

*
*

* Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more * information, see Encrypting Your * CRLs. *

* * @param createCertificateAuthorityRequest * @return Result of the CreateCertificateAuthority operation returned by the service. * @throws InvalidArgsException * One or more of the specified arguments was not valid. * @throws InvalidPolicyException * The resource policy is invalid or is missing a required statement. For general information about IAM * policy and statement structure, see Overview of JSON Policies. * @throws InvalidTagException * The tag associated with the CA is not valid. The invalid argument is contained in the message field. * @throws LimitExceededException * An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to * determine the quota that was exceeded. * @sample AWSACMPCA.CreateCertificateAuthority * @see AWS API Documentation */ @Override public CreateCertificateAuthorityResult createCertificateAuthority(CreateCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeCreateCertificateAuthority(request); } @SdkInternalApi final CreateCertificateAuthorityResult executeCreateCertificateAuthority(CreateCertificateAuthorityRequest createCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(createCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CreateCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(createCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* 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 * actions use the private key. *

* *

* Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you * specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception * is thrown. For more information, see Access policies for * CRLs in Amazon S3. *

*
*

* Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more * information, see Encrypting Your Audit Reports. *

* *

* You can generate a maximum of one report every 30 minutes. *

*
* * @param createCertificateAuthorityAuditReportRequest * @return Result of the CreateCertificateAuthorityAuditReport operation returned by the service. * @throws RequestInProgressException * Your request is already in progress. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidArgsException * One or more of the specified arguments was not valid. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @sample AWSACMPCA.CreateCertificateAuthorityAuditReport * @see AWS API Documentation */ @Override public CreateCertificateAuthorityAuditReportResult createCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request) { request = beforeClientExecution(request); return executeCreateCertificateAuthorityAuditReport(request); } @SdkInternalApi final CreateCertificateAuthorityAuditReportResult executeCreateCertificateAuthorityAuditReport( CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest) { ExecutionContext executionContext = createExecutionContext(createCertificateAuthorityAuditReportRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CreateCertificateAuthorityAuditReportRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(createCertificateAuthorityAuditReportRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateCertificateAuthorityAuditReport"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateCertificateAuthorityAuditReportResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal ( * acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in * the same Amazon Web Services account as the CA. *

*

* You can list current permissions with the ListPermissions * action and revoke them with the DeletePermission * action. *

*

* About Permissions *

*
    *
  • *

    * If the private CA and the certificates it issues reside in the same account, you can use * CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. *

    *
  • *
  • *

    * For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, * and list certificates. *

    *
  • *
  • *

    * If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to * enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable * cross-account issuance and renewals. For more information, see Using a Resource Based Policy with * Amazon Web Services Private CA. *

    *
  • *
* * @param createPermissionRequest * @return Result of the CreatePermission operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws PermissionAlreadyExistsException * The designated permission has already been given to the user. * @throws LimitExceededException * An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to * determine the quota that was exceeded. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws RequestFailedException * The request has failed for an unspecified reason. * @sample AWSACMPCA.CreatePermission * @see AWS API * Documentation */ @Override public CreatePermissionResult createPermission(CreatePermissionRequest request) { request = beforeClientExecution(request); return executeCreatePermission(request); } @SdkInternalApi final CreatePermissionResult executeCreatePermission(CreatePermissionRequest createPermissionRequest) { ExecutionContext executionContext = createExecutionContext(createPermissionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new CreatePermissionRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createPermissionRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreatePermission"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreatePermissionResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA * that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action. *

* *

* Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy. *

*
*

* Before you can delete a CA that you have created and activated, you must disable it. To do this, call the * UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to * DISABLED. *

*

* Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is * CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed * certificate into Amazon Web Services Private CA (that is, the status of the CA is * PENDING_CERTIFICATE). *

*

* When you successfully 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 action returns the time remaining in the restoration window of a private CA in * the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action. *

* * @param deleteCertificateAuthorityRequest * @return Result of the DeleteCertificateAuthority operation returned by the service. * @throws ConcurrentModificationException * A previous update to your private CA is still ongoing. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @sample AWSACMPCA.DeleteCertificateAuthority * @see AWS API Documentation */ @Override public DeleteCertificateAuthorityResult deleteCertificateAuthority(DeleteCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeDeleteCertificateAuthority(request); } @SdkInternalApi final DeleteCertificateAuthorityResult executeDeleteCertificateAuthority(DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(deleteCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(deleteCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DeleteCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal * (acm.amazonaws.com). *

*

* These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services * account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates * automatically. *

*

* Permissions can be granted with the CreatePermission * action and listed with the ListPermissions * action. *

*

* About Permissions *

*
    *
  • *

    * If the private CA and the certificates it issues reside in the same account, you can use * CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. *

    *
  • *
  • *

    * For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, * and list certificates. *

    *
  • *
  • *

    * If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to * enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable * cross-account issuance and renewals. For more information, see Using a Resource Based Policy with * Amazon Web Services Private CA. *

    *
  • *
* * @param deletePermissionRequest * @return Result of the DeletePermission operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws RequestFailedException * The request has failed for an unspecified reason. * @sample AWSACMPCA.DeletePermission * @see AWS API * Documentation */ @Override public DeletePermissionResult deletePermission(DeletePermissionRequest request) { request = beforeClientExecution(request); return executeDeletePermission(request); } @SdkInternalApi final DeletePermissionResult executeDeletePermission(DeletePermissionRequest deletePermissionRequest) { ExecutionContext executionContext = createExecutionContext(deletePermissionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeletePermissionRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(deletePermissionRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DeletePermission"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeletePermissionResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has * granted. If there is no policy attached to the private CA, this action will return successful. *

*

* If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be * removed from all shares in which it was included. *

*

* The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. *

*

* The current policy can be shown with GetPolicy and updated * with PutPolicy. *

*

* About Policies *

*
    *
  • *

    * A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services * Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA * administrator. For more information, see Using a Resource Based Policy with * Amazon Web Services Private CA. *

    *
  • *
  • *

    * A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account. *

    *
  • *
  • *

    * For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role * (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the * Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM. *

    *
  • *
  • *

    * Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see * Attach a Policy for Cross-Account * Access. *

    *
  • *
* * @param deletePolicyRequest * @return Result of the DeletePolicy operation returned by the service. * @throws ConcurrentModificationException * A previous update to your private CA is still ongoing. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws LockoutPreventedException * The current action was prevented because it would lock the caller out from performing subsequent actions. * Verify that the specified parameters would not result in the caller being denied access to the resource. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @sample AWSACMPCA.DeletePolicy * @see AWS API * Documentation */ @Override public DeletePolicyResult deletePolicy(DeletePolicyRequest request) { request = beforeClientExecution(request); return executeDeletePolicy(request); } @SdkInternalApi final DeletePolicyResult executeDeletePolicy(DeletePolicyRequest deletePolicyRequest) { ExecutionContext executionContext = createExecutionContext(deletePolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeletePolicyRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(deletePolicyRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DeletePolicy"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeletePolicyResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Lists information about your private certificate authority (CA) or one that has been shared with you. 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 - Amazon Web Services Private CA is creating your private certificate authority. *

    *
  • *
  • *

    * PENDING_CERTIFICATE - The certificate is pending. You must use your Amazon Web Services Private * CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web * Services Private CA. *

    *
  • *
  • *

    * 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 * back-end Amazon Web Services 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 action's output. *

    *
  • *
* * @param describeCertificateAuthorityRequest * @return Result of the DescribeCertificateAuthority operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @sample AWSACMPCA.DescribeCertificateAuthority * @see AWS API Documentation */ @Override public DescribeCertificateAuthorityResult describeCertificateAuthority(DescribeCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeDescribeCertificateAuthority(request); } @SdkInternalApi final DescribeCertificateAuthorityResult executeDescribeCertificateAuthority(DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(describeCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(describeCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate * authority (CA) private key is used. The private key is used when you call the IssueCertificate * action or the RevokeCertificate * action. *

* * @param describeCertificateAuthorityAuditReportRequest * @return Result of the DescribeCertificateAuthorityAuditReport operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidArgsException * One or more of the specified arguments was not valid. * @sample AWSACMPCA.DescribeCertificateAuthorityAuditReport * @see AWS API Documentation */ @Override public DescribeCertificateAuthorityAuditReportResult describeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request) { request = beforeClientExecution(request); return executeDescribeCertificateAuthorityAuditReport(request); } @SdkInternalApi final DescribeCertificateAuthorityAuditReportResult executeDescribeCertificateAuthorityAuditReport( DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest) { ExecutionContext executionContext = createExecutionContext(describeCertificateAuthorityAuditReportRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeCertificateAuthorityAuditReportRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(describeCertificateAuthorityAuditReportRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeCertificateAuthorityAuditReport"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory .createResponseHandler(new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeCertificateAuthorityAuditReportResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is * returned when you call the IssueCertificate * action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the * GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call * the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the * certificates issued and revoked by your private CA. *

* * @param getCertificateRequest * @return Result of the GetCertificate operation returned by the service. * @throws RequestInProgressException * Your request is already in progress. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @sample AWSACMPCA.GetCertificate * @see AWS API * Documentation */ @Override public GetCertificateResult getCertificate(GetCertificateRequest request) { request = beforeClientExecution(request); return executeGetCertificate(request); } @SdkInternalApi final GetCertificateResult executeGetCertificate(GetCertificateRequest getCertificateRequest) { ExecutionContext executionContext = createExecutionContext(getCertificateRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new GetCertificateRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getCertificateRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetCertificate"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetCertificateResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been * shared with you. 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 Result of the GetCertificateAuthorityCertificate operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @sample AWSACMPCA.GetCertificateAuthorityCertificate * @see AWS API Documentation */ @Override public GetCertificateAuthorityCertificateResult getCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request) { request = beforeClientExecution(request); return executeGetCertificateAuthorityCertificate(request); } @SdkInternalApi final GetCertificateAuthorityCertificateResult executeGetCertificateAuthorityCertificate( GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest) { ExecutionContext executionContext = createExecutionContext(getCertificateAuthorityCertificateRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new GetCertificateAuthorityCertificateRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(getCertificateAuthorityCertificateRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetCertificateAuthorityCertificate"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetCertificateAuthorityCertificateResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created * when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted or * on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA * by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string. *

* * @param getCertificateAuthorityCsrRequest * @return Result of the GetCertificateAuthorityCsr operation returned by the service. * @throws RequestInProgressException * Your request is already in progress. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @sample AWSACMPCA.GetCertificateAuthorityCsr * @see AWS API Documentation */ @Override public GetCertificateAuthorityCsrResult getCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request) { request = beforeClientExecution(request); return executeGetCertificateAuthorityCsr(request); } @SdkInternalApi final GetCertificateAuthorityCsrResult executeGetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest) { ExecutionContext executionContext = createExecutionContext(getCertificateAuthorityCsrRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new GetCertificateAuthorityCsrRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(getCertificateAuthorityCsrRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetCertificateAuthorityCsr"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetCertificateAuthorityCsrResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy * cannot be found, this action returns a ResourceNotFoundException. *

*

* The policy can be attached or updated with PutPolicy and removed * with DeletePolicy. *

*

* About Policies *

*
    *
  • *

    * A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services * Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA * administrator. For more information, see Using a Resource Based Policy with * Amazon Web Services Private CA. *

    *
  • *
  • *

    * A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account. *

    *
  • *
  • *

    * For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role * (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the * Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM. *

    *
  • *
  • *

    * Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see * Attach a Policy for Cross-Account * Access. *

    *
  • *
* * @param getPolicyRequest * @return Result of the GetPolicy operation returned by the service. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @sample AWSACMPCA.GetPolicy * @see AWS API * Documentation */ @Override public GetPolicyResult getPolicy(GetPolicyRequest request) { request = beforeClientExecution(request); return executeGetPolicy(request); } @SdkInternalApi final GetPolicyResult executeGetPolicy(GetPolicyRequest getPolicyRequest) { ExecutionContext executionContext = createExecutionContext(getPolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new GetPolicyRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getPolicyRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetPolicy"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata() .withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetPolicyResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are * using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this * action, the following preparations must in place: *

*
    *
  1. *

    * In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported * certificate. *

    *
  2. *
  3. *

    * Call the * GetCertificateAuthorityCsr action to generate a certificate signing request (CSR). *

    *
  4. *
  5. *

    * Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA. *

    *
  6. *
  7. *

    * Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. *

    *
  8. *
*

* Amazon Web Services Private CA supports three scenarios for installing a CA certificate: *

*
    *
  • *

    * Installing a certificate for a root CA hosted by Amazon Web Services Private CA. *

    *
  • *
  • *

    * Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA. *

    *
  • *
  • *

    * Installing a subordinate CA certificate whose parent authority is externally hosted. *

    *
  • *
*

* The following additional requirements apply when you import a CA certificate. *

*
    *
  • *

    * Only a self-signed certificate can be imported as a root CA. *

    *
  • *
  • *

    * A self-signed certificate cannot be imported as a subordinate CA. *

    *
  • *
  • *

    * Your certificate chain must not include the private CA certificate that you are importing. *

    *
  • *
  • *

    * Your root CA 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. *

    *
  • *
  • *

    * The maximum allowed size of a certificate is 32 KB. *

    *
  • *
  • *

    * The maximum allowed size of a certificate chain is 2 MB. *

    *
  • *
*

* Enforcement of Critical Constraints *

*

* Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA * certificate or chain. *

*
    *
  • *

    * Basic constraints (must be marked critical) *

    *
  • *
  • *

    * Subject alternative names *

    *
  • *
  • *

    * Key usage *

    *
  • *
  • *

    * Extended key usage *

    *
  • *
  • *

    * Authority key identifier *

    *
  • *
  • *

    * Subject key identifier *

    *
  • *
  • *

    * Issuer alternative name *

    *
  • *
  • *

    * Subject directory attributes *

    *
  • *
  • *

    * Subject information access *

    *
  • *
  • *

    * Certificate policies *

    *
  • *
  • *

    * Policy mappings *

    *
  • *
  • *

    * Inhibit anyPolicy *

    *
  • *
*

* Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA * certificate or chain. *

*
    *
  • *

    * Name constraints *

    *
  • *
  • *

    * Policy constraints *

    *
  • *
  • *

    * CRL distribution points *

    *
  • *
  • *

    * Authority information access *

    *
  • *
  • *

    * Freshest CRL *

    *
  • *
  • *

    * Any other extension *

    *
  • *
* * @param importCertificateAuthorityCertificateRequest * @return Result of the ImportCertificateAuthorityCertificate operation returned by the service. * @throws ConcurrentModificationException * A previous update to your private CA is still ongoing. * @throws RequestInProgressException * Your request is already in progress. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidRequestException * The request action cannot be performed or is prohibited. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws MalformedCertificateException * One or more fields in the certificate are invalid. * @throws CertificateMismatchException * The certificate authority certificate you are importing does not comply with conditions specified in the * certificate that signed it. * @sample AWSACMPCA.ImportCertificateAuthorityCertificate * @see AWS API Documentation */ @Override public ImportCertificateAuthorityCertificateResult importCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request) { request = beforeClientExecution(request); return executeImportCertificateAuthorityCertificate(request); } @SdkInternalApi final ImportCertificateAuthorityCertificateResult executeImportCertificateAuthorityCertificate( ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest) { ExecutionContext executionContext = createExecutionContext(importCertificateAuthorityCertificateRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ImportCertificateAuthorityCertificateRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(importCertificateAuthorityCertificateRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ImportCertificateAuthorityCertificate"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ImportCertificateAuthorityCertificateResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Uses your private certificate authority (CA), or one that has been shared with you, to issue a client * certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the * certificate by calling the GetCertificate * action and specifying the ARN. *

* *

* You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you * issue by using Amazon Web Services Private CA. *

*
* * @param issueCertificateRequest * @return Result of the IssueCertificate operation returned by the service. * @throws LimitExceededException * An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to * determine the quota that was exceeded. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidArgsException * One or more of the specified arguments was not valid. * @throws MalformedCSRException * The certificate signing request is invalid. * @sample AWSACMPCA.IssueCertificate * @see AWS API * Documentation */ @Override public IssueCertificateResult issueCertificate(IssueCertificateRequest request) { request = beforeClientExecution(request); return executeIssueCertificate(request); } @SdkInternalApi final IssueCertificateResult executeIssueCertificate(IssueCertificateRequest issueCertificateRequest) { ExecutionContext executionContext = createExecutionContext(issueCertificateRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new IssueCertificateRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(issueCertificateRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "IssueCertificate"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new IssueCertificateResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. *

* * @param listCertificateAuthoritiesRequest * @return Result of the ListCertificateAuthorities operation returned by the service. * @throws InvalidNextTokenException * The token specified in the NextToken argument is not valid. Use the token returned from your * previous call to ListCertificateAuthorities. * @sample AWSACMPCA.ListCertificateAuthorities * @see AWS API Documentation */ @Override public ListCertificateAuthoritiesResult listCertificateAuthorities(ListCertificateAuthoritiesRequest request) { request = beforeClientExecution(request); return executeListCertificateAuthorities(request); } @SdkInternalApi final ListCertificateAuthoritiesResult executeListCertificateAuthorities(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest) { ExecutionContext executionContext = createExecutionContext(listCertificateAuthoritiesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListCertificateAuthoritiesRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(listCertificateAuthoritiesRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListCertificateAuthorities"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListCertificateAuthoritiesResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal * (acm.amazonaws.com). *

*

* These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services * account as the CA. *

*

* Permissions can be granted with the CreatePermission * action and revoked with the DeletePermission * action. *

*

* About Permissions *

*
    *
  • *

    * If the private CA and the certificates it issues reside in the same account, you can use * CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. *

    *
  • *
  • *

    * For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, * and list certificates. *

    *
  • *
  • *

    * If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to * enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable * cross-account issuance and renewals. For more information, see Using a Resource Based Policy with * Amazon Web Services Private CA. *

    *
  • *
* * @param listPermissionsRequest * @return Result of the ListPermissions operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidNextTokenException * The token specified in the NextToken argument is not valid. Use the token returned from your * previous call to ListCertificateAuthorities. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws RequestFailedException * The request has failed for an unspecified reason. * @sample AWSACMPCA.ListPermissions * @see AWS API * Documentation */ @Override public ListPermissionsResult listPermissions(ListPermissionsRequest request) { request = beforeClientExecution(request); return executeListPermissions(request); } @SdkInternalApi final ListPermissionsResult executeListPermissions(ListPermissionsRequest listPermissionsRequest) { ExecutionContext executionContext = createExecutionContext(listPermissionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListPermissionsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listPermissionsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListPermissions"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListPermissionsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Lists the tags, if any, that are associated with your private CA or one that has been shared with you. 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 action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags. *

* * @param listTagsRequest * @return Result of the ListTags operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @sample AWSACMPCA.ListTags * @see AWS API * Documentation */ @Override public ListTagsResult listTags(ListTagsRequest request) { request = beforeClientExecution(request); return executeListTags(request); } @SdkInternalApi final ListTagsResult executeListTags(ListTagsRequest listTagsRequest) { ExecutionContext executionContext = createExecutionContext(listTagsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new ListTagsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listTagsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListTags"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata() .withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListTagsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Attaches a resource-based policy to a private CA. *

*

* A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). * For more information, see Attach a * Policy for Cross-Account Access. *

*

* The policy can be displayed with GetPolicy and removed * with DeletePolicy. *

*

* About Policies *

*
    *
  • *

    * A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services * Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA * administrator. For more information, see Using a Resource Based Policy with * Amazon Web Services Private CA. *

    *
  • *
  • *

    * A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account. *

    *
  • *
  • *

    * For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role * (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the * Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM. *

    *
  • *
  • *

    * Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see * Attach a Policy for Cross-Account * Access. *

    *
  • *
* * @param putPolicyRequest * @return Result of the PutPolicy operation returned by the service. * @throws ConcurrentModificationException * A previous update to your private CA is still ongoing. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidPolicyException * The resource policy is invalid or is missing a required statement. For general information about IAM * policy and statement structure, see Overview of JSON Policies. * @throws LockoutPreventedException * The current action was prevented because it would lock the caller out from performing subsequent actions. * Verify that the specified parameters would not result in the caller being denied access to the resource. * @throws RequestFailedException * The request has failed for an unspecified reason. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @sample AWSACMPCA.PutPolicy * @see AWS API * Documentation */ @Override public PutPolicyResult putPolicy(PutPolicyRequest request) { request = beforeClientExecution(request); return executePutPolicy(request); } @SdkInternalApi final PutPolicyResult executePutPolicy(PutPolicyRequest putPolicyRequest) { ExecutionContext executionContext = createExecutionContext(putPolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new PutPolicyRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(putPolicyRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "PutPolicy"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata() .withPayloadJson(true).withHasStreamingSuccessResponse(false), new PutPolicyResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* 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 action. 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 actions. The status of a restored CA is set to its pre-deletion status when the * RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at * deletion, you must use the ImportCertificateAuthorityCertificate action 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 Result of the RestoreCertificateAuthority operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @sample AWSACMPCA.RestoreCertificateAuthority * @see AWS API Documentation */ @Override public RestoreCertificateAuthorityResult restoreCertificateAuthority(RestoreCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeRestoreCertificateAuthority(request); } @SdkInternalApi final RestoreCertificateAuthorityResult executeRestoreCertificateAuthority(RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(restoreCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new RestoreCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(restoreCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "RestoreCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new RestoreCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Revokes a certificate that was issued inside Amazon Web Services Private CA. 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. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is * typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update * fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, * you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more * information, see Supported * CloudWatch Metrics. *

* *

* Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you * specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception * is thrown. For more information, see Access policies for * CRLs in Amazon S3. *

*
*

* Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see * CreateCertificateAuthorityAuditReport. *

* *

* You cannot revoke a root CA self-signed certificate. *

*
* * @param revokeCertificateRequest * @return Result of the RevokeCertificate operation returned by the service. * @throws ConcurrentModificationException * A previous update to your private CA is still ongoing. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidRequestException * The request action cannot be performed or is prohibited. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws LimitExceededException * An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to * determine the quota that was exceeded. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws RequestAlreadyProcessedException * Your request has already been completed. * @throws RequestInProgressException * Your request is already in progress. * @throws RequestFailedException * The request has failed for an unspecified reason. * @sample AWSACMPCA.RevokeCertificate * @see AWS API * Documentation */ @Override public RevokeCertificateResult revokeCertificate(RevokeCertificateRequest request) { request = beforeClientExecution(request); return executeRevokeCertificate(request); } @SdkInternalApi final RevokeCertificateResult executeRevokeCertificate(RevokeCertificateRequest revokeCertificateRequest) { ExecutionContext executionContext = createExecutionContext(revokeCertificateRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new RevokeCertificateRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(revokeCertificateRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "RevokeCertificate"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new RevokeCertificateResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* Adds one or more tags to your private CA. 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 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 action. Call the ListTags action to see * what tags are associated with your CA. *

* *

* To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline * IAM policy with the CreateCertificateAuthority action and explicitly allow tagging. For more * information, see Attaching * tags to a CA at the time of creation. *

*
* * @param tagCertificateAuthorityRequest * @return Result of the TagCertificateAuthority operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidTagException * The tag associated with the CA is not valid. The invalid argument is contained in the message field. * @throws TooManyTagsException * You can associate up to 50 tags with a private CA. Exception information is contained in the exception * message field. * @sample AWSACMPCA.TagCertificateAuthority * @see AWS API Documentation */ @Override public TagCertificateAuthorityResult tagCertificateAuthority(TagCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeTagCertificateAuthority(request); } @SdkInternalApi final TagCertificateAuthorityResult executeTagCertificateAuthority(TagCertificateAuthorityRequest tagCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(tagCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new TagCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(tagCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "TagCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new TagCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* 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 action, 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 action to see * what tags are associated with your CA. *

* * @param untagCertificateAuthorityRequest * @return Result of the UntagCertificateAuthority operation returned by the service. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidTagException * The tag associated with the CA is not valid. The invalid argument is contained in the message field. * @sample AWSACMPCA.UntagCertificateAuthority * @see AWS API Documentation */ @Override public UntagCertificateAuthorityResult untagCertificateAuthority(UntagCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeUntagCertificateAuthority(request); } @SdkInternalApi final UntagCertificateAuthorityResult executeUntagCertificateAuthority(UntagCertificateAuthorityRequest untagCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(untagCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new UntagCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(untagCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UntagCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UntagCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** *

* 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. *

* *

* Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you * specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception * is thrown. For more information, see Access policies for * CRLs in Amazon S3. *

*
* * @param updateCertificateAuthorityRequest * @return Result of the UpdateCertificateAuthority operation returned by the service. * @throws ConcurrentModificationException * A previous update to your private CA is still ongoing. * @throws ResourceNotFoundException * A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. * @throws InvalidArgsException * One or more of the specified arguments was not valid. * @throws InvalidArnException * The requested Amazon Resource Name (ARN) does not refer to an existing resource. * @throws InvalidStateException * The state of the private CA does not allow this action to occur. * @throws InvalidPolicyException * The resource policy is invalid or is missing a required statement. For general information about IAM * policy and statement structure, see Overview of JSON Policies. * @sample AWSACMPCA.UpdateCertificateAuthority * @see AWS API Documentation */ @Override public UpdateCertificateAuthorityResult updateCertificateAuthority(UpdateCertificateAuthorityRequest request) { request = beforeClientExecution(request); return executeUpdateCertificateAuthority(request); } @SdkInternalApi final UpdateCertificateAuthorityResult executeUpdateCertificateAuthority(UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest) { ExecutionContext executionContext = createExecutionContext(updateCertificateAuthorityRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request request = null; Response response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new UpdateCertificateAuthorityRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(updateCertificateAuthorityRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint); request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden()); request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion()); request.addHandlerContext(HandlerContextKey.SERVICE_ID, "ACM PCA"); request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UpdateCertificateAuthority"); request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateCertificateAuthorityResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * 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 the request. * * @param request * The originally executed request * * @return The response metadata for the specified request, or null if none is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) { return client.getResponseMetadataForRequest(request); } /** * Normal invoke with authentication. Credentials are required and may be overriden at the request level. **/ private Response invoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext) { return invoke(request, responseHandler, executionContext, null, null); } /** * Normal invoke with authentication. Credentials are required and may be overriden at the request level. **/ private Response invoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext, URI cachedEndpoint, URI uriFromEndpointTrait) { executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider)); return doInvoke(request, responseHandler, executionContext, cachedEndpoint, uriFromEndpointTrait); } /** * Invoke with no authentication. Credentials are not required and any credentials set on the client or request will * be ignored for this operation. **/ private Response anonymousInvoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext) { return doInvoke(request, responseHandler, executionContext, null, null); } /** * Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the * ExecutionContext beforehand. **/ private Response doInvoke(Request request, HttpResponseHandler> responseHandler, ExecutionContext executionContext, URI discoveredEndpoint, URI uriFromEndpointTrait) { if (discoveredEndpoint != null) { request.setEndpoint(discoveredEndpoint); request.getOriginalRequest().getRequestClientOptions().appendUserAgent("endpoint-discovery"); } else if (uriFromEndpointTrait != null) { request.setEndpoint(uriFromEndpointTrait); } else { request.setEndpoint(endpoint); } request.setTimeOffset(timeOffset); HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata()); return client.execute(request, responseHandler, errorResponseHandler, executionContext); } @com.amazonaws.annotation.SdkInternalApi static com.amazonaws.protocol.json.SdkJsonProtocolFactory getProtocolFactory() { return protocolFactory; } @Override public AWSACMPCAWaiters waiters() { if (waiters == null) { synchronized (this) { if (waiters == null) { waiters = new AWSACMPCAWaiters(this); } } } return waiters; } @Override public void shutdown() { super.shutdown(); if (waiters != null) { waiters.shutdown(); } } }