aws_sdk_athena/client/
list_notebook_sessions.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 [`ListNotebookSessions`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`notebook_id(impl Into<String>)`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::notebook_id) / [`set_notebook_id(Option<String>)`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::set_notebook_id):<br>required: **true**<br><p>The ID of the notebook to list sessions for.</p><br>
7    ///   - [`max_results(i32)`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of notebook sessions to return.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::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    /// - On success, responds with [`ListNotebookSessionsOutput`](crate::operation::list_notebook_sessions::ListNotebookSessionsOutput) with field(s):
10    ///   - [`notebook_sessions_list(Vec::<NotebookSessionSummary>)`](crate::operation::list_notebook_sessions::ListNotebookSessionsOutput::notebook_sessions_list): <p>A list of the sessions belonging to the notebook.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_notebook_sessions::ListNotebookSessionsOutput::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 <code>NextToken</code> from the response object of the previous page call.</p>
12    /// - On failure, responds with [`SdkError<ListNotebookSessionsError>`](crate::operation::list_notebook_sessions::ListNotebookSessionsError)
13    pub fn list_notebook_sessions(&self) -> crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder {
14        crate::operation::list_notebook_sessions::builders::ListNotebookSessionsFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_athena/client/list_notebook_sessions.rs

aws_sdk_athena/client/
list_notebook_sessions.rs
