Skip to content

RDS  >  Operations  >  describe_certificates

describe_certificates

Operation

describe_certificates async

describe_certificates(request: DescribeCertificatesInput | DescribeCertificatesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCertificatesOutput
describe_certificates(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCertificatesInputDict]) -> DescribeCertificatesOutput

Lists the set of certificate authority (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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeCertificatesOutput

An instance of DescribeCertificatesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeCertificatesInput dataclass

Bases: _SerdeShape

Attributes
certificate_identifier class-attribute instance-attribute
certificate_identifier: str | None = ...

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.
filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

marker class-attribute instance-attribute
marker: str | None = ...

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 by MaxRecords.

max_records class-attribute instance-attribute
max_records: int | None = ...

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.

Dictionaries

DescribeCertificatesInputDict

Bases: TypedDict

Dictionary form of DescribeCertificatesInput.

Attributes
certificate_identifier instance-attribute
certificate_identifier: str | None

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.
filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

marker instance-attribute
marker: str | None

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 by MaxRecords.

max_records instance-attribute
max_records: int | None

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.

Output

DescribeCertificatesOutput dataclass

Bases: _SerdeShape

Data returned by the DescribeCertificates action.

Attributes

certificates class-attribute instance-attribute
certificates: list[Certificate] | None = ...

The list of Certificate objects for the Amazon Web Services account.

default_certificate_for_new_launches class-attribute instance-attribute
default_certificate_for_new_launches: str | None = ...

The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the ModifyCertificates operation.

marker class-attribute instance-attribute
marker: str | None = ...

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 by MaxRecords .

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.