DeleteCertificateCommand

Suggest an Edit

Deletes the certificate that's specified in the CertificateId parameter.

Example Syntax

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

import { TransferClient, DeleteCertificateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, DeleteCertificateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // DeleteCertificateRequest
  CertificateId: "STRING_VALUE", // required
};
const command = new DeleteCertificateCommand(input);
const response = await client.send(command);
// {};

DeleteCertificateCommand Input

See DeleteCertificateCommandInput for more details

Parameter
Type
Description
CertificateId
Required
string | undefined

The identifier of the certificate object that you are deleting.

DeleteCertificateCommand Output

See DeleteCertificateCommandOutput for details

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

Throws

Name
Fault
Details
InternalServiceError
server

This exception is thrown when an error occurs in the Transfer Family service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

ResourceNotFoundException
client

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

ServiceUnavailableException
server

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

TransferServiceException
Base exception class for all service exceptions from Transfer service.