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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the web portal.

Synopsis

data GetPortal = GetPortal' {
- portalArn :: Text
}
newGetPortal :: Text -> GetPortal
getPortal_portalArn :: Lens' GetPortal Text
data GetPortalResponse = GetPortalResponse' {
- portal :: Maybe Portal
- httpStatus :: Int
}
newGetPortalResponse :: Int -> GetPortalResponse
getPortalResponse_portal :: Lens' GetPortalResponse (Maybe Portal)
getPortalResponse_httpStatus :: Lens' GetPortalResponse Int

Creating a Request

data GetPortal Source #

See: newGetPortal smart constructor.

Constructors

GetPortal'
Fields portalArn :: Text The ARN of the web portal.

Instances

Instances details

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

newGetPortal Source #

Arguments

:: Text	`GetPortal`
-> GetPortal

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

GetPortal, getPortal_portalArn - The ARN of the web portal.

Request Lenses

getPortal_portalArn :: Lens' GetPortal Text Source #

The ARN of the web portal.

Destructuring the Response

data GetPortalResponse Source #

See: newGetPortalResponse smart constructor.

Constructors

GetPortalResponse'
Fields portal :: Maybe Portal The web portal. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetPortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.GetPortal Associated Types type Rep GetPortalResponse :: Type -> Type # Methods from :: GetPortalResponse -> Rep GetPortalResponse x # to :: Rep GetPortalResponse x -> GetPortalResponse #
Show GetPortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.GetPortal Methods showsPrec :: Int -> GetPortalResponse -> ShowS # show :: GetPortalResponse -> String # showList :: [GetPortalResponse] -> ShowS #
NFData GetPortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.GetPortal Methods rnf :: GetPortalResponse -> () #
Eq GetPortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.GetPortal Methods (==) :: GetPortalResponse -> GetPortalResponse -> Bool # (/=) :: GetPortalResponse -> GetPortalResponse -> Bool #
type Rep GetPortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.GetPortal type Rep GetPortalResponse = D1 ('MetaData "GetPortalResponse" "Amazonka.WorkSpacesWeb.GetPortal" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "GetPortalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "portal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Portal)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetPortalResponse Source #

Arguments

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

Create a value of GetPortalResponse 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:portal:GetPortalResponse', getPortalResponse_portal - The web portal.

$sel:httpStatus:GetPortalResponse', getPortalResponse_httpStatus - The response's http status code.

Response Lenses

getPortalResponse_portal :: Lens' GetPortalResponse (Maybe Portal) Source #

The web portal.

getPortalResponse_httpStatus :: Lens' GetPortalResponse Int Source #

The response's http status code.