com.amazonaws.services.acmpca

Interface AWSACMPCA

All Known Subinterfaces:

AWSACMPCAAsync

All Known Implementing Classes:

AbstractAWSACMPCA, AbstractAWSACMPCAAsync, AWSACMPCAAsyncClient, AWSACMPCAClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSACMPCA

Interface for accessing ACM-PCA.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSACMPCA instead.

This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.

The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA in the ACM Private CA user guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateCertificateAuthorityResult	createCertificateAuthority(CreateCertificateAuthorityRequest createCertificateAuthorityRequest) Creates a root or subordinate private certificate authority (CA).
CreateCertificateAuthorityAuditReportResult	createCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest) Creates an audit report that lists every time that your CA private key is used.
CreatePermissionResult	createPermission(CreatePermissionRequest createPermissionRequest) Assigns permissions from a private CA to a designated AWS service.
DeleteCertificateAuthorityResult	deleteCertificateAuthority(DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest) Deletes a private certificate authority (CA).
DeletePermissionResult	deletePermission(DeletePermissionRequest deletePermissionRequest) Revokes permissions that a private CA assigned to a designated AWS service.
DescribeCertificateAuthorityResult	describeCertificateAuthority(DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest) Lists information about your private certificate authority (CA).
DescribeCertificateAuthorityAuditReportResult	describeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest) Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCertificateResult	getCertificate(GetCertificateRequest getCertificateRequest) Retrieves a certificate from your private CA.
GetCertificateAuthorityCertificateResult	getCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest) Retrieves the certificate and certificate chain for your private certificate authority (CA).
GetCertificateAuthorityCsrResult	getCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest) Retrieves the certificate signing request (CSR) for your private certificate authority (CA).
ImportCertificateAuthorityCertificateResult	importCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest) Imports a signed private CA certificate into ACM Private CA.
IssueCertificateResult	issueCertificate(IssueCertificateRequest issueCertificateRequest) Uses your private certificate authority (CA) to issue a client certificate.
ListCertificateAuthoritiesResult	listCertificateAuthorities(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest) Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
ListPermissionsResult	listPermissions(ListPermissionsRequest listPermissionsRequest) Lists all the permissions, if any, that have been assigned by a private CA.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Lists the tags, if any, that are associated with your private CA.
RestoreCertificateAuthorityResult	restoreCertificateAuthority(RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest) Restores a certificate authority (CA) that is in the DELETED state.
RevokeCertificateResult	revokeCertificate(RevokeCertificateRequest revokeCertificateRequest) Revokes a certificate that was issued inside ACM Private CA.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagCertificateAuthorityResult	tagCertificateAuthority(TagCertificateAuthorityRequest tagCertificateAuthorityRequest) Adds one or more tags to your private CA.
UntagCertificateAuthorityResult	untagCertificateAuthority(UntagCertificateAuthorityRequest untagCertificateAuthorityRequest) Remove one or more tags from your private CA.
UpdateCertificateAuthorityResult	updateCertificateAuthority(UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest) Updates the status or configuration of a private certificate authority (CA).
AWSACMPCAWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createCertificateAuthority

CreateCertificateAuthorityResult createCertificateAuthority(CreateCertificateAuthorityRequest createCertificateAuthorityRequest)

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, 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 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.

Parameters:

createCertificateAuthorityRequest -

Returns:

Result of the CreateCertificateAuthority operation returned by the service.

Throws:

InvalidArgsException - One or more of the specified arguments was not valid.

InvalidPolicyException - The S3 bucket policy is not valid. The policy must give ACM Private CA rights to read from and write to the bucket and find the bucket location.

InvalidTagException - The tag associated with the CA is not valid. The invalid argument is contained in the message field.

LimitExceededException - An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

See Also:

AWS API Documentation

createCertificateAuthorityAuditReport

CreateCertificateAuthorityAuditReportResult createCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest)

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

Parameters:

createCertificateAuthorityAuditReportRequest -

Returns:

Result of the CreateCertificateAuthorityAuditReport operation returned by the service.

Throws:

RequestInProgressException - Your request is already in progress.

RequestFailedException - The request has failed for an unspecified reason.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidArgsException - One or more of the specified arguments was not valid.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

See Also:

AWS API Documentation

createPermission

CreatePermissionResult createPermission(CreatePermissionRequest createPermissionRequest)

Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.

At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission action and listed with the ListPermissions action.

Parameters:

createPermissionRequest -

Returns:

Result of the CreatePermission operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

PermissionAlreadyExistsException - The designated permission has already been given to the user.

LimitExceededException - An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

RequestFailedException - The request has failed for an unspecified reason.

See Also:

AWS API Documentation

deleteCertificateAuthority

DeleteCertificateAuthorityResult deleteCertificateAuthority(DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest)

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

Parameters:

deleteCertificateAuthorityRequest -

Returns:

Result of the DeleteCertificateAuthority operation returned by the service.

Throws:

ConcurrentModificationException - A previous update to your private CA is still ongoing.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

See Also:

AWS API Documentation

deletePermission

DeletePermissionResult deletePermission(DeletePermissionRequest deletePermissionRequest)

Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action.

Parameters:

deletePermissionRequest -

Returns:

Result of the DeletePermission operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

RequestFailedException - The request has failed for an unspecified reason.

See Also:

AWS API Documentation

describeCertificateAuthority

DescribeCertificateAuthorityResult describeCertificateAuthority(DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest)

Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

• CREATING - ACM Private CA is creating your private certificate authority.

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

• ACTIVE - Your private CA is active.

• DISABLED - Your private CA has been disabled.

• EXPIRED - Your private CA certificate has expired.

• FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

• DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

Parameters:

describeCertificateAuthorityRequest -

Returns:

Result of the DescribeCertificateAuthority operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See Also:

AWS API Documentation

describeCertificateAuthorityAuditReport

DescribeCertificateAuthorityAuditReportResult describeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest)

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.

Parameters:

describeCertificateAuthorityAuditReportRequest -

Returns:

Result of the DescribeCertificateAuthorityAuditReport operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidArgsException - One or more of the specified arguments was not valid.

See Also:

AWS API Documentation

getCertificate

GetCertificateResult getCertificate(GetCertificateRequest getCertificateRequest)

Retrieves a certificate from your private CA. 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.

Parameters:

getCertificateRequest -

Returns:

Result of the GetCertificate operation returned by the service.

Throws:

RequestInProgressException - Your request is already in progress.

RequestFailedException - The request has failed for an unspecified reason.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

See Also:

AWS API Documentation

getCertificateAuthorityCertificate

GetCertificateAuthorityCertificateResult getCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest)

Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

Parameters:

getCertificateAuthorityCertificateRequest -

Returns:

Result of the GetCertificateAuthorityCertificate operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See Also:

AWS API Documentation

getCertificateAuthorityCsr

GetCertificateAuthorityCsrResult getCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest)

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 ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.

Parameters:

getCertificateAuthorityCsrRequest -

Returns:

Result of the GetCertificateAuthorityCsr operation returned by the service.

Throws:

RequestInProgressException - Your request is already in progress.

RequestFailedException - The request has failed for an unspecified reason.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

See Also:

AWS API Documentation

importCertificateAuthorityCertificate

ImportCertificateAuthorityCertificateResult importCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest)

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

1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

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

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

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

The following requirements apply when you import a CA certificate.

• You cannot import a non-self-signed certificate for use as a root CA.

• You cannot import a self-signed certificate for use as a subordinate CA.

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

• Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

• The chain must be PEM-encoded.

Parameters:

importCertificateAuthorityCertificateRequest -

Returns:

Result of the ImportCertificateAuthorityCertificate operation returned by the service.

Throws:

ConcurrentModificationException - A previous update to your private CA is still ongoing.

RequestInProgressException - Your request is already in progress.

RequestFailedException - The request has failed for an unspecified reason.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidRequestException - The request action cannot be performed or is prohibited.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

MalformedCertificateException - One or more fields in the certificate are invalid.

CertificateMismatchException - The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.

See Also:

AWS API Documentation

issueCertificate

IssueCertificateResult issueCertificate(IssueCertificateRequest issueCertificateRequest)

Uses your private certificate authority (CA) 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 ACM Private CA.

Parameters:

issueCertificateRequest -

Returns:

Result of the IssueCertificate operation returned by the service.

Throws:

LimitExceededException - An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidArgsException - One or more of the specified arguments was not valid.

MalformedCSRException - The certificate signing request is invalid.

See Also:

AWS API Documentation

listCertificateAuthorities

ListCertificateAuthoritiesResult listCertificateAuthorities(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest)

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

Parameters:

listCertificateAuthoritiesRequest -

Returns:

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.

See Also:

AWS API Documentation

listPermissions

ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

Parameters:

listPermissionsRequest -

Returns:

Result of the ListPermissions operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidNextTokenException - The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

RequestFailedException - The request has failed for an unspecified reason.

See Also:

AWS API Documentation

listTags

ListTagsResult listTags(ListTagsRequest listTagsRequest)

Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

Parameters:

listTagsRequest -

Returns:

Result of the ListTags operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

See Also:

AWS API Documentation

restoreCertificateAuthority

RestoreCertificateAuthorityResult restoreCertificateAuthority(RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest)

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority 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.

Parameters:

restoreCertificateAuthorityRequest -

Returns:

Result of the RestoreCertificateAuthority operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See Also:

AWS API Documentation

revokeCertificate

RevokeCertificateResult revokeCertificate(RevokeCertificateRequest revokeCertificateRequest)

Revokes a certificate that was issued inside ACM 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. ACM Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate.

Parameters:

revokeCertificateRequest -

Returns:

Result of the RevokeCertificate operation returned by the service.

Throws:

ConcurrentModificationException - A previous update to your private CA is still ongoing.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidRequestException - The request action cannot be performed or is prohibited.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

LimitExceededException - An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

RequestAlreadyProcessedException - Your request has already been completed.

RequestInProgressException - Your request is already in progress.

RequestFailedException - The request has failed for an unspecified reason.

See Also:

AWS API Documentation

tagCertificateAuthority

TagCertificateAuthorityResult tagCertificateAuthority(TagCertificateAuthorityRequest tagCertificateAuthorityRequest)

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.

Parameters:

tagCertificateAuthorityRequest -

Returns:

Result of the TagCertificateAuthority operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

InvalidTagException - The tag associated with the CA is not valid. The invalid argument is contained in the message field.

TooManyTagsException - You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

See Also:

AWS API Documentation

untagCertificateAuthority

UntagCertificateAuthorityResult untagCertificateAuthority(UntagCertificateAuthorityRequest untagCertificateAuthorityRequest)

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this 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.

Parameters:

untagCertificateAuthorityRequest -

Returns:

Result of the UntagCertificateAuthority operation returned by the service.

Throws:

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

InvalidTagException - The tag associated with the CA is not valid. The invalid argument is contained in the message field.

See Also:

AWS API Documentation

updateCertificateAuthority

UpdateCertificateAuthorityResult updateCertificateAuthority(UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest)

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Parameters:

updateCertificateAuthorityRequest -

Returns:

Result of the UpdateCertificateAuthority operation returned by the service.

Throws:

ConcurrentModificationException - A previous update to your private CA is still ongoing.

ResourceNotFoundException - A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

InvalidArgsException - One or more of the specified arguments was not valid.

InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidStateException - The private CA is in a state during which a report or certificate cannot be generated.

InvalidPolicyException - The S3 bucket policy is not valid. The policy must give ACM Private CA rights to read from and write to the bucket and find the bucket location.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AWSACMPCAWaiters waiters()