CreateCertificateFromCsrCommand

Suggest an Edit

Creates an X.509 certificate using the specified certificate signing request.

Requires permission to access the CreateCertificateFromCsr  action.

The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT .

Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.

You can also run the aws iot create-certificate-from-csr part of the command in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://path"

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTClient, CreateCertificateFromCsrCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, CreateCertificateFromCsrCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // CreateCertificateFromCsrRequest
  certificateSigningRequest: "STRING_VALUE", // required
  setAsActive: true || false,
};
const command = new CreateCertificateFromCsrCommand(input);
const response = await client.send(command);
// { // CreateCertificateFromCsrResponse
//   certificateArn: "STRING_VALUE",
//   certificateId: "STRING_VALUE",
//   certificatePem: "STRING_VALUE",
// };

CreateCertificateFromCsrCommand Input

See CreateCertificateFromCsrCommandInput for more details

Parameter
Type
Description
certificateSigningRequest
Required
string | undefined

The certificate signing request (CSR).

setAsActive
boolean | undefined

Specifies whether the certificate is active.

CreateCertificateFromCsrCommand Output

See CreateCertificateFromCsrCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
certificateArn
string | undefined

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

certificateId
string | undefined

The ID of the certificate. Certificate management operations only take a certificateId.

certificatePem
string | undefined

The certificate data, in PEM format.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

InvalidRequestException
client

The request is not valid.

ServiceUnavailableException
server

The service is temporarily unavailable.

ThrottlingException
client

The rate exceeds the limit.

UnauthorizedException
client

You are not authorized to perform this operation.

IoTServiceException
Base exception class for all service exceptions from IoT service.