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.
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: mike.ralphson@gmail.com 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: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.
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: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.
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.
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.
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.
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.
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.
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.
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:
In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
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
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.
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.
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.
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.
responses:
"200":
description: Success
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: InvalidStateException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidStateException"
"482":
description: InvalidArnException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArnException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RestoreCertificateAuthorityRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.RestoreCertificateAuthority
summary: Amazon Private CA Restore 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.RevokeCertificate:
post:
operationId: RevokeCertificate
description: 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.
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.
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.
If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
The following requirements apply to revocation configurations.
A configuration
disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are
included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
CertificateAuthorityType: allOf: - $ref: "#/components/schemas/CertificateAuthorityType" - description: The type of the certificate authority. IdempotencyToken: allOf: - $ref: "#/components/schemas/IdempotencyToken" - description: Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities. KeyStorageSecurityStandard: allOf: - $ref: "#/components/schemas/KeyStorageSecurityStandard" - description: 'Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: FIPS_140_2_LEVEL_3_OR_HIGHER
is not supported in the following Regions:
ap-northeast-3
ap-southeast-3
When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for KeyStorageSecurityStandard. Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created
in this region with the specified security standard."
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
InvalidArgsException: {} InvalidPolicyException: {} InvalidTagException: {} LimitExceededException: {} CreateCertificateAuthorityAuditReportResponse: type: object properties: AuditReportId: allOf: - $ref: "#/components/schemas/AuditReportId" - description: An alphanumeric string that contains a report identifier. S3Key: allOf: - $ref: "#/components/schemas/S3Key" - description: The key that uniquely identifies the report file in your S3 bucket. CreateCertificateAuthorityAuditReportRequest: type: object required: - CertificateAuthorityArn - S3BucketName - AuditReportResponseFormat title: CreateCertificateAuthorityAuditReportRequest properties: CertificateAuthorityArn: allOf: - $ref: "#/components/schemas/Arn" - description:The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
acm.amazonaws.com.
SourceAccount:
allOf:
- $ref: "#/components/schemas/AccountId"
- description: The ID of the calling account.
Actions:
allOf:
- $ref: "#/components/schemas/ActionList"
- description: The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and
ListPermissions.
PermissionAlreadyExistsException: {}
DeleteCertificateAuthorityRequest:
type: object
required:
- CertificateAuthorityArn
title: DeleteCertificateAuthorityRequest
properties:
CertificateAuthorityArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: 'The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
.
acm.amazonaws.com "
SourceAccount:
allOf:
- $ref: "#/components/schemas/AccountId"
- description: The Amazon Web Services account that calls this action.
DeletePolicyRequest:
type: object
required:
- ResourceArn
title: DeletePolicyRequest
properties:
ResourceArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: "The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab. "
LockoutPreventedException: {}
DescribeCertificateAuthorityResponse:
type: object
properties:
CertificateAuthority:
allOf:
- $ref: "#/components/schemas/CertificateAuthority"
- description: A CertificateAuthority structure that contains information about your
private CA.
DescribeCertificateAuthorityRequest:
type: object
required:
- CertificateAuthorityArn
title: DescribeCertificateAuthorityRequest
properties:
CertificateAuthorityArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: 'The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) of the private CA. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
CertificateArn parameter.
CertificateChain:
allOf:
- $ref: "#/components/schemas/CertificateChain"
- description: "The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate. "
GetCertificateRequest:
type: object
required:
- CertificateAuthorityArn
- CertificateArn
title: GetCertificateRequest
properties:
CertificateAuthorityArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: 'The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
The Amazon Resource Name (ARN) of your private CA. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.
This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.
InvalidRequestException: {} MalformedCertificateException: {} CertificateMismatchException: {} IssueCertificateResponse: type: object properties: CertificateArn: allOf: - $ref: "#/components/schemas/Arn" - description:The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be
selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
CertificateAuthorityArn: allOf: - $ref: "#/components/schemas/Arn" - description:The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can then
use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf
-extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
" SigningAlgorithm: allOf: - $ref: "#/components/schemas/SigningAlgorithm" - description:The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm
parameter used to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) much match the algorithm family of the CA's secret key.
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1
template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the
CA depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding
Certificate Templates.
Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.
Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
This value is unaffected when
ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless
of the ValidityNotBefore value.
The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
ValidityNotBefore: allOf: - $ref: "#/components/schemas/Validity" - description:Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
By default, when issuing a
certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The
ValidityNotBefore parameter can be used to customize the “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore parameter
is optional.
The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more
information, see Validity in this API reference and Validity in RFC 5280.
NextToken parameter in a subsequent pagination request.
ListCertificateAuthoritiesRequest:
type: object
title: ListCertificateAuthoritiesRequest
properties:
NextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken
parameter from the response you just received.
MaxResults:
allOf:
- $ref: "#/components/schemas/MaxResults"
- description: Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you
specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
ResourceOwner:
allOf:
- $ref: "#/components/schemas/ResourceOwner"
- description: Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.
InvalidNextTokenException: {}
ListPermissionsResponse:
type: object
properties:
Permissions:
allOf:
- $ref: "#/components/schemas/PermissionList"
- description: Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.
NextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: "When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request. "
ListPermissionsRequest:
type: object
required:
- CertificateAuthorityArn
title: ListPermissionsRequest
properties:
CertificateAuthorityArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: "The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private
CA's ARN by running the ListCertificateAuthorities action."
NextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the
response you just received.
MaxResults:
allOf:
- $ref: "#/components/schemas/MaxResults"
- description: When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the
NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
ListTagsResponse:
type: object
properties:
Tags:
allOf:
- $ref: "#/components/schemas/TagList"
- description: The tags associated with your private CA.
NextToken:
allOf:
- $ref: "#/components/schemas/NextToken"
- description: "When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request. "
ListTagsRequest:
type: object
required:
- CertificateAuthorityArn
title: ListTagsRequest
properties:
CertificateAuthorityArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: 'The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.
Policy: allOf: - $ref: "#/components/schemas/AWSPolicy" - description: The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, thePutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.
RestoreCertificateAuthorityRequest:
type: object
required:
- CertificateAuthorityArn
title: RestoreCertificateAuthorityRequest
properties:
CertificateAuthorityArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: 'The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.
RevocationReason: allOf: - $ref: "#/components/schemas/RevocationReason" - description: Specifies why you revoked the certificate. RequestAlreadyProcessedException: {} TagCertificateAuthorityRequest: type: object required: - CertificateAuthorityArn - Tags title: TagCertificateAuthorityRequest properties: CertificateAuthorityArn: allOf: - $ref: "#/components/schemas/Arn" - description: 'The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as
CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
" SerialNumber: allOf: - $ref: "#/components/schemas/ASN1PrintableString64" - description: The certificate serial number. Locality: allOf: - $ref: "#/components/schemas/String128" - description: The locality (such as a city or town) in which the certificate subject is located. Title: allOf: - $ref: "#/components/schemas/String64" - description: A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject. Surname: allOf: - $ref: "#/components/schemas/String40" - description: Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first. GivenName: allOf: - $ref: "#/components/schemas/String16" - description: First name. Initials: allOf: - $ref: "#/components/schemas/String5" - description: Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname. Pseudonym: allOf: - $ref: "#/components/schemas/String128" - description: Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza. GenerationQualifier: allOf: - $ref: "#/components/schemas/String3" - description: Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third. CustomAttributes: allOf: - $ref: "#/components/schemas/CustomAttributeList" - description:Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).
Custom attributes cannot be used in combination with standard attributes.
Subject field in the certificate identifies the entity that owns or controls the public key in the certificate.
The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The
RDNs are separated by commas in the certificate.
AWSPolicy:
type: string
pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
minLength: 1
maxLength: 20480
AccessMethod:
type: object
properties:
CustomObjectIdentifier:
allOf:
- $ref: "#/components/schemas/CustomObjectIdentifier"
- description: An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).
AccessMethodType:
allOf:
- $ref: "#/components/schemas/AccessMethodType"
- description: Specifies the AccessMethod.
description: Describes the type and format of extension access. Only one of CustomObjectIdentifier or AccessMethodType may be provided. Providing both results in
InvalidArgsException.
GeneralName:
type: object
properties:
OtherName:
allOf:
- $ref: "#/components/schemas/OtherName"
- description: Represents GeneralName using an OtherName object.
Rfc822Name:
allOf:
- $ref: "#/components/schemas/String256"
- description: Represents GeneralName as an RFC 822 email address.
DnsName:
allOf:
- $ref: "#/components/schemas/String253"
- description: Represents GeneralName as a DNS name.
DirectoryName:
$ref: "#/components/schemas/ASN1Subject"
EdiPartyName:
allOf:
- $ref: "#/components/schemas/EdiPartyName"
- description: Represents GeneralName as an EdiPartyName object.
UniformResourceIdentifier:
allOf:
- $ref: "#/components/schemas/String253"
- description: Represents GeneralName as a URI.
IpAddress:
allOf:
- $ref: "#/components/schemas/String39"
- description: Represents GeneralName as an IPv4 or IPv6 address.
RegisteredId:
allOf:
- $ref: "#/components/schemas/CustomObjectIdentifier"
- description: " Represents GeneralName as an object identifier (OID)."
description: Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should
be provided. Providing more than one option results in an InvalidArgsException error.
AccessDescription:
type: object
required:
- AccessMethod
- AccessLocation
properties:
AccessMethod:
allOf:
- $ref: "#/components/schemas/AccessMethod"
- description: The type and format of AccessDescription information.
AccessLocation:
allOf:
- $ref: "#/components/schemas/GeneralName"
- description: The location of AccessDescription information.
description: Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280.
AccessDescriptionList:
type: array
items:
$ref: "#/components/schemas/AccessDescription"
CustomObjectIdentifier:
type: string
pattern: ^([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})$
minLength: 0
maxLength: 64
AccessMethodType:
type: string
enum:
- CA_REPOSITORY
- RESOURCE_PKI_MANIFEST
- RESOURCE_PKI_NOTIFY
AccountId:
type: string
pattern: "[0-9]+"
minLength: 12
maxLength: 12
ActionType:
type: string
enum:
- IssueCertificate
- GetCertificate
- ListPermissions
ActionList:
type: array
items:
$ref: "#/components/schemas/ActionType"
minItems: 1
maxItems: 3
Extensions:
type: object
properties:
CertificatePolicies:
allOf:
- $ref: "#/components/schemas/CertificatePolicyList"
- description: Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).
In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
ExtendedKeyUsage: allOf: - $ref: "#/components/schemas/ExtendedKeyUsageList" - description: Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in theKeyUsage extension.
KeyUsage:
$ref: "#/components/schemas/KeyUsage"
SubjectAlternativeNames:
allOf:
- $ref: "#/components/schemas/GeneralNameList"
- description: The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the
identity in the subject field of the certificate.
CustomExtensions:
allOf:
- $ref: "#/components/schemas/CustomExtensionList"
- description: Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.
description: Contains X.509 extension information for a certificate. ApiPassthrough: type: object properties: Extensions: allOf: - $ref: "#/components/schemas/Extensions" - description: Specifies X.509 extension information for a certificate. Subject: $ref: "#/components/schemas/ASN1Subject" description:Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected,
or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
Arn: type: string pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w+=,.@-]+)* minLength: 5 maxLength: 200 AuditReportId: type: string pattern: "[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" minLength: 36 maxLength: 36 AuditReportResponseFormat: type: string enum: - JSON - CSV AuditReportStatus: type: string enum: - CREATING - SUCCESS - FAILED Base64String1To4096: type: string pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ minLength: 1 maxLength: 4096 Boolean: type: boolean CertificateAuthority: type: object properties: Arn: allOf: - $ref: "#/components/schemas/Arn" - description: Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
OwnerAccount:
allOf:
- $ref: "#/components/schemas/AccountId"
- description: The Amazon Web Services account ID that owns the certificate authority.
CreatedAt:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Date and time at which your private CA was created.
LastStateChangeAt:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Date and time at which your private CA was last updated.
Type:
allOf:
- $ref: "#/components/schemas/CertificateAuthorityType"
- description: Type of your private CA.
Serial:
allOf:
- $ref: "#/components/schemas/String"
- description: Serial number of your private CA.
Status:
allOf:
- $ref: "#/components/schemas/CertificateAuthorityStatus"
- description: Status of your private CA.
NotBefore:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Date and time before which your private CA certificate is not valid.
NotAfter:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: Date and time after which your private CA certificate is not valid.
FailureReason:
allOf:
- $ref: "#/components/schemas/FailureReason"
- description: Reason the request to create your private CA failed.
CertificateAuthorityConfiguration:
allOf:
- $ref: "#/components/schemas/CertificateAuthorityConfiguration"
- description: Your private CA configuration.
RevocationConfiguration:
allOf:
- $ref: "#/components/schemas/RevocationConfiguration"
- description: "Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA. "
RestorableUntil:
allOf:
- $ref: "#/components/schemas/TStamp"
- description: 'The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest
action. '
KeyStorageSecurityStandard:
allOf:
- $ref: "#/components/schemas/KeyStorageSecurityStandard"
- description: 'Defines a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: Amazon Web Services Region ap-northeast-3
supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an
InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
description: 'Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM). ' CertificateAuthorities: type: array items: $ref: "#/components/schemas/CertificateAuthority" TStamp: type: string format: date-time CertificateAuthorityType: type: string enum: - ROOT - SUBORDINATE String: type: string CertificateAuthorityStatus: type: string enum: - CREATING - PENDING_CERTIFICATE - ACTIVE - DELETED - DISABLED - EXPIRED - FAILED FailureReason: type: string enum: - REQUEST_TIMED_OUT - UNSUPPORTED_ALGORITHM - OTHER CertificateAuthorityConfiguration: type: object required: - KeyAlgorithm - SigningAlgorithm - Subject properties: KeyAlgorithm: allOf: - $ref: "#/components/schemas/KeyAlgorithm" - description: Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA. SigningAlgorithm: allOf: - $ref: "#/components/schemas/SigningAlgorithm" - description:Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the SigningAlgorithm parameter used
to sign certificates when they are issued.
CertPolicyId with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.
description: Defines the X.509 CertificatePolicies extension.
CertificatePolicyList:
type: array
items:
$ref: "#/components/schemas/PolicyInformation"
minItems: 1
maxItems: 20
CnameString:
type: string
pattern: ^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$
minLength: 0
maxLength: 253
S3BucketName:
type: string
minLength: 3
maxLength: 63
S3Key:
type: string
maxLength: 1024
IdempotencyToken:
type: string
pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
minLength: 1
maxLength: 36
TagList:
type: array
items:
$ref: "#/components/schemas/Tag"
minItems: 1
maxItems: 50
Principal:
type: string
pattern: ^[^*]+$
minLength: 0
maxLength: 128
Integer1To5000:
type: integer
minimum: 1
maximum: 5000
S3BucketName3To255:
type: string
pattern: ^[-a-zA-Z0-9._/]+$
minLength: 3
maxLength: 255
S3ObjectAcl:
type: string
enum:
- PUBLIC_READ
- BUCKET_OWNER_FULL_CONTROL
CrlConfiguration:
type: object
required:
- Enabled
properties:
Enabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: 'Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority
action. '
ExpirationInDays:
allOf:
- $ref: "#/components/schemas/Integer1To5000"
- description: Validity period of the CRL in days.
CustomCname:
allOf:
- $ref: "#/components/schemas/CnameString"
- description: Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.
The S3BucketName parameter must conform to the S3 bucket naming
rules.
Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.
If no
value is specified, the default is PUBLIC_READ.
Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block
Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you
have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.
For more information, see Blocking public access to the S3 bucket.
description: "Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable
CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName
parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points
extension of each certificate it issues. Your S3 bucket policy must give write permission to Amazon Web Services Private CA.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.
A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
CRLs contain the following fields:
Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
Signature Algorithm: The name of the algorithm used to sign the CRL.
Issuer: The X.500 distinguished name of your private CA that issued the CRL.
Last Update: The issue date and time of this CRL.
Next Update: The day and time by which the next CRL will be issued.
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
Revocation Date: Date and time the certificate was revoked.
CRL Entry Extensions: Optional extensions for the CRL entry.
X509v3 CRL Reason Code: Reason the certificate was revoked.
CRL Extensions: Optional extensions for the CRL.
X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
X509v3 CRL Number:: Decimal sequence number for the CRL.
Signature Algorithm: Algorithm used by your private CA to sign the CRL.
Signature Value: Signature computed over the CRL.
Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout
For more information, see Planning a certificate revocation list (CRL) in the Amazon Web Services Private Certificate Authority User Guide
" CsrBlob: type: string minLength: 1 maxLength: 32768 CsrBody: type: string KeyUsage: type: object properties: DigitalSignature: allOf: - $ref: "#/components/schemas/Boolean" - description: " Key can be used for digital signing." NonRepudiation: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used for non-repudiation. KeyEncipherment: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used to encipher data. DataEncipherment: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used to decipher data. KeyAgreement: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used in a key-agreement protocol. KeyCertSign: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used to sign certificates. CRLSign: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used to sign CRLs. EncipherOnly: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used only to encipher data. DecipherOnly: allOf: - $ref: "#/components/schemas/Boolean" - description: Key can be used only to decipher data. description: Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false. String1To256: type: string minLength: 1 maxLength: 256 CustomAttribute: type: object required: - ObjectIdentifier - Value properties: ObjectIdentifier: allOf: - $ref: "#/components/schemas/CustomObjectIdentifier" - description: Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN). Value: allOf: - $ref: "#/components/schemas/String1To256" - description:Specifies the attribute value of relative distinguished name (RDN).
description: Defines the X.500 relative distinguished name (RDN). CustomExtension: type: object required: - ObjectIdentifier - Value properties: ObjectIdentifier: allOf: - $ref: "#/components/schemas/CustomObjectIdentifier" - description:Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database.
Value: allOf: - $ref: "#/components/schemas/Base64String1To4096" - description:Specifies the base64-encoded value of the X.509 extension.
Critical: allOf: - $ref: "#/components/schemas/Boolean" - description:Specifies the critical flag of the X.509 extension.
description:Specifies the X.509 extension information for a certificate.
Extensions present in CustomExtensions follow the ApiPassthrough template rules.
ExtendedKeyUsage as defined as in RFC 5280.
ExtendedKeyUsageObjectIdentifier:
allOf:
- $ref: "#/components/schemas/CustomObjectIdentifier"
- description: Specifies a custom ExtendedKeyUsage with an object identifier (OID).
description: Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
ExtendedKeyUsageList:
type: array
items:
$ref: "#/components/schemas/ExtendedKeyUsage"
minItems: 1
maxItems: 20
GeneralNameList:
type: array
items:
$ref: "#/components/schemas/GeneralName"
minItems: 1
maxItems: 20
OtherName:
type: object
required:
- TypeId
- Value
properties:
TypeId:
allOf:
- $ref: "#/components/schemas/CustomObjectIdentifier"
- description: "Specifies an OID. "
Value:
allOf:
- $ref: "#/components/schemas/String256"
- description: Specifies an OID value.
description: Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see
NIST's definition of Object Identifier (OID).
String253:
type: string
minLength: 0
maxLength: 253
String39:
type: string
minLength: 0
maxLength: 39
Validity:
type: object
required:
- Value
- Type
properties:
Value:
allOf:
- $ref: "#/components/schemas/PositiveLong"
- description: A long integer interpreted according to the value of Type, below.
Type:
allOf:
- $ref: "#/components/schemas/ValidityPeriodType"
- description: "Determines how Amazon Web Services Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions
with values include a sample input value and the resulting output.
END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS)
or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50,
the year is interpreted as 20YY.
Sample input value: 491231235959 (UTCTime format)
Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE:
The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.
Sample input value: 2524608000
Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the
certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
Sample input value: 90
Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity
for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.
Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
Amazon Web Services Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required
parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter
IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.
By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.
description:Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
Permission: type: object properties: CertificateAuthorityArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Number (ARN) of the private CA from which the permission was issued. CreatedAt: allOf: - $ref: "#/components/schemas/TStamp" - description: The time at which the permission was created. Principal: allOf: - $ref: "#/components/schemas/Principal" - description: The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal isacm.amazonaws.com.
SourceAccount:
allOf:
- $ref: "#/components/schemas/AccountId"
- description: The ID of the account that assigned the permission.
Actions:
allOf:
- $ref: "#/components/schemas/ActionList"
- description: The private CA actions that can be performed by the designated Amazon Web Services service.
Policy:
allOf:
- $ref: "#/components/schemas/AWSPolicy"
- description: The name of the policy that is associated with the permission.
description: Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must
give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.
PolicyQualifierInfoList:
type: array
items:
$ref: "#/components/schemas/PolicyQualifierInfo"
minItems: 1
maxItems: 20
PolicyQualifierId:
type: string
enum:
- CPS
Qualifier:
type: object
required:
- CpsUri
properties:
CpsUri:
allOf:
- $ref: "#/components/schemas/String256"
- description: Contains a pointer to a certification practice statement (CPS) published by the CA.
description: 'Defines a PolicyInformation qualifier. Amazon Web Services Private CA supports the certification
practice statement (CPS) qualifier defined in RFC 5280. '
PolicyQualifierInfo:
type: object
required:
- PolicyQualifierId
- Qualifier
properties:
PolicyQualifierId:
allOf:
- $ref: "#/components/schemas/PolicyQualifierId"
- description: Identifies the qualifier modifying a CertPolicyId.
Qualifier:
allOf:
- $ref: "#/components/schemas/Qualifier"
- description: Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field.
description: Modifies the CertPolicyId of a PolicyInformation object with a qualifier. Amazon Web Services Private CA supports the certification practice statement
(CPS) qualifier.
PositiveLong:
type: integer
minimum: 1
RevocationReason:
type: string
enum:
- UNSPECIFIED
- KEY_COMPROMISE
- CERTIFICATE_AUTHORITY_COMPROMISE
- AFFILIATION_CHANGED
- SUPERSEDED
- CESSATION_OF_OPERATION
- PRIVILEGE_WITHDRAWN
- A_A_COMPROMISE
TagKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
TagValue:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 0
maxLength: 256
Tag:
type: object
required:
- Key
properties:
Key:
allOf:
- $ref: "#/components/schemas/TagKey"
- description: Key (name) of the tag.
Value:
allOf:
- $ref: "#/components/schemas/TagValue"
- description: Value of the tag.
description: 'Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add
one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag,
call the UntagCertificateAuthority action. '
ValidityPeriodType:
type: string
enum:
- END_DATE
- ABSOLUTE
- DAYS
- MONTHS
- YEARS
security:
- hmac: []