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.WorkSpaces.ImportClientBranding

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.

Synopsis

Creating a Request

data ImportClientBranding Source #

See: newImportClientBranding smart constructor.

Constructors

ImportClientBranding'

Fields

deviceTypeAndroid :: Maybe DefaultImportClientBrandingAttributes
The branding information to import for Android devices.
deviceTypeIos :: Maybe IosImportClientBrandingAttributes
The branding information to import for iOS devices.
deviceTypeLinux :: Maybe DefaultImportClientBrandingAttributes
The branding information to import for Linux devices.
deviceTypeOsx :: Maybe DefaultImportClientBrandingAttributes
The branding information to import for macOS devices.
deviceTypeWeb :: Maybe DefaultImportClientBrandingAttributes
The branding information to import for web access.
deviceTypeWindows :: Maybe DefaultImportClientBrandingAttributes
The branding information to import for Windows devices.
resourceId :: Text
The directory identifier of the WorkSpace for which you want to import client branding.

Instances

Instances details

ToJSON ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods toJSON :: ImportClientBranding -> Value # toEncoding :: ImportClientBranding -> Encoding # toJSONList :: [ImportClientBranding] -> Value # toEncodingList :: [ImportClientBranding] -> Encoding #
ToHeaders ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods toHeaders :: ImportClientBranding -> [Header] #
ToPath ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods toPath :: ImportClientBranding -> ByteString #
ToQuery ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods toQuery :: ImportClientBranding -> QueryString #
AWSRequest ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Associated Types type AWSResponse ImportClientBranding # Methods request :: (Service -> Service) -> ImportClientBranding -> Request ImportClientBranding # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportClientBranding -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportClientBranding))) #
Generic ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Associated Types type Rep ImportClientBranding :: Type -> Type # Methods from :: ImportClientBranding -> Rep ImportClientBranding x # to :: Rep ImportClientBranding x -> ImportClientBranding #
Read ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods readsPrec :: Int -> ReadS ImportClientBranding # readList :: ReadS [ImportClientBranding] # readPrec :: ReadPrec ImportClientBranding # readListPrec :: ReadPrec [ImportClientBranding] #
Show ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods showsPrec :: Int -> ImportClientBranding -> ShowS # show :: ImportClientBranding -> String # showList :: [ImportClientBranding] -> ShowS #
NFData ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods rnf :: ImportClientBranding -> () #
Eq ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods (==) :: ImportClientBranding -> ImportClientBranding -> Bool # (/=) :: ImportClientBranding -> ImportClientBranding -> Bool #
Hashable ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods hashWithSalt :: Int -> ImportClientBranding -> Int # hash :: ImportClientBranding -> Int #
type AWSResponse ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding type AWSResponse ImportClientBranding = ImportClientBrandingResponse
type Rep ImportClientBranding Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding type Rep ImportClientBranding = D1 ('MetaData "ImportClientBranding" "Amazonka.WorkSpaces.ImportClientBranding" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ImportClientBranding'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deviceTypeAndroid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultImportClientBrandingAttributes)) :: (S1 ('MetaSel ('Just "deviceTypeIos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IosImportClientBrandingAttributes)) :: S1 ('MetaSel ('Just "deviceTypeLinux") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultImportClientBrandingAttributes)))) :: ((S1 ('MetaSel ('Just "deviceTypeOsx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultImportClientBrandingAttributes)) :: S1 ('MetaSel ('Just "deviceTypeWeb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultImportClientBrandingAttributes))) :: (S1 ('MetaSel ('Just "deviceTypeWindows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultImportClientBrandingAttributes)) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newImportClientBranding Source #

Arguments

:: Text	`ImportClientBranding`
-> ImportClientBranding

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

ImportClientBranding, importClientBranding_deviceTypeAndroid - The branding information to import for Android devices.

ImportClientBranding, importClientBranding_deviceTypeIos - The branding information to import for iOS devices.

ImportClientBranding, importClientBranding_deviceTypeLinux - The branding information to import for Linux devices.

ImportClientBranding, importClientBranding_deviceTypeOsx - The branding information to import for macOS devices.

ImportClientBranding, importClientBranding_deviceTypeWeb - The branding information to import for web access.

ImportClientBranding, importClientBranding_deviceTypeWindows - The branding information to import for Windows devices.

ImportClientBranding, importClientBranding_resourceId - The directory identifier of the WorkSpace for which you want to import client branding.

Request Lenses

importClientBranding_deviceTypeAndroid :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for Android devices.

importClientBranding_deviceTypeIos :: Lens' ImportClientBranding (Maybe IosImportClientBrandingAttributes) Source #

The branding information to import for iOS devices.

importClientBranding_deviceTypeLinux :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for Linux devices.

importClientBranding_deviceTypeOsx :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for macOS devices.

importClientBranding_deviceTypeWeb :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for web access.

importClientBranding_deviceTypeWindows :: Lens' ImportClientBranding (Maybe DefaultImportClientBrandingAttributes) Source #

The branding information to import for Windows devices.

importClientBranding_resourceId :: Lens' ImportClientBranding Text Source #

The directory identifier of the WorkSpace for which you want to import client branding.

Destructuring the Response

data ImportClientBrandingResponse Source #

See: newImportClientBrandingResponse smart constructor.

Constructors

ImportClientBrandingResponse'

Fields

deviceTypeAndroid :: Maybe DefaultClientBrandingAttributes
The branding information configured for Android devices.
deviceTypeIos :: Maybe IosClientBrandingAttributes
The branding information configured for iOS devices.
deviceTypeLinux :: Maybe DefaultClientBrandingAttributes
The branding information configured for Linux devices.
deviceTypeOsx :: Maybe DefaultClientBrandingAttributes
The branding information configured for macOS devices.
deviceTypeWeb :: Maybe DefaultClientBrandingAttributes
The branding information configured for web access.
deviceTypeWindows :: Maybe DefaultClientBrandingAttributes
The branding information configured for Windows devices.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ImportClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Associated Types type Rep ImportClientBrandingResponse :: Type -> Type # Methods from :: ImportClientBrandingResponse -> Rep ImportClientBrandingResponse x # to :: Rep ImportClientBrandingResponse x -> ImportClientBrandingResponse #
Read ImportClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods readsPrec :: Int -> ReadS ImportClientBrandingResponse # readList :: ReadS [ImportClientBrandingResponse] # readPrec :: ReadPrec ImportClientBrandingResponse # readListPrec :: ReadPrec [ImportClientBrandingResponse] #
Show ImportClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods showsPrec :: Int -> ImportClientBrandingResponse -> ShowS # show :: ImportClientBrandingResponse -> String # showList :: [ImportClientBrandingResponse] -> ShowS #
NFData ImportClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods rnf :: ImportClientBrandingResponse -> () #
Eq ImportClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding Methods (==) :: ImportClientBrandingResponse -> ImportClientBrandingResponse -> Bool # (/=) :: ImportClientBrandingResponse -> ImportClientBrandingResponse -> Bool #
type Rep ImportClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportClientBranding type Rep ImportClientBrandingResponse = D1 ('MetaData "ImportClientBrandingResponse" "Amazonka.WorkSpaces.ImportClientBranding" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ImportClientBrandingResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deviceTypeAndroid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultClientBrandingAttributes)) :: (S1 ('MetaSel ('Just "deviceTypeIos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IosClientBrandingAttributes)) :: S1 ('MetaSel ('Just "deviceTypeLinux") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultClientBrandingAttributes)))) :: ((S1 ('MetaSel ('Just "deviceTypeOsx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultClientBrandingAttributes)) :: S1 ('MetaSel ('Just "deviceTypeWeb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultClientBrandingAttributes))) :: (S1 ('MetaSel ('Just "deviceTypeWindows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultClientBrandingAttributes)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newImportClientBrandingResponse Source #

Arguments

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

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

ImportClientBranding, importClientBrandingResponse_deviceTypeAndroid - The branding information configured for Android devices.

ImportClientBranding, importClientBrandingResponse_deviceTypeIos - The branding information configured for iOS devices.

ImportClientBranding, importClientBrandingResponse_deviceTypeLinux - The branding information configured for Linux devices.

ImportClientBranding, importClientBrandingResponse_deviceTypeOsx - The branding information configured for macOS devices.

ImportClientBranding, importClientBrandingResponse_deviceTypeWeb - The branding information configured for web access.

ImportClientBranding, importClientBrandingResponse_deviceTypeWindows - The branding information configured for Windows devices.

$sel:httpStatus:ImportClientBrandingResponse', importClientBrandingResponse_httpStatus - The response's http status code.

Response Lenses

importClientBrandingResponse_deviceTypeAndroid :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for Android devices.

importClientBrandingResponse_deviceTypeIos :: Lens' ImportClientBrandingResponse (Maybe IosClientBrandingAttributes) Source #

The branding information configured for iOS devices.

importClientBrandingResponse_deviceTypeLinux :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for Linux devices.

importClientBrandingResponse_deviceTypeOsx :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for macOS devices.

importClientBrandingResponse_deviceTypeWeb :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for web access.

importClientBrandingResponse_deviceTypeWindows :: Lens' ImportClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information configured for Windows devices.

importClientBrandingResponse_httpStatus :: Lens' ImportClientBrandingResponse Int Source #

The response's http status code.