

# CertificateDescription
<a name="API_CertificateDescription"></a>

Describes a certificate.

## Contents
<a name="API_CertificateDescription_Contents"></a>

 ** caCertificateId **   <a name="iot-Type-CertificateDescription-caCertificateId"></a>
The certificate ID of the CA certificate used to sign this certificate.  
Type: String  
Length Constraints: Fixed length of 64.  
Pattern: `(0x)?[a-fA-F0-9]+`   
Required: No

 ** certificateArn **   <a name="iot-Type-CertificateDescription-certificateArn"></a>
The ARN of the certificate.  
Type: String  
Required: No

 ** certificateId **   <a name="iot-Type-CertificateDescription-certificateId"></a>
The ID of the certificate.  
Type: String  
Length Constraints: Fixed length of 64.  
Pattern: `(0x)?[a-fA-F0-9]+`   
Required: No

 ** certificateMode **   <a name="iot-Type-CertificateDescription-certificateMode"></a>
The mode of the certificate.  
 `DEFAULT`: A certificate in `DEFAULT` mode is either generated by Amazon 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 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 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 IoT Core.   
For more information about the value for SNI extension, see [Transport security in Amazon IoT](https://docs.amazonaws.cn/iot/latest/developerguide/transport-security.html).  
Type: String  
Valid Values: `DEFAULT | SNI_ONLY`   
Required: No

 ** certificatePem **   <a name="iot-Type-CertificateDescription-certificatePem"></a>
The certificate data, in PEM format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\s\S]*`   
Required: No

 ** creationDate **   <a name="iot-Type-CertificateDescription-creationDate"></a>
The date and time the certificate was created.  
Type: Timestamp  
Required: No

 ** customerVersion **   <a name="iot-Type-CertificateDescription-customerVersion"></a>
The customer version of the certificate.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** generationId **   <a name="iot-Type-CertificateDescription-generationId"></a>
The generation ID of the certificate.  
Type: String  
Required: No

 ** lastModifiedDate **   <a name="iot-Type-CertificateDescription-lastModifiedDate"></a>
The date and time the certificate was last modified.  
Type: Timestamp  
Required: No

 ** ownedBy **   <a name="iot-Type-CertificateDescription-ownedBy"></a>
The ID of the Amazon Web Services account that owns the certificate.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]+`   
Required: No

 ** previousOwnedBy **   <a name="iot-Type-CertificateDescription-previousOwnedBy"></a>
The ID of the Amazon Web Services account of the previous owner of the certificate.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]+`   
Required: No

 ** status **   <a name="iot-Type-CertificateDescription-status"></a>
The status of the certificate.  
Type: String  
Valid Values: `ACTIVE | INACTIVE | REVOKED | PENDING_TRANSFER | REGISTER_INACTIVE | PENDING_ACTIVATION`   
Required: No

 ** transferData **   <a name="iot-Type-CertificateDescription-transferData"></a>
The transfer data.  
Type: [TransferData](API_TransferData.md) object  
Required: No

 ** validity **   <a name="iot-Type-CertificateDescription-validity"></a>
When the certificate is valid.  
Type: [CertificateValidity](API_CertificateValidity.md) object  
Required: No

## See Also
<a name="API_CertificateDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\+\+](https://docs.amazonaws.cn/goto/SdkForCpp/iot-2015-05-28/CertificateDescription) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iot-2015-05-28/CertificateDescription) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iot-2015-05-28/CertificateDescription) 