自訂 WorkSpace 建立品牌 - Amazon WorkSpaces

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

自訂 WorkSpace 建立品牌

亞馬遜 WorkSpaces 允許您創建一個熟悉的 WorkSpaces 通過使用 API 自定義 Workspace 登錄頁面的外觀,使用您自己的品牌徽標、IT 支持信息、忘記密碼鏈接和登錄消息來自定義您的用户體驗。您的品牌推廣將顯示給您的用户 WorkSpace 登錄頁面而不是默認 WorkSpaces 品牌。

支持以下客户端:

  • Windows

  • Linux

  • Android

  • MacOS

  • iOS

  • Web 存取

注意

WorkSpaces 自定義品牌推廣目前不可用AWS GovCloud (美國) 區域.

導入自訂品牌

要導入客户端品牌自定義,請使用操作ImportClientBranding,其中包含下列元素。請參閱 ImportClientBranding API 參考如需詳細資訊。

重要

客户端品牌推廣屬性面向公眾。確保您不包含敏感信息。


               WorkSpaces 客户端登錄屏幕
  1. 支援連結

  2. 標誌

  3. 忘記密碼鏈接

  4. 登入消息

自訂品牌元素
品牌元素 描述 要求和建議
支援連結 允許您指定一個支持電子郵件鏈接,供用户聯繫以獲取有關其 WorkSpaces 的幫助。您可以使用SupportEmail屬性,或使用SupportLink屬性。
  • 對於每種平台類型,SupportEmailSupportLink參數是互斥的。您可以為每個平台類型指定單個參數,但不能同時指定兩者。

  • 默認電子郵件為workspaces-feedback@amazon.com

  • 長度限制:長度下限為 1。長度上限為 200。

標誌 允許您使用Logo屬性。 唯一接受的圖像格式是二進制數據對象,該數據對象從.pngfile.
忘記密碼鏈接 允許您使用 ForgotPasswordLink 屬性,用户可以在忘記 WorkSpace 的密碼時轉到該屬性。 長度限制:長度下限為 1。長度上限為 200。
登入消息 允許您使用LoginMessage屬性在登錄屏幕上。 長度限制:長度下限為 0。長度上限為 600

以下是使用導入客户端品牌的示例代碼片段。

AWSCLI 版本 2

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

導入 JSON 檔案現在應該與下列範例代碼類似:

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

以下示例 Java 代碼片段將徽標圖像轉換為 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);

下面的示例 Python 代碼片段將徽標圖像轉換為 base64 位二進制格式。

# Read logo into 64bit based string with open("~/Downloads/logo.png", "rb") as imageFile: f = imageFile.read() base64String = base64.b64encode(f) print(base64String)

Java

// 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("<direcory-id>") .deviceTypeOsx(attributes) .build(); // Call ImportClientBranding API ImportClientBrandingResponse response = client.importClientBranding(request);

Python

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

PowerShell

# This forces the latest version of Tools or newer. May want to just add a note incase the have the full awspowershell module #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.IP.File]::ReadAllBytes($imagePath)) # Call import API Import-WKSClientBranding -ResourceId <direcory-id> ` -DeviceTypeLinux_LoginMessage @{en_US="Hello!!"} ` -DeviceTypeLinux_Logo $imageByte ` -DeviceTypeLinux_ForgotPasswordLink "https://aws.amazon.com/" ` -DeviceTypeLinux_SupportLink "https://aws.amazon.com/"

要預覽登錄頁面,請啟動 WorkSpaces 應用程序或 Web 登錄頁面。

注意

變更可能需要最多 1 分鐘才能顯示。

描述自訂品牌

要查看您當前擁有的客户端品牌定製的詳細信息,請使用操作DescribeCustomBranding。下列是使用描述品牌化的範例腳本。請參閱 DescribeClientBranding API 參考如需詳細資訊。

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

刪除自訂品牌

要刪除客户端品牌自定義,請使用操作DeleteCustomBranding。下列是使用刪除品牌化的範例腳本。請參閱 DeleteClientBranding API 參考如需詳細資訊。

aws workspaces delete-client-branding \ —resource-id d-92677ad933 \ —platforms DeviceTypeAndroid DeviceTypeIos \ —region us-west-2
注意

變更可能需要最多 1 分鐘才能顯示。