DescribeCertificate
Describes the certificate that's identified by the CertificateId.
Request Syntax
{
"CertificateId": "string"
}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.
- CertificateId
-
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
Type: String
Length Constraints: Fixed length of 22.
Pattern:
cert-([0-9a-f]{17})Required: Yes
Response Syntax
{
"Certificate": {
"ActiveDate": number,
"Arn": "string",
"Certificate": "string",
"CertificateChain": "string",
"CertificateId": "string",
"Description": "string",
"InactiveDate": number,
"NotAfterDate": number,
"NotBeforeDate": number,
"Serial": "string",
"Status": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": "string",
"Usage": "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.
- Certificate
-
The details for the specified certificate, returned as an object.
Type: DescribedCertificate object
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 AWS Transfer 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
