/AWS1/CL_TRNDESCRIBEDCERT¶
Describes the properties of a certificate.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/TRNARN /AWS1/TRNARN¶
The unique Amazon Resource Name (ARN) for the certificate.
Optional arguments:¶
iv_certificateid TYPE /AWS1/TRNCERTIFICATEID /AWS1/TRNCERTIFICATEID¶
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
iv_usage TYPE /AWS1/TRNCERTIFICATEUSAGETYPE /AWS1/TRNCERTIFICATEUSAGETYPE¶
Specifies how this certificate is used. It can be used in the following ways:
SIGNING: For signing AS2 messages
ENCRYPTION: For encrypting AS2 messages
TLS: For securing AS2 communications sent over HTTPS
iv_status TYPE /AWS1/TRNCERTIFICATESTATUSTYPE /AWS1/TRNCERTIFICATESTATUSTYPE¶
A certificate's status can be either
ACTIVEorINACTIVE.You can set
ActiveDateandInactiveDatein theUpdateCertificatecall. If you set values for these parameters, those values are used to determine whether the certificate has a status ofACTIVEorINACTIVE.If you don't set values for
ActiveDateandInactiveDate, we use theNotBeforeandNotAfterdate as specified on the X509 certificate to determine when a certificate is active and when it is inactive.
iv_certificate TYPE /AWS1/TRNCERTIFICATEBODYTYPE /AWS1/TRNCERTIFICATEBODYTYPE¶
The file name for the certificate.
iv_certificatechain TYPE /AWS1/TRNCERTIFICATECHAINTYPE /AWS1/TRNCERTIFICATECHAINTYPE¶
The list of certificates that make up the chain for the certificate.
iv_activedate TYPE /AWS1/TRNCERTDATE /AWS1/TRNCERTDATE¶
An optional date that specifies when the certificate becomes active. If you do not specify a value,
ActiveDatetakes the same value asNotBeforeDate, which is specified by the CA.
iv_inactivedate TYPE /AWS1/TRNCERTDATE /AWS1/TRNCERTDATE¶
An optional date that specifies when the certificate becomes inactive. If you do not specify a value,
InactiveDatetakes the same value asNotAfterDate, which is specified by the CA.
iv_serial TYPE /AWS1/TRNCERTSERIAL /AWS1/TRNCERTSERIAL¶
The serial number for the certificate.
iv_notbeforedate TYPE /AWS1/TRNCERTDATE /AWS1/TRNCERTDATE¶
The earliest date that the certificate is valid.
iv_notafterdate TYPE /AWS1/TRNCERTDATE /AWS1/TRNCERTDATE¶
The final date that the certificate is valid.
iv_type TYPE /AWS1/TRNCERTIFICATETYPE /AWS1/TRNCERTIFICATETYPE¶
If a private key has been specified for the certificate, its type is
CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type isCERTIFICATE.
iv_description TYPE /AWS1/TRNDESCRIPTION /AWS1/TRNDESCRIPTION¶
The name or description that's used to identity the certificate.
it_tags TYPE /AWS1/CL_TRNTAG=>TT_TAGS TT_TAGS¶
Key-value pairs that can be used to group and search for certificates.
Queryable Attributes¶
Arn¶
The unique Amazon Resource Name (ARN) for the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
CertificateId¶
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CERTIFICATEID() |
Getter for CERTIFICATEID, with configurable default |
ASK_CERTIFICATEID() |
Getter for CERTIFICATEID w/ exceptions if field has no value |
HAS_CERTIFICATEID() |
Determine if CERTIFICATEID has a value |
Usage¶
Specifies how this certificate is used. It can be used in the following ways:
SIGNING: For signing AS2 messages
ENCRYPTION: For encrypting AS2 messages
TLS: For securing AS2 communications sent over HTTPS
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USAGE() |
Getter for USAGE, with configurable default |
ASK_USAGE() |
Getter for USAGE w/ exceptions if field has no value |
HAS_USAGE() |
Determine if USAGE has a value |
Status¶
A certificate's status can be either
ACTIVEorINACTIVE.You can set
ActiveDateandInactiveDatein theUpdateCertificatecall. If you set values for these parameters, those values are used to determine whether the certificate has a status ofACTIVEorINACTIVE.If you don't set values for
ActiveDateandInactiveDate, we use theNotBeforeandNotAfterdate as specified on the X509 certificate to determine when a certificate is active and when it is inactive.
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 |
Certificate¶
The file name for the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CERTIFICATE() |
Getter for CERTIFICATE, with configurable default |
ASK_CERTIFICATE() |
Getter for CERTIFICATE w/ exceptions if field has no value |
HAS_CERTIFICATE() |
Determine if CERTIFICATE has a value |
CertificateChain¶
The list of certificates that make up the chain for the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CERTIFICATECHAIN() |
Getter for CERTIFICATECHAIN, with configurable default |
ASK_CERTIFICATECHAIN() |
Getter for CERTIFICATECHAIN w/ exceptions if field has no va |
HAS_CERTIFICATECHAIN() |
Determine if CERTIFICATECHAIN has a value |
ActiveDate¶
An optional date that specifies when the certificate becomes active. If you do not specify a value,
ActiveDatetakes the same value asNotBeforeDate, which is specified by the CA.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTIVEDATE() |
Getter for ACTIVEDATE, with configurable default |
ASK_ACTIVEDATE() |
Getter for ACTIVEDATE w/ exceptions if field has no value |
HAS_ACTIVEDATE() |
Determine if ACTIVEDATE has a value |
InactiveDate¶
An optional date that specifies when the certificate becomes inactive. If you do not specify a value,
InactiveDatetakes the same value asNotAfterDate, which is specified by the CA.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INACTIVEDATE() |
Getter for INACTIVEDATE, with configurable default |
ASK_INACTIVEDATE() |
Getter for INACTIVEDATE w/ exceptions if field has no value |
HAS_INACTIVEDATE() |
Determine if INACTIVEDATE has a value |
Serial¶
The serial number for the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERIAL() |
Getter for SERIAL, with configurable default |
ASK_SERIAL() |
Getter for SERIAL w/ exceptions if field has no value |
HAS_SERIAL() |
Determine if SERIAL has a value |
NotBeforeDate¶
The earliest date that the certificate is valid.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTBEFOREDATE() |
Getter for NOTBEFOREDATE, with configurable default |
ASK_NOTBEFOREDATE() |
Getter for NOTBEFOREDATE w/ exceptions if field has no value |
HAS_NOTBEFOREDATE() |
Determine if NOTBEFOREDATE has a value |
NotAfterDate¶
The final date that the certificate is valid.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTAFTERDATE() |
Getter for NOTAFTERDATE, with configurable default |
ASK_NOTAFTERDATE() |
Getter for NOTAFTERDATE w/ exceptions if field has no value |
HAS_NOTAFTERDATE() |
Determine if NOTAFTERDATE has a value |
Type¶
If a private key has been specified for the certificate, its type is
CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type isCERTIFICATE.
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 |
Description¶
The name or description that's used to identity the certificate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Tags¶
Key-value pairs that can be used to group and search for certificates.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |