describe_client_branding ¶

def describe_client_branding(
    self,
    resource_id: "capo_workspaces.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.describe_client_branding_result.DescribeClientBrandingResult":
    """<p>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.</p> <note> <p>Only device types that have branding information configured will be shown in the response.</p> </note>

    Args:
        resource_id: <p>The directory identifier of the WorkSpace for which you want to view client branding information.</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.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.describe_client_branding_request.DescribeClientBrandingRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.describe_client_branding_result.DescribeClientBrandingResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_client_branding

        output, http_response = (
            capo_workspaces._operations.workspaces_service.describe_client_branding.describe_client_branding(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClientBranding")
    )
    input_: capo_workspaces.types.describe_client_branding_request.DescribeClientBrandingRequest = {
        "resource_id": resource_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output