Skip to content

GetCertificatesRequest

Source code in docs_src/capo_lightsail/types/get_certificates_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class GetCertificatesRequest(TypedDict, closed=True):
    certificate_statuses: NotRequired[
        "capo_lightsail.types.certificate_status_list.CertificateStatusList"
    ]
    """<p>The status of the certificates for which to return information.</p> <p>For example, specify <code>ISSUED</code> to return only certificates with an <code>ISSUED</code> status.</p> <p>When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.</p>"""
    include_certificate_details: (
        "capo_lightsail.types.include_certificate_details.IncludeCertificateDetails"
    )
    """<p>Indicates whether to include detailed information about the certificates in the response.</p> <p>When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.</p>"""
    certificate_name: NotRequired[
        "capo_lightsail.types.certificate_name.CertificateName"
    ]
    """<p>The name for the certificate for which to return information.</p> <p>When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.</p>"""
    page_token: NotRequired["capo_lightsail.types.string.string"]
    """<p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetCertificates</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p>"""

certificate_name instance-attribute 

certificate_name: NotRequired[CertificateName]

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

certificate_statuses instance-attribute 

certificate_statuses: NotRequired[CertificateStatusList]

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

include_certificate_details instance-attribute 

include_certificate_details: IncludeCertificateDetails

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

page_token instance-attribute 

page_token: NotRequired[string]

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.