Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

@aws-sdk/client-acm-pca

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.

Index

Enumerations

AccessMethodType ActionType AuditReportResponseFormat AuditReportStatus CertificateAuthorityStatus CertificateAuthorityType CertificateAuthorityUsageMode ExtendedKeyUsageType FailureReason KeyAlgorithm KeyStorageSecurityStandard PolicyQualifierId ResourceOwner RevocationReason S3ObjectAcl SigningAlgorithm ValidityPeriodType

Classes

$Command ACMPCA ACMPCAClient ACMPCAServiceException CertificateMismatchException ConcurrentModificationException CreateCertificateAuthorityAuditReportCommand CreateCertificateAuthorityCommand CreatePermissionCommand DeleteCertificateAuthorityCommand DeletePermissionCommand DeletePolicyCommand DescribeCertificateAuthorityAuditReportCommand DescribeCertificateAuthorityCommand GetCertificateAuthorityCertificateCommand GetCertificateAuthorityCsrCommand GetCertificateCommand GetPolicyCommand ImportCertificateAuthorityCertificateCommand InvalidArgsException InvalidArnException InvalidNextTokenException InvalidPolicyException InvalidRequestException InvalidStateException InvalidTagException IssueCertificateCommand LimitExceededException ListCertificateAuthoritiesCommand ListPermissionsCommand ListTagsCommand LockoutPreventedException MalformedCSRException MalformedCertificateException PermissionAlreadyExistsException PutPolicyCommand RequestAlreadyProcessedException RequestFailedException RequestInProgressException ResourceNotFoundException RestoreCertificateAuthorityCommand RevokeCertificateCommand TagCertificateAuthorityCommand TooManyTagsException UntagCertificateAuthorityCommand UpdateCertificateAuthorityCommand __Client

Interfaces

ACMPCAClientConfig ACMPCAClientResolvedConfig ACMPCAPaginationConfiguration ASN1Subject AccessDescription AccessMethod ApiPassthrough CertificateAuthority CertificateAuthorityConfiguration ClientDefaults CreateCertificateAuthorityAuditReportCommandInput CreateCertificateAuthorityAuditReportCommandOutput CreateCertificateAuthorityAuditReportRequest CreateCertificateAuthorityAuditReportResponse CreateCertificateAuthorityCommandInput CreateCertificateAuthorityCommandOutput CreateCertificateAuthorityRequest CreateCertificateAuthorityResponse CreatePermissionCommandInput CreatePermissionCommandOutput CreatePermissionRequest CrlConfiguration CsrExtensions CustomAttribute CustomExtension DeleteCertificateAuthorityCommandInput DeleteCertificateAuthorityCommandOutput DeleteCertificateAuthorityRequest DeletePermissionCommandInput DeletePermissionCommandOutput DeletePermissionRequest DeletePolicyCommandInput DeletePolicyCommandOutput DeletePolicyRequest DescribeCertificateAuthorityAuditReportCommandInput DescribeCertificateAuthorityAuditReportCommandOutput DescribeCertificateAuthorityAuditReportRequest DescribeCertificateAuthorityAuditReportResponse DescribeCertificateAuthorityCommandInput DescribeCertificateAuthorityCommandOutput DescribeCertificateAuthorityRequest DescribeCertificateAuthorityResponse EdiPartyName ExtendedKeyUsage Extensions GeneralName GetCertificateAuthorityCertificateCommandInput GetCertificateAuthorityCertificateCommandOutput GetCertificateAuthorityCertificateRequest GetCertificateAuthorityCertificateResponse GetCertificateAuthorityCsrCommandInput GetCertificateAuthorityCsrCommandOutput GetCertificateAuthorityCsrRequest GetCertificateAuthorityCsrResponse GetCertificateCommandInput GetCertificateCommandOutput GetCertificateRequest GetCertificateResponse GetPolicyCommandInput GetPolicyCommandOutput GetPolicyRequest GetPolicyResponse ImportCertificateAuthorityCertificateCommandInput ImportCertificateAuthorityCertificateCommandOutput ImportCertificateAuthorityCertificateRequest IssueCertificateCommandInput IssueCertificateCommandOutput IssueCertificateRequest IssueCertificateResponse KeyUsage ListCertificateAuthoritiesCommandInput ListCertificateAuthoritiesCommandOutput ListCertificateAuthoritiesRequest ListCertificateAuthoritiesResponse ListPermissionsCommandInput ListPermissionsCommandOutput ListPermissionsRequest ListPermissionsResponse ListTagsCommandInput ListTagsCommandOutput ListTagsRequest ListTagsResponse OcspConfiguration OtherName Permission PolicyInformation PolicyQualifierInfo PutPolicyCommandInput PutPolicyCommandOutput PutPolicyRequest Qualifier RestoreCertificateAuthorityCommandInput RestoreCertificateAuthorityCommandOutput RestoreCertificateAuthorityRequest RevocationConfiguration RevokeCertificateCommandInput RevokeCertificateCommandOutput RevokeCertificateRequest Tag TagCertificateAuthorityCommandInput TagCertificateAuthorityCommandOutput TagCertificateAuthorityRequest UntagCertificateAuthorityCommandInput UntagCertificateAuthorityCommandOutput UntagCertificateAuthorityRequest UpdateCertificateAuthorityCommandInput UpdateCertificateAuthorityCommandOutput UpdateCertificateAuthorityRequest Validity __MetadataBearer

Type Aliases

ACMPCAClientConfigType ACMPCAClientResolvedConfigType ServiceInputTypes ServiceOutputTypes

Functions

paginateListCertificateAuthorities paginateListPermissions paginateListTags waitForAuditReportCreated waitForCertificateAuthorityCSRCreated waitForCertificateIssued waitUntilAuditReportCreated waitUntilCertificateAuthorityCSRCreated waitUntilCertificateIssued

SDK - Clients

ACMPCA ACMPCAClient

SDK - Commands

CreateCertificateAuthorityAuditReportCommand CreateCertificateAuthorityAuditReportCommandInput CreateCertificateAuthorityAuditReportCommandOutput CreateCertificateAuthorityCommand CreateCertificateAuthorityCommandInput CreateCertificateAuthorityCommandOutput CreatePermissionCommand CreatePermissionCommandInput CreatePermissionCommandOutput DeleteCertificateAuthorityCommand DeleteCertificateAuthorityCommandInput DeleteCertificateAuthorityCommandOutput DeletePermissionCommand DeletePermissionCommandInput DeletePermissionCommandOutput DeletePolicyCommand DeletePolicyCommandInput DeletePolicyCommandOutput DescribeCertificateAuthorityAuditReportCommand DescribeCertificateAuthorityAuditReportCommandInput DescribeCertificateAuthorityAuditReportCommandOutput DescribeCertificateAuthorityCommand DescribeCertificateAuthorityCommandInput DescribeCertificateAuthorityCommandOutput GetCertificateAuthorityCertificateCommand GetCertificateAuthorityCertificateCommandInput GetCertificateAuthorityCertificateCommandOutput GetCertificateAuthorityCsrCommand GetCertificateAuthorityCsrCommandInput GetCertificateAuthorityCsrCommandOutput GetCertificateCommand GetCertificateCommandInput GetCertificateCommandOutput GetPolicyCommand GetPolicyCommandInput GetPolicyCommandOutput ImportCertificateAuthorityCertificateCommand ImportCertificateAuthorityCertificateCommandInput ImportCertificateAuthorityCertificateCommandOutput IssueCertificateCommand IssueCertificateCommandInput IssueCertificateCommandOutput ListCertificateAuthoritiesCommand ListCertificateAuthoritiesCommandInput ListCertificateAuthoritiesCommandOutput ListPermissionsCommand ListPermissionsCommandInput ListPermissionsCommandOutput ListTagsCommand ListTagsCommandInput ListTagsCommandOutput PutPolicyCommand PutPolicyCommandInput PutPolicyCommandOutput RestoreCertificateAuthorityCommand RestoreCertificateAuthorityCommandInput RestoreCertificateAuthorityCommandOutput RevokeCertificateCommand RevokeCertificateCommandInput RevokeCertificateCommandOutput TagCertificateAuthorityCommand TagCertificateAuthorityCommandInput TagCertificateAuthorityCommandOutput UntagCertificateAuthorityCommand UntagCertificateAuthorityCommandInput UntagCertificateAuthorityCommandOutput UpdateCertificateAuthorityCommand UpdateCertificateAuthorityCommandInput UpdateCertificateAuthorityCommandOutput

SDK - Paginators

paginateListCertificateAuthorities paginateListPermissions paginateListTags

SDK - Waiters

waitForAuditReportCreated waitForCertificateAuthorityCSRCreated waitForCertificateIssued

Settings

Member Visibility

Theme