aws-sdk-datazone 1.137.0

AWS SDK for Amazon DataZone
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListNotebooks`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p><br>
    ///   - [`owning_project_identifier(impl Into<String>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::owning_project_identifier) / [`set_owning_project_identifier(Option<String>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_owning_project_identifier):<br>required: **true**<br><p>The identifier of the project that owns the notebooks.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for the results.</p><br>
    ///   - [`sort_by(SortKey)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::sort_by) / [`set_sort_by(Option<SortKey>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field to sort the results by.</p><br>
    ///   - [`status(NotebookStatus)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::status) / [`set_status(Option<NotebookStatus>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_status):<br>required: **false**<br><p>The status to filter notebooks by.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p><br>
    /// - On success, responds with [`ListNotebooksOutput`](crate::operation::list_notebooks::ListNotebooksOutput) with field(s):
    ///   - [`items(Option<Vec::<NotebookSummary>>)`](crate::operation::list_notebooks::ListNotebooksOutput::items): <p>The results of the <code>ListNotebooks</code> action.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_notebooks::ListNotebooksOutput::next_token): <p>When the number of notebooks is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notebooks, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotebooks</code> to list the next set of notebooks.</p>
    /// - On failure, responds with [`SdkError<ListNotebooksError>`](crate::operation::list_notebooks::ListNotebooksError)
    pub fn list_notebooks(&self) -> crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder {
        crate::operation::list_notebooks::builders::ListNotebooksFluentBuilder::new(self.handle.clone())
    }
}