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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list or web portals.

Synopsis

Creating a Request

data ListPortals Source #

See: newListPortals smart constructor.

Constructors

ListPortals'
Fields maxResults :: Maybe Natural The maximum number of results to be included in the next page. nextToken :: Maybe Text The pagination token used to retrieve the next page of results for this operation.

Instances

Instances details

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

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:maxResults:ListPortals', listPortals_maxResults - The maximum number of results to be included in the next page.

ListPortals, listPortals_nextToken - The pagination token used to retrieve the next page of results for this operation.

Request Lenses

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

The maximum number of results to be included in the next page.

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

The pagination token used to retrieve the next page of results for this operation.

Destructuring the Response

data ListPortalsResponse Source #

See: newListPortalsResponse smart constructor.

Constructors

ListPortalsResponse'
Fields nextToken :: Maybe Text The pagination token used to retrieve the next page of results for this operation. portals :: Maybe [PortalSummary] The portals in the list. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListPortalsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.ListPortals Associated Types type Rep ListPortalsResponse :: Type -> Type # Methods from :: ListPortalsResponse -> Rep ListPortalsResponse x # to :: Rep ListPortalsResponse x -> ListPortalsResponse #
Show ListPortalsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.ListPortals Methods showsPrec :: Int -> ListPortalsResponse -> ShowS # show :: ListPortalsResponse -> String # showList :: [ListPortalsResponse] -> ShowS #
NFData ListPortalsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.ListPortals Methods rnf :: ListPortalsResponse -> () #
Eq ListPortalsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.ListPortals Methods (==) :: ListPortalsResponse -> ListPortalsResponse -> Bool # (/=) :: ListPortalsResponse -> ListPortalsResponse -> Bool #
type Rep ListPortalsResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.ListPortals type Rep ListPortalsResponse = D1 ('MetaData "ListPortalsResponse" "Amazonka.WorkSpacesWeb.ListPortals" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "ListPortalsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "portals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PortalSummary])) :: 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:

ListPortals, listPortalsResponse_nextToken - The pagination token used to retrieve the next page of results for this operation.

$sel:portals:ListPortalsResponse', listPortalsResponse_portals - The portals in the list.

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

Response Lenses

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

The pagination token used to retrieve the next page of results for this operation.

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

The portals in the list.

listPortalsResponse_httpStatus :: Lens' ListPortalsResponse Int Source #

The response's http status code.