Skip to content

ListNotebooksInput

Source code in docs_src/capo_datazone/types/list_notebooks_input.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ListNotebooksInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.</p>"""
    owning_project_identifier: "capo_datazone.types.project_id.ProjectId"
    """<p>The identifier of the project that owns the notebooks.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<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>"""
    sort_order: NotRequired["capo_datazone.types.sort_order.SortOrder"]
    """<p>The sort order for the results.</p>"""
    sort_by: NotRequired["capo_datazone.types.sort_key.SortKey"]
    """<p>The field to sort the results by.</p>"""
    status: NotRequired["capo_datazone.types.notebook_status.NotebookStatus"]
    """<p>The status to filter notebooks by.</p>"""
    type: NotRequired["capo_datazone.types.notebook_type.NotebookType"]
    """<p>The type to filter notebooks by.</p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<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>"""

domain_identifier instance-attribute 

domain_identifier: DomainId

The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of MaxResults, the response contains a NextToken value.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.

owning_project_identifier instance-attribute 

owning_project_identifier: ProjectId

The identifier of the project that owns the notebooks.

sort_by instance-attribute 

sort_by: NotRequired[SortKey]

The field to sort the results by.

sort_order instance-attribute 

sort_order: NotRequired[SortOrder]

The sort order for the results.

status instance-attribute 

status: NotRequired[NotebookStatus]

The status to filter notebooks by.

type instance-attribute 

type: NotRequired[NotebookType]

The type to filter notebooks by.