client_brandings

Creates, updates, deletes, gets or lists a client_brandings resource.

Overview

Name	client_brandings
Type	Resource
Id	aws.workspaces.client_brandings

Fields

The following fields are returned by SELECT queries:

describe_client_branding

Name	Datatype	Description
device_type_android	object	The branding information for Android devices.
device_type_ios	object	The branding information for iOS devices.
device_type_linux	object	The branding information for Linux devices.
device_type_osx	object	The branding information for macOS devices.
device_type_web	object	The branding information for Web access.
device_type_windows	object	The branding information for Windows devices.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_client_branding	select	region		Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.
delete_client_branding	delete	region		Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_client_branding

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.

SELECT
device_type_android,
device_type_ios,
device_type_linux,
device_type_osx,
device_type_web,
device_type_windows
FROM aws.workspaces.client_brandings
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_client_branding

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.

DELETE FROM aws.workspaces.client_brandings
WHERE region = '{{ region }}' --required
;