Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.ListContexts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the contexts in your account and their properties.

This operation returns paginated results.

Synopsis

data ListContexts = ListContexts' {
- contextType :: Maybe Text
- createdAfter :: Maybe POSIX
- createdBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortContextsBy
- sortOrder :: Maybe SortOrder
- sourceUri :: Maybe Text
}
newListContexts :: ListContexts
listContexts_contextType :: Lens' ListContexts (Maybe Text)
listContexts_createdAfter :: Lens' ListContexts (Maybe UTCTime)
listContexts_createdBefore :: Lens' ListContexts (Maybe UTCTime)
listContexts_maxResults :: Lens' ListContexts (Maybe Natural)
listContexts_nextToken :: Lens' ListContexts (Maybe Text)
listContexts_sortBy :: Lens' ListContexts (Maybe SortContextsBy)
listContexts_sortOrder :: Lens' ListContexts (Maybe SortOrder)
listContexts_sourceUri :: Lens' ListContexts (Maybe Text)
data ListContextsResponse = ListContextsResponse' {
- contextSummaries :: Maybe [ContextSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListContextsResponse :: Int -> ListContextsResponse
listContextsResponse_contextSummaries :: Lens' ListContextsResponse (Maybe [ContextSummary])
listContextsResponse_nextToken :: Lens' ListContextsResponse (Maybe Text)
listContextsResponse_httpStatus :: Lens' ListContextsResponse Int

Creating a Request

data ListContexts Source #

See: newListContexts smart constructor.

Constructors

ListContexts'

Fields

contextType :: Maybe Text
A filter that returns only contexts of the specified type.
createdAfter :: Maybe POSIX
A filter that returns only contexts created on or after the specified time.
createdBefore :: Maybe POSIX
A filter that returns only contexts created on or before the specified time.
maxResults :: Maybe Natural
The maximum number of contexts to return in the response. The default value is 10.
nextToken :: Maybe Text
If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
sortBy :: Maybe SortContextsBy
The property used to sort results. The default value is CreationTime.
sortOrder :: Maybe SortOrder
The sort order. The default value is Descending.
sourceUri :: Maybe Text
A filter that returns only contexts with the specified source URI.

Instances

Instances details

ToJSON ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods toJSON :: ListContexts -> Value # toEncoding :: ListContexts -> Encoding # toJSONList :: [ListContexts] -> Value # toEncodingList :: [ListContexts] -> Encoding #
ToHeaders ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods toHeaders :: ListContexts -> [Header] #
ToPath ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods toPath :: ListContexts -> ByteString #
ToQuery ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods toQuery :: ListContexts -> QueryString #
AWSPager ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods page :: ListContexts -> AWSResponse ListContexts -> Maybe ListContexts #
AWSRequest ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Associated Types type AWSResponse ListContexts # Methods request :: (Service -> Service) -> ListContexts -> Request ListContexts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListContexts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListContexts))) #
Generic ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Associated Types type Rep ListContexts :: Type -> Type # Methods from :: ListContexts -> Rep ListContexts x # to :: Rep ListContexts x -> ListContexts #
Read ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods readsPrec :: Int -> ReadS ListContexts # readList :: ReadS [ListContexts] # readPrec :: ReadPrec ListContexts # readListPrec :: ReadPrec [ListContexts] #
Show ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods showsPrec :: Int -> ListContexts -> ShowS # show :: ListContexts -> String # showList :: [ListContexts] -> ShowS #
NFData ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods rnf :: ListContexts -> () #
Eq ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods (==) :: ListContexts -> ListContexts -> Bool # (/=) :: ListContexts -> ListContexts -> Bool #
Hashable ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods hashWithSalt :: Int -> ListContexts -> Int # hash :: ListContexts -> Int #
type AWSResponse ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts type AWSResponse ListContexts = ListContextsResponse
type Rep ListContexts Source #
Instance details Defined in Amazonka.SageMaker.ListContexts type Rep ListContexts = D1 ('MetaData "ListContexts" "Amazonka.SageMaker.ListContexts" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListContexts'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "contextType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "createdBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortContextsBy))) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "sourceUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListContexts :: ListContexts Source #

Create a value of ListContexts 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:

ListContexts, listContexts_contextType - A filter that returns only contexts of the specified type.

ListContexts, listContexts_createdAfter - A filter that returns only contexts created on or after the specified time.

ListContexts, listContexts_createdBefore - A filter that returns only contexts created on or before the specified time.

$sel:maxResults:ListContexts', listContexts_maxResults - The maximum number of contexts to return in the response. The default value is 10.

ListContexts, listContexts_nextToken - If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.

$sel:sortBy:ListContexts', listContexts_sortBy - The property used to sort results. The default value is CreationTime.

$sel:sortOrder:ListContexts', listContexts_sortOrder - The sort order. The default value is Descending.

ListContexts, listContexts_sourceUri - A filter that returns only contexts with the specified source URI.

Request Lenses

listContexts_contextType :: Lens' ListContexts (Maybe Text) Source #

A filter that returns only contexts of the specified type.

listContexts_createdAfter :: Lens' ListContexts (Maybe UTCTime) Source #

A filter that returns only contexts created on or after the specified time.

listContexts_createdBefore :: Lens' ListContexts (Maybe UTCTime) Source #

A filter that returns only contexts created on or before the specified time.

listContexts_maxResults :: Lens' ListContexts (Maybe Natural) Source #

The maximum number of contexts to return in the response. The default value is 10.

listContexts_nextToken :: Lens' ListContexts (Maybe Text) Source #

If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.

listContexts_sortBy :: Lens' ListContexts (Maybe SortContextsBy) Source #

The property used to sort results. The default value is CreationTime.

listContexts_sortOrder :: Lens' ListContexts (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listContexts_sourceUri :: Lens' ListContexts (Maybe Text) Source #

A filter that returns only contexts with the specified source URI.

Destructuring the Response

data ListContextsResponse Source #

See: newListContextsResponse smart constructor.

Constructors

ListContextsResponse'
Fields contextSummaries :: Maybe [ContextSummary] A list of contexts and their properties. nextToken :: Maybe Text A token for getting the next set of contexts, if there are any. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListContextsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Associated Types type Rep ListContextsResponse :: Type -> Type # Methods from :: ListContextsResponse -> Rep ListContextsResponse x # to :: Rep ListContextsResponse x -> ListContextsResponse #
Read ListContextsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods readsPrec :: Int -> ReadS ListContextsResponse # readList :: ReadS [ListContextsResponse] # readPrec :: ReadPrec ListContextsResponse # readListPrec :: ReadPrec [ListContextsResponse] #
Show ListContextsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods showsPrec :: Int -> ListContextsResponse -> ShowS # show :: ListContextsResponse -> String # showList :: [ListContextsResponse] -> ShowS #
NFData ListContextsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods rnf :: ListContextsResponse -> () #
Eq ListContextsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListContexts Methods (==) :: ListContextsResponse -> ListContextsResponse -> Bool # (/=) :: ListContextsResponse -> ListContextsResponse -> Bool #
type Rep ListContextsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListContexts type Rep ListContextsResponse = D1 ('MetaData "ListContextsResponse" "Amazonka.SageMaker.ListContexts" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListContextsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contextSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContextSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListContextsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListContextsResponse'`
-> ListContextsResponse

Create a value of ListContextsResponse 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:contextSummaries:ListContextsResponse', listContextsResponse_contextSummaries - A list of contexts and their properties.

ListContexts, listContextsResponse_nextToken - A token for getting the next set of contexts, if there are any.

$sel:httpStatus:ListContextsResponse', listContextsResponse_httpStatus - The response's http status code.

Response Lenses

listContextsResponse_contextSummaries :: Lens' ListContextsResponse (Maybe [ContextSummary]) Source #

A list of contexts and their properties.

listContextsResponse_nextToken :: Lens' ListContextsResponse (Maybe Text) Source #

A token for getting the next set of contexts, if there are any.

listContextsResponse_httpStatus :: Lens' ListContextsResponse Int Source #

The response's http status code.