ListNotebookInstances

class SageMaker.Paginator.ListNotebookInstances

paginator = client.get_paginator('list_notebook_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_notebook_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NameContains='string',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    StatusEquals='Pending'|'InService'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Updating',
    NotebookInstanceLifecycleConfigNameContains='string',
    DefaultCodeRepositoryContains='string',
    AdditionalCodeRepositoryEquals='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• SortBy (string) -- The field to sort results by. The default is Name .
• SortOrder (string) -- The sort order for results.
• NameContains (string) -- A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
• CreationTimeBefore (datetime) -- A filter that returns only notebook instances that were created before the specified time (timestamp).
• CreationTimeAfter (datetime) -- A filter that returns only notebook instances that were created after the specified time (timestamp).
• LastModifiedTimeBefore (datetime) -- A filter that returns only notebook instances that were modified before the specified time (timestamp).
• LastModifiedTimeAfter (datetime) -- A filter that returns only notebook instances that were modified after the specified time (timestamp).
• StatusEquals (string) -- A filter that returns only notebook instances with the specified status.
• NotebookInstanceLifecycleConfigNameContains (string) -- A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.
• DefaultCodeRepositoryContains (string) -- A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.
• AdditionalCodeRepositoryEquals (string) -- A filter that returns only notebook instances with associated with the specified git repository.
• 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

{
    'NotebookInstances': [
        {
            'NotebookInstanceName': 'string',
            'NotebookInstanceArn': 'string',
            'NotebookInstanceStatus': 'Pending'|'InService'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Updating',
            'Url': 'string',
            'InstanceType': 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'NotebookInstanceLifecycleConfigName': 'string',
            'DefaultCodeRepository': 'string',
            'AdditionalCodeRepositories': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) --

  • NotebookInstances (list) --

    An array of NotebookInstanceSummary objects, one for each notebook instance.

    • (dict) --

      Provides summary information for an SageMaker notebook instance.

      • NotebookInstanceName (string) --

        The name of the notebook instance that you want a summary for.

      • NotebookInstanceArn (string) --

        The Amazon Resource Name (ARN) of the notebook instance.

      • NotebookInstanceStatus (string) --

        The status of the notebook instance.

      • Url (string) --

        The URL that you use to connect to the Jupyter notebook running in your notebook instance.

      • InstanceType (string) --

        The type of ML compute instance that the notebook instance is running on.

      • CreationTime (datetime) --

        A timestamp that shows when the notebook instance was created.

      • LastModifiedTime (datetime) --

        A timestamp that shows when the notebook instance was last modified.

      • NotebookInstanceLifecycleConfigName (string) --

        The name of a notebook instance lifecycle configuration associated with this notebook instance.

        For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

      • DefaultCodeRepository (string) --

        The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

      • AdditionalCodeRepositories (list) --

        An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

        • (string) --