aws_sdk_lightsail/client/
get_relational_database_parameters.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetRelationalDatabaseParameters`](crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`relational_database_name(impl Into<String>)`](crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder::relational_database_name) / [`set_relational_database_name(Option<String>)`](crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder::set_relational_database_name):<br>required: **true**<br><p>The name of your database for which to get parameters.</p><br>
7    ///   - [`page_token(impl Into<String>)`](crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder::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>GetRelationalDatabaseParameters</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>
8    /// - On success, responds with [`GetRelationalDatabaseParametersOutput`](crate::operation::get_relational_database_parameters::GetRelationalDatabaseParametersOutput) with field(s):
9    ///   - [`parameters(Option<Vec::<RelationalDatabaseParameter>>)`](crate::operation::get_relational_database_parameters::GetRelationalDatabaseParametersOutput::parameters): <p>An object describing the result of your get relational database parameters request.</p>
10    ///   - [`next_page_token(Option<String>)`](crate::operation::get_relational_database_parameters::GetRelationalDatabaseParametersOutput::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>GetRelationalDatabaseParameters</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
11    /// - On failure, responds with [`SdkError<GetRelationalDatabaseParametersError>`](crate::operation::get_relational_database_parameters::GetRelationalDatabaseParametersError)
12    pub fn get_relational_database_parameters(
13        &self,
14    ) -> crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder {
15        crate::operation::get_relational_database_parameters::builders::GetRelationalDatabaseParametersFluentBuilder::new(self.handle.clone())
16    }
17}