Menu
AWS Certificate Manager
API Reference (API Version 2015-12-08)

CertificateDetail

Contains detailed metadata about an ACM Certificate. This structure is returned in the response to a DescribeCertificate request.

Contents

Note

In the following list, the required parameters are described first.

CertificateArn

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=/,.@-]+)*

Required: No

CreatedAt

The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.

Type: Timestamp

Required: No

DomainName

The fully qualified domain name for the certificate, such as www.example.com or example.com.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ^(\*\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$

Required: No

DomainValidationOptions

Contains information about the email address or addresses used for domain validation. This field exists only when the certificate type is AMAZON_ISSUED.

Type: array of DomainValidation objects

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Required: No

FailureReason

The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide.

Type: String

Valid Values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | OTHER

Required: No

ImportedAt

The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.

Type: Timestamp

Required: No

InUseBy

A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.

Type: array of Strings

Required: No

IssuedAt

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

Type: Timestamp

Required: No

Issuer

The name of the certificate authority that issued and signed the certificate.

Type: String

Required: No

KeyAlgorithm

The algorithm that was used to generate the key pair (the public and private key).

Type: String

Valid Values: RSA_2048 | RSA_1024 | EC_prime256v1

Required: No

NotAfter

The time after which the certificate is not valid.

Type: Timestamp

Required: No

NotBefore

The time before which the certificate is not valid.

Type: Timestamp

Required: No

RevocationReason

The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

Type: String

Valid Values: UNSPECIFIED | KEY_COMPROMISE | CA_COMPROMISE | AFFILIATION_CHANGED | SUPERCEDED | CESSATION_OF_OPERATION | CERTIFICATE_HOLD | REMOVE_FROM_CRL | PRIVILEGE_WITHDRAWN | A_A_COMPROMISE

Required: No

RevokedAt

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

Type: Timestamp

Required: No

Serial

The serial number of the certificate.

Type: String

Required: No

SignatureAlgorithm

The algorithm that was used to sign the certificate.

Type: String

Required: No

Status

The status of the certificate.

Type: String

Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Required: No

Subject

The name of the entity that is associated with the public key contained in the certificate.

Type: String

Required: No

SubjectAlternativeNames

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Type: array of Strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ^(\*\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$

Required: No

Type

The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.

Type: String

Valid Values: IMPORTED | AMAZON_ISSUED

Required: No