/AWS1/CL_IOTCERTIFICATEDESC

Describes a certificate.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_certificatearn TYPE /AWS1/IOTCERTIFICATEARN /AWS1/IOTCERTIFICATEARN

The ARN of the certificate.

iv_certificateid TYPE /AWS1/IOTCERTIFICATEID /AWS1/IOTCERTIFICATEID

The ID of the certificate.

iv_cacertificateid TYPE /AWS1/IOTCERTIFICATEID /AWS1/IOTCERTIFICATEID

The certificate ID of the CA certificate used to sign this certificate.

iv_status TYPE /AWS1/IOTCERTIFICATESTATUS /AWS1/IOTCERTIFICATESTATUS

The status of the certificate.

iv_certificatepem TYPE /AWS1/IOTCERTIFICATEPEM /AWS1/IOTCERTIFICATEPEM

The certificate data, in PEM format.

iv_ownedby TYPE /AWS1/IOTAWSACCOUNTID /AWS1/IOTAWSACCOUNTID

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

iv_previousownedby TYPE /AWS1/IOTAWSACCOUNTID /AWS1/IOTAWSACCOUNTID

The ID of the Amazon Web Services account of the previous owner of the certificate.

iv_creationdate TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE

The date and time the certificate was created.

iv_lastmodifieddate TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE

The date and time the certificate was last modified.

iv_customerversion TYPE /AWS1/IOTCUSTOMERVERSION /AWS1/IOTCUSTOMERVERSION

The customer version of the certificate.

io_transferdata TYPE REF TO /AWS1/CL_IOTTRANSFERDATA /AWS1/CL_IOTTRANSFERDATA

The transfer data.

iv_generationid TYPE /AWS1/IOTGENERATIONID /AWS1/IOTGENERATIONID

The generation ID of the certificate.

io_validity TYPE REF TO /AWS1/CL_IOTCERTVALIDITY /AWS1/CL_IOTCERTVALIDITY

When the certificate is valid.

iv_certificatemode TYPE /AWS1/IOTCERTIFICATEMODE /AWS1/IOTCERTIFICATEMODE

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

---

Queryable Attributes

certificateArn

The ARN of the certificate.

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

certificateId

The ID of the certificate.

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

caCertificateId

The certificate ID of the CA certificate used to sign this certificate.

Accessible with the following methods

Method	Description
GET_CACERTIFICATEID()	Getter for CACERTIFICATEID, with configurable default
ASK_CACERTIFICATEID()	Getter for CACERTIFICATEID w/ exceptions if field has no val
HAS_CACERTIFICATEID()	Determine if CACERTIFICATEID has a value

status

The status of the certificate.

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

certificatePem

The certificate data, in PEM format.

Accessible with the following methods

Method	Description
GET_CERTIFICATEPEM()	Getter for CERTIFICATEPEM, with configurable default
ASK_CERTIFICATEPEM()	Getter for CERTIFICATEPEM w/ exceptions if field has no valu
HAS_CERTIFICATEPEM()	Determine if CERTIFICATEPEM has a value

ownedBy

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

Accessible with the following methods

Method	Description
GET_OWNEDBY()	Getter for OWNEDBY, with configurable default
ASK_OWNEDBY()	Getter for OWNEDBY w/ exceptions if field has no value
HAS_OWNEDBY()	Determine if OWNEDBY has a value

previousOwnedBy

The ID of the Amazon Web Services account of the previous owner of the certificate.

Accessible with the following methods

Method	Description
GET_PREVIOUSOWNEDBY()	Getter for PREVIOUSOWNEDBY, with configurable default
ASK_PREVIOUSOWNEDBY()	Getter for PREVIOUSOWNEDBY w/ exceptions if field has no val
HAS_PREVIOUSOWNEDBY()	Determine if PREVIOUSOWNEDBY has a value

creationDate

The date and time the certificate was created.

Accessible with the following methods

Method	Description
GET_CREATIONDATE()	Getter for CREATIONDATE, with configurable default
ASK_CREATIONDATE()	Getter for CREATIONDATE w/ exceptions if field has no value
HAS_CREATIONDATE()	Determine if CREATIONDATE has a value

lastModifiedDate

The date and time the certificate was last modified.

Accessible with the following methods

Method	Description
GET_LASTMODIFIEDDATE()	Getter for LASTMODIFIEDDATE, with configurable default
ASK_LASTMODIFIEDDATE()	Getter for LASTMODIFIEDDATE w/ exceptions if field has no va
HAS_LASTMODIFIEDDATE()	Determine if LASTMODIFIEDDATE has a value

customerVersion

The customer version of the certificate.

Accessible with the following methods

Method	Description
GET_CUSTOMERVERSION()	Getter for CUSTOMERVERSION, with configurable default
ASK_CUSTOMERVERSION()	Getter for CUSTOMERVERSION w/ exceptions if field has no val
HAS_CUSTOMERVERSION()	Determine if CUSTOMERVERSION has a value

transferData

The transfer data.

Accessible with the following methods

Method	Description
GET_TRANSFERDATA()	Getter for TRANSFERDATA

generationId

The generation ID of the certificate.

Accessible with the following methods

Method	Description
GET_GENERATIONID()	Getter for GENERATIONID, with configurable default
ASK_GENERATIONID()	Getter for GENERATIONID w/ exceptions if field has no value
HAS_GENERATIONID()	Determine if GENERATIONID has a value

validity

When the certificate is valid.

Accessible with the following methods

Method	Description
GET_VALIDITY()	Getter for VALIDITY

certificateMode

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

Accessible with the following methods

Method	Description
GET_CERTIFICATEMODE()	Getter for CERTIFICATEMODE, with configurable default
ASK_CERTIFICATEMODE()	Getter for CERTIFICATEMODE w/ exceptions if field has no val
HAS_CERTIFICATEMODE()	Determine if CERTIFICATEMODE has a value