[ aws . acm-pca ]

describe-certificate-authority

Description

Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

• CREATING - ACM Private CA is creating your private certificate authority.

• PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

• ACTIVE - Your private CA is active.

• DISABLED - Your private CA has been disabled.

• EXPIRED - Your private CA certificate has expired.

• FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

• DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA’s restoration period is also included in this action’s output.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-certificate-authority
--certificate-authority-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--certificate-authority-arn (string)

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 `` .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a private certificate authority

The following describe-certificate-authority command lists information about the private CA identified by the ARN.

aws acm-pca describe-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012

Output

CertificateAuthority -> (structure)

A CertificateAuthority structure that contains information about your private CA.

Arn -> (string)

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is `` 12345678-1234-1234-1234-123456789012 `` .

OwnerAccount -> (string)

The Amazon Web Services account ID that owns the certificate authority.

CreatedAt -> (timestamp)

Date and time at which your private CA was created.

LastStateChangeAt -> (timestamp)

Date and time at which your private CA was last updated.

Type -> (string)

Type of your private CA.

Serial -> (string)

Serial number of your private CA.

Status -> (string)

Status of your private CA.

NotBefore -> (timestamp)

Date and time before which your private CA certificate is not valid.

NotAfter -> (timestamp)

Date and time after which your private CA certificate is not valid.

FailureReason -> (string)

Reason the request to create your private CA failed.

CertificateAuthorityConfiguration -> (structure)

Your private CA configuration.

KeyAlgorithm -> (string)

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 -> (string)

Name of the algorithm your private CA uses to sign certificate requests.

This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

Subject -> (structure)

Structure that contains X.500 distinguished name information for your private CA.

Country -> (string)

Two-digit code that specifies the country in which the certificate subject located.

Organization -> (string)

Legal name of the organization with which the certificate subject is affiliated.

OrganizationalUnit -> (string)

A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

DistinguishedNameQualifier -> (string)

Disambiguating information for the certificate subject.

State -> (string)

State in which the subject of the certificate is located.

CommonName -> (string)

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 -> (string)

The certificate serial number.

Locality -> (string)

The locality (such as a city or town) in which the certificate subject is located.

Title -> (string)

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

Surname -> (string)

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 -> (string)

First name.

Initials -> (string)

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 -> (string)

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 -> (string)

Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

CustomAttributes -> (list)

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) .

Note

Custom attributes cannot be used in combination with standard attributes.

(structure)

Defines the X.500 relative distinguished name (RDN).

ObjectIdentifier -> (string)

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

Value -> (string)

Specifies the attribute value of relative distinguished name (RDN).

CsrExtensions -> (structure)

Specifies information to be added to the extension section of the certificate signing request (CSR).

KeyUsage -> (structure)

Indicates the purpose of the certificate and of the key contained in the certificate.

DigitalSignature -> (boolean)

Key can be used for digital signing.

NonRepudiation -> (boolean)

Key can be used for non-repudiation.

KeyEncipherment -> (boolean)

Key can be used to encipher data.

DataEncipherment -> (boolean)

Key can be used to decipher data.

KeyAgreement -> (boolean)

Key can be used in a key-agreement protocol.

KeyCertSign -> (boolean)

Key can be used to sign certificates.

CRLSign -> (boolean)

Key can be used to sign CRLs.

EncipherOnly -> (boolean)

Key can be used only to encipher data.

DecipherOnly -> (boolean)

Key can be used only to decipher data.

SubjectInformationAccess -> (list)

For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.

(structure)

Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280 .

AccessMethod -> (structure)

The type and format of AccessDescription information.

CustomObjectIdentifier -> (string)

An object identifier (OID) specifying the AccessMethod . The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID) .

AccessMethodType -> (string)

Specifies the AccessMethod .

AccessLocation -> (structure)

The location of AccessDescription information.

OtherName -> (structure)

Represents GeneralName using an OtherName object.

TypeId -> (string)

Specifies an OID.

Value -> (string)

Specifies an OID value.

Rfc822Name -> (string)

Represents GeneralName as an RFC 822 email address.

DnsName -> (string)

Represents GeneralName as a DNS name.

DirectoryName -> (structure)

Contains information about the certificate subject. The 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.

Country -> (string)

Two-digit code that specifies the country in which the certificate subject located.

Organization -> (string)

Legal name of the organization with which the certificate subject is affiliated.

OrganizationalUnit -> (string)

A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

DistinguishedNameQualifier -> (string)

Disambiguating information for the certificate subject.

State -> (string)

State in which the subject of the certificate is located.

CommonName -> (string)

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 -> (string)

The certificate serial number.

Locality -> (string)

The locality (such as a city or town) in which the certificate subject is located.

Title -> (string)

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

Surname -> (string)

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 -> (string)

First name.

Initials -> (string)

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 -> (string)

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 -> (string)

Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

CustomAttributes -> (list)

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) .

Note

Custom attributes cannot be used in combination with standard attributes.

(structure)

Defines the X.500 relative distinguished name (RDN).

ObjectIdentifier -> (string)

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

Value -> (string)

Specifies the attribute value of relative distinguished name (RDN).

EdiPartyName -> (structure)

Represents GeneralName as an EdiPartyName object.

PartyName -> (string)

Specifies the party name.

NameAssigner -> (string)

Specifies the name assigner.

UniformResourceIdentifier -> (string)

Represents GeneralName as a URI.

IpAddress -> (string)

Represents GeneralName as an IPv4 or IPv6 address.

RegisteredId -> (string)

Represents GeneralName as an object identifier (OID).

RevocationConfiguration -> (structure)

Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

CrlConfiguration -> (structure)

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, ACM Private CA makes further attempts every 15 minutes.

Enabled -> (boolean)

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.

ExpirationInDays -> (integer)

Validity period of the CRL in days.

CustomCname -> (string)

Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don’t want the name of your S3 bucket to be public.

S3BucketName -> (string)

Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

S3ObjectAcl -> (string)

Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

If no value is specified, the default is PUBLIC_READ .

Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

For more information, see Blocking public access to the S3 bucket .

OcspConfiguration -> (structure)

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.

Enabled -> (boolean)

Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

OcspCustomCname -> (string)

By default, ACM 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.

Note: The value of the CNAME must not include a protocol prefix such as “http://” or “https://”.

For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Certificate Manager Private Certificate Authority (PCA) User Guide .

RestorableUntil -> (timestamp)

The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

KeyStorageSecurityStandard -> (string)

Defines a cryptographic key management compliance standard used for handling CA keys.

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message “A certificate authority cannot be created in this region with the specified security standard.”