Menu
AWS IoT
Developer Guide

DescribeCACertificate

Describes a registered CA certificate.

Request syntax:

GET /cacertificate/caCertificateId

URI Request Parameters:

Name

Type

Req?

Description

certificateId

CertificateId

yes

The CA certificate identifier.

Response syntax:

Content-type: application/json { "certificateDescription": { "certificateArn": "string", "certificateId": "string", "status": "string", "certificatePem": "string", "ownedBy": "string", "creationDate": "timestamp", "autoRegistrationStatus": "string" }, "registrationConfig": { "templateBody": "string", "roleArn": "string" } }

Response Body Parameters:

Name

Type

Req?

Description

certificateDescription

CACertificateDescription

no

The CA certificate description.

registrationConfig

RegistrationConfig

no

Information about the registration configuration.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

CLI

Synopsis:

aws iot describe-ca-certificate \ --certificate-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "certificateId": "string" }

cli-input-json fields:

Name

Type

Description

certificateId

string

length max:64 min:64

pattern: (0x)?[a-fA-F0-9]+

The CA certificate identifier.

Output:

{ "certificateDescription": { "certificateArn": "string", "certificateId": "string", "status": "string", "certificatePem": "string", "ownedBy": "string", "creationDate": "timestamp", "autoRegistrationStatus": "string" }, "registrationConfig": { "templateBody": "string", "roleArn": "string" } }

cli output fields:

Name

Type

Description

certificateDescription

CACertificateDescription

The CA certificate description.

certificateArn

string

The CA certificate ARN.

certificateId

string

length max:64 min:64

pattern: (0x)?[a-fA-F0-9]+

The CA certificate ID.

status

string

enum: ACTIVE | INACTIVE

java class: iot.identity.service.CACertificateStatus

The status of a CA certificate.

certificatePem

string

length max:65536 min:1

The CA certificate data, in PEM format.

ownedBy

string

pattern: [0-9]{12}

The owner of the CA certificate.

creationDate

timestamp

The date the CA certificate was created.

autoRegistrationStatus

string

enum: ENABLE | DISABLE

java class: iot.identity.service.AutoRegistrationStatus

Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"

registrationConfig

RegistrationConfig

Information about the registration configuration.

templateBody

string

The template body.

roleArn

string

length max:2048 min:20

The ARN of the role.

On this page: