get_certificates ¶

def get_certificates(
    self,
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    certificate_statuses: Optional[
        "capo_lightsail.types.certificate_status_list.CertificateStatusList"
    ] = None,
    include_certificate_details: Optional[
        "capo_lightsail.types.include_certificate_details.IncludeCertificateDetails"
    ] = None,
    certificate_name: Optional[
        "capo_lightsail.types.certificate_name.CertificateName"
    ] = None,
    page_token: Optional["capo_lightsail.types.string.string"] = None,
) -> "capo_lightsail.types.get_certificates_result.GetCertificatesResult":
    """<p>Returns information about one or more Amazon Lightsail SSL/TLS certificates.</p> <note> <p>To get a summary of a certificate, omit <code>includeCertificateDetails</code> from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.</p> </note>

    Args:
        certificate_statuses: <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: <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: <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: <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>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.get_certificates_request.GetCertificatesRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.get_certificates_result.GetCertificatesResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_certificates

        output, http_response = (
            capo_lightsail._operations.lightsail_20161128.get_certificates.get_certificates(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCertificates")
    )
    input_: capo_lightsail.types.get_certificates_request.GetCertificatesRequest = {}
    if certificate_statuses is not None:
        input_["certificate_statuses"] = certificate_statuses
    if include_certificate_details is not None:
        input_["include_certificate_details"] = include_certificate_details
    if certificate_name is not None:
        input_["certificate_name"] = certificate_name
    if page_token is not None:
        input_["page_token"] = page_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output