aws_sdk_lightsail/client/

get_distributions.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetDistributions`](crate::operation::get_distributions::builders::GetDistributionsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`distribution_name(impl Into<String>)`](crate::operation::get_distributions::builders::GetDistributionsFluentBuilder::distribution_name) / [`set_distribution_name(Option<String>)`](crate::operation::get_distributions::builders::GetDistributionsFluentBuilder::set_distribution_name):<br>required: **false**<br><p>The name of the distribution for which to return information.</p> <p>When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.</p><br>
    ///   - [`page_token(impl Into<String>)`](crate::operation::get_distributions::builders::GetDistributionsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_distributions::builders::GetDistributionsFluentBuilder::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>GetDistributions</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 [`GetDistributionsOutput`](crate::operation::get_distributions::GetDistributionsOutput) with field(s):
    ///   - [`distributions(Option<Vec::<LightsailDistribution>>)`](crate::operation::get_distributions::GetDistributionsOutput::distributions): <p>An array of objects that describe your distributions.</p>
    ///   - [`next_page_token(Option<String>)`](crate::operation::get_distributions::GetDistributionsOutput::next_page_token): <p>The token to advance to the next page of results from your request.</p> <p>A next page token is not returned if there are no more results to display.</p> <p>To get the next page of results, perform another <code>GetDistributions</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
    /// - On failure, responds with [`SdkError<GetDistributionsError>`](crate::operation::get_distributions::GetDistributionsError)
    pub fn get_distributions(&self) -> crate::operation::get_distributions::builders::GetDistributionsFluentBuilder {
        crate::operation::get_distributions::builders::GetDistributionsFluentBuilder::new(self.handle.clone())
    }
}