CertificateDescription
Describes a certificate.
Contents
- caCertificateId
-
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
-
The ARN of the certificate.
Type: String
Required: No
- certificateId
-
The ID of the certificate.
Type: String
Length Constraints: Fixed length of 64.
Pattern:
(0x)?[a-fA-F0-9]+Required: No
- certificateMode
-
The mode of the certificate.
DEFAULT: A certificate inDEFAULTmode is either generated by AWS IoT Core or registered with an issuer certificate authority (CA) inDEFAULTmode. Devices with certificates inDEFAULTmode aren't required to send the Server Name Indication (SNI) extension when connecting to AWS IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to AWS IoT Core.SNI_ONLY: A certificate inSNI_ONLYmode is registered without an issuer CA. Devices with certificates inSNI_ONLYmode must send the SNI extension when connecting to AWS IoT Core.For more information about the value for SNI extension, see Transport security in AWS IoT.
Type: String
Valid Values:
DEFAULT | SNI_ONLYRequired: No
- certificatePem
-
The certificate data, in PEM format.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern:
[\s\S]*Required: No
- creationDate
-
The date and time the certificate was created.
Type: Timestamp
Required: No
- customerVersion
-
The customer version of the certificate.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- generationId
-
The generation ID of the certificate.
Type: String
Required: No
- lastModifiedDate
-
The date and time the certificate was last modified.
Type: Timestamp
Required: No
- ownedBy
-
The ID of the AWS account that owns the certificate.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]+Required: No
- previousOwnedBy
-
The ID of the AWS account of the previous owner of the certificate.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]+Required: No
- status
-
The status of the certificate.
Type: String
Valid Values:
ACTIVE | INACTIVE | REVOKED | PENDING_TRANSFER | REGISTER_INACTIVE | PENDING_ACTIVATIONRequired: No
- transferData
-
The transfer data.
Type: TransferData object
Required: No
- validity
-
When the certificate is valid.
Type: CertificateValidity object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
