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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of IoT SiteWise Monitor portals.

This operation returns paginated results.

Creating a Request

data ListPortals Source #

See: newListPortals smart constructor.

Constructors

ListPortals'
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

Instances

Instances details

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

newListPortals :: ListPortals Source #

Create a value of ListPortals 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:ListPortals', listPortals_nextToken - The token to be used for the next set of paginated results.

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

Default: 50

Request Lenses

listPortals_nextToken :: Lens' ListPortals (Maybe Text) Source #

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

listPortals_maxResults :: Lens' ListPortals (Maybe Natural) Source #

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

Default: 50

Destructuring the Response

data ListPortalsResponse Source #

See: newListPortalsResponse smart constructor.

Constructors

ListPortalsResponse'
Fields portalSummaries :: Maybe [PortalSummary] A list that summarizes each portal. 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.

Instances

Instances details

Eq ListPortalsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListPortals Methods (==) :: ListPortalsResponse -> ListPortalsResponse -> Bool # (/=) :: ListPortalsResponse -> ListPortalsResponse -> Bool #
Read ListPortalsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListPortals Methods readsPrec :: Int -> ReadS ListPortalsResponse # readList :: ReadS [ListPortalsResponse] # readPrec :: ReadPrec ListPortalsResponse # readListPrec :: ReadPrec [ListPortalsResponse] #
Show ListPortalsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListPortals Methods showsPrec :: Int -> ListPortalsResponse -> ShowS # show :: ListPortalsResponse -> String # showList :: [ListPortalsResponse] -> ShowS #
Generic ListPortalsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListPortals Associated Types type Rep ListPortalsResponse :: Type -> Type # Methods from :: ListPortalsResponse -> Rep ListPortalsResponse x # to :: Rep ListPortalsResponse x -> ListPortalsResponse #
NFData ListPortalsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListPortals Methods rnf :: ListPortalsResponse -> () #
type Rep ListPortalsResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.ListPortals type Rep ListPortalsResponse = D1 ('MetaData "ListPortalsResponse" "Amazonka.IoTSiteWise.ListPortals" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "ListPortalsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "portalSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PortalSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPortalsResponse Source #

Arguments

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

Create a value of ListPortalsResponse 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:portalSummaries:ListPortalsResponse', listPortalsResponse_portalSummaries - A list that summarizes each portal.

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

$sel:httpStatus:ListPortalsResponse', listPortalsResponse_httpStatus - The response's http status code.

Response Lenses

listPortalsResponse_portalSummaries :: Lens' ListPortalsResponse (Maybe [PortalSummary]) Source #

A list that summarizes each portal.

listPortalsResponse_nextToken :: Lens' ListPortalsResponse (Maybe Text) Source #

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

listPortalsResponse_httpStatus :: Lens' ListPortalsResponse Int Source #

The response's http status code.