import_client_branding ¶

def import_client_branding(
    self,
    resource_id: "capo_workspaces.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    device_type_windows: Optional[
        "capo_workspaces.types.default_import_client_branding_attributes.DefaultImportClientBrandingAttributes"
    ] = None,
    device_type_osx: Optional[
        "capo_workspaces.types.default_import_client_branding_attributes.DefaultImportClientBrandingAttributes"
    ] = None,
    device_type_android: Optional[
        "capo_workspaces.types.default_import_client_branding_attributes.DefaultImportClientBrandingAttributes"
    ] = None,
    device_type_ios: Optional[
        "capo_workspaces.types.ios_import_client_branding_attributes.IosImportClientBrandingAttributes"
    ] = None,
    device_type_linux: Optional[
        "capo_workspaces.types.default_import_client_branding_attributes.DefaultImportClientBrandingAttributes"
    ] = None,
    device_type_web: Optional[
        "capo_workspaces.types.default_import_client_branding_attributes.DefaultImportClientBrandingAttributes"
    ] = None,
) -> (
    "capo_workspaces.types.import_client_branding_result.ImportClientBrandingResult"
):
    """<p>Imports 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 import client branding, the default branding experience for the specified platform type is replaced with the imported experience</p> <note> <ul> <li> <p>You must specify at least one platform type when importing client branding.</p> </li> <li> <p>You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.</p> </li> <li> <p>In each platform type, the <code>SupportEmail</code> and <code>SupportLink</code> parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.</p> </li> <li> <p>Imported data can take up to a minute to appear in the WorkSpaces client.</p> </li> </ul> </note>

    Args:
        resource_id: <p>The directory identifier of the WorkSpace for which you want to import client branding.</p>
        device_type_windows: <p>The branding information to import for Windows devices.</p>
        device_type_osx: <p>The branding information to import for macOS devices.</p>
        device_type_android: <p>The branding information to import for Android devices.</p>
        device_type_ios: <p>The branding information to import for iOS devices.</p>
        device_type_linux: <p>The branding information to import for Linux devices.</p>
        device_type_web: <p>The branding information to import for web access.</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_limit_exceeded_exception.ResourceLimitExceededException: <p>Your resource limits have been exceeded.</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.import_client_branding_request.ImportClientBrandingRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.import_client_branding_result.ImportClientBrandingResult"
    ]:
        import capo_workspaces._operations.workspaces_service.import_client_branding

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ImportClientBranding")
    )
    input_: capo_workspaces.types.import_client_branding_request.ImportClientBrandingRequest = {
        "resource_id": resource_id
    }
    if device_type_windows is not None:
        input_["device_type_windows"] = device_type_windows
    if device_type_osx is not None:
        input_["device_type_osx"] = device_type_osx
    if device_type_android is not None:
        input_["device_type_android"] = device_type_android
    if device_type_ios is not None:
        input_["device_type_ios"] = device_type_ios
    if device_type_linux is not None:
        input_["device_type_linux"] = device_type_linux
    if device_type_web is not None:
        input_["device_type_web"] = device_type_web

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