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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the user settings.

Synopsis

data UpdateUserSettings = UpdateUserSettings' {
- clientToken :: Maybe Text
- copyAllowed :: Maybe EnabledType
- disconnectTimeoutInMinutes :: Maybe Natural
- downloadAllowed :: Maybe EnabledType
- idleDisconnectTimeoutInMinutes :: Maybe Natural
- pasteAllowed :: Maybe EnabledType
- printAllowed :: Maybe EnabledType
- uploadAllowed :: Maybe EnabledType
- userSettingsArn :: Text
}
newUpdateUserSettings :: Text -> UpdateUserSettings
updateUserSettings_clientToken :: Lens' UpdateUserSettings (Maybe Text)
updateUserSettings_copyAllowed :: Lens' UpdateUserSettings (Maybe EnabledType)
updateUserSettings_disconnectTimeoutInMinutes :: Lens' UpdateUserSettings (Maybe Natural)
updateUserSettings_downloadAllowed :: Lens' UpdateUserSettings (Maybe EnabledType)
updateUserSettings_idleDisconnectTimeoutInMinutes :: Lens' UpdateUserSettings (Maybe Natural)
updateUserSettings_pasteAllowed :: Lens' UpdateUserSettings (Maybe EnabledType)
updateUserSettings_printAllowed :: Lens' UpdateUserSettings (Maybe EnabledType)
updateUserSettings_uploadAllowed :: Lens' UpdateUserSettings (Maybe EnabledType)
updateUserSettings_userSettingsArn :: Lens' UpdateUserSettings Text
data UpdateUserSettingsResponse = UpdateUserSettingsResponse' {
- httpStatus :: Int
- userSettings :: UserSettings
}
newUpdateUserSettingsResponse :: Int -> UserSettings -> UpdateUserSettingsResponse
updateUserSettingsResponse_httpStatus :: Lens' UpdateUserSettingsResponse Int
updateUserSettingsResponse_userSettings :: Lens' UpdateUserSettingsResponse UserSettings

Creating a Request

data UpdateUserSettings Source #

See: newUpdateUserSettings smart constructor.

Constructors

UpdateUserSettings'

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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
copyAllowed :: Maybe EnabledType
Specifies whether the user can copy text from the streaming session to the local device.
disconnectTimeoutInMinutes :: Maybe Natural
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed :: Maybe EnabledType
Specifies whether the user can download files from the streaming session to the local device.
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.
pasteAllowed :: Maybe EnabledType
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed :: Maybe EnabledType
Specifies whether the user can print to the local device.
uploadAllowed :: Maybe EnabledType
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn :: Text
The ARN of the user settings.

Instances

Instances details

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

newUpdateUserSettings Source #

Arguments

:: Text	`UpdateUserSettings`
-> UpdateUserSettings

Create a value of UpdateUserSettings 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:UpdateUserSettings', updateUserSettings_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 return the result from the original successful request.

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

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

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

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

UpdateUserSettings, updateUserSettings_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.

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

UpdateUserSettings, updateUserSettings_printAllowed - Specifies whether the user can print to the local device.

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

UpdateUserSettings, updateUserSettings_userSettingsArn - The ARN of the user settings.

Request Lenses

updateUserSettings_clientToken :: Lens' UpdateUserSettings (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 return the result from the original successful request.

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

updateUserSettings_copyAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

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

updateUserSettings_disconnectTimeoutInMinutes :: Lens' UpdateUserSettings (Maybe Natural) Source #

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

updateUserSettings_downloadAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

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

updateUserSettings_idleDisconnectTimeoutInMinutes :: Lens' UpdateUserSettings (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.

updateUserSettings_pasteAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

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

updateUserSettings_printAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

Specifies whether the user can print to the local device.

updateUserSettings_uploadAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

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

updateUserSettings_userSettingsArn :: Lens' UpdateUserSettings Text Source #

The ARN of the user settings.

Destructuring the Response

data UpdateUserSettingsResponse Source #

See: newUpdateUserSettingsResponse smart constructor.

Constructors

UpdateUserSettingsResponse'
Fields httpStatus :: Int The response's http status code. userSettings :: UserSettings The user settings.

Instances

Instances details

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

newUpdateUserSettingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateUserSettingsResponse'`
-> UserSettings	`$sel:userSettings:UpdateUserSettingsResponse'`
-> UpdateUserSettingsResponse

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

$sel:userSettings:UpdateUserSettingsResponse', updateUserSettingsResponse_userSettings - The user settings.

Response Lenses

updateUserSettingsResponse_httpStatus :: Lens' UpdateUserSettingsResponse Int Source #

The response's http status code.

updateUserSettingsResponse_userSettings :: Lens' UpdateUserSettingsResponse UserSettings Source #

The user settings.