aws_sdk_lightsail/client/

get_key_pairs.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetKeyPairs`](crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`page_token(impl Into<String>)`](crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder::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>GetKeyPairs</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>
    ///   - [`include_default_key_pair(bool)`](crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder::include_default_key_pair) / [`set_include_default_key_pair(Option<bool>)`](crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder::set_include_default_key_pair):<br>required: **false**<br><p>A Boolean value that indicates whether to include the default key pair in the response of your request.</p><br>
    /// - On success, responds with [`GetKeyPairsOutput`](crate::operation::get_key_pairs::GetKeyPairsOutput) with field(s):
    ///   - [`key_pairs(Option<Vec::<KeyPair>>)`](crate::operation::get_key_pairs::GetKeyPairsOutput::key_pairs): <p>An array of key-value pairs containing information about the key pairs.</p>
    ///   - [`next_page_token(Option<String>)`](crate::operation::get_key_pairs::GetKeyPairsOutput::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>GetKeyPairs</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
    /// - On failure, responds with [`SdkError<GetKeyPairsError>`](crate::operation::get_key_pairs::GetKeyPairsError)
    pub fn get_key_pairs(&self) -> crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder {
        crate::operation::get_key_pairs::builders::GetKeyPairsFluentBuilder::new(self.handle.clone())
    }
}