RenewCertificateCommand

Suggest an Edit

Renews an eligible ACM certificate . In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so . For more information, see Testing Managed Renewal  in the ACM User Guide.

Example Syntax

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

import { ACMClient, RenewCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import
// const { ACMClient, RenewCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import
const client = new ACMClient(config);
const input = { // RenewCertificateRequest
  CertificateArn: "STRING_VALUE", // required
};
const command = new RenewCertificateCommand(input);
const response = await client.send(command);
// {};

RenewCertificateCommand Input

See RenewCertificateCommandInput for more details

Parameter
Type
Description
CertificateArn
Required
string | undefined

String that contains the ARN of the ACM certificate to be renewed. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) .

RenewCertificateCommand Output

See RenewCertificateCommandOutput for details

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

Throws

Name
Fault
Details
InvalidArnException
client

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

RequestInProgressException
client

The certificate request is in process and the certificate in your account has not yet been issued.

ResourceNotFoundException
client

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

ACMServiceException
Base exception class for all service exceptions from ACM service.