describeCertificates method

Future<CertificateMessage> describeCertificates({
  1. String? certificateIdentifier,
  2. List<Filter>? filters,
  3. String? marker,
  4. int? maxRecords,
})

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.

May throw CertificateNotFoundFault.

Parameter certificateIdentifier : The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

Parameter filters : This parameter is not currently supported.

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

Parameter 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 that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20
  • Maximum: 100

Implementation

Future<CertificateMessage> describeCertificates({
  String? certificateIdentifier,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  certificateIdentifier
      ?.also((arg) => $request['CertificateIdentifier'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeCertificates',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeCertificatesMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeCertificatesResult',
  );
  return CertificateMessage.fromXml($result);
}