Amazon WorkSpaces · Schema

IosClientBrandingAttributes

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

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

DesktopEnd User ComputingVirtual DesktopDesktop as a Service

Properties

Name Type Description
LogoUrl object
Logo2xUrl object
Logo3xUrl object
SupportEmail object
SupportLink object
ForgotPasswordLink object
LoginMessage object
View JSON Schema on GitHub

JSON Schema

workspaces-ios-client-branding-attributes-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "LogoUrl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "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 <code>.png</code> file."
        }
      ]
    },
    "Logo2xUrl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "<p>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 <code>.png</code> file.</p> <note> <p> For more information about iOS image size and resolution, see <a href=\"https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/\">Image Size and Resolution </a> in the <i>Apple Human Interface Guidelines</i>.</p> </note>"
        }
      ]
    },
    "Logo3xUrl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "<p>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 <code>.png</code> file.</p> <note> <p> For more information about iOS image size and resolution, see <a href=\"https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/\">Image Size and Resolution </a> in the <i>Apple Human Interface Guidelines</i>.</p> </note>"
        }
      ]
    },
    "SupportEmail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientEmail"
        },
        {
          "description": "<p>The support email. The company's customer support email address.</p> <note> <ul> <li> <p>In each platform type, the <code>SupportEmail</code> and <code>SupportLink</code> parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.</p> </li> <li> <p>The default email is <code>[email protected]</code>.</p> </li> </ul> </note>"
        }
      ]
    },
    "SupportLink": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "<p>The support link. The link for the company's customer support page for their WorkSpace.</p> <note> <ul> <li> <p>In each platform type, the <code>SupportEmail</code> and <code>SupportLink</code> parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.</p> </li> <li> <p>The default support link is <code>[email protected]</code>.</p> </li> </ul> </note>"
        }
      ]
    },
    "ForgotPasswordLink": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace."
        }
      ]
    },
    "LoginMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoginMessage"
        },
        {
          "description": "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 <code>en_US</code>. The HTML tags supported include the following: <code>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</code>."
        }
      ]
    }
  },
  "description": "<p>The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.</p> <important> <p>Client branding attributes are public facing. Ensure you do not include sensitive information.</p> </important>",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "IosClientBrandingAttributes",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-ios-client-branding-attributes-schema.json"
}