DescribeCertificates
Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- CertificateIdentifier
-
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
Constraints:
-
Must match an existing CertificateIdentifier.
Type: String
Required: No
-
- Filters.Filter.N
-
This parameter isn't currently supported.
Type: Array of Filter objects
Required: No
- Marker
-
An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.Type: String
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
Response Elements
The following elements are returned by the service.
- Certificates.Certificate.N
-
The list of
Certificate
objects for the Amazon Web Services account.Type: Array of Certificate objects
- Marker
-
An optional pagination token provided by a previous
DescribeCertificates
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- CertificateNotFound
-
CertificateIdentifier
doesn't refer to an existing certificate.HTTP Status Code: 404
Examples
Example
This example illustrates one usage of DescribeCertificates.
Sample Request
https://rds.amazonaws.com/
?Action=DescribeCertificates
&MaxRecords=100
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20141121/us-west-2/rds/aws4_request
&X-Amz-Date=20141121T164732Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b
Sample Response
<DescribeCertificatesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<DescribeCertificatesResult>
<Certificates>
<Certificate>
<CertificateIdentifier>rdscacertificate</CertificateIdentifier>
<CertificateType>ca</CertificateType>
<ThumbPrint>xxxxxxxxxxxx</ThumbPrint>
<ValidFrom>2010-05-22T01:12:00.000Z</ValidFrom>
<ValidTill>2014-05-22T01:12:00.000Z</ValidTill>
</Certificate>
</Certificates>
</DescribeCertificatesResult>
<ResponseMetadata>
<RequestId>9135fff3-8509-11e0-bd9b-a7b1ece36d51</RequestId>
</ResponseMetadata>
</DescribeCertificatesResponse>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: