aws_sdk_lightsail/client/

get_relational_database_events.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetRelationalDatabaseEvents`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`relational_database_name(impl Into<String>)`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::relational_database_name) / [`set_relational_database_name(Option<String>)`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::set_relational_database_name):<br>required: **true**<br><p>The name of the database from which to get events.</p><br>
    ///   - [`duration_in_minutes(i32)`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::duration_in_minutes) / [`set_duration_in_minutes(Option<i32>)`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::set_duration_in_minutes):<br>required: **false**<br><p>The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.</p> <p>Default: <code>60</code></p> <p>The minimum is 1 and the maximum is 14 days (20160 minutes).</p><br>
    ///   - [`page_token(impl Into<String>)`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::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>GetRelationalDatabaseEvents</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 [`GetRelationalDatabaseEventsOutput`](crate::operation::get_relational_database_events::GetRelationalDatabaseEventsOutput) with field(s):
    ///   - [`relational_database_events(Option<Vec::<RelationalDatabaseEvent>>)`](crate::operation::get_relational_database_events::GetRelationalDatabaseEventsOutput::relational_database_events): <p>An object describing the result of your get relational database events request.</p>
    ///   - [`next_page_token(Option<String>)`](crate::operation::get_relational_database_events::GetRelationalDatabaseEventsOutput::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>GetRelationalDatabaseEvents</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
    /// - On failure, responds with [`SdkError<GetRelationalDatabaseEventsError>`](crate::operation::get_relational_database_events::GetRelationalDatabaseEventsError)
    pub fn get_relational_database_events(
        &self,
    ) -> crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder {
        crate::operation::get_relational_database_events::builders::GetRelationalDatabaseEventsFluentBuilder::new(self.handle.clone())
    }
}