Skip to content

ListCertificatesRequest

Source code in docs_src/capo_acm/types/list_certificates_request.py
class ListCertificatesRequest(TypedDict, closed=True):
    certificate_statuses: NotRequired[
        "capo_acm.types.certificate_statuses.CertificateStatuses"
    ]
    """<p>Filter the certificate list by status value.</p>"""
    certificate_key_pair_origins: NotRequired[
        "capo_acm.types.certificate_key_pair_origins.CertificateKeyPairOrigins"
    ]
    """<p>Filter the certificate list by certificate key pair origin. Specify one or more <code>CertificateKeyPairOrigin</code> values. Default filtering returns only certificates with key pair origin of <code>AWS_MANAGED</code> and <code>CUSTOMER_PROVIDED</code>.</p>"""
    includes: NotRequired["capo_acm.types.filters.Filters"]
    """<p>Filter the certificate list. For more information, see the <a>Filters</a> structure.</p>"""
    next_token: NotRequired["capo_acm.types.next_token.NextToken"]
    """<p>Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the response you just received.</p>"""
    max_items: NotRequired["capo_acm.types.max_items.MaxItems"]
    """<p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>"""
    sort_by: NotRequired["capo_acm.types.sort_by.SortBy"]
    """<p>Specifies the field to sort results by. If you specify <code>SortBy</code>, you must also specify <code>SortOrder</code>.</p>"""
    sort_order: NotRequired["capo_acm.types.sort_order.SortOrder"]
    """<p>Specifies the order of sorted results. If you specify <code>SortOrder</code>, you must also specify <code>SortBy</code>.</p>"""

certificate_key_pair_origins instance-attribute

certificate_key_pair_origins: NotRequired[CertificateKeyPairOrigins]

Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.

certificate_statuses instance-attribute

certificate_statuses: NotRequired[CertificateStatuses]

Filter the certificate list by status value.

includes instance-attribute

includes: NotRequired[Filters]

Filter the certificate list. For more information, see the Filters structure.

max_items instance-attribute

max_items: NotRequired[MaxItems]

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

next_token instance-attribute

next_token: NotRequired[NextToken]

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

sort_by instance-attribute

sort_by: NotRequired[SortBy]

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.