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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Only device types that have branding information configured will be shown in the response.

Synopsis

Creating a Request

data DescribeClientBranding Source #

See: newDescribeClientBranding smart constructor.

Constructors

DescribeClientBranding'
Fields resourceId :: Text The directory identifier of the WorkSpace for which you want to view client branding information.

Instances

Instances details

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

newDescribeClientBranding Source #

Arguments

:: Text	`DescribeClientBranding`
-> DescribeClientBranding

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

DescribeClientBranding, describeClientBranding_resourceId - The directory identifier of the WorkSpace for which you want to view client branding information.

Request Lenses

describeClientBranding_resourceId :: Lens' DescribeClientBranding Text Source #

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

Destructuring the Response

data DescribeClientBrandingResponse Source #

See: newDescribeClientBrandingResponse smart constructor.

Constructors

DescribeClientBrandingResponse'

Fields

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

Instances

Instances details

Generic DescribeClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeClientBranding Associated Types type Rep DescribeClientBrandingResponse :: Type -> Type # Methods from :: DescribeClientBrandingResponse -> Rep DescribeClientBrandingResponse x # to :: Rep DescribeClientBrandingResponse x -> DescribeClientBrandingResponse #
Read DescribeClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeClientBranding Methods readsPrec :: Int -> ReadS DescribeClientBrandingResponse # readList :: ReadS [DescribeClientBrandingResponse] # readPrec :: ReadPrec DescribeClientBrandingResponse # readListPrec :: ReadPrec [DescribeClientBrandingResponse] #
Show DescribeClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeClientBranding Methods showsPrec :: Int -> DescribeClientBrandingResponse -> ShowS # show :: DescribeClientBrandingResponse -> String # showList :: [DescribeClientBrandingResponse] -> ShowS #
NFData DescribeClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeClientBranding Methods rnf :: DescribeClientBrandingResponse -> () #
Eq DescribeClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeClientBranding Methods (==) :: DescribeClientBrandingResponse -> DescribeClientBrandingResponse -> Bool # (/=) :: DescribeClientBrandingResponse -> DescribeClientBrandingResponse -> Bool #
type Rep DescribeClientBrandingResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeClientBranding type Rep DescribeClientBrandingResponse = D1 ('MetaData "DescribeClientBrandingResponse" "Amazonka.WorkSpaces.DescribeClientBranding" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeClientBrandingResponse'" '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)))))

newDescribeClientBrandingResponse Source #

Arguments

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

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

DescribeClientBrandingResponse, describeClientBrandingResponse_deviceTypeAndroid - The branding information for Android devices.

DescribeClientBrandingResponse, describeClientBrandingResponse_deviceTypeIos - The branding information for iOS devices.

DescribeClientBrandingResponse, describeClientBrandingResponse_deviceTypeLinux - The branding information for Linux devices.

DescribeClientBrandingResponse, describeClientBrandingResponse_deviceTypeOsx - The branding information for macOS devices.

DescribeClientBrandingResponse, describeClientBrandingResponse_deviceTypeWeb - The branding information for Web access.

DescribeClientBrandingResponse, describeClientBrandingResponse_deviceTypeWindows - The branding information for Windows devices.

$sel:httpStatus:DescribeClientBrandingResponse', describeClientBrandingResponse_httpStatus - The response's http status code.

Response Lenses

describeClientBrandingResponse_deviceTypeAndroid :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Android devices.

describeClientBrandingResponse_deviceTypeIos :: Lens' DescribeClientBrandingResponse (Maybe IosClientBrandingAttributes) Source #

The branding information for iOS devices.

describeClientBrandingResponse_deviceTypeLinux :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Linux devices.

describeClientBrandingResponse_deviceTypeOsx :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for macOS devices.

describeClientBrandingResponse_deviceTypeWeb :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Web access.

describeClientBrandingResponse_deviceTypeWindows :: Lens' DescribeClientBrandingResponse (Maybe DefaultClientBrandingAttributes) Source #

The branding information for Windows devices.

describeClientBrandingResponse_httpStatus :: Lens' DescribeClientBrandingResponse Int Source #

The response's http status code.