- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteCertificateCommand
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, DeleteCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DeleteCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // DeleteCertificateRequest
certificateId: "STRING_VALUE", // required
forceDelete: true || false,
};
const command = new DeleteCertificateCommand(input);
const response = await client.send(command);
// {};
DeleteCertificateCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
certificateIdRequired | string | undefined | The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) |
forceDelete | boolean | undefined | Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing. |
DeleteCertificateCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| CertificateStateException | client | The certificate operation is not allowed. |
| DeleteConflictException | client | You can't delete the resource because it is attached to one or more resources. |
| InternalFailureException | server | An unexpected error has occurred. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource does not exist. |
| 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. |