aws_sdk_lightsail/client/

get_relational_database_log_events.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetRelationalDatabaseLogEvents`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`relational_database_name(impl Into<String>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::relational_database_name) / [`set_relational_database_name(Option<String>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::set_relational_database_name):<br>required: **true**<br><p>The name of your database for which to get log events.</p><br>
    ///   - [`log_stream_name(impl Into<String>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::log_stream_name) / [`set_log_stream_name(Option<String>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::set_log_stream_name):<br>required: **true**<br><p>The name of the log stream.</p> <p>Use the <code>get relational database log streams</code> operation to get a list of available log streams.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::set_start_time):<br>required: **false**<br><p>The start of the time interval from which to get log events.</p> <p>Constraints:</p> <ul>  <li>   <p>Specified in Coordinated Universal Time (UTC).</p></li>  <li>   <p>Specified in the Unix time format.</p>   <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p></li> </ul><br>
    ///   - [`end_time(DateTime)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::set_end_time):<br>required: **false**<br><p>The end of the time interval from which to get log events.</p> <p>Constraints:</p> <ul>  <li>   <p>Specified in Coordinated Universal Time (UTC).</p></li>  <li>   <p>Specified in the Unix time format.</p>   <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p></li> </ul><br>
    ///   - [`start_from_head(bool)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::start_from_head) / [`set_start_from_head(Option<bool>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::set_start_from_head):<br>required: **false**<br><p>Parameter to specify if the log should start from head or tail. If <code>true</code> is specified, the log event starts from the head of the log. If <code>false</code> is specified, the log event starts from the tail of the log.</p><note>  <p>For PostgreSQL, the default value of <code>false</code> is the only option available.</p> </note><br>
    ///   - [`page_token(impl Into<String>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::set_page_token):<br>required: **false**<br><p>The token to advance to the next or previous page of results from your request.</p> <p>To get a page token, perform an initial <code>GetRelationalDatabaseLogEvents</code> request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.</p><br>
    /// - On success, responds with [`GetRelationalDatabaseLogEventsOutput`](crate::operation::get_relational_database_log_events::GetRelationalDatabaseLogEventsOutput) with field(s):
    ///   - [`resource_log_events(Option<Vec::<LogEvent>>)`](crate::operation::get_relational_database_log_events::GetRelationalDatabaseLogEventsOutput::resource_log_events): <p>An object describing the result of your get relational database log events request.</p>
    ///   - [`next_backward_token(Option<String>)`](crate::operation::get_relational_database_log_events::GetRelationalDatabaseLogEventsOutput::next_backward_token): <p>A token used for advancing to the previous page of results from your get relational database log events request.</p>
    ///   - [`next_forward_token(Option<String>)`](crate::operation::get_relational_database_log_events::GetRelationalDatabaseLogEventsOutput::next_forward_token): <p>A token used for advancing to the next page of results from your get relational database log events request.</p>
    /// - On failure, responds with [`SdkError<GetRelationalDatabaseLogEventsError>`](crate::operation::get_relational_database_log_events::GetRelationalDatabaseLogEventsError)
    pub fn get_relational_database_log_events(
        &self,
    ) -> crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder {
        crate::operation::get_relational_database_log_events::builders::GetRelationalDatabaseLogEventsFluentBuilder::new(self.handle.clone())
    }
}