/keys-and-certificate

The AWS IoT Wireless multi-region endpoint

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

POST

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Requires permission to access the CreateKeysAndCertificate action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/keys-and-certificate'

Response Example

200 - Example 1

{
    "certificateArn": "string",
    "certificateId": "string",
    "certificatePem": "string",
    "keyPair": {
        "PublicKey": "string",
        "PrivateKey": "string"
    }
}

Request

Query Params

setAsActive

string

optional

Specifies whether the certificate is active.

Responses

🟢200Success

application/json

Body

The output of the CreateKeysAndCertificate operation.

certificateArn

string

optional

The ARN of the certificate.

certificateId

string

optional

The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).

>= 64 characters<= 64 characters

Match pattern:

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

certificatePem

string

optional

The certificate data, in PEM format.

>= 1 characters<= 4096 characters

Match pattern:

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

keyPair

object

optional

The generated key pair.

PublicKey

string

optional

The public key.

>= 1 characters

PrivateKey

string <password>

optional

The private key.

>= 1 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

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

/job-templates/{jobTemplateId}

/mitigationactions/actions/{actionName}