Impor merek khusus Jelaskan merek khusus Hapus branding kustom

Sesuaikan branding di WorkSpaces Personal

Amazon WorkSpaces memungkinkan Anda untuk membuat WorkSpaces pengalaman yang akrab bagi pengguna Anda dengan menggunakan API untuk menyesuaikan tampilan halaman login Anda WorkSpace dengan logo merek Anda sendiri, informasi dukungan TI, tautan lupa kata sandi, dan pesan masuk. Branding Anda akan ditampilkan kepada pengguna Anda di halaman WorkSpace login mereka, bukan WorkSpaces branding default.

Klien berikut didukung:

Windows
Linux
Android
macOS
iOS
Akses Web

catatan

Untuk memodifikasi elemen branding menggunakan ClientBranding API di AWS GovCloud (US) Region, gunakan versi WorkSpaces klien yaitu 5.10.0.

Impor merek khusus

Untuk mengimpor kustomisasi branding klien Anda, gunakan tindakanImportClientBranding, yang mencakup elemen-elemen berikut. Lihat referensi ImportClientBranding API untuk informasi selengkapnya.

penting

Atribut branding klien dihadapi publik. Pastikan Anda tidak menyertakan informasi sensitif.

Tautan Support
Logo
Lupa tautan kata sandi
Pesan login

Elemen branding kustom
Elemen branding	Deskripsi	Persyaratan dan rekomendasi
Tautan Support	Memungkinkan Anda untuk menentukan link email dukungan bagi pengguna untuk menghubungi untuk bantuan dengan mereka WorkSpaces. Anda dapat menggunakan `SupportEmail` atribut atau memberikan link ke halaman dukungan Anda menggunakan `SupportLink` atribut.	Untuk setiap jenis platform, `SupportLink` parameter `SupportEmail` dan saling eksklusif. Anda dapat menentukan satu parameter untuk setiap jenis platform, tetapi tidak keduanya. Email default adalah`workspaces-feedback@amazon.com`. Panjang batasan: Panjang minimum 1. Panjang maksimum 200.
Logo	Memungkinkan Anda menyesuaikan logo organisasi Anda menggunakan `Logo` atribut.	Satu-satunya format gambar yang diterima adalah objek data biner yang dikonversi dari `.png` file. Resolusi yang direkomendasikan: Android: 978 x 190 Desktop: 319 x 55 iOS @2x: 110 x 200 iOS @3x: 1650 x 300
Lupa tautan kata sandi	Memungkinkan Anda menambahkan alamat web menggunakan ForgotPasswordLink atribut yang dapat dikunjungi pengguna jika mereka lupa kata sandi mereka WorkSpace.	Batasan Panjang: Panjang minimum 1. Panjang maksimum 200.
Pesan login	Memungkinkan Anda menyesuaikan pesan menggunakan `LoginMessage` atribut pada layar masuk.	Batasan Panjang: Panjang minimum sebesar 0. Panjang maksimum 2000 karakter untuk integrasi dengan tag HTML dan ukuran font yang berbeda. Untuk kasus default tanpa tag HTML, disarankan untuk menyimpan pesan login di bawah 600 karakter. Tag HTML didukung: `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`

Berikut ini adalah contoh cuplikan kode untuk digunakan. ImportClientBranding

AWS CLI Versi 2

Awas

Mengimpor merek khusus menimpa atribut, di dalam platform itu, yang Anda tentukan dengan data kustom Anda. Ini juga menimpa atribut yang tidak Anda tentukan dengan nilai atribut pencitraan merek kustom default. Anda harus menyertakan data untuk atribut apa pun yang tidak ingin Anda timpa.


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

File impor JSON akan terlihat seperti kode contoh berikut:


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

Contoh cuplikan kode Java berikut mengubah gambar logo menjadi string yang dikodekan 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);

Contoh cuplikan kode Python berikut mengubah gambar logo menjadi string yang dikodekan 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

Awas


// 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

Awas


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/"

Untuk melihat pratinjau halaman login, luncurkan WorkSpaces aplikasi atau halaman login web.

catatan

Perubahan mungkin memakan waktu hingga 1 menit untuk muncul.

Jelaskan merek khusus

Untuk melihat detail kustomisasi branding klien yang Anda miliki saat ini, gunakan tindakanDescribeCustomBranding. Berikut ini adalah contoh script untuk menggunakan DescribeClientBranding. Lihat referensi DescribeClientBranding API untuk informasi selengkapnya.


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

Hapus branding kustom

Untuk menghapus kustomisasi branding klien Anda, gunakan tindakanDeleteCustomBranding. Berikut ini adalah contoh script untuk menggunakan DeleteClientBranding. Lihat referensi DeleteClientBranding API untuk informasi selengkapnya.


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

catatan

Perubahan mungkin memakan waktu hingga 1 menit untuk muncul.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Memodifikasi WorkSpace

Memberi tanda pada sumber daya