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 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) security: - hmac: [] tags: - name: '#X Amz Target=ACMPrivateCA.IssueCertificate' paths: /#X-Amz-Target=ACMPrivateCA.IssueCertificate: 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' post: operationId: IssueCertificate description: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.
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.
String39:
type: string
minLength: 0
maxLength: 39
PolicyInformation:
type: object
required:
- CertPolicyId
properties:
CertPolicyId:
allOf:
- $ref: '#/components/schemas/CustomObjectIdentifier'
- description: Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).
PolicyQualifiers:
allOf:
- $ref: '#/components/schemas/PolicyQualifierInfoList'
- description: Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.
description: Defines the X.509 CertificatePolicies extension.
CustomAttributeList:
type: array
items:
$ref: '#/components/schemas/CustomAttribute'
minItems: 1
maxItems: 30
CustomObjectIdentifier:
type: string
pattern: ^([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})$
minLength: 0
maxLength: 64
InvalidArgsException: {}
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.
String64: type: string minLength: 0 maxLength: 64 String256: type: string minLength: 0 maxLength: 256 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.400GeneralName 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).
PositiveLong:
type: integer
minimum: 1
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.
InvalidStateException: {}
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). IdempotencyToken: type: string pattern: '[\u0009\u000A\u000D\u0020-\u00FF]*' minLength: 1 maxLength: 36 PolicyQualifierId: type: string enum: - CPS LimitExceededException: {} 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. Arn: type: string pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w+=,.@-]+)* minLength: 5 maxLength: 200 Base64String1To4096: type: string pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ minLength: 1 maxLength: 4096 CertificatePolicyList: type: array items: $ref: '#/components/schemas/PolicyInformation' minItems: 1 maxItems: 20 MalformedCSRException: {} String253: type: string minLength: 0 maxLength: 253 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
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.
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.
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.
CustomExtensionList:
type: array
items:
$ref: '#/components/schemas/CustomExtension'
minItems: 1
maxItems: 20
ValidityPeriodType:
type: string
enum:
- END_DATE
- ABSOLUTE
- DAYS
- MONTHS
- YEARS
PolicyQualifierInfoList:
type: array
items:
$ref: '#/components/schemas/PolicyQualifierInfo'
minItems: 1
maxItems: 20
String128:
type: string
minLength: 0
maxLength: 128
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.
PolicyInformation qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280. '
InvalidArnException: {}
IssueCertificateRequest:
type: object
required:
- CertificateAuthorityArn
- Csr
- SigningAlgorithm
- Validity
title: IssueCertificateRequest
properties:
ApiPassthrough:
allOf:
- $ref: '#/components/schemas/ApiPassthrough'
- description: 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.