Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.ListProjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

This operation returns paginated results.

Creating a Request

data ListProjects Source #

See: newListProjects smart constructor.

Constructors

ListProjects'
Fields nextToken :: Maybe Text The token to be used for the next set of paginated results. maxResults :: Maybe Natural The maximum number of results to return for each paginated request. Default: 50 portalId :: Text The ID of the portal.

Instances

Instances details

Eq ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods (==) :: ListProjects -> ListProjects -> Bool # (/=) :: ListProjects -> ListProjects -> Bool #
Read ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods readsPrec :: Int -> ReadS ListProjects # readList :: ReadS [ListProjects] # readPrec :: ReadPrec ListProjects # readListPrec :: ReadPrec [ListProjects] #
Show ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods showsPrec :: Int -> ListProjects -> ShowS # show :: ListProjects -> String # showList :: [ListProjects] -> ShowS #
Generic ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Associated Types type Rep ListProjects :: Type -> Type # Methods from :: ListProjects -> Rep ListProjects x # to :: Rep ListProjects x -> ListProjects #
NFData ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods rnf :: ListProjects -> () #
Hashable ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods hashWithSalt :: Int -> ListProjects -> Int # hash :: ListProjects -> Int #
AWSPager ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods page :: ListProjects -> AWSResponse ListProjects -> Maybe ListProjects #
AWSRequest ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Associated Types type AWSResponse ListProjects # Methods request :: ListProjects -> Request ListProjects # response :: MonadResource m => Logger -> Service -> Proxy ListProjects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListProjects))) #
ToHeaders ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods toHeaders :: ListProjects -> [Header] #
ToPath ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods toPath :: ListProjects -> ByteString #
ToQuery ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods toQuery :: ListProjects -> QueryString #
type Rep ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects type Rep ListProjects = D1 ('MetaData "ListProjects" "Amazonka.IoTSiteWise.ListProjects" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "ListProjects'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "portalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListProjects Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects type AWSResponse ListProjects = ListProjectsResponse

newListProjects Source #

Arguments

:: Text	`$sel:portalId:ListProjects'`
-> ListProjects

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:nextToken:ListProjects', listProjects_nextToken - The token to be used for the next set of paginated results.

$sel:maxResults:ListProjects', listProjects_maxResults - The maximum number of results to return for each paginated request.

Default: 50

$sel:portalId:ListProjects', listProjects_portalId - The ID of the portal.

Request Lenses

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

The token to be used for the next set of paginated results.

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

The maximum number of results to return for each paginated request.

Default: 50

listProjects_portalId :: Lens' ListProjects Text Source #

The ID of the portal.

Destructuring the Response

data ListProjectsResponse Source #

See: newListProjectsResponse smart constructor.

Constructors

ListProjectsResponse'
Fields nextToken :: Maybe Text The token for the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code. projectSummaries :: [ProjectSummary] A list that summarizes each project in the portal.

Instances

Instances details

Eq ListProjectsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods (==) :: ListProjectsResponse -> ListProjectsResponse -> Bool # (/=) :: ListProjectsResponse -> ListProjectsResponse -> Bool #
Read ListProjectsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods readsPrec :: Int -> ReadS ListProjectsResponse # readList :: ReadS [ListProjectsResponse] # readPrec :: ReadPrec ListProjectsResponse # readListPrec :: ReadPrec [ListProjectsResponse] #
Show ListProjectsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods showsPrec :: Int -> ListProjectsResponse -> ShowS # show :: ListProjectsResponse -> String # showList :: [ListProjectsResponse] -> ShowS #
Generic ListProjectsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Associated Types type Rep ListProjectsResponse :: Type -> Type # Methods from :: ListProjectsResponse -> Rep ListProjectsResponse x # to :: Rep ListProjectsResponse x -> ListProjectsResponse #
NFData ListProjectsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects Methods rnf :: ListProjectsResponse -> () #
type Rep ListProjectsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListProjects type Rep ListProjectsResponse = D1 ('MetaData "ListProjectsResponse" "Amazonka.IoTSiteWise.ListProjects" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" '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 "projectSummaries") '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:

$sel:nextToken:ListProjects', listProjectsResponse_nextToken - The token for the next set of results, or null if there are no additional results.

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

$sel:projectSummaries:ListProjectsResponse', listProjectsResponse_projectSummaries - A list that summarizes each project in the portal.

Response Lenses

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

The token for the next set of results, or null if there are no additional results.

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #

The response's http status code.

listProjectsResponse_projectSummaries :: Lens' ListProjectsResponse [ProjectSummary] Source #

A list that summarizes each project in the portal.