/AWS1/CL_ACMCERTIFICATESUMMARY¶
This structure is returned in the response object of ListCertificates action.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_certificatearn TYPE /AWS1/ACMARN /AWS1/ACMARN¶
Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012For more information about ARNs, see Amazon Resource Names (ARNs).
iv_domainname TYPE /AWS1/ACMDOMAINNAMESTRING /AWS1/ACMDOMAINNAMESTRING¶
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
it_subjectalternativenames00 TYPE /AWS1/CL_ACMDOMAINLIST_W=>TT_DOMAINLIST TT_DOMAINLIST¶
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.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
iv_hasaddlsubjectalternati00 TYPE /AWS1/ACMNULLABLEBOOLEAN /AWS1/ACMNULLABLEBOOLEAN¶
When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
iv_status TYPE /AWS1/ACMCERTIFICATESTATUS /AWS1/ACMCERTIFICATESTATUS¶
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.
iv_type TYPE /AWS1/ACMCERTIFICATETYPE /AWS1/ACMCERTIFICATETYPE¶
The source of the certificate. For certificates provided by ACM, this value is
AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value isIMPORTED. 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.
iv_keyalgorithm TYPE /AWS1/ACMKEYALGORITHM /AWS1/ACMKEYALGORITHM¶
The algorithm that was used to generate the public-private key pair.
it_keyusages TYPE /AWS1/CL_ACMKEYUSAGENAMES_W=>TT_KEYUSAGENAMES TT_KEYUSAGENAMES¶
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.
it_extendedkeyusages TYPE /AWS1/CL_ACMEXTENDEDKEYUSAGE01=>TT_EXTENDEDKEYUSAGENAMES TT_EXTENDEDKEYUSAGENAMES¶
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).
iv_exportoption TYPE /AWS1/ACMCERTIFICATEEXPORT /AWS1/ACMCERTIFICATEEXPORT¶
Indicates if export is enabled for the certificate.
iv_inuse TYPE /AWS1/ACMNULLABLEBOOLEAN /AWS1/ACMNULLABLEBOOLEAN¶
Indicates whether the certificate is currently in use by any Amazon Web Services resources.
iv_exported TYPE /AWS1/ACMNULLABLEBOOLEAN /AWS1/ACMNULLABLEBOOLEAN¶
Indicates whether the certificate has been exported. This value exists only when the certificate type is
PRIVATE.
iv_renewaleligibility TYPE /AWS1/ACMRENEWALELIGIBILITY /AWS1/ACMRENEWALELIGIBILITY¶
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
iv_notbefore TYPE /AWS1/ACMTSTAMP /AWS1/ACMTSTAMP¶
The time before which the certificate is not valid.
iv_notafter TYPE /AWS1/ACMTSTAMP /AWS1/ACMTSTAMP¶
The time after which the certificate is not valid.
iv_createdat TYPE /AWS1/ACMTSTAMP /AWS1/ACMTSTAMP¶
The time at which the certificate was requested.
iv_issuedat TYPE /AWS1/ACMTSTAMP /AWS1/ACMTSTAMP¶
The time at which the certificate was issued. This value exists only when the certificate type is
AMAZON_ISSUED.
iv_importedat TYPE /AWS1/ACMTSTAMP /AWS1/ACMTSTAMP¶
The date and time when the certificate was imported. This value exists only when the certificate type is
IMPORTED.
iv_revokedat TYPE /AWS1/ACMTSTAMP /AWS1/ACMTSTAMP¶
The time at which the certificate was revoked. This value exists only when the certificate status is
REVOKED.
iv_managedby TYPE /AWS1/ACMCERTIFICATEMANAGEDBY /AWS1/ACMCERTIFICATEMANAGEDBY¶
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
Queryable Attributes¶
CertificateArn¶
Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012For more information about ARNs, see Amazon Resource Names (ARNs).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CERTIFICATEARN() |
Getter for CERTIFICATEARN, with configurable default |
ASK_CERTIFICATEARN() |
Getter for CERTIFICATEARN w/ exceptions if field has no valu |
HAS_CERTIFICATEARN() |
Determine if CERTIFICATEARN has a value |
DomainName¶
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOMAINNAME() |
Getter for DOMAINNAME, with configurable default |
ASK_DOMAINNAME() |
Getter for DOMAINNAME w/ exceptions if field has no value |
HAS_DOMAINNAME() |
Determine if DOMAINNAME has a value |
SubjectAlternativeNameSummaries¶
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.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBJECTALTERNATIVENAME00() |
Getter for SUBJECTALTERNATIVENAMESUMS, with configurable def |
ASK_SUBJECTALTERNATIVENAME00() |
Getter for SUBJECTALTERNATIVENAMESUMS w/ exceptions if field |
HAS_SUBJECTALTERNATIVENAME00() |
Determine if SUBJECTALTERNATIVENAMESUMS has a value |
HasAdditionalSubjectAlternativeNames¶
When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASADDLSUBJECTALTERNAT00() |
Getter for HASADDLSUBJECTALTERNATIVEN00, with configurable d |
ASK_HASADDLSUBJECTALTERNAT00() |
Getter for HASADDLSUBJECTALTERNATIVEN00 w/ exceptions if fie |
HAS_HASADDLSUBJECTALTERNAT00() |
Determine if HASADDLSUBJECTALTERNATIVEN00 has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
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 isIMPORTED. 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
KeyAlgorithm¶
The algorithm that was used to generate the public-private key pair.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYALGORITHM() |
Getter for KEYALGORITHM, with configurable default |
ASK_KEYALGORITHM() |
Getter for KEYALGORITHM w/ exceptions if field has no value |
HAS_KEYALGORITHM() |
Determine if KEYALGORITHM has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYUSAGES() |
Getter for KEYUSAGES, with configurable default |
ASK_KEYUSAGES() |
Getter for KEYUSAGES w/ exceptions if field has no value |
HAS_KEYUSAGES() |
Determine if KEYUSAGES has a value |
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXTENDEDKEYUSAGES() |
Getter for EXTENDEDKEYUSAGES, with configurable default |
ASK_EXTENDEDKEYUSAGES() |
Getter for EXTENDEDKEYUSAGES w/ exceptions if field has no v |
HAS_EXTENDEDKEYUSAGES() |
Determine if EXTENDEDKEYUSAGES has a value |
ExportOption¶
Indicates if export is enabled for the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPORTOPTION() |
Getter for EXPORTOPTION, with configurable default |
ASK_EXPORTOPTION() |
Getter for EXPORTOPTION w/ exceptions if field has no value |
HAS_EXPORTOPTION() |
Determine if EXPORTOPTION has a value |
InUse¶
Indicates whether the certificate is currently in use by any Amazon Web Services resources.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INUSE() |
Getter for INUSE, with configurable default |
ASK_INUSE() |
Getter for INUSE w/ exceptions if field has no value |
HAS_INUSE() |
Determine if INUSE has a value |
Exported¶
Indicates whether the certificate has been exported. This value exists only when the certificate type is
PRIVATE.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPORTED() |
Getter for EXPORTED, with configurable default |
ASK_EXPORTED() |
Getter for EXPORTED w/ exceptions if field has no value |
HAS_EXPORTED() |
Determine if EXPORTED has a value |
RenewalEligibility¶
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RENEWALELIGIBILITY() |
Getter for RENEWALELIGIBILITY, with configurable default |
ASK_RENEWALELIGIBILITY() |
Getter for RENEWALELIGIBILITY w/ exceptions if field has no |
HAS_RENEWALELIGIBILITY() |
Determine if RENEWALELIGIBILITY has a value |
NotBefore¶
The time before which the certificate is not valid.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTBEFORE() |
Getter for NOTBEFORE, with configurable default |
ASK_NOTBEFORE() |
Getter for NOTBEFORE w/ exceptions if field has no value |
HAS_NOTBEFORE() |
Determine if NOTBEFORE has a value |
NotAfter¶
The time after which the certificate is not valid.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTAFTER() |
Getter for NOTAFTER, with configurable default |
ASK_NOTAFTER() |
Getter for NOTAFTER w/ exceptions if field has no value |
HAS_NOTAFTER() |
Determine if NOTAFTER has a value |
CreatedAt¶
The time at which the certificate was requested.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
IssuedAt¶
The time at which the certificate was issued. This value exists only when the certificate type is
AMAZON_ISSUED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISSUEDAT() |
Getter for ISSUEDAT, with configurable default |
ASK_ISSUEDAT() |
Getter for ISSUEDAT w/ exceptions if field has no value |
HAS_ISSUEDAT() |
Determine if ISSUEDAT has a value |
ImportedAt¶
The date and time when the certificate was imported. This value exists only when the certificate type is
IMPORTED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMPORTEDAT() |
Getter for IMPORTEDAT, with configurable default |
ASK_IMPORTEDAT() |
Getter for IMPORTEDAT w/ exceptions if field has no value |
HAS_IMPORTEDAT() |
Determine if IMPORTEDAT has a value |
RevokedAt¶
The time at which the certificate was revoked. This value exists only when the certificate status is
REVOKED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REVOKEDAT() |
Getter for REVOKEDAT, with configurable default |
ASK_REVOKEDAT() |
Getter for REVOKEDAT w/ exceptions if field has no value |
HAS_REVOKEDAT() |
Determine if REVOKEDAT has a value |
ManagedBy¶
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MANAGEDBY() |
Getter for MANAGEDBY, with configurable default |
ASK_MANAGEDBY() |
Getter for MANAGEDBY w/ exceptions if field has no value |
HAS_MANAGEDBY() |
Determine if MANAGEDBY has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_CERTIFICATESUMMARYLIST¶
TYPES TT_CERTIFICATESUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ACMCERTIFICATESUMMARY WITH DEFAULT KEY
.