DeleteClientBranding
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.
Request Syntax
{
"Platforms": [ "string" ],
"ResourceId": "string"
}Request Parameters
The request accepts the following data in JSON format.
- Platforms
-
The device type for which you want to delete client branding.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Valid Values:
DeviceTypeWindows | DeviceTypeOsx | DeviceTypeAndroid | DeviceTypeIos | DeviceTypeLinux | DeviceTypeWebRequired: Yes
- ResourceId
-
The directory identifier of the WorkSpace for which you want to delete client branding.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 65.
Pattern:
^d-[0-9a-f]{8,63}$Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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 AWS SDKs, see the following:
