openapi: 3.0.0
info:
version: 2017-08-22
x-release: v4
title: 'AWS Certificate Manager Private Certificate Authority #X Amz Target=ACMPrivateCA.CreateCertificateAuthority #X Amz Target=ACMPrivateCA.CreateCertificateAuthority #X Amz Target=ACMPrivateCA.IssueCertificate API'
description: <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: 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: <p>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 <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a> action and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.</p> </note>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/IssueCertificateResponse'
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidStateException'
'483':
description: InvalidArnException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArnException'
'484':
description: InvalidArgsException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArgsException'
'485':
description: MalformedCSRException
content:
application/json:
schema:
$ref: '#/components/schemas/MalformedCSRException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IssueCertificateRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- ACMPrivateCA.IssueCertificate
summary: Amazon Private CA Issue Certificate
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=ACMPrivateCA.IssueCertificate'
components:
schemas:
CsrBlob:
type: string
minLength: 1
maxLength: 32768
ASN1Subject:
type: object
properties:
Country:
allOf:
- $ref: '#/components/schemas/CountryCodeString'
- description: Two-digit code that specifies the country in which the certificate subject located.
Organization:
allOf:
- $ref: '#/components/schemas/String64'
- description: 'Legal name of the organization with which the certificate subject is affiliated. '
OrganizationalUnit:
allOf:
- $ref: '#/components/schemas/String64'
- description: A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
DistinguishedNameQualifier:
allOf:
- $ref: '#/components/schemas/ASN1PrintableString64'
- description: Disambiguating information for the certificate subject.
State:
allOf:
- $ref: '#/components/schemas/String128'
- description: State in which the subject of the certificate is located.
CommonName:
allOf:
- $ref: '#/components/schemas/String64'
- description: '<p>For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. </p> <p>Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.</p>'
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 <b>GivenName</b>, the first letter of the middle name if one exists, and the first letter of the <b>Surname</b>.
Pseudonym:
allOf:
- $ref: '#/components/schemas/String128'
- description: Typically a shortened version of a longer <b>GivenName</b>. 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: <p/> <p>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 <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier (OID)</a>.</p> <note> <p>Custom attributes cannot be used in combination with standard attributes.</p> </note>
description: Contains information about the certificate subject. The <code>Subject</code> 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 <code>Subject </code>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 <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier (OID)</a>.
PolicyQualifiers:
allOf:
- $ref: '#/components/schemas/PolicyQualifierInfoList'
- description: Modifies the given <code>CertPolicyId</code> with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.
description: Defines the X.509 <code>CertificatePolicies</code> 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: <p>Contains X.509 certificate information to be placed in an issued certificate. An <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must be selected, or else this parameter is ignored. </p> <p>If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations">order of operation rules</a> to determine what information is used.</p>
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.400 <code>GeneralName</code> using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier (OID)</a>.
PositiveLong:
type: integer
minimum: 1
GeneralName:
type: object
properties:
OtherName:
allOf:
- $ref: '#/components/schemas/OtherName'
- description: Represents <code>GeneralName</code> using an <code>OtherName</code> object.
Rfc822Name:
allOf:
- $ref: '#/components/schemas/String256'
- description: Represents <code>GeneralName</code> as an <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a> email address.
DnsName:
allOf:
- $ref: '#/components/schemas/String253'
- description: Represents <code>GeneralName</code> as a DNS name.
DirectoryName:
$ref: '#/components/schemas/ASN1Subject'
EdiPartyName:
allOf:
- $ref: '#/components/schemas/EdiPartyName'
- description: Represents <code>GeneralName</code> as an <code>EdiPartyName</code> object.
UniformResourceIdentifier:
allOf:
- $ref: '#/components/schemas/String253'
- description: Represents <code>GeneralName</code> as a URI.
IpAddress:
allOf:
- $ref: '#/components/schemas/String39'
- description: Represents <code>GeneralName</code> as an IPv4 or IPv6 address.
RegisteredId:
allOf:
- $ref: '#/components/schemas/CustomObjectIdentifier'
- description: ' Represents <code>GeneralName</code> as an object identifier (OID).'
description: Describes an ASN.1 X.400 <code>GeneralName</code> as defined in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>. Only one of the following naming options should be provided. Providing more than one option results in an <code>InvalidArgsException</code> 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: <p/> <p>Specifies the attribute value of relative distinguished name (RDN).</p>
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: <p>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 <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier (OID)</a>.</p> <p>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.</p>
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 the <code>KeyUsage</code> 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: <p/> <p>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 <a href="https://oidref.com/2.5.29">Global OID reference database.</a> </p>
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: <p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>
String16:
type: string
minLength: 0
maxLength: 16
ExtendedKeyUsage:
type: object
properties:
ExtendedKeyUsageType:
allOf:
- $ref: '#/components/schemas/ExtendedKeyUsageType'
- description: Specifies a standard <code>ExtendedKeyUsage</code> as defined as in <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12">RFC 5280</a>.
ExtendedKeyUsageObjectIdentifier:
allOf:
- $ref: '#/components/schemas/CustomObjectIdentifier'
- description: Specifies a custom <code>ExtendedKeyUsage</code> 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 <code>KeyUsage</code> extension.
Validity:
type: object
required:
- Value
- Type
properties:
Value:
allOf:
- $ref: '#/components/schemas/PositiveLong'
- description: A long integer interpreted according to the value of <code>Type</code>, below.
Type:
allOf:
- $ref: '#/components/schemas/ValidityPeriodType'
- description: '<p>Determines how <i>Amazon Web Services Private CA</i> interprets the <code>Value</code> parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output. </p> <p> <code>END_DATE</code>: 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.</p> <ul> <li> <p>Sample input value: 491231235959 (UTCTime format)</p> </li> <li> <p>Output expiration date/time: 12/31/2049 23:59:59</p> </li> </ul> <p> <code>ABSOLUTE</code>: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch. </p> <ul> <li> <p>Sample input value: 2524608000</p> </li> <li> <p>Output expiration date/time: 01/01/2050 00:00:00</p> </li> </ul> <p> <code>DAYS</code>, <code>MONTHS</code>, <code>YEARS</code>: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years. </p> <p>Example if <code>DAYS</code>, issued on 10/12/2020 at 12:34:54 UTC:</p> <ul> <li> <p>Sample input value: 90</p> </li> <li> <p>Output expiration date: 01/10/2020 12:34:54 UTC</p> </li> </ul> <p>The minimum validity duration for a certificate using relative time (<code>DAYS</code>) is one day. The minimum validity for a certificate using absolute time (<code>ABSOLUTE</code> or <code>END_DATE</code>) is one second.</p>'
description: <p>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 <a href="https://tools.ietf.org/html/rfc5280#section-4.1.2.5">Validity</a> in RFC 5280.</p> <p>Amazon Web Services Private CA API consumes the <code>Validity</code> data type differently in two distinct parameters of the <code>IssueCertificate</code> action. The required parameter <code>IssueCertificate</code>:<code>Validity</code> specifies the end of a certificate's validity period. The optional parameter <code>IssueCertificate</code>:<code>ValidityNotBefore</code> specifies a customized starting time for the validity period.</p>
String3:
type: string
minLength: 0
maxLength: 3
GeneralNameList:
type: array
items:
$ref: '#/components/schemas/GeneralName'
minItems: 1
maxItems: 20
ASN1PrintableString64:
type: string
pattern: '[a-zA-Z0-9''()+-.?:/= ]*'
minLength: 0
maxLength: 64
String40:
type: string
minLength: 0
maxLength: 40
PolicyQualifierInfo:
type: object
required:
- PolicyQualifierId
- Qualifier
properties:
PolicyQualifierId:
allOf:
- $ref: '#/components/schemas/PolicyQualifierId'
- description: Identifies the qualifier modifying a <code>CertPolicyId</code>.
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 <code>CertPolicyId</code> of a <code>PolicyInformation</code> 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: <p/> <p>Specifies the object identifier (OID) of the X.509 extension. For more information, see the <a href="https://oidref.com/2.5.29">Global OID reference database.</a> </p>
Value:
allOf:
- $ref: '#/components/schemas/Base64String1To4096'
- description: <p/> <p>Specifies the base64-encoded value of the X.509 extension.</p>
Critical:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: <p/> <p>Specifies the critical flag of the X.509 extension.</p>
description: <p/> <p>Specifies the X.509 extension information for a certificate.</p> <p>Extensions present in <code>CustomExtensions</code> follow the <code>ApiPassthrough</code> <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations">template rules</a>. </p>
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.
ExtendedKeyUsageType:
type: string
enum:
- SERVER_AUTH
- CLIENT_AUTH
- CODE_SIGNING
- EMAIL_PROTECTION
- TIME_STAMPING
- OCSP_SIGNING
- SMART_CARD_LOGIN
- DOCUMENT_SIGNING
- CERTIFICATE_TRANSPARENCY
String5:
type: string
minLength: 0
maxLength: 5
Boolean:
type: boolean
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 <code>PolicyInformation</code> qualifier. Amazon Web Services Private CA supports the <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4">certification practice statement (CPS) qualifier</a> defined in RFC 5280. '
InvalidArnException: {}
IssueCertificateRequest:
type: object
required:
- CertificateAuthorityArn
- Csr
- SigningAlgorithm
- Validity
title: IssueCertificateRequest
properties:
ApiPassthrough:
allOf:
- $ref: '#/components/schemas/ApiPassthrough'
- description: <p>Specifies X.509 certificate information to be included in the issued certificate. An <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must be selected, or else this parameter is ignored. For more information about using these templates, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html">Understanding Certificate Templates</a>.</p> <p>If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies <a href="https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations">order of operation rules</a> to determine what information is used.</p>
CertificateAuthorityArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>
Csr:
allOf:
- $ref: '#/components/schemas/CsrBlob'
- description: '<p>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. </p> <p> <code>openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>If you have a configuration file, you can then use the following OpenSSL command. The <code>usr_cert</code> block in the configuration file contains your X509 version 3 extensions. </p> <p> <code>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</code> </p> <p>Note: A CSR must provide either a <i>subject name</i> or a <i>subject alternative name</i> or the request will be rejected. </p>'
SigningAlgorithm:
allOf:
- $ref: '#/components/schemas/SigningAlgorithm'
- description: <p>The name of the algorithm that will be used to sign the certificate to be issued. </p> <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p> <note> <p>The specified signing algorithm family (RSA or ECDSA) much match the algorithm family of the CA's secret key.</p> </note>
TemplateArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: '<p>Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazo
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-private-ca/refs/heads/main/openapi/amazon-private-ca-x-amz-target-acmprivateca-issuecertificate-api-openapi.yml