describe_certificates `async` ¶

describe_certificates(
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    certificate_identifier: Optional[String] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> CertificateMessage

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

Parameters:

certificate_identifier (Optional[String], default: None ) –
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.
filters (Optional[FilterList], default: None ) –

This parameter is not currently supported.
max_records (Optional[IntegerOptional], default: 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 that the remaining results can be retrieved.

Default: 100

Constraints:
- Minimum: 20
- Maximum: 100
marker (Optional[String], default: 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.

Raises:

CertificateNotFoundFault –

CertificateIdentifier doesn't refer to an existing certificate.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_docdb/_services/async_doc_db.py

async def describe_certificates(
    self,
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    certificate_identifier: Optional["capo_docdb.types.string.String"] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
    max_records: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_docdb.types.string.String"] = None,
) -> "capo_docdb.types.certificate_message.CertificateMessage":
    """<p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.</p>

    Args:
        certificate_identifier: <p>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 <code>MaxRecords</code> certificates is returned. This parameter is not case sensitive.</p> <p>Constraints</p> <ul> <li> <p>Must match an existing <code>CertificateIdentifier</code>.</p> </li> </ul>
        filters: <p>This parameter is not currently supported.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints:</p> <ul> <li> <p>Minimum: 20</p> </li> <li> <p>Maximum: 100</p> </li> </ul>
        marker: <p>An optional pagination token provided by a previous <code>DescribeCertificates</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>

    Raises:
        capo_docdb.errors.certificate_not_found_fault.CertificateNotFoundFault: <p> <code>CertificateIdentifier</code> doesn't refer to an existing certificate. </p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb.types.describe_certificates_message.DescribeCertificatesMessage]",
    ) -> AsyncOperationResponse[
        "capo_docdb.types.certificate_message.CertificateMessage"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_certificates

        (
            output,
            http_response,
        ) = await capo_docdb._operations.amazon_rd_sv19.describe_certificates.async_describe_certificates(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCertificates")
    )
    input_: capo_docdb.types.describe_certificates_message.DescribeCertificatesMessage = {}
    if certificate_identifier is not None:
        input_["certificate_identifier"] = certificate_identifier
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_certificates async ¶

describe_certificates `async` ¶