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.DescribeCertificateAuthority 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.DescribeCertificateAuthority'
paths:
  /#X-Amz-Target=ACMPrivateCA.DescribeCertificateAuthority:
    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: DescribeCertificateAuthority
      description: '<p>Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate authority.</p> </li> <li> <p> <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p> </li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> <li> <p> <code>DELETED</code> - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA''s restoration period is also included in this action''s output.</p> </li> </ul>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeCertificateAuthorityResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: InvalidArnException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArnException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeCertificateAuthorityRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - ACMPrivateCA.DescribeCertificateAuthority
      summary: Amazon Private CA Describe Certificate Authority
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=ACMPrivateCA.DescribeCertificateAuthority'
components:
  schemas:
    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.
    CsrExtensions:
      type: object
      properties:
        KeyUsage:
          allOf:
          - $ref: '#/components/schemas/KeyUsage'
          - description: Indicates the purpose of the certificate and of the key contained in the certificate.
        SubjectInformationAccess:
          allOf:
          - $ref: '#/components/schemas/AccessDescriptionList'
          - description: For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2">Subject Information Access</a> in RFC 5280.
      description: Describes the certificate extensions to be added to the certificate signing request (CSR).
    String39:
      type: string
      minLength: 0
      maxLength: 39
    CustomAttributeList:
      type: array
      items:
        $ref: '#/components/schemas/CustomAttribute'
      minItems: 1
      maxItems: 30
    CertificateAuthorityStatus:
      type: string
      enum:
      - CREATING
      - PENDING_CERTIFICATE
      - ACTIVE
      - DELETED
      - DISABLED
      - EXPIRED
      - FAILED
    S3ObjectAcl:
      type: string
      enum:
      - PUBLIC_READ
      - BUCKET_OWNER_FULL_CONTROL
    AccessDescriptionList:
      type: array
      items:
        $ref: '#/components/schemas/AccessDescription'
    CertificateAuthorityType:
      type: string
      enum:
      - ROOT
      - SUBORDINATE
    CustomObjectIdentifier:
      type: string
      pattern: ^([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})$
      minLength: 0
      maxLength: 64
    CertificateAuthorityUsageMode:
      type: string
      enum:
      - GENERAL_PURPOSE
      - SHORT_LIVED_CERTIFICATE
    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>.
    String64:
      type: string
      minLength: 0
      maxLength: 64
    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.
    DescribeCertificateAuthorityRequest:
      type: object
      required:
      - CertificateAuthorityArn
      title: DescribeCertificateAuthorityRequest
      properties:
        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>'
    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: <p>Name of the algorithm your private CA uses to sign certificate requests.</p> <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter used to sign certificates when they are issued.</p>
        Subject:
          allOf:
          - $ref: '#/components/schemas/ASN1Subject'
          - description: Structure that contains X.500 distinguished name information for your private CA.
        CsrExtensions:
          allOf:
          - $ref: '#/components/schemas/CsrExtensions'
          - description: Specifies information to be added to the extension section of the certificate signing request (CSR).
      description: 'Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. '
    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).
    OcspConfiguration:
      type: object
      required:
      - Enabled
      properties:
        Enabled:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
        OcspCustomCname:
          allOf:
          - $ref: '#/components/schemas/CnameString'
          - description: <p>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.</p> <note> <p>The content of a Canonical Name (CNAME) record must conform to <a href="https://www.ietf.org/rfc/rfc2396.txt">RFC2396</a> 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://".</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/ocsp-customize.html">Customizing Online Certificate Status Protocol (OCSP) </a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i>.</p>
      description: <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.</p> <p>When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.</p>
    Integer1To5000:
      type: integer
      minimum: 1
      maximum: 5000
    KeyStorageSecurityStandard:
      type: string
      enum:
      - FIPS_140_2_LEVEL_2_OR_HIGHER
      - FIPS_140_2_LEVEL_3_OR_HIGHER
    TStamp:
      type: string
      format: date-time
    RevocationConfiguration:
      type: object
      properties:
        CrlConfiguration:
          allOf:
          - $ref: '#/components/schemas/CrlConfiguration'
          - description: Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. 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.
        OcspConfiguration:
          allOf:
          - $ref: '#/components/schemas/OcspConfiguration'
          - description: Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
      description: Certificate revocation information used by the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html">Setting up a certificate revocation method</a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i>.
    Arn:
      type: string
      pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w+=,.@-]+)*
      minLength: 5
      maxLength: 200
    CertificateAuthority:
      type: object
      properties:
        Arn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: Amazon Resource Name (ARN) for your private certificate authority (CA). The format is <code> <i>12345678-1234-1234-1234-123456789012</i> </code>.
        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 <code>PermanentDeletionTimeInDays</code> parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html">DeleteCertificateAuthorityRequest</a> action. '
        KeyStorageSecurityStandard:
          allOf:
          - $ref: '#/components/schemas/KeyStorageSecurityStandard'
          - description: '<p>Defines a cryptographic key management compliance standard used for handling CA keys. </p> <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p> <p>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 <code>InvalidArgsException</code> with the message "A certificate authority cannot be created in this region with the specified security standard."</p>'
        UsageMode:
          allOf:
          - $ref: '#/components/schemas/CertificateAuthorityUsageMode'
          - description: <p>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.</p> <p>The default value is GENERAL_PURPOSE.</p>
      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 <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action to create your private CA. You must then call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCertificate.html">GetCertificateAuthorityCertificate</a> 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 <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a> action to import the signed certificate into Certificate Manager (ACM). '
    CnameString:
      type: string
      pattern: ^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$
      minLength: 0
      maxLength: 253
    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 <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action or for an existing CA when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action. '
        ExpirationInDays:
          allOf:
          - $ref: '#/components/schemas/Integer1To5000'
          - description: Validity period of the CRL in days.
        CustomCname:
          allOf:
          - $ref: '#/components/schemas/CnameString'
          - description: <p>Name inserted into the certificate <b>CRL Distribution Points</b> 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.</p> <note> <p>The content of a Canonical Name (CNAME) record must conform to <a href="https://www.ietf.org/rfc/rfc2396.txt">RFC2396</a> 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://".</p> </note>
        S3BucketName:
          allOf:
          - $ref: '#/components/schemas/S3BucketName3To255'
          - description: <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> operation. You must specify a <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies">bucket policy</a> that allows Amazon Web Services Private CA to write the CRL to your bucket.</p> <note> <p>The <code>S3BucketName</code> parameter must conform to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">S3 bucket naming rules</a>.</p> </note>
        S3ObjectAcl:
          allOf:
          - $ref: '#/components/schemas/S3ObjectAcl'
          - description: <p>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. </p> <p>If no value is specified, the default is <code>PUBLIC_READ</code>.</p> <p> <i>Note:</i> 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 <code>BUCKET_OWNER_FULL_CONTROL</code>, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either <code>BUCKET_OWNER_FULL_CONTROL</code> or <code>PUBLIC_READ</code> as the value.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa">Blocking public access to the S3 bucket</a>.</p>
      description: '<p>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 <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to Amazon Web Services Private CA. </p> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your CRLs</a>.</p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> 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.</p> <p>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.</p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html">Planning a certificate revocation list (CRL)</a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i> </p>'
    String253:
      type: string
      minLength: 0
      maxLength: 253
    AccessMethodType:
      type: string
      enum:
      - CA_REPOSITORY
      - RESOURCE_PKI_MANIFEST
      - RESOURCE_PKI_NOTIFY
    String16:
      type: string
      minLength: 0
      maxLength: 16
    String3:
      type: string
      minLength: 0
      maxLength: 3
    AccessDescription:
      type: object
      required:
      - AccessMethod
      - AccessLocation
      properties:
        AccessMethod:
          allOf:
          - $ref: '#/components/schemas/AccessMethod'
          - description: The type and format of <code>AccessDescription</code> information.
        AccessLocation:
          allOf:
          - $ref: '#/components/schemas/GeneralName'
          - description: The location of <code>AccessDescription</code> information.
      description: Provides access information used by the <code>authorityInfoAccess</code> and <code>subjectInfoAccess</code> extensions described in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>.
    ASN1PrintableString64:
      type: string
      pattern: '[a-zA-Z0-9''()+-.?:/= ]*'
      minLength: 0
      maxLength: 64
    String40:
      type: string
      minLength: 0
      maxLength: 40
    String:
      type: string
    String128:
      type: string
      minLength: 0
      maxLength: 128
    InvalidArnException: {}
    S3BucketName3To255:
      type: string
      pattern: ^[-a-zA-Z0-9._/]+$
      minLength: 3
      maxLength: 255
    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.
    Boolean:
      type: boolean
    String5:
      type: string
      minLength: 0
      maxLength: 5
    KeyAlgorithm:
      type: string
      enum:
      - RSA_2048
      - RSA_4096
      - EC_prime256v1
      - EC_secp384r1
    AccountId:
      type: string
      pattern: '[0-9]+'
      minLength: 12
      maxLength: 12
    DescribeCertificateAuthorityResponse:
      type: object
      properties:
        CertificateAuthority:
          allOf:
          - $ref: '#/components/schemas/CertificateAuthority'
          - description: A <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html">CertificateAuthority</a> structure that contains information about your private CA.
    AccessMethod:
      type: object
      properties:
        CustomObjectIdentifier:
          allOf:
          - $ref: '#/components/schemas/CustomObjectIdentifier'
          - description: An object identifier (OID) specifying the <code>AccessMethod</code>. 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>.
        AccessMethodType:
          allOf:
          - $ref: '#/components/schemas/AccessMethodType'
          - description: Specifies the <code>AccessMethod</code>.
      description: Describes the type and format of extension access. Only one of <code>CustomObjectIdentifier</code> or <code>AccessMethodType</code> may be provided. Providing both results in <code>InvalidArgsException</code>.
    CountryCodeString:
      type: string
      pattern: '[A-Za-z]{2}'
      minLength: 2
      maxLength: 2
    String1To256:
      type: string
      minLength: 1
      maxLength: 256
    FailureReason:
      type: string
      enum:
      - REQUEST_TIMED_OUT
      - UNSUPPORTED_ALGORITHM
      - OTHER
    ResourceNotFoundException: {}
    SigningAlgorithm:
      type: string
      enum:
      - SHA256WITHECDSA
      - SHA384WITHECDSA
      - SHA512WITHECDSA
      - SHA256WITHRSA
      - SHA384WITHRSA
      - SHA512WITHRSA
    EdiPartyName:
      type: object
      required:
      - PartyName
      properties:
        PartyName:
          allOf:
          - $ref: '#/components/schemas/String256'
          - description: Specifies the party name.
        NameAssigner:
          allOf:
          - $ref: '#/components/schemas/String256'
          - description: Specifies the name assigner.
      description: Describes an Electronic Data Interchange (EDI) entity as described in as defined in <a href="https://datatracker.ietf.org/doc/html/rfc5280">Subject Alternative Name</a> in RFC 5280.
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/acm-pca/
x-hasEquivalentPaths: true