openapi: 3.0.0
info:
version: 2017-08-22
x-release: v4
title: AWS Certificate Manager Private Certificate Authority
description: <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. 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.</p> <p>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 <a
href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>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 <a
href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.
</p> <p>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 <a
href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: acm-pca
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/acm-pca-2017-08-22.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/acm-pca/
servers:
- url: http://acm-pca.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The ACM-PCA multi-region endpoint
- url: https://acm-pca.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The ACM-PCA multi-region endpoint
- url: http://acm-pca.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The ACM-PCA endpoint for China (Beijing) and China (Ningxia)
- url: https://acm-pca.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The ACM-PCA endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/#X-Amz-Target=ACMPrivateCA.CreateCertificateAuthority:
post:
operationId: CreateCertificateAuthority
description: <p>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.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access policies for CRLs in Amazon
S3</a>.</p> </note> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a
href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your CRLs</a>.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateCertificateAuthorityResponse"
"480":
description: InvalidArgsException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgsException"
"481":
description: InvalidPolicyException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidPolicyException"
"482":
description: InvalidTagException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidTagException"
"483":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateCertificateAuthorityRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.CreateCertificateAuthority
summary: Amazon Private CA Create Certificate Authority
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.CreateCertificateAuthorityAuditReport:
post:
operationId: CreateCertificateAuthorityAuditReport
description: <p>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 <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use the private key. </p> <note> <p>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 <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access policies for CRLs in Amazon S3</a>.</p>
</note> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a
href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit Reports</a>.</p> <note> <p>You can generate a maximum of one
report every 30 minutes.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateCertificateAuthorityAuditReportResponse"
"480":
description: RequestInProgressException
content:
application/json:
schema:
$ref: "#/components/schemas/RequestInProgressException"
"481":
description: RequestFailedException
content:
application/json:
schema:
$ref: "#/components/schemas/RequestFailedException"
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"483":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
"484":
description: InvalidArgsException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgsException"
"485":
description: InvalidStateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidStateException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateCertificateAuthorityAuditReportRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.CreateCertificateAuthorityAuditReport
summary: Amazon Private CA Create Certificate Authority Audit Report
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.CreatePermission:
post:
operationId: CreatePermission
description: <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and renew
ACM certificates that reside in the same Amazon Web Services account as the CA.</p> <p>You can list current permissions with the <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action and revoke them with the <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p> <p class="title"> <b>About Permissions</b> </p> <ul> <li> <p>If the
private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p>
</li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web
Services Private CA</a>.</p> </li> </ul>
responses:
"200":
description: Success
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
"482":
description: PermissionAlreadyExistsException
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionAlreadyExistsException"
"483":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"484":
description: InvalidStateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidStateException"
"485":
description: RequestFailedException
content:
application/json:
schema:
$ref: "#/components/schemas/RequestFailedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreatePermissionRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.CreatePermission
summary: Amazon Private CA Create Permission
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.DeleteCertificateAuthority:
post:
operationId: DeleteCertificateAuthority
description: <p>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 <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. </p> <note> <p>Deleting a CA will invalidate other
CAs and certificates below it in your CA hierarchy.</p> </note> <p>Before you can delete a CA that you have created and activated, you must disable it. To do this, call the <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action and set the <b>CertificateAuthorityStatus</b>
parameter to <code>DISABLED</code>. </p> <p>Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is <code>CREATING</code>). 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
<code>PENDING_CERTIFICATE</code>). </p> <p>When you successfully call <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>, the CA's status changes to <code>DELETED</code>. However,
the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
30 days. You can set the parameter from 7 to 30 days. The <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a> action returns the time remaining in the restoration
window of a private CA in the <code>DELETED</code> state. To restore an eligible CA, call the <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a> action.</p>
responses:
"200":
description: Success
"480":
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: "#/components/schemas/ConcurrentModificationException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
"483":
description: InvalidStateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidStateException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteCertificateAuthorityRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.DeleteCertificateAuthority
summary: Amazon Private CA Delete Certificate Authority
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.DeletePermission:
post:
operationId: DeletePermission
description: <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). </p> <p>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.</p>
<p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and listed with the <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p> <p class="title"> <b>About Permissions</b> </p> <ul> <li> <p>If the
private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p>
</li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web
Services Private CA</a>.</p> </li> </ul>
responses:
"200":
description: Success
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
"482":
description: InvalidStateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidStateException"
"483":
description: RequestFailedException
content:
application/json:
schema:
$ref: "#/components/schemas/RequestFailedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeletePermissionRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.DeletePermission
summary: Amazon Private CA Delete Permission
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.DeletePolicy:
post:
operationId: DeletePolicy
description: <p>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.</p> <p>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. </p> <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. </p> <p>The current policy can be shown with <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a> and updated with <a
href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.</p> <p class="title"> <b>About Policies</b> </p> <ul> <li> <p>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 <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private
CA</a>.</p> </li> <li> <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a Service Linked Role with ACM</a>.</p> </li>
<li> <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see <a
href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>
responses:
"200":
description: Success
"480":
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: "#/components/schemas/ConcurrentModificationException"
"481":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
"482":
description: InvalidStateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidStateException"
"483":
description: LockoutPreventedException
content:
application/json:
schema:
$ref: "#/components/schemas/LockoutPreventedException"
"484":
description: RequestFailedException
content:
application/json:
schema:
$ref: "#/components/schemas/RequestFailedException"
"485":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeletePolicyRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.DeletePolicy
summary: Amazon Private CA Delete Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.DescribeCertificateAuthority:
post:
operationId: DescribeCertificateAuthority
description: "<p>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: </p> <ul> <li> <p> <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate authority.</p> </li>
<li> <p> <code>PENDING_CERTIFICATE</code> - 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. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p>
</li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - 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. </p> </li> <li> <p> <code>DELETED</code> - 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.</p> </li> </ul>"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeCertificateAuthorityResponse"
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeCertificateAuthorityRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.DescribeCertificateAuthority
summary: Amazon Private CA Describe Certificate Authority
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=ACMPrivateCA.DescribeCertificateAuthorityAuditReport:
post:
operationId: DescribeCertificateAuthorityAuditReport
description: 'Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> action. '
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeCertificateAuthorityAuditReportResponse"
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
"482":
description: InvalidArgsException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgsException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/sc
# --- truncated at 32 KB (173 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-private-ca/refs/heads/main/openapi/amazon-private-ca-openapi-original.yaml