/certificates/{certificateId}

The AWS IoT Wireless multi-region endpoint

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

GET

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "certificateDescription": {
        "certificateArn": "string",
        "certificateId": "string",
        "caCertificateId": "string",
        "status": "ACTIVE",
        "certificatePem": "string",
        "ownedBy": "string",
        "previousOwnedBy": "string",
        "creationDate": "string",
        "lastModifiedDate": "string",
        "customerVersion": 0,
        "transferData": {
            "transferMessage": "string",
            "rejectReason": "string",
            "transferDate": "string",
            "acceptDate": "string",
            "rejectDate": "string"
        },
        "generationId": "string",
        "validity": {
            "notBefore": "string",
            "notAfter": "string"
        },
        "certificateMode": "DEFAULT"
    }
}

Request

Path Params

certificateId

string

required

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Responses

🟢200Success

application/json

Body

The output of the DescribeCertificate operation.

certificateDescription

object

optional

The description of the certificate.

certificateArn

string

optional

The ARN of the certificate.

certificateId

string

optional

The ID of the certificate.

>= 64 characters<= 64 characters

Match pattern:

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

caCertificateId

string

optional

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

>= 64 characters<= 64 characters

Match pattern:

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

status

enum<string>

optional

The status of the certificate.

Allowed values:

ACTIVEINACTIVEREVOKEDPENDING_TRANSFERREGISTER_INACTIVEPENDING_ACTIVATION

certificatePem

string

optional

The certificate data, in PEM format.

>= 1 characters<= 4096 characters

Match pattern:

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

ownedBy

string

optional

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

>= 12 characters<= 12 characters

Match pattern:

[0-9]+

previousOwnedBy

string

optional

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

>= 12 characters<= 12 characters

Match pattern:

[0-9]+

creationDate

string <date-time>

optional

The date and time the certificate was created.

lastModifiedDate

string <date-time>

optional

The date and time the certificate was last modified.

customerVersion

integer

optional

The customer version of the certificate.

>= 1

transferData

object

optional

The transfer data.

generationId

string

optional

The generation ID of the certificate.

validity

object

optional

When the certificate is valid.

certificateMode

enum<string>

optional

The mode of the certificate.

Allowed values:

DEFAULTSNI_ONLY

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

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

/certificates/{certificateId}

/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}