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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

Synopsis

data CreateUserSettings = CreateUserSettings' {
- clientToken :: Maybe Text
- disconnectTimeoutInMinutes :: Maybe Natural
- idleDisconnectTimeoutInMinutes :: Maybe Natural
- tags :: Maybe [Sensitive Tag]
- copyAllowed :: EnabledType
- downloadAllowed :: EnabledType
- pasteAllowed :: EnabledType
- printAllowed :: EnabledType
- uploadAllowed :: EnabledType
}
newCreateUserSettings :: EnabledType -> EnabledType -> EnabledType -> EnabledType -> EnabledType -> CreateUserSettings
createUserSettings_clientToken :: Lens' CreateUserSettings (Maybe Text)
createUserSettings_disconnectTimeoutInMinutes :: Lens' CreateUserSettings (Maybe Natural)
createUserSettings_idleDisconnectTimeoutInMinutes :: Lens' CreateUserSettings (Maybe Natural)
createUserSettings_tags :: Lens' CreateUserSettings (Maybe [Tag])
createUserSettings_copyAllowed :: Lens' CreateUserSettings EnabledType
createUserSettings_downloadAllowed :: Lens' CreateUserSettings EnabledType
createUserSettings_pasteAllowed :: Lens' CreateUserSettings EnabledType
createUserSettings_printAllowed :: Lens' CreateUserSettings EnabledType
createUserSettings_uploadAllowed :: Lens' CreateUserSettings EnabledType
data CreateUserSettingsResponse = CreateUserSettingsResponse' {
- httpStatus :: Int
- userSettingsArn :: Text
}
newCreateUserSettingsResponse :: Int -> Text -> CreateUserSettingsResponse
createUserSettingsResponse_httpStatus :: Lens' CreateUserSettingsResponse Int
createUserSettingsResponse_userSettingsArn :: Lens' CreateUserSettingsResponse Text

Creating a Request

data CreateUserSettings Source #

See: newCreateUserSettings smart constructor.

Constructors

CreateUserSettings'

Fields

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.
disconnectTimeoutInMinutes :: Maybe Natural
The amount of time that a streaming session remains active after users disconnect.
idleDisconnectTimeoutInMinutes :: Maybe Natural
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
tags :: Maybe [Sensitive Tag]
The tags to add to the user settings resource. A tag is a key-value pair.
copyAllowed :: EnabledType
Specifies whether the user can copy text from the streaming session to the local device.
downloadAllowed :: EnabledType
Specifies whether the user can download files from the streaming session to the local device.
pasteAllowed :: EnabledType
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed :: EnabledType
Specifies whether the user can print to the local device.
uploadAllowed :: EnabledType
Specifies whether the user can upload files from the local device to the streaming session.

Instances

Instances details

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

newCreateUserSettings Source #

Arguments

:: EnabledType	`CreateUserSettings`
-> EnabledType	`CreateUserSettings`
-> EnabledType	`CreateUserSettings`
-> EnabledType	`CreateUserSettings`
-> EnabledType	`CreateUserSettings`
-> CreateUserSettings

Create a value of CreateUserSettings 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:clientToken:CreateUserSettings', createUserSettings_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.

CreateUserSettings, createUserSettings_disconnectTimeoutInMinutes - The amount of time that a streaming session remains active after users disconnect.

CreateUserSettings, createUserSettings_idleDisconnectTimeoutInMinutes - The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

$sel:tags:CreateUserSettings', createUserSettings_tags - The tags to add to the user settings resource. A tag is a key-value pair.

CreateUserSettings, createUserSettings_copyAllowed - Specifies whether the user can copy text from the streaming session to the local device.

CreateUserSettings, createUserSettings_downloadAllowed - Specifies whether the user can download files from the streaming session to the local device.

CreateUserSettings, createUserSettings_pasteAllowed - Specifies whether the user can paste text from the local device to the streaming session.

CreateUserSettings, createUserSettings_printAllowed - Specifies whether the user can print to the local device.

CreateUserSettings, createUserSettings_uploadAllowed - Specifies whether the user can upload files from the local device to the streaming session.

Request Lenses

createUserSettings_clientToken :: Lens' CreateUserSettings (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.

createUserSettings_disconnectTimeoutInMinutes :: Lens' CreateUserSettings (Maybe Natural) Source #

The amount of time that a streaming session remains active after users disconnect.

createUserSettings_idleDisconnectTimeoutInMinutes :: Lens' CreateUserSettings (Maybe Natural) Source #

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

createUserSettings_tags :: Lens' CreateUserSettings (Maybe [Tag]) Source #

The tags to add to the user settings resource. A tag is a key-value pair.

createUserSettings_copyAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can copy text from the streaming session to the local device.

createUserSettings_downloadAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can download files from the streaming session to the local device.

createUserSettings_pasteAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can paste text from the local device to the streaming session.

createUserSettings_printAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can print to the local device.

createUserSettings_uploadAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can upload files from the local device to the streaming session.

Destructuring the Response

data CreateUserSettingsResponse Source #

See: newCreateUserSettingsResponse smart constructor.

Constructors

CreateUserSettingsResponse'
Fields httpStatus :: Int The response's http status code. userSettingsArn :: Text The ARN of the user settings.

Instances

Instances details

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

newCreateUserSettingsResponse Source #

Arguments

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

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

CreateUserSettingsResponse, createUserSettingsResponse_userSettingsArn - The ARN of the user settings.

Response Lenses

createUserSettingsResponse_httpStatus :: Lens' CreateUserSettingsResponse Int Source #

The response's http status code.

createUserSettingsResponse_userSettingsArn :: Lens' CreateUserSettingsResponse Text Source #

The ARN of the user settings.