The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Important
Client branding attributes are public facing. Ensure you do not include sensitive information.
Contents
- ForgotPasswordLink
-
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^(http|https)\://\S+Required: No
- 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.Type: String to string map
Key Length Constraints: Fixed length of 5.
Key Pattern:
^[a-z]{2}_[A-Z]{2}$Value Length Constraints: Minimum length of 0. Maximum length of 2000.
Value Pattern:
^.*$Required: No
- Logo2xUrl
-
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
.pngfile.Note
For more information about iOS image size and resolution, see Image Size and Resolution
in the Apple Human Interface Guidelines. Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^(http|https)\://\S+Required: No
- Logo3xUrl
-
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
.pngfile.Note
For more information about iOS image size and resolution, see Image Size and Resolution
in the Apple Human Interface Guidelines. Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^(http|https)\://\S+Required: No
- LogoUrl
-
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
.pngfile.Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^(http|https)\://\S+Required: No
- SupportEmail
-
The support email. The company's customer support email address.
Note
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default email is
workspaces-feedback@amazon.com.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 64.
Pattern:
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$Required: No
-
- SupportLink
-
The support link. The link for the company's customer support page for their WorkSpace.
Note
-
In each platform type, the
SupportEmailandSupportLinkparameters are mutually exclusive. You can specify one parameter for each platform type, but not both. -
The default support link is
workspaces-feedback@amazon.com.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^(http|https)\://\S+Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
