DataZone / Client / list_notebook_runs

list_notebook_runs

DataZone.Client.list_notebook_runs(**kwargs)

Lists notebook runs in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

response = client.list_notebook_runs(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    notebookIdentifier='string',
    status='QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
    scheduleIdentifier='string',
    maxResults=123,
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

  • owningProjectIdentifier (string) –

    [REQUIRED]

    The identifier of the project that owns the notebook runs.

  • notebookIdentifier (string) – The identifier of the notebook to filter runs by.

  • status (string) – The status to filter notebook runs by.

  • scheduleIdentifier (string) – The identifier of the schedule to filter notebook runs by.

  • maxResults (integer) – The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.

  • sortOrder (string) – The sort order for the results.

  • nextToken (string) – When the number of notebook runs 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 notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'domainId': 'string',
            'owningProjectId': 'string',
            'notebookId': 'string',
            'scheduleId': 'string',
            'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
            'triggerSource': {
                'type': 'MANUAL'|'SCHEDULED'|'WORKFLOW',
                'name': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'startedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListNotebookRuns action.

      • (dict) –

        The summary of a notebook run in Amazon SageMaker Unified Studio.

        • id (string) –

          The identifier of the notebook run.

        • domainId (string) –

          The identifier of the Amazon SageMaker Unified Studio domain.

        • owningProjectId (string) –

          The identifier of the project that owns the notebook run.

        • notebookId (string) –

          The identifier of the notebook.

        • scheduleId (string) –

          The identifier of the schedule associated with the notebook run.

        • status (string) –

          The status of the notebook run.

        • triggerSource (dict) –

          The source that triggered the notebook run.

          • type (string) –

            The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.

          • name (string) –

            The name of the trigger source.

        • createdAt (datetime) –

          The timestamp of when the notebook run was created.

        • createdBy (string) –

          The identifier of the user who created the notebook run.

        • updatedAt (datetime) –

          The timestamp of when the notebook run was last updated.

        • updatedBy (string) –

          The identifier of the user who last updated the notebook run.

        • startedAt (datetime) –

          The timestamp of when the notebook run started executing.

        • completedAt (datetime) –

          The timestamp of when the notebook run completed.

    • nextToken (string) –

      When the number of notebook runs 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 notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

Exceptions