amazonka-sagemaker-1.6.1: Amazon SageMaker Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SageMaker.ListNotebookInstances

Contents

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

listNotebookInstances :: ListNotebookInstances Source #

Creates a value of ListNotebookInstances with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lniNameContains - A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
  • lniLastModifiedTimeBefore - A filter that returns only notebook instances that were modified before the specified time (timestamp).
  • lniNotebookInstanceLifecycleConfigNameContains - 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.
  • lniCreationTimeAfter - A filter that returns only notebook instances that were created after the specified time (timestamp).
  • lniNextToken - 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.
  • lniSortOrder - The sort order for results.
  • lniLastModifiedTimeAfter - A filter that returns only notebook instances that were modified after the specified time (timestamp).
  • lniCreationTimeBefore - A filter that returns only notebook instances that were created before the specified time (timestamp).
  • lniStatusEquals - A filter that returns only notebook instances with the specified status.
  • lniMaxResults - The maximum number of notebook instances to return.
  • lniSortBy - The field to sort results by. The default is Name .

data ListNotebookInstances Source #

See: listNotebookInstances smart constructor.

Instances
Eq ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Data ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListNotebookInstances -> c ListNotebookInstances #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListNotebookInstances #

toConstr :: ListNotebookInstances -> Constr #

dataTypeOf :: ListNotebookInstances -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListNotebookInstances) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListNotebookInstances) #

gmapT :: (forall b. Data b => b -> b) -> ListNotebookInstances -> ListNotebookInstances #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListNotebookInstances -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListNotebookInstances -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListNotebookInstances -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListNotebookInstances -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListNotebookInstances -> m ListNotebookInstances #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListNotebookInstances -> m ListNotebookInstances #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListNotebookInstances -> m ListNotebookInstances #

Read ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Show ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Generic ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Associated Types

type Rep ListNotebookInstances :: Type -> Type #

Hashable ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

ToJSON ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

AWSPager ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

AWSRequest ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Associated Types

type Rs ListNotebookInstances :: Type #

ToHeaders ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

ToPath ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

ToQuery ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

NFData ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Methods

rnf :: ListNotebookInstances -> () #

type Rep ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

type Rep ListNotebookInstances = D1 (MetaData "ListNotebookInstances" "Network.AWS.SageMaker.ListNotebookInstances" "amazonka-sagemaker-1.6.1-KSR3FgWuE9u23bvJsHopKu" False) (C1 (MetaCons "ListNotebookInstances'" PrefixI True) (((S1 (MetaSel (Just "_lniNameContains") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lniLastModifiedTimeBefore") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_lniNotebookInstanceLifecycleConfigNameContains") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lniCreationTimeAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_lniNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_lniSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NotebookInstanceSortOrder)) :*: (S1 (MetaSel (Just "_lniLastModifiedTimeAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_lniCreationTimeBefore") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 (MetaSel (Just "_lniStatusEquals") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NotebookInstanceStatus)) :*: (S1 (MetaSel (Just "_lniMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_lniSortBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NotebookInstanceSortKey)))))))
type Rs ListNotebookInstances Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Request Lenses

lniNameContains :: Lens' ListNotebookInstances (Maybe Text) Source #

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

lniLastModifiedTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

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

lniNotebookInstanceLifecycleConfigNameContains :: Lens' ListNotebookInstances (Maybe Text) Source #

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.

lniCreationTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

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

lniNextToken :: Lens' ListNotebookInstances (Maybe Text) Source #

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.

lniLastModifiedTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

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

lniCreationTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

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

lniStatusEquals :: Lens' ListNotebookInstances (Maybe NotebookInstanceStatus) Source #

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

lniMaxResults :: Lens' ListNotebookInstances (Maybe Natural) Source #

The maximum number of notebook instances to return.

lniSortBy :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortKey) Source #

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

Destructuring the Response

listNotebookInstancesResponse Source #

Creates a value of ListNotebookInstancesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lnirsNotebookInstances - An array of NotebookInstanceSummary objects, one for each notebook instance.
  • lnirsNextToken - If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.
  • lnirsResponseStatus - -- | The response status code.

data ListNotebookInstancesResponse Source #

See: listNotebookInstancesResponse smart constructor.

Instances
Eq ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Data ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListNotebookInstancesResponse -> c ListNotebookInstancesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListNotebookInstancesResponse #

toConstr :: ListNotebookInstancesResponse -> Constr #

dataTypeOf :: ListNotebookInstancesResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListNotebookInstancesResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListNotebookInstancesResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListNotebookInstancesResponse -> ListNotebookInstancesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListNotebookInstancesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListNotebookInstancesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListNotebookInstancesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListNotebookInstancesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListNotebookInstancesResponse -> m ListNotebookInstancesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListNotebookInstancesResponse -> m ListNotebookInstancesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListNotebookInstancesResponse -> m ListNotebookInstancesResponse #

Read ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Show ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Generic ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

Associated Types

type Rep ListNotebookInstancesResponse :: Type -> Type #

NFData ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

type Rep ListNotebookInstancesResponse Source # 
Instance details

Defined in Network.AWS.SageMaker.ListNotebookInstances

type Rep ListNotebookInstancesResponse = D1 (MetaData "ListNotebookInstancesResponse" "Network.AWS.SageMaker.ListNotebookInstances" "amazonka-sagemaker-1.6.1-KSR3FgWuE9u23bvJsHopKu" False) (C1 (MetaCons "ListNotebookInstancesResponse'" PrefixI True) (S1 (MetaSel (Just "_lnirsNotebookInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [NotebookInstanceSummary])) :*: (S1 (MetaSel (Just "_lnirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lnirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lnirsNotebookInstances :: Lens' ListNotebookInstancesResponse [NotebookInstanceSummary] Source #

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

lnirsNextToken :: Lens' ListNotebookInstancesResponse (Maybe Text) Source #

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