Personalización de la marca en WorkSpaces Personal - Amazon WorkSpaces

Personalización de la marca en WorkSpaces Personal

Amazon WorkSpaces le permite crear una experiencia de WorkSpaces familiar para sus usuarios mediante el uso de API para personalizar la apariencia de la página de inicio de sesión de su WorkSpace con su propio logotipo de marca, información de soporte de TI, enlace de contraseña olvidada y mensaje de inicio de sesión. Los usuarios verán su marca en su página de inicio de sesión de WorkSpace en lugar de mostrarse en la marca predeterminada de WorkSpaces.

Se admiten los siguientes caracteres:

  • Windows

  • Linux

  • Android

  • MacOS

  • iOS

  • Acceso web

nota

Para modificar los elementos de marca mediante las API ClientBranding deAWS GovCloud (US) Region, utilice una versión de cliente de WorkSpaces que sea 5.10.0.

Importe una marca personalizada

Para importar la personalización de la marca de tu cliente, usa la acciónImportClientBranding, que incluye los siguientes elementos. Consulta la referencia de la API ImportClientBranding para obtener más información.

importante

Los atributos de la marca del cliente están orientados al público. Asegúrese de no incluir información confidencial.

Pantalla de inicio de sesión del cliente de WorkSpaces
  1. Support link

  2. Logo

  3. Código de contraseña olvidada

  4. Mensaje de inicio de sesión

Elementos de marca personalizados
Elemento de marca Descripción Requisitos y recomendaciones
Support link Permite especificar un enlace de correo electrónico de soporte para que los usuarios se pongan en contacto con ellos para obtener ayuda con sus WorkSpaces. Puede usar el SupportEmail atributo o proporcionar un enlace a su página de soporte mediante el SupportLink atributo.
  • Para cada tipo de plataforma, los SupportLink parámetros SupportEmail y se excluyen mutuamente. Puede especificar un parámetro único para cada tipo de plataforma, pero no ambos.

  • El correo electrónico predeterminado esworkspaces-feedback@amazon.com.

  • Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 200 caracteres.

Logo Le permite personalizar el logotipo de su organización mediante el Logo atributo.
  • El único formato de imagen aceptado es un objeto de datos binarios que se convierte a partir de un .png archivo.

  • Resoluciones recomendadas:

    • Android: 978 x 190

    • Escritorio: 319 x 55

    • iOS @2x: 110 x 200

    • iOS @3x: 1650 x 300

Código de contraseña olvidada Permite añadir una dirección web mediante el atributo forgotPasswordLink al que los usuarios pueden ir si olvidan la contraseña de su WorkSpace. Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 200 caracteres.
Mensaje de inicio de sesión Permite personalizar un mensaje mediante el LoginMessage atributo de la pantalla de inicio de sesión.
  • Limitaciones de longitud: longitud mínima de 0. Longitud máxima de 2000 caracteres para la integración con etiquetas HTML y diferentes tamaños de fuente. En los casos predeterminados sin etiquetas HTML, se recomienda mantener el mensaje de inicio de sesión en menos de 600 caracteres.

  • Etiquetas HTML compatibles: 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

A continuación, se muestran ejemplos de fragmentos de código para usar ImportClientBranding.

AWSCLI versión 2

aviso

La importación de una marca personalizada sobrescribe los atributos, dentro de esa plataforma, que especifique con sus datos personalizados. También sobrescribe los atributos que no especifiques con los valores predeterminados de los atributos de marca personalizados. Debe incluir los datos de cualquier atributo que no desee sobrescribir.

aws workspaces import-client-branding \ --cli-input-json file://~/Downloads/import-input.json \ --region us-west-2

El archivo JSON de importación debe tener el siguiente aspecto:

{ "ResourceId": "<directory-id>", "DeviceTypeOsx": { "Logo": "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAC0lEQVR42mNgQAcAABIAAeRVjecAAAAASUVORK5CYII=", "ForgotPasswordLink": "https://amazon.com/", "SupportLink": "https://amazon.com/", "LoginMessage": { "en_US": "Hello!!" } } }

El siguiente fragmento de código Java de ejemplo convierte la imagen del logotipo en una cadena codificada en base64:

// Read image as BufferImage BufferedImage bi = ImageIO.read(new File("~/Downloads/logo.png")); // convert BufferedImage to byte[] ByteArrayOutputStream baos = new ByteArrayOutputStream(); ImageIO.write(bi, "png", baos); byte[] bytes = baos.toByteArray(); //convert byte[] to base64 format and print it String bytesBase64 = Base64.encodeBase64String(bytes); System.out.println(bytesBase64);

El siguiente fragmento de código Python de ejemplo convierte la imagen del logotipo en una cadena codificada en base64:

# Read logo into base64-encoded string with open("~/Downloads/logo.png", "rb") as image_file: f = image_file.read() base64_string = base64.b64encode(f) print(base64_string)

Java

aviso

La importación de una marca personalizada sobrescribe los atributos, dentro de esa plataforma, que especifique con sus datos personalizados. También sobrescribe los atributos que no especifiques con los valores predeterminados de los atributos de marca personalizados. Debe incluir los datos de cualquier atributo que no desee sobrescribir.

// Create WS Client WorkSpacesClient client = WorkSpacesClient.builder().build(); // Read image as BufferImage BufferedImage bi = ImageIO.read(new File("~/Downloads/logo.png")); // convert BufferedImage to byte[] ByteArrayOutputStream baos = new ByteArrayOutputStream(); ImageIO.write(bi, "png", baos); byte[] bytes = baos.toByteArray(); // Create import attributes for the plateform DefaultImportClientBrandingAttributes attributes = DefaultImportClientBrandingAttributes.builder() .logo(SdkBytes.fromByteArray(bytes)) .forgotPasswordLink("https://aws.amazon.com/") .supportLink("https://aws.amazon.com/") .build(); // Create import request ImportClientBrandingRequest request = ImportClientBrandingRequest.builder() .resourceId("<directory-id>") .deviceTypeOsx(attributes) .build(); // Call ImportClientBranding API ImportClientBrandingResponse response = client.importClientBranding(request);

Python

aviso

La importación de una marca personalizada sobrescribe los atributos, dentro de esa plataforma, que especifique con sus datos personalizados. También sobrescribe los atributos que no especifiques con los valores predeterminados de los atributos de marca personalizados. Debe incluir los datos de cualquier atributo que no desee sobrescribir.

import boto3 # Read logo into bytearray with open("~/Downloads/logo.png", "rb") as image_file: f = image_file.read() bytes = bytearray(f) # Create WorkSpaces client client = boto3.client('workspaces') # Call import API response = client.import_client_branding( ResourceId='<directory-id>', DeviceTypeOsx={ 'Logo': bytes, 'SupportLink': 'https://aws.amazon.com/', 'ForgotPasswordLink': 'https://aws.amazon.com/', 'LoginMessage': { 'en_US': 'Hello!!' } } )

PowerShell

#Requires -Modules @{ ModuleName="AWS.Tools.WorkSpaces"; ModuleVersion="4.1.56"} # Specify Image Path $imagePath = "~/Downloads/logo.png" # Create Byte Array from image file $imageByte = ([System.IO.File]::ReadAllBytes($imagePath)) # Call import API Import-WKSClientBranding -ResourceId <directory-id> ` -DeviceTypeLinux_LoginMessage @{en_US="Hello!!"} ` -DeviceTypeLinux_Logo $imageByte ` -DeviceTypeLinux_ForgotPasswordLink "https://aws.amazon.com/" ` -DeviceTypeLinux_SupportLink "https://aws.amazon.com/"

Para obtener una vista previa de la página de inicio de sesión, inicie la aplicación WorkSpaces o la página de inicio de sesión web.

nota

Los cambios pueden tardar hasta 1 minuto en aparecer.

Describe la marca personalizada

Para ver los detalles de la personalización de la marca del cliente que tienes actualmente, usa la acciónDescribeCustomBranding. Lo siguiente es el script de muestra para usar DescribeClientBranding. Para obtener más información, consulte DescribeCases en la referencia de la API de .

aws workspaces describe-client-branding \ --resource-id <directory-id> \ --region us-west-2

Eliminar la marca personalizada

Para eliminar la personalización de la marca de tu cliente, usa la acciónDeleteCustomBranding. Lo siguiente es el script de muestra para usar DeleteClientBranding. Para obtener más información, consulte DeleteOpsItem en la Referencia de la API de .

aws workspaces delete-client-branding \ --resource-id <directory-id> \ --platforms DeviceTypeAndroid DeviceTypeIos \ --region us-west-2
nota

Los cambios pueden tardar hasta 1 minuto en aparecer.