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.ListProjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the projects in an Amazon Web Services account.

Synopsis

data ListProjects = ListProjects' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe ProjectSortBy
- sortOrder :: Maybe ProjectSortOrder
}
newListProjects :: ListProjects
listProjects_creationTimeAfter :: Lens' ListProjects (Maybe UTCTime)
listProjects_creationTimeBefore :: Lens' ListProjects (Maybe UTCTime)
listProjects_maxResults :: Lens' ListProjects (Maybe Natural)
listProjects_nameContains :: Lens' ListProjects (Maybe Text)
listProjects_nextToken :: Lens' ListProjects (Maybe Text)
listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortBy)
listProjects_sortOrder :: Lens' ListProjects (Maybe ProjectSortOrder)
data ListProjectsResponse = ListProjectsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- projectSummaryList :: [ProjectSummary]
}
newListProjectsResponse :: Int -> ListProjectsResponse
listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)
listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int
listProjectsResponse_projectSummaryList :: Lens' ListProjectsResponse [ProjectSummary]

Creating a Request

data ListProjects Source #

See: newListProjects smart constructor.

Constructors

ListProjects'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns the projects that were created after a specified time.
creationTimeBefore :: Maybe POSIX
A filter that returns the projects that were created before a specified time.
maxResults :: Maybe Natural
The maximum number of projects to return in the response.
nameContains :: Maybe Text
A filter that returns the projects whose name contains a specified string.
nextToken :: Maybe Text
If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
sortBy :: Maybe ProjectSortBy
The field by which to sort results. The default is CreationTime.
sortOrder :: Maybe ProjectSortOrder
The sort order for results. The default is Ascending.

Instances

Instances details

ToJSON ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods toJSON :: ListProjects -> Value # toEncoding :: ListProjects -> Encoding # toJSONList :: [ListProjects] -> Value # toEncodingList :: [ListProjects] -> Encoding #
ToHeaders ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods toHeaders :: ListProjects -> [Header] #
ToPath ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods toPath :: ListProjects -> ByteString #
ToQuery ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods toQuery :: ListProjects -> QueryString #
AWSRequest ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Associated Types type AWSResponse ListProjects # Methods request :: (Service -> Service) -> ListProjects -> Request ListProjects # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListProjects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListProjects))) #
Generic ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Associated Types type Rep ListProjects :: Type -> Type # Methods from :: ListProjects -> Rep ListProjects x # to :: Rep ListProjects x -> ListProjects #
Read ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods readsPrec :: Int -> ReadS ListProjects # readList :: ReadS [ListProjects] # readPrec :: ReadPrec ListProjects # readListPrec :: ReadPrec [ListProjects] #
Show ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods showsPrec :: Int -> ListProjects -> ShowS # show :: ListProjects -> String # showList :: [ListProjects] -> ShowS #
NFData ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods rnf :: ListProjects -> () #
Eq ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods (==) :: ListProjects -> ListProjects -> Bool # (/=) :: ListProjects -> ListProjects -> Bool #
Hashable ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects Methods hashWithSalt :: Int -> ListProjects -> Int # hash :: ListProjects -> Int #
type AWSResponse ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects type AWSResponse ListProjects = ListProjectsResponse
type Rep ListProjects Source #
Instance details Defined in Amazonka.SageMaker.ListProjects type Rep ListProjects = D1 ('MetaData "ListProjects" "Amazonka.SageMaker.ListProjects" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListProjects'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "creationTimeBefore") '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 "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectSortBy)) :: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectSortOrder))))))

newListProjects :: ListProjects Source #

Create a value of ListProjects 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:creationTimeAfter:ListProjects', listProjects_creationTimeAfter - A filter that returns the projects that were created after a specified time.

$sel:creationTimeBefore:ListProjects', listProjects_creationTimeBefore - A filter that returns the projects that were created before a specified time.

$sel:maxResults:ListProjects', listProjects_maxResults - The maximum number of projects to return in the response.

$sel:nameContains:ListProjects', listProjects_nameContains - A filter that returns the projects whose name contains a specified string.

ListProjects, listProjects_nextToken - If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

$sel:sortBy:ListProjects', listProjects_sortBy - The field by which to sort results. The default is CreationTime.

$sel:sortOrder:ListProjects', listProjects_sortOrder - The sort order for results. The default is Ascending.

Request Lenses

listProjects_creationTimeAfter :: Lens' ListProjects (Maybe UTCTime) Source #

A filter that returns the projects that were created after a specified time.

listProjects_creationTimeBefore :: Lens' ListProjects (Maybe UTCTime) Source #

A filter that returns the projects that were created before a specified time.

listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #

The maximum number of projects to return in the response.

listProjects_nameContains :: Lens' ListProjects (Maybe Text) Source #

A filter that returns the projects whose name contains a specified string.

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortBy) Source #

The field by which to sort results. The default is CreationTime.

listProjects_sortOrder :: Lens' ListProjects (Maybe ProjectSortOrder) Source #

The sort order for results. The default is Ascending.

Destructuring the Response

data ListProjectsResponse Source #

See: newListProjectsResponse smart constructor.

Constructors

ListProjectsResponse'
Fields nextToken :: Maybe Text If the result of the previous `ListCompilationJobs` request was truncated, the response includes a `NextToken`. To retrieve the next set of model compilation jobs, use the token in the next request. httpStatus :: Int The response's http status code. projectSummaryList :: [ProjectSummary] A list of summaries of projects.

Instances

Instances details

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

newListProjectsResponse Source #

Arguments

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

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

ListProjects, listProjectsResponse_nextToken - If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.

$sel:projectSummaryList:ListProjectsResponse', listProjectsResponse_projectSummaryList - A list of summaries of projects.

Response Lenses

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #

The response's http status code.

listProjectsResponse_projectSummaryList :: Lens' ListProjectsResponse [ProjectSummary] Source #

A list of summaries of projects.