DataZone / Paginator / ListNotebooks

ListNotebooks¶

class DataZone.Paginator.ListNotebooks¶

paginator = client.get_paginator('list_notebooks')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DataZone.Client.list_notebooks().

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='CREATED_AT'|'UPDATED_AT',
    status='ACTIVE'|'ARCHIVED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.
owningProjectIdentifier (string) –
[REQUIRED]

The identifier of the project that owns the notebooks.
sortOrder (string) – The sort order for the results.
sortBy (string) – The field to sort the results by.
status (string) – The status to filter notebooks by.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'owningProjectId': 'string',
            'domainId': 'string',
            'status': 'ACTIVE'|'ARCHIVED',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the ListNotebooks action.
  - (dict) –
    
    The summary of a notebook in Amazon SageMaker Unified Studio.
    - id (string) –
      
      The identifier of the notebook.
    - name (string) –
      
      The name of the notebook.
    - owningProjectId (string) –
      
      The identifier of the project that owns the notebook.
    - domainId (string) –
      
      The identifier of the Amazon SageMaker Unified Studio domain.
    - status (string) –
      
      The status of the notebook.
    - description (string) –
      
      The description of the notebook.
    - createdAt (datetime) –
      
      The timestamp of when the notebook was created.
    - createdBy (string) –
      
      The identifier of the user who created the notebook.
    - updatedAt (datetime) –
      
      The timestamp of when the notebook was last updated.
    - updatedBy (string) –
      
      The identifier of the user who last updated the notebook.
- NextToken (string) –
  
  A token to resume pagination.