aws_sdk_timestreamwrite/client/
list_databases.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 [`ListDatabases`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::set_max_results):<br>required: **false**<br><p>The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p><br>
9    /// - On success, responds with [`ListDatabasesOutput`](crate::operation::list_databases::ListDatabasesOutput) with field(s):
10    ///   - [`databases(Option<Vec::<Database>>)`](crate::operation::list_databases::ListDatabasesOutput::databases): <p>A list of database names.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_databases::ListDatabasesOutput::next_token): <p>The pagination token. This parameter is returned when the response is truncated.</p>
12    /// - On failure, responds with [`SdkError<ListDatabasesError>`](crate::operation::list_databases::ListDatabasesError)
13    pub fn list_databases(&self) -> crate::operation::list_databases::builders::ListDatabasesFluentBuilder {
14        crate::operation::list_databases::builders::ListDatabasesFluentBuilder::new(self.handle.clone())
15    }
16}