DescribeClientBranding - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeClientBranding

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.

Note

Only device types that have branding information configured will be shown in the response.

Request Syntax

{ "ResourceId": "string" }

Request Parameters

The request accepts the following data in JSON format.

ResourceId

The directory identifier of the WorkSpace for which you want to view client branding information.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes

Response Syntax

{ "DeviceTypeAndroid": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo2xUrl": "string", "Logo3xUrl": "string", "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeviceTypeAndroid

The branding information for Android devices.

Type: DefaultClientBrandingAttributes object

DeviceTypeIos

The branding information for iOS devices.

Type: IosClientBrandingAttributes object

DeviceTypeLinux

The branding information for Linux devices.

Type: DefaultClientBrandingAttributes object

DeviceTypeOsx

The branding information for macOS devices.

Type: DefaultClientBrandingAttributes object

DeviceTypeWeb

The branding information for Web access.

Type: DefaultClientBrandingAttributes object

DeviceTypeWindows

The branding information for Windows devices.

Type: DefaultClientBrandingAttributes object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: