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:
-
resource_id
(DirectoryId)
–
The directory identifier of the WorkSpace for which you want to delete client branding.
-
platforms
(ClientDeviceTypeList)
–
The device type for which you want to delete client branding.
Raises:
Source code in docs_src/capo_workspaces/_services/async_work_spaces.py
| async def delete_client_branding(
self,
resource_id: "capo_workspaces.types.directory_id.DirectoryId",
platforms: "capo_workspaces.types.client_device_type_list.ClientDeviceTypeList",
*,
config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
) -> (
"capo_workspaces.types.delete_client_branding_result.DeleteClientBrandingResult"
):
"""<p>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.</p> <p>After you delete your customized client branding, your login portal reverts to the default client branding.</p>
Args:
resource_id: <p>The directory identifier of the WorkSpace for which you want to delete client branding.</p>
platforms: <p>The device type for which you want to delete client branding.</p>
Raises:
capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_workspaces.types.delete_client_branding_request.DeleteClientBrandingRequest]",
) -> AsyncOperationResponse[
"capo_workspaces.types.delete_client_branding_result.DeleteClientBrandingResult"
]:
import capo_workspaces._operations.workspaces_service.delete_client_branding
(
output,
http_response,
) = await capo_workspaces._operations.workspaces_service.delete_client_branding.async_delete_client_branding(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteClientBranding")
)
input_: capo_workspaces.types.delete_client_branding_request.DeleteClientBrandingRequest = {
"resource_id": resource_id,
"platforms": platforms,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|