DataZone / Paginator / ListNotebookRuns

ListNotebookRuns

class DataZone.Paginator.ListNotebookRuns

paginator = client.get_paginator('list_notebook_runs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    notebookIdentifier='string',
    status='QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
    scheduleIdentifier='string',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

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

• 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',
            '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) –

    A token to resume pagination.