amazonka-workspaces-2.0: Amazon WorkSpaces SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

Description

 
Synopsis

Documentation

data IosImportClientBrandingAttributes Source #

The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.

Client branding attributes are public facing. Ensure you do not include sensitive information.

See: newIosImportClientBrandingAttributes smart constructor.

Constructors

IosImportClientBrandingAttributes' 

Fields

  • forgotPasswordLink :: Maybe Text

    The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

  • loginMessage :: Maybe (HashMap Text Text)

    The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

  • :: Maybe Base64

    The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

  • logo2x :: Maybe Base64

    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

  • logo3x :: Maybe Base64

    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.

    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

  • supportEmail :: Maybe Text

    The support email. The company's customer support email address.

    • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    • The default email is workspaces-feedback@amazon.com.
  • supportLink :: Maybe Text

    The support link. The link for the company's customer support page for their WorkSpace.

    • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
    • The default support link is workspaces-feedback@amazon.com.

Instances

Instances details
ToJSON IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

Generic IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

Associated Types

type Rep IosImportClientBrandingAttributes :: Type -> Type #

Read IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

Show IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

NFData IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

Eq IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

Hashable IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

type Rep IosImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes

type Rep IosImportClientBrandingAttributes = D1 ('MetaData "IosImportClientBrandingAttributes" "Amazonka.WorkSpaces.Types.IosImportClientBrandingAttributes" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "IosImportClientBrandingAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forgotPasswordLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "loginMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "logo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) :*: ((S1 ('MetaSel ('Just "logo2x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "logo3x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 ('MetaSel ('Just "supportEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIosImportClientBrandingAttributes :: IosImportClientBrandingAttributes Source #

Create a value of IosImportClientBrandingAttributes 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:forgotPasswordLink:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_forgotPasswordLink - The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

$sel:loginMessage:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_loginMessage - The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

$sel:logo:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_logo - The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:logo2x:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_logo2x - The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:logo3x:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_logo3x - The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:supportEmail:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_supportEmail - The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
  • The default email is workspaces-feedback@amazon.com.

$sel:supportLink:IosImportClientBrandingAttributes', iosImportClientBrandingAttributes_supportLink - The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
  • The default support link is workspaces-feedback@amazon.com.

iosImportClientBrandingAttributes_forgotPasswordLink :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

iosImportClientBrandingAttributes_loginMessage :: Lens' IosImportClientBrandingAttributes (Maybe (HashMap Text Text)) Source #

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

:: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

iosImportClientBrandingAttributes_logo2x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

iosImportClientBrandingAttributes_logo3x :: Lens' IosImportClientBrandingAttributes (Maybe ByteString) Source #

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

iosImportClientBrandingAttributes_supportEmail :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
  • The default email is workspaces-feedback@amazon.com.

iosImportClientBrandingAttributes_supportLink :: Lens' IosImportClientBrandingAttributes (Maybe Text) Source #

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
  • The default support link is workspaces-feedback@amazon.com.