aws_sdk_honeycode/client/
list_tables.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 [`ListTables`](crate::operation::list_tables::builders::ListTablesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_tables::builders::ListTablesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workbook_id(impl Into<String>)`](crate::operation::list_tables::builders::ListTablesFluentBuilder::workbook_id) / [`set_workbook_id(Option<String>)`](crate::operation::list_tables::builders::ListTablesFluentBuilder::set_workbook_id):<br>required: **true**<br><p>The ID of the workbook whose tables are being retrieved.</p> <p>If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_tables::builders::ListTablesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_tables::builders::ListTablesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of tables to return in each page of the results.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_tables::builders::ListTablesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_tables::builders::ListTablesFluentBuilder::set_next_token):<br>required: **false**<br><p>This parameter is optional. If a nextToken is not specified, the API returns the first page of data.</p> <p>Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.</p><br>
10    /// - On success, responds with [`ListTablesOutput`](crate::operation::list_tables::ListTablesOutput) with field(s):
11    ///   - [`tables(Vec::<Table>)`](crate::operation::list_tables::ListTablesOutput::tables): <p>The list of tables in the workbook.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_tables::ListTablesOutput::next_token): <p>Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.</p>
13    ///   - [`workbook_cursor(i64)`](crate::operation::list_tables::ListTablesOutput::workbook_cursor): <p>Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.</p>
14    /// - On failure, responds with [`SdkError<ListTablesError>`](crate::operation::list_tables::ListTablesError)
15    pub fn list_tables(&self) -> crate::operation::list_tables::builders::ListTablesFluentBuilder {
16        crate::operation::list_tables::builders::ListTablesFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_honeycode/client/list_tables.rs

aws_sdk_honeycode/client/
list_tables.rs
