aws_sdk_athena/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    ///   - [`catalog_name(impl Into<String>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::catalog_name) / [`set_catalog_name(Option<String>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::set_catalog_name):<br>required: **true**<br><p>The name of the data catalog that contains the databases to return.</p><br>
8    ///   - [`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>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p><br>
9    ///   - [`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>Specifies the maximum number of results to return.</p><br>
10    ///   - [`work_group(impl Into<String>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::work_group) / [`set_work_group(Option<String>)`](crate::operation::list_databases::builders::ListDatabasesFluentBuilder::set_work_group):<br>required: **false**<br><p>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</p><br>
11    /// - On success, responds with [`ListDatabasesOutput`](crate::operation::list_databases::ListDatabasesOutput) with field(s):
12    ///   - [`database_list(Option<Vec::<Database>>)`](crate::operation::list_databases::ListDatabasesOutput::database_list): <p>A list of databases from a data catalog.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_databases::ListDatabasesOutput::next_token): <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.</p>
14    /// - On failure, responds with [`SdkError<ListDatabasesError>`](crate::operation::list_databases::ListDatabasesError)
15    pub fn list_databases(&self) -> crate::operation::list_databases::builders::ListDatabasesFluentBuilder {
16        crate::operation::list_databases::builders::ListDatabasesFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_athena/client/list_databases.rs

aws_sdk_athena/client/
list_databases.rs
