Network.AWS.SageMaker.ListNotebookInstances

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

This operation returns paginated results.

Creating a Request

listNotebookInstances :: ListNotebookInstances

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

See: listNotebookInstances smart constructor.

Instances

Eq ListNotebookInstances

Methods

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

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

Data 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

Methods

readsPrec :: Int -> ReadS ListNotebookInstances

readList :: ReadS [ListNotebookInstances]

readPrec :: ReadPrec ListNotebookInstances

readListPrec :: ReadPrec [ListNotebookInstances]

Show ListNotebookInstances

Methods

showsPrec :: Int -> ListNotebookInstances -> ShowS

show :: ListNotebookInstances -> String

showList :: [ListNotebookInstances] -> ShowS

Generic ListNotebookInstances

Associated Types

type Rep ListNotebookInstances :: * -> *

Methods

from :: ListNotebookInstances -> Rep ListNotebookInstances x

to :: Rep ListNotebookInstances x -> ListNotebookInstances

Hashable ListNotebookInstances

Methods

hashWithSalt :: Int -> ListNotebookInstances -> Int

hash :: ListNotebookInstances -> Int

ToJSON ListNotebookInstances

Methods

toJSON :: ListNotebookInstances -> Value

toEncoding :: ListNotebookInstances -> Encoding

toJSONList :: [ListNotebookInstances] -> Value

toEncodingList :: [ListNotebookInstances] -> Encoding

NFData ListNotebookInstances

Methods

rnf :: ListNotebookInstances -> ()

AWSPager ListNotebookInstances

Methods

page :: ListNotebookInstances -> Rs ListNotebookInstances -> Maybe ListNotebookInstances

AWSRequest ListNotebookInstances

Associated Types

type Rs ListNotebookInstances :: *

Methods

request :: ListNotebookInstances -> Request ListNotebookInstances

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListNotebookInstances -> ClientResponse -> m (Response ListNotebookInstances)

ToHeaders ListNotebookInstances

Methods

toHeaders :: ListNotebookInstances -> [Header]

ToPath ListNotebookInstances

Methods

toPath :: ListNotebookInstances -> ByteString

ToQuery ListNotebookInstances

Methods

toQuery :: ListNotebookInstances -> QueryString

type Rep ListNotebookInstances

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

type Rs ListNotebookInstances

type Rs ListNotebookInstances = ListNotebookInstancesResponse

Request Lenses

lniNameContains :: Lens' ListNotebookInstances (Maybe Text)

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

lniLastModifiedTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime)

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

lniNotebookInstanceLifecycleConfigNameContains :: 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.

lniCreationTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime)

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

lniNextToken :: 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.

lniSortOrder :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortOrder)

The sort order for results.

lniLastModifiedTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime)

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

lniCreationTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime)

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

lniStatusEquals :: Lens' ListNotebookInstances (Maybe NotebookInstanceStatus)

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

lniMaxResults :: Lens' ListNotebookInstances (Maybe Natural)

The maximum number of notebook instances to return.

lniSortBy :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortKey)

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

Destructuring the Response

listNotebookInstancesResponse

Arguments

:: Int

lnirsResponseStatus

-> ListNotebookInstancesResponse

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

See: listNotebookInstancesResponse smart constructor.

Instances

Eq ListNotebookInstancesResponse

Methods

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

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

Data ListNotebookInstancesResponse

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

Methods

readsPrec :: Int -> ReadS ListNotebookInstancesResponse

readList :: ReadS [ListNotebookInstancesResponse]

readPrec :: ReadPrec ListNotebookInstancesResponse

readListPrec :: ReadPrec [ListNotebookInstancesResponse]

Show ListNotebookInstancesResponse

Methods

showsPrec :: Int -> ListNotebookInstancesResponse -> ShowS

show :: ListNotebookInstancesResponse -> String

showList :: [ListNotebookInstancesResponse] -> ShowS

Generic ListNotebookInstancesResponse

Associated Types

type Rep ListNotebookInstancesResponse :: * -> *

Methods

from :: ListNotebookInstancesResponse -> Rep ListNotebookInstancesResponse x

to :: Rep ListNotebookInstancesResponse x -> ListNotebookInstancesResponse

NFData ListNotebookInstancesResponse

Methods

rnf :: ListNotebookInstancesResponse -> ()

type Rep ListNotebookInstancesResponse

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

Response Lenses

lnirsNotebookInstances :: Lens' ListNotebookInstancesResponse [NotebookInstanceSummary]

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

lnirsNextToken :: Lens' ListNotebookInstancesResponse (Maybe Text)

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 :: Lens' ListNotebookInstancesResponse Int

• - | The response status code.