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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a web portal.

Synopsis

data CreatePortal = CreatePortal' {
- additionalEncryptionContext :: Maybe (HashMap Text Text)
- clientToken :: Maybe Text
- customerManagedKey :: Maybe Text
- displayName :: Maybe (Sensitive Text)
- tags :: Maybe [Sensitive Tag]
}
newCreatePortal :: CreatePortal
createPortal_additionalEncryptionContext :: Lens' CreatePortal (Maybe (HashMap Text Text))
createPortal_clientToken :: Lens' CreatePortal (Maybe Text)
createPortal_customerManagedKey :: Lens' CreatePortal (Maybe Text)
createPortal_displayName :: Lens' CreatePortal (Maybe Text)
createPortal_tags :: Lens' CreatePortal (Maybe [Tag])
data CreatePortalResponse = CreatePortalResponse' {
- httpStatus :: Int
- portalArn :: Text
- portalEndpoint :: Text
}
newCreatePortalResponse :: Int -> Text -> Text -> CreatePortalResponse
createPortalResponse_httpStatus :: Lens' CreatePortalResponse Int
createPortalResponse_portalArn :: Lens' CreatePortalResponse Text
createPortalResponse_portalEndpoint :: Lens' CreatePortalResponse Text

Creating a Request

data CreatePortal Source #

See: newCreatePortal smart constructor.

Constructors

CreatePortal'

Fields

additionalEncryptionContext :: Maybe (HashMap Text Text)
The additional encryption context of the portal.
clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
customerManagedKey :: Maybe Text
The customer managed key of the web portal.
displayName :: Maybe (Sensitive Text)
The name of the web portal. This is not visible to users who log into the web portal.
tags :: Maybe [Sensitive Tag]
The tags to add to the web portal. A tag is a key-value pair.

Instances

Instances details

ToJSON CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods toJSON :: CreatePortal -> Value # toEncoding :: CreatePortal -> Encoding # toJSONList :: [CreatePortal] -> Value # toEncodingList :: [CreatePortal] -> Encoding #
ToHeaders CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods toHeaders :: CreatePortal -> [Header] #
ToPath CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods toPath :: CreatePortal -> ByteString #
ToQuery CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods toQuery :: CreatePortal -> QueryString #
AWSRequest CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Associated Types type AWSResponse CreatePortal # Methods request :: (Service -> Service) -> CreatePortal -> Request CreatePortal # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePortal -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePortal))) #
Generic CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Associated Types type Rep CreatePortal :: Type -> Type # Methods from :: CreatePortal -> Rep CreatePortal x # to :: Rep CreatePortal x -> CreatePortal #
Show CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods showsPrec :: Int -> CreatePortal -> ShowS # show :: CreatePortal -> String # showList :: [CreatePortal] -> ShowS #
NFData CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods rnf :: CreatePortal -> () #
Eq CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods (==) :: CreatePortal -> CreatePortal -> Bool # (/=) :: CreatePortal -> CreatePortal -> Bool #
Hashable CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods hashWithSalt :: Int -> CreatePortal -> Int # hash :: CreatePortal -> Int #
type AWSResponse CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal type AWSResponse CreatePortal = CreatePortalResponse
type Rep CreatePortal Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal type Rep CreatePortal = D1 ('MetaData "CreatePortal" "Amazonka.WorkSpacesWeb.CreatePortal" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "CreatePortal'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerManagedKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sensitive Tag]))))))

newCreatePortal :: CreatePortal Source #

Create a value of CreatePortal 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:additionalEncryptionContext:CreatePortal', createPortal_additionalEncryptionContext - The additional encryption context of the portal.

$sel:clientToken:CreatePortal', createPortal_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

$sel:customerManagedKey:CreatePortal', createPortal_customerManagedKey - The customer managed key of the web portal.

CreatePortal, createPortal_displayName - The name of the web portal. This is not visible to users who log into the web portal.

$sel:tags:CreatePortal', createPortal_tags - The tags to add to the web portal. A tag is a key-value pair.

Request Lenses

createPortal_additionalEncryptionContext :: Lens' CreatePortal (Maybe (HashMap Text Text)) Source #

The additional encryption context of the portal.

createPortal_clientToken :: Lens' CreatePortal (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createPortal_customerManagedKey :: Lens' CreatePortal (Maybe Text) Source #

The customer managed key of the web portal.

createPortal_displayName :: Lens' CreatePortal (Maybe Text) Source #

The name of the web portal. This is not visible to users who log into the web portal.

createPortal_tags :: Lens' CreatePortal (Maybe [Tag]) Source #

The tags to add to the web portal. A tag is a key-value pair.

Destructuring the Response

data CreatePortalResponse Source #

See: newCreatePortalResponse smart constructor.

Constructors

CreatePortalResponse'
Fields httpStatus :: Int The response's http status code. portalArn :: Text The ARN of the web portal. portalEndpoint :: Text The endpoint URL of the web portal that users access in order to start streaming sessions.

Instances

Instances details

Generic CreatePortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Associated Types type Rep CreatePortalResponse :: Type -> Type # Methods from :: CreatePortalResponse -> Rep CreatePortalResponse x # to :: Rep CreatePortalResponse x -> CreatePortalResponse #
Read CreatePortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods readsPrec :: Int -> ReadS CreatePortalResponse # readList :: ReadS [CreatePortalResponse] # readPrec :: ReadPrec CreatePortalResponse # readListPrec :: ReadPrec [CreatePortalResponse] #
Show CreatePortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods showsPrec :: Int -> CreatePortalResponse -> ShowS # show :: CreatePortalResponse -> String # showList :: [CreatePortalResponse] -> ShowS #
NFData CreatePortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods rnf :: CreatePortalResponse -> () #
Eq CreatePortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal Methods (==) :: CreatePortalResponse -> CreatePortalResponse -> Bool # (/=) :: CreatePortalResponse -> CreatePortalResponse -> Bool #
type Rep CreatePortalResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreatePortal type Rep CreatePortalResponse = D1 ('MetaData "CreatePortalResponse" "Amazonka.WorkSpacesWeb.CreatePortal" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "CreatePortalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "portalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "portalEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreatePortalResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePortalResponse'`
-> Text	`CreatePortalResponse`
-> Text	`CreatePortalResponse`
-> CreatePortalResponse

Create a value of CreatePortalResponse 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:httpStatus:CreatePortalResponse', createPortalResponse_httpStatus - The response's http status code.

CreatePortalResponse, createPortalResponse_portalArn - The ARN of the web portal.

CreatePortalResponse, createPortalResponse_portalEndpoint - The endpoint URL of the web portal that users access in order to start streaming sessions.

Response Lenses

createPortalResponse_httpStatus :: Lens' CreatePortalResponse Int Source #

The response's http status code.

createPortalResponse_portalArn :: Lens' CreatePortalResponse Text Source #

The ARN of the web portal.

createPortalResponse_portalEndpoint :: Lens' CreatePortalResponse Text Source #

The endpoint URL of the web portal that users access in order to start streaming sessions.