aws_sdk_lightsail/client/

get_certificates.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetCertificates`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`certificate_statuses(CertificateStatus)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::certificate_statuses) / [`set_certificate_statuses(Option<Vec::<CertificateStatus>>)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::set_certificate_statuses):<br>required: **false**<br><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><br>
    ///   - [`include_certificate_details(bool)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::include_certificate_details) / [`set_include_certificate_details(Option<bool>)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::set_include_certificate_details):<br>required: **false**<br><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><br>
    ///   - [`certificate_name(impl Into<String>)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::certificate_name) / [`set_certificate_name(Option<String>)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::set_certificate_name):<br>required: **false**<br><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><br>
    ///   - [`page_token(impl Into<String>)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::set_page_token):<br>required: **false**<br><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><br>
    /// - On success, responds with [`GetCertificatesOutput`](crate::operation::get_certificates::GetCertificatesOutput) with field(s):
    ///   - [`certificates(Option<Vec::<CertificateSummary>>)`](crate::operation::get_certificates::GetCertificatesOutput::certificates): <p>An object that describes certificates.</p>
    ///   - [`next_page_token(Option<String>)`](crate::operation::get_certificates::GetCertificatesOutput::next_page_token): <p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
    /// - On failure, responds with [`SdkError<GetCertificatesError>`](crate::operation::get_certificates::GetCertificatesError)
    pub fn get_certificates(&self) -> crate::operation::get_certificates::builders::GetCertificatesFluentBuilder {
        crate::operation::get_certificates::builders::GetCertificatesFluentBuilder::new(self.handle.clone())
    }
}