aws_sdk_athena/client/list_data_catalogs.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 [`ListDataCatalogs`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::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 NextToken from the response object of the previous page call.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::set_max_results):<br>required: **false**<br><p>Specifies the maximum number of data catalogs to return.</p><br>
9 /// - [`work_group(impl Into<String>)`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::work_group) / [`set_work_group(Option<String>)`](crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::set_work_group):<br>required: **false**<br><p>The name of the workgroup. Required if making an IAM Identity Center request.</p><br>
10 /// - On success, responds with [`ListDataCatalogsOutput`](crate::operation::list_data_catalogs::ListDataCatalogsOutput) with field(s):
11 /// - [`data_catalogs_summary(Option<Vec::<DataCatalogSummary>>)`](crate::operation::list_data_catalogs::ListDataCatalogsOutput::data_catalogs_summary): <p>A summary list of data catalogs.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_data_catalogs::ListDataCatalogsOutput::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>
13 /// - On failure, responds with [`SdkError<ListDataCatalogsError>`](crate::operation::list_data_catalogs::ListDataCatalogsError)
14 pub fn list_data_catalogs(&self) -> crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder {
15 crate::operation::list_data_catalogs::builders::ListDataCatalogsFluentBuilder::new(self.handle.clone())
16 }
17}