Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

自定义 WorkSpace 品牌

亚马逊 WorkSpaces 允许您使用 API 自定义登录页面的外观，包括您自己的品牌徽标、IT 支持信息、忘记密码链接和登录消息，从而为用户创建熟悉的 WorkSpaces 体验。 WorkSpace您的品牌将在用户的 WorkSpace 登录页面上显示给他们，而不是默认的 WorkSpaces 品牌。

支持以下客户端：

导入自定义品牌

要导入您的客户品牌自定义设置，请使用操作ImportClientBranding，其中包括以下元素。有关更多信息，请参阅 ImportClientBranding API 参考。

以下是供使用的示例代码片段 ImportClientBranding。

Amazon命令行界面版本 2

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

导入 JSON 文件应与以下示例代码类似：

{
    "ResourceId": "<directory-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("<directory-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='<directory-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.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/"

要预览登录页面，请启动 WorkSpaces 应用程序或 Web 登录页面。

描述自定义品牌

要查看您当前的客户品牌自定义的详细信息，请使用操作DescribeCustomBranding。以下是使用的示例脚本 DescribeClientBranding。有关更多信息，请参阅 DescribeClientBranding API 参考。

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

删除自定义品牌

要删除您的客户品牌自定义设置，请使用操作DeleteCustomBranding。以下是使用的示例脚本 DeleteClientBranding。有关更多信息，请参阅 DeleteClientBranding API 参考。

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