Amazonka.SageMaker.ListNotebookInstances

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

This operation returns paginated results.

Creating a Request

data ListNotebookInstances

See: newListNotebookInstances smart constructor.

Constructors

ListNotebookInstances'

Fields

• additionalCodeRepositoryEquals :: Maybe Text

  A filter that returns only notebook instances with associated with the specified git repository.

• creationTimeAfter :: Maybe POSIX

  A filter that returns only notebook instances that were created after the specified time (timestamp).

• creationTimeBefore :: Maybe POSIX

  A filter that returns only notebook instances that were created before the specified time (timestamp).

• defaultCodeRepositoryContains :: Maybe Text

  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.

• lastModifiedTimeAfter :: Maybe POSIX

  A filter that returns only notebook instances that were modified after the specified time (timestamp).

• lastModifiedTimeBefore :: Maybe POSIX

  A filter that returns only notebook instances that were modified before the specified time (timestamp).

• maxResults :: Maybe Natural

  The maximum number of notebook instances to return.

• nameContains :: Maybe Text

  A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

• nextToken :: Maybe Text

  If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

  You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

• notebookInstanceLifecycleConfigNameContains :: Maybe Text

  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.

• sortBy :: Maybe NotebookInstanceSortKey

  The field to sort results by. The default is Name.

• sortOrder :: Maybe NotebookInstanceSortOrder

  The sort order for results.

• statusEquals :: Maybe NotebookInstanceStatus

  A filter that returns only notebook instances with the specified status.

Instances

ToJSON ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

toJSON :: ListNotebookInstances -> Value

toEncoding :: ListNotebookInstances -> Encoding

toJSONList :: [ListNotebookInstances] -> Value

toEncodingList :: [ListNotebookInstances] -> Encoding

ToHeaders ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

toHeaders :: ListNotebookInstances -> [Header]

ToPath ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

toPath :: ListNotebookInstances -> ByteString

ToQuery ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

toQuery :: ListNotebookInstances -> QueryString

AWSPager ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

page :: ListNotebookInstances -> AWSResponse ListNotebookInstances -> Maybe ListNotebookInstances

AWSRequest ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Associated Types

type AWSResponse ListNotebookInstances

Methods

request :: (Service -> Service) -> ListNotebookInstances -> Request ListNotebookInstances

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListNotebookInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListNotebookInstances)))

Generic ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Associated Types

type Rep ListNotebookInstances :: Type -> Type

Methods

from :: ListNotebookInstances -> Rep ListNotebookInstances x

to :: Rep ListNotebookInstances x -> ListNotebookInstances

Read ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

readsPrec :: Int -> ReadS ListNotebookInstances

readList :: ReadS [ListNotebookInstances]

readPrec :: ReadPrec ListNotebookInstances

readListPrec :: ReadPrec [ListNotebookInstances]

Show ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

showsPrec :: Int -> ListNotebookInstances -> ShowS

show :: ListNotebookInstances -> String

showList :: [ListNotebookInstances] -> ShowS

NFData ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

rnf :: ListNotebookInstances -> ()

Eq ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

(==) :: ListNotebookInstances -> ListNotebookInstances -> Bool

(/=) :: ListNotebookInstances -> ListNotebookInstances -> Bool

Hashable ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

hashWithSalt :: Int -> ListNotebookInstances -> Int

hash :: ListNotebookInstances -> Int

type AWSResponse ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

type AWSResponse ListNotebookInstances = ListNotebookInstancesResponse

type Rep ListNotebookInstances

Defined in Amazonka.SageMaker.ListNotebookInstances

type Rep ListNotebookInstances = D1 ('MetaData "ListNotebookInstances" "Amazonka.SageMaker.ListNotebookInstances" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListNotebookInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalCodeRepositoryEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "defaultCodeRepositoryContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastModifiedTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "notebookInstanceLifecycleConfigNameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookInstanceSortKey))) :*: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookInstanceSortOrder)) :*: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookInstanceStatus)))))))

newListNotebookInstances :: ListNotebookInstances

Create a value of ListNotebookInstances with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalCodeRepositoryEquals:ListNotebookInstances', listNotebookInstances_additionalCodeRepositoryEquals - A filter that returns only notebook instances with associated with the specified git repository.

$sel:creationTimeAfter:ListNotebookInstances', listNotebookInstances_creationTimeAfter - A filter that returns only notebook instances that were created after the specified time (timestamp).

$sel:creationTimeBefore:ListNotebookInstances', listNotebookInstances_creationTimeBefore - A filter that returns only notebook instances that were created before the specified time (timestamp).

$sel:defaultCodeRepositoryContains:ListNotebookInstances', listNotebookInstances_defaultCodeRepositoryContains - 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.

$sel:lastModifiedTimeAfter:ListNotebookInstances', listNotebookInstances_lastModifiedTimeAfter - A filter that returns only notebook instances that were modified after the specified time (timestamp).

$sel:lastModifiedTimeBefore:ListNotebookInstances', listNotebookInstances_lastModifiedTimeBefore - A filter that returns only notebook instances that were modified before the specified time (timestamp).

$sel:maxResults:ListNotebookInstances', listNotebookInstances_maxResults - The maximum number of notebook instances to return.

$sel:nameContains:ListNotebookInstances', listNotebookInstances_nameContains - A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

ListNotebookInstances, listNotebookInstances_nextToken - If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

$sel:notebookInstanceLifecycleConfigNameContains:ListNotebookInstances', listNotebookInstances_notebookInstanceLifecycleConfigNameContains - 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.

$sel:sortBy:ListNotebookInstances', listNotebookInstances_sortBy - The field to sort results by. The default is Name.

$sel:sortOrder:ListNotebookInstances', listNotebookInstances_sortOrder - The sort order for results.

$sel:statusEquals:ListNotebookInstances', listNotebookInstances_statusEquals - A filter that returns only notebook instances with the specified status.

Request Lenses

listNotebookInstances_additionalCodeRepositoryEquals :: Lens' ListNotebookInstances (Maybe Text)

A filter that returns only notebook instances with associated with the specified git repository.

listNotebookInstances_creationTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime)

A filter that returns only notebook instances that were created after the specified time (timestamp).

listNotebookInstances_creationTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime)

A filter that returns only notebook instances that were created before the specified time (timestamp).

listNotebookInstances_defaultCodeRepositoryContains :: Lens' ListNotebookInstances (Maybe Text)

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.

listNotebookInstances_lastModifiedTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime)

A filter that returns only notebook instances that were modified after the specified time (timestamp).

listNotebookInstances_lastModifiedTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime)

A filter that returns only notebook instances that were modified before the specified time (timestamp).

listNotebookInstances_maxResults :: Lens' ListNotebookInstances (Maybe Natural)

The maximum number of notebook instances to return.

listNotebookInstances_nameContains :: Lens' ListNotebookInstances (Maybe Text)

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

listNotebookInstances_nextToken :: Lens' ListNotebookInstances (Maybe Text)

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

listNotebookInstances_notebookInstanceLifecycleConfigNameContains :: Lens' ListNotebookInstances (Maybe Text)

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.

listNotebookInstances_sortBy :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortKey)

The field to sort results by. The default is Name.

listNotebookInstances_sortOrder :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortOrder)

The sort order for results.

listNotebookInstances_statusEquals :: Lens' ListNotebookInstances (Maybe NotebookInstanceStatus)

A filter that returns only notebook instances with the specified status.

Destructuring the Response

data ListNotebookInstancesResponse

See: newListNotebookInstancesResponse smart constructor.

Constructors

ListNotebookInstancesResponse'

Fields

• nextToken :: Maybe Text

  If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

• notebookInstances :: Maybe [NotebookInstanceSummary]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListNotebookInstancesResponse

Defined in Amazonka.SageMaker.ListNotebookInstances

Associated Types

type Rep ListNotebookInstancesResponse :: Type -> Type

Methods

from :: ListNotebookInstancesResponse -> Rep ListNotebookInstancesResponse x

to :: Rep ListNotebookInstancesResponse x -> ListNotebookInstancesResponse

Read ListNotebookInstancesResponse

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

readsPrec :: Int -> ReadS ListNotebookInstancesResponse

readList :: ReadS [ListNotebookInstancesResponse]

readPrec :: ReadPrec ListNotebookInstancesResponse

readListPrec :: ReadPrec [ListNotebookInstancesResponse]

Show ListNotebookInstancesResponse

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

showsPrec :: Int -> ListNotebookInstancesResponse -> ShowS

show :: ListNotebookInstancesResponse -> String

showList :: [ListNotebookInstancesResponse] -> ShowS

NFData ListNotebookInstancesResponse

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

rnf :: ListNotebookInstancesResponse -> ()

Eq ListNotebookInstancesResponse

Defined in Amazonka.SageMaker.ListNotebookInstances

Methods

(==) :: ListNotebookInstancesResponse -> ListNotebookInstancesResponse -> Bool

(/=) :: ListNotebookInstancesResponse -> ListNotebookInstancesResponse -> Bool

type Rep ListNotebookInstancesResponse

Defined in Amazonka.SageMaker.ListNotebookInstances

type Rep ListNotebookInstancesResponse = D1 ('MetaData "ListNotebookInstancesResponse" "Amazonka.SageMaker.ListNotebookInstances" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListNotebookInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "notebookInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotebookInstanceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListNotebookInstancesResponse

Arguments

:: Int

$sel:httpStatus:ListNotebookInstancesResponse'

-> ListNotebookInstancesResponse

Create a value of ListNotebookInstancesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListNotebookInstances, listNotebookInstancesResponse_nextToken - If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

$sel:notebookInstances:ListNotebookInstancesResponse', listNotebookInstancesResponse_notebookInstances - An array of NotebookInstanceSummary objects, one for each notebook instance.

$sel:httpStatus:ListNotebookInstancesResponse', listNotebookInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listNotebookInstancesResponse_nextToken :: Lens' ListNotebookInstancesResponse (Maybe Text)

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

listNotebookInstancesResponse_notebookInstances :: Lens' ListNotebookInstancesResponse (Maybe [NotebookInstanceSummary])

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

listNotebookInstancesResponse_httpStatus :: Lens' ListNotebookInstancesResponse Int

The response's http status code.