CancelCertificateTransferCommand

Suggest an Edit

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Requires permission to access the CancelCertificateTransfer  action.

Example Syntax

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

import { IoTClient, CancelCertificateTransferCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, CancelCertificateTransferCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // CancelCertificateTransferRequest
  certificateId: "STRING_VALUE", // required
};
const command = new CancelCertificateTransferCommand(input);
const response = await client.send(command);
// {};

CancelCertificateTransferCommand Input

See CancelCertificateTransferCommandInput for more details

Parameter
Type
Description
certificateId
Required
string | undefined

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

CancelCertificateTransferCommand Output

See CancelCertificateTransferCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
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.

TransferAlreadyCompletedException
client

You can't revert the certificate transfer because the transfer is already complete.

UnauthorizedException
client

You are not authorized to perform this operation.

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