UpdateCertificate - AWS Transfer Family

UpdateCertificate

Updates the active and inactive dates for a certificate.

Request Syntax

{ "ActiveDate": number, "CertificateId": "string", "Description": "string", "InactiveDate": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ActiveDate

An optional date that specifies when the certificate becomes active.

Type: Timestamp

Required: No

CertificateId

The identifier of the certificate object that you are updating.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^cert-([0-9a-f]{17})$

Required: Yes

Description

A short description to help identify the certificate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[\p{Graph}]+

Required: No

InactiveDate

An optional date that specifies when the certificate becomes inactive.

Type: Timestamp

Required: No

Response Syntax

{ "CertificateId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CertificateId

Returns the identifier of the certificate object that you are updating.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^cert-([0-9a-f]{17})$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWSTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWSTransfer Family service is not available.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

Examples

Example

The following example updates the active date for a certificate, setting the active date to January 16, 2022 at 16:12:07 UTC -5 hours.

Sample Request

aws transfer update-certificate --certificate-id c-abcdefg123456hijk --active-date 2022-01-16T16:12:07-05:00

Example

The following is a sample response for this API call.

Sample Response

"CertificateId": "c-abcdefg123456hijk"

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: