Amazonka.CertificateManager.Types.CertificateDetail

Documentation

data CertificateDetail

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

See: newCertificateDetail smart constructor.

Constructors

CertificateDetail'

Fields

• certificateArn :: Maybe Text

  The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

• certificateAuthorityArn :: Maybe Text

  The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

  arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

• createdAt :: Maybe POSIX

  The time at which the certificate was requested.

• domainName :: Maybe Text

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

• domainValidationOptions :: Maybe (NonEmpty DomainValidation)

  Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

• extendedKeyUsages :: Maybe [ExtendedKeyUsage]

  Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

• failureReason :: Maybe 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 Certificate Manager User Guide.

• importedAt :: Maybe POSIX

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

• inUseBy :: Maybe [Text]

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

• issuedAt :: Maybe POSIX

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

• issuer :: Maybe Text

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

• keyAlgorithm :: Maybe KeyAlgorithm

  The algorithm that was used to generate the public-private key pair.

• keyUsages :: Maybe [KeyUsage]

  A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

• notAfter :: Maybe POSIX

  The time after which the certificate is not valid.

• notBefore :: Maybe POSIX

  The time before which the certificate is not valid.

• options :: Maybe CertificateOptions

  Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

• renewalEligibility :: Maybe RenewalEligibility

  Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

• renewalSummary :: Maybe RenewalSummary

  Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

• revocationReason :: Maybe RevocationReason

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

• revokedAt :: Maybe POSIX

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

• serial :: Maybe Text

  The serial number of the certificate.

• signatureAlgorithm :: Maybe Text

  The algorithm that was used to sign the certificate.

• status :: Maybe CertificateStatus

  The status of the certificate.

  A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

• subject :: Maybe Text

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

• subjectAlternativeNames :: Maybe (NonEmpty Text)

  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' :: Maybe CertificateType

  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 Certificate Manager User Guide.

Instances

FromJSON CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Methods

parseJSON :: Value -> Parser CertificateDetail

parseJSONList :: Value -> Parser [CertificateDetail]

Generic CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Associated Types

type Rep CertificateDetail :: Type -> Type

Methods

from :: CertificateDetail -> Rep CertificateDetail x

to :: Rep CertificateDetail x -> CertificateDetail

Read CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Methods

readsPrec :: Int -> ReadS CertificateDetail

readList :: ReadS [CertificateDetail]

readPrec :: ReadPrec CertificateDetail

readListPrec :: ReadPrec [CertificateDetail]

Show CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Methods

showsPrec :: Int -> CertificateDetail -> ShowS

show :: CertificateDetail -> String

showList :: [CertificateDetail] -> ShowS

NFData CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Methods

rnf :: CertificateDetail -> ()

Eq CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Methods

(==) :: CertificateDetail -> CertificateDetail -> Bool

(/=) :: CertificateDetail -> CertificateDetail -> Bool

Hashable CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

Methods

hashWithSalt :: Int -> CertificateDetail -> Int

hash :: CertificateDetail -> Int

type Rep CertificateDetail

Defined in Amazonka.CertificateManager.Types.CertificateDetail

type Rep CertificateDetail = D1 ('MetaData "CertificateDetail" "Amazonka.CertificateManager.Types.CertificateDetail" "amazonka-certificatemanager-2.0-CRaDh4gXGsJGb4mnkgvuBR" 'False) (C1 ('MetaCons "CertificateDetail'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domainValidationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DomainValidation))) :*: S1 ('MetaSel ('Just "extendedKeyUsages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExtendedKeyUsage]))))) :*: ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureReason)) :*: (S1 ('MetaSel ('Just "importedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "inUseBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "issuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "keyAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyAlgorithm)) :*: S1 ('MetaSel ('Just "keyUsages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyUsage])))))) :*: (((S1 ('MetaSel ('Just "notAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "notBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateOptions)))) :*: (S1 ('MetaSel ('Just "renewalEligibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RenewalEligibility)) :*: (S1 ('MetaSel ('Just "renewalSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RenewalSummary)) :*: S1 ('MetaSel ('Just "revocationReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RevocationReason))))) :*: ((S1 ('MetaSel ('Just "revokedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "serial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signatureAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateStatus)) :*: S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "subjectAlternativeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateType))))))))

newCertificateDetail :: CertificateDetail

Create a value of CertificateDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateArn:CertificateDetail', certificateDetail_certificateArn - The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

$sel:certificateAuthorityArn:CertificateDetail', certificateDetail_certificateAuthorityArn - The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

$sel:createdAt:CertificateDetail', certificateDetail_createdAt - The time at which the certificate was requested.

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

CertificateDetail, certificateDetail_domainValidationOptions - Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

$sel:extendedKeyUsages:CertificateDetail', certificateDetail_extendedKeyUsages - Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

$sel:failureReason:CertificateDetail', certificateDetail_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 Certificate Manager User Guide.

$sel:importedAt:CertificateDetail', certificateDetail_importedAt - The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

$sel:inUseBy:CertificateDetail', certificateDetail_inUseBy - A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

$sel:issuedAt:CertificateDetail', certificateDetail_issuedAt - The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

$sel:issuer:CertificateDetail', certificateDetail_issuer - The name of the certificate authority that issued and signed the certificate.

$sel:keyAlgorithm:CertificateDetail', certificateDetail_keyAlgorithm - The algorithm that was used to generate the public-private key pair.

$sel:keyUsages:CertificateDetail', certificateDetail_keyUsages - A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

$sel:notAfter:CertificateDetail', certificateDetail_notAfter - The time after which the certificate is not valid.

$sel:notBefore:CertificateDetail', certificateDetail_notBefore - The time before which the certificate is not valid.

$sel:options:CertificateDetail', certificateDetail_options - Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

$sel:renewalEligibility:CertificateDetail', certificateDetail_renewalEligibility - Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

$sel:renewalSummary:CertificateDetail', certificateDetail_renewalSummary - Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

$sel:revocationReason:CertificateDetail', certificateDetail_revocationReason - The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

$sel:revokedAt:CertificateDetail', certificateDetail_revokedAt - The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

$sel:serial:CertificateDetail', certificateDetail_serial - The serial number of the certificate.

$sel:signatureAlgorithm:CertificateDetail', certificateDetail_signatureAlgorithm - The algorithm that was used to sign the certificate.

$sel:status:CertificateDetail', certificateDetail_status - The status of the certificate.

A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

$sel:subject:CertificateDetail', certificateDetail_subject - The name of the entity that is associated with the public key contained in the certificate.

$sel:subjectAlternativeNames:CertificateDetail', certificateDetail_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.

$sel:type':CertificateDetail', certificateDetail_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 Certificate Manager User Guide.

certificateDetail_certificateArn :: Lens' CertificateDetail (Maybe Text)

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

certificateDetail_certificateAuthorityArn :: Lens' CertificateDetail (Maybe Text)

The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

certificateDetail_createdAt :: Lens' CertificateDetail (Maybe UTCTime)

The time at which the certificate was requested.

certificateDetail_domainName :: Lens' CertificateDetail (Maybe Text)

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

certificateDetail_domainValidationOptions :: Lens' CertificateDetail (Maybe (NonEmpty DomainValidation))

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

certificateDetail_extendedKeyUsages :: Lens' CertificateDetail (Maybe [ExtendedKeyUsage])

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

certificateDetail_failureReason :: Lens' CertificateDetail (Maybe 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 Certificate Manager User Guide.

certificateDetail_importedAt :: Lens' CertificateDetail (Maybe UTCTime)

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

certificateDetail_inUseBy :: Lens' CertificateDetail (Maybe [Text])

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

certificateDetail_issuedAt :: Lens' CertificateDetail (Maybe UTCTime)

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

certificateDetail_issuer :: Lens' CertificateDetail (Maybe Text)

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

certificateDetail_keyAlgorithm :: Lens' CertificateDetail (Maybe KeyAlgorithm)

The algorithm that was used to generate the public-private key pair.

certificateDetail_keyUsages :: Lens' CertificateDetail (Maybe [KeyUsage])

A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

certificateDetail_notAfter :: Lens' CertificateDetail (Maybe UTCTime)

The time after which the certificate is not valid.

certificateDetail_notBefore :: Lens' CertificateDetail (Maybe UTCTime)

The time before which the certificate is not valid.

certificateDetail_options :: Lens' CertificateDetail (Maybe CertificateOptions)

Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

certificateDetail_renewalEligibility :: Lens' CertificateDetail (Maybe RenewalEligibility)

Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

certificateDetail_renewalSummary :: Lens' CertificateDetail (Maybe RenewalSummary)

Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

certificateDetail_revocationReason :: Lens' CertificateDetail (Maybe RevocationReason)

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

certificateDetail_revokedAt :: Lens' CertificateDetail (Maybe UTCTime)

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

certificateDetail_serial :: Lens' CertificateDetail (Maybe Text)

The serial number of the certificate.

certificateDetail_signatureAlgorithm :: Lens' CertificateDetail (Maybe Text)

The algorithm that was used to sign the certificate.

certificateDetail_status :: Lens' CertificateDetail (Maybe CertificateStatus)

The status of the certificate.

A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

certificateDetail_subject :: Lens' CertificateDetail (Maybe Text)

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

certificateDetail_subjectAlternativeNames :: Lens' CertificateDetail (Maybe (NonEmpty Text))

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.

certificateDetail_type :: Lens' CertificateDetail (Maybe CertificateType)

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 Certificate Manager User Guide.