DataZone / Client / list_notebooks

list_notebooks

DataZone.Client.list_notebooks(**kwargs)

Lists notebooks in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

response = client.list_notebooks(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    maxResults=123,
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='CREATED_AT'|'UPDATED_AT',
    status='ACTIVE'|'ARCHIVED',
    nextToken='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.

  • maxResults (integer) – 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.

  • 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.

  • nextToken (string) – 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.

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) –

      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.

Exceptions