/cacertificate/{caCertificateId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/cacertificate/'

Response Example

200 - Example 1

{
    "certificateDescription": {
        "certificateArn": "string",
        "certificateId": "string",
        "status": "ACTIVE",
        "certificatePem": "string",
        "ownedBy": "string",
        "creationDate": "string",
        "autoRegistrationStatus": "ENABLE",
        "lastModifiedDate": "string",
        "customerVersion": 0,
        "generationId": "string",
        "validity": {
            "notBefore": "string",
            "notAfter": "string"
        }
    },
    "registrationConfig": {
        "templateBody": "string",
        "roleArn": "string"
    }
}

Request

Path Params

caCertificateId

string

required

The CA certificate identifier.

Responses

🟢200Success

application/json

Body

The output from the DescribeCACertificate operation.

certificateDescription

object

optional

The CA certificate description.

certificateArn

string

optional

The CA certificate ARN.

certificateId

string

optional

The CA certificate ID.

>= 64 characters<= 64 characters

Match pattern:

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

status

enum<string>

optional

The status of a CA certificate.

Allowed values:

ACTIVEINACTIVE

certificatePem

string

optional

The CA certificate data, in PEM format.

>= 1 characters<= 4096 characters

Match pattern:

[^-A-Za-z0-9\+/=]\|=[^=]\|=\{3,\}$\{1,4096\}

ownedBy

string

optional

The owner of the CA certificate.

>= 12 characters<= 12 characters

Match pattern:

[0-9]+

creationDate

string <date-time>

optional

The date the CA certificate was created.

autoRegistrationStatus

enum<string>

optional

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

Allowed values:

ENABLEDISABLE

lastModifiedDate

string <date-time>

optional

The date the CA certificate was last modified.

customerVersion

integer

optional

The customer version of the CA certificate.

>= 1

generationId

string

optional

The generation ID of the CA certificate.

validity

object

optional

When the CA certificate is valid.

registrationConfig

object

optional

Information about the registration configuration.

templateBody

string

optional

The template body.

roleArn

string

optional

The ARN of the role.

>= 20 characters<= 2048 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

Modified at 2022-09-10 23:12:15

/cacertificate/{caCertificateId}