- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeClientBrandingCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkSpacesClient, DescribeClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, DescribeClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // DescribeClientBrandingRequest
ResourceId: "STRING_VALUE", // required
};
const command = new DescribeClientBrandingCommand(input);
const response = await client.send(command);
// { // DescribeClientBrandingResult
// DeviceTypeWindows: { // DefaultClientBrandingAttributes
// LogoUrl: "STRING_VALUE",
// SupportEmail: "STRING_VALUE",
// SupportLink: "STRING_VALUE",
// ForgotPasswordLink: "STRING_VALUE",
// LoginMessage: { // LoginMessage
// "<keys>": "STRING_VALUE",
// },
// },
// DeviceTypeOsx: {
// LogoUrl: "STRING_VALUE",
// SupportEmail: "STRING_VALUE",
// SupportLink: "STRING_VALUE",
// ForgotPasswordLink: "STRING_VALUE",
// LoginMessage: {
// "<keys>": "STRING_VALUE",
// },
// },
// DeviceTypeAndroid: {
// LogoUrl: "STRING_VALUE",
// SupportEmail: "STRING_VALUE",
// SupportLink: "STRING_VALUE",
// ForgotPasswordLink: "STRING_VALUE",
// LoginMessage: {
// "<keys>": "STRING_VALUE",
// },
// },
// DeviceTypeIos: { // IosClientBrandingAttributes
// LogoUrl: "STRING_VALUE",
// Logo2xUrl: "STRING_VALUE",
// Logo3xUrl: "STRING_VALUE",
// SupportEmail: "STRING_VALUE",
// SupportLink: "STRING_VALUE",
// ForgotPasswordLink: "STRING_VALUE",
// LoginMessage: {
// "<keys>": "STRING_VALUE",
// },
// },
// DeviceTypeLinux: {
// LogoUrl: "STRING_VALUE",
// SupportEmail: "STRING_VALUE",
// SupportLink: "STRING_VALUE",
// ForgotPasswordLink: "STRING_VALUE",
// LoginMessage: {
// "<keys>": "STRING_VALUE",
// },
// },
// DeviceTypeWeb: {
// LogoUrl: "STRING_VALUE",
// SupportEmail: "STRING_VALUE",
// SupportLink: "STRING_VALUE",
// ForgotPasswordLink: "STRING_VALUE",
// LoginMessage: "<LoginMessage>",
// },
// };
DescribeClientBrandingCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ResourceId Required | string | undefined | The directory identifier of the WorkSpace for which you want to view client branding information. |
DescribeClientBrandingCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DeviceTypeAndroid | DefaultClientBrandingAttributes | undefined | The branding information for Android devices. |
DeviceTypeIos | IosClientBrandingAttributes | undefined | The branding information for iOS devices. |
DeviceTypeLinux | DefaultClientBrandingAttributes | undefined | The branding information for Linux devices. |
DeviceTypeOsx | DefaultClientBrandingAttributes | undefined | The branding information for macOS devices. |
DeviceTypeWeb | DefaultClientBrandingAttributes | undefined | The branding information for Web access. |
DeviceTypeWindows | DefaultClientBrandingAttributes | undefined | The branding information for Windows devices. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The user is not authorized to access a resource. |
InvalidParameterValuesException | client | One or more parameter values are not valid. |
ResourceNotFoundException | client | The resource could not be found. |
WorkSpacesServiceException | Base exception class for all service exceptions from WorkSpaces service. |