ml.yaml

x-generated: Automatically generated by CDP protoc plugin. Do not edit manually.
swagger: '2.0'
x-endpoint-name: ml
x-products: CDP
x-form-factors: public,private
x-cdp-releases: PUBLIC
info:
  version: 0.9.135 (BETA)
  title: Cloudera AI
  license:
    name: Apache 2.0
  description: Install and manage Cloudera AI applications.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/ml/addInstanceGroups:
    post:
      summary: Add new Cloudera AI workbench cluster instance groups.
      description: Add new Cloudera AI workbench cluster instance groups.
      operationId: addInstanceGroups
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/AddInstanceGroupsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AddInstanceGroupsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/addInstanceGroupsMlServingApp:
    post:
      summary: Add instance group to an existing Cloudera AI Inference Service instance.
      description: Add instance group to an existing Cloudera AI Inference Service instance.
      operationId: addInstanceGroupsMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/AddInstanceGroupsMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AddInstanceGroupsMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/backupWorkspace:
    post:
      summary: Backup a Cloudera AI workbench.
      description: Backup a Cloudera AI workbench.
      operationId: backupWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/BackupWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/BackupWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/createMlServingApp:
    post:
      summary: Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
      description: Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
      operationId: createMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/createModelRegistry:
    post:
      summary: Creates a new model registry.
      description: Create a new model registry by creating a new workbench and install model registry on it.
      operationId: createModelRegistry
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateModelRegistryRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateModelRegistryResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/createWorkspace:
    post:
      summary: Create a Cloudera AI workbench.
      description: Provision a Kubernetes cluster and install the Cloudera AI application in it.
      operationId: createWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/deleteBackup:
    post:
      summary: Deletes a backup snapshot.
      description: Deletes a Cloudera AI workbench backup.
      operationId: deleteBackup
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteBackupRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteBackupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/deleteInstanceGroup:
    post:
      summary: Deletes an instance group from the cluster.
      description: Deletes an instance group from a Cloudera AI workbench.
      operationId: deleteInstanceGroup
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteInstanceGroupRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteInstanceGroupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/deleteInstanceGroupMlServingApp:
    post:
      summary: Deletes an instance group from a Cloudera AI Inference Service instance.
      description: Deletes an instance group from a Cloudera AI Inference Service instance.
      operationId: deleteInstanceGroupMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteInstanceGroupMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteInstanceGroupMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/deleteMlServingApp:
    post:
      summary: Deletes Cloudera AI Inference Service instance.
      description: Gracefully deletes the Cloudera AI Inference Service instance without deleting the cluster.
      operationId: deleteMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/deleteModelRegistry:
    post:
      summary: Deletes a model registry.
      description: Delete a model registry.
      operationId: deleteModelRegistry
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteModelRegistryRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteModelRegistryResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/deleteWorkspace:
    post:
      summary: Delete Cloudera AI workbench.
      description: Deletes a Cloudera AI workbench.
      operationId: deleteWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/describeMlServingApp:
    post:
      summary: Describe Cloudera AI Inference Service instance.
      description: Describe Cloudera AI Inference Service instance.
      operationId: describeMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/describeModelRegistry:
    post:
      summary: Describe Cloudera AI Model Registry.
      description: Describes a Cloudera AI Model Registry.
      operationId: describeModelRegistry
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeModelRegistryRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeModelRegistryResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/describeWorkspace:
    post:
      summary: Describe Cloudera AI workbench.
      description: Describes a Cloudera AI workbench.
      operationId: describeWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/getAuditEvents:
    post:
      summary: Gets all the events belong to a workbench crn.
      description: Gets all the events belong to a workbench crn.
      operationId: getAuditEvents
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetAuditEventsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetAuditEventsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/getKubeconfig:
    post:
      summary: ListWorkspaceAccess Cloudera AI workbench.
      description: Lists users that can perform Kubernetes operations on a Cloudera AI workbench via EKS.
      operationId: getKubeconfig
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetKubeconfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetKubeconfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/getLatestWorkspaceVersion:
    post:
      summary: GetLatestWorkspaceVersion Cloudera AI workbench.
      description: Retrieves the latest version that Cloudera AI deploys to workbenches.
      operationId: getLatestWorkspaceVersion
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetLatestWorkspaceVersionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetLatestWorkspaceVersionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/getLogs:
    post:
      summary: Gets all the logs belong to a request id.
      description: Gets all the logs belong to a request id.
      operationId: getLogs
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetLogsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetLogsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/getMlServingAppKubeconfig:
    post:
      summary: Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.
      description: Gets the Kubeconfig of the Cloudera AI Inference Service kubernetes cluster.
      operationId: getMlServingAppKubeconfig
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetMlServingAppKubeconfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetMlServingAppKubeconfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/getModelRegistryKubeconfig:
    post:
      summary: GetModelRegistryKubeconfig returns kube config for model registry.
      description: Gets the Kubeconfig of the model registry cluster.
      operationId: getModelRegistryKubeconfig
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetModelRegistryKubeconfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetModelRegistryKubeconfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/grantMlServingAppAccess:
    post:
      summary: Grants admin access to a Cloudera AI Inference Service cluster.
      description: Grants an AWS user permissions to perform Kubernetes operations on a Cloudera AI Inference Service cluster.
      operationId: grantMlServingAppAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantMlServingAppAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GrantMlServingAppAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/grantModelRegistryAccess:
    post:
      summary: GrantModelRegistryAccess Cloudera AI Model Registry.
      description: Grants an AWS user to perform Kubernetes operations on a Cloudera AI model registry via EKS.
      operationId: grantModelRegistryAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantModelRegistryAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GrantModelRegistryAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/grantWorkspaceAccess:
    post:
      summary: GrantWorkspaceAccess Cloudera AI workbench.
      description: Grants an AWS user to perform Kubernetes operations on a Cloudera AI workbench via EKS.
      operationId: grantWorkspaceAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantWorkspaceAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GrantWorkspaceAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/listInstanceTypeConfiguration:
    post:
      summary: List the instance configuration for a given instance type.
      description: List of instances.
      operationId: listInstanceTypeConfiguration
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListInstanceTypeConfigurationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListInstanceTypeConfigurationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listMlServingAppAccess:
    post:
      summary: List members that have Kubernetes access to a Cloudera AI Inference Service cluster.
      description: Lists users that can perform Kubernetes operations on a Cloudera AI Inference Service cluster.
      operationId: listMlServingAppAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListMlServingAppAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListMlServingAppAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listMlServingApps:
    post:
      summary: List all Cloudera AI Inference Service instances.
      description: List all Cloudera AI Inference Service instances.
      operationId: listMlServingApps
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListMlServingAppsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListMlServingAppsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-skip-auditing: true
  /api/v1/ml/listModelRegistries:
    post:
      summary: Lists all model registries.
      description: List all model registries.
      operationId: listModelRegistries
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListModelRegistriesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListModelRegistriesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listModelRegistryAccess:
    post:
      summary: ListWorkspaceAccess Cloudera AI Model Registry.
      description: Lists users that can perform Kubernetes operations on a Cloudera AI model registry via EKS.
      operationId: listModelRegistryAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListModelRegistryAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListModelRegistryAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listRelevantInstances:
    post:
      summary: List the instance types for Cloudera AI workbench creation that have the requested resource.
      description: List of relevant instance type for Cloudera AI workbench creation.
      operationId: listRelevantInstances
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListRelevantInstancesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListRelevantInstancesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listWorkspaceAccess:
    post:
      summary: ListWorkspaceAccess Cloudera AI workbench.
      description: Lists users that can perform Kubernetes operations on a Cloudera AI workbench via EKS.
      operationId: listWorkspaceAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListWorkspaceAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListWorkspaceAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listWorkspaceBackups:
    post:
      summary: List backup snapshots of a workbench.
      description: List backup snapshots of a workbench.
      operationId: listWorkspaceBackups
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListWorkspaceBackupsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListWorkspaceBackupsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/ml/listWorkspaces:
    post:
      summary: List Cloudera AI workbenches.
      description: List Cloudera AI workbenches.
      operationId: listWorkspaces
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListWorkspacesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListWorkspacesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-skip-auditing: true
  /api/v1/ml/modifyClusterInstanceGroup:
    post:
      summary: Modify Cloudera AI workbench cluster instance group.
      description: Modify a Cloudera AI workbench cluster instance group.
      operationId: modifyClusterInstanceGroup
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModifyClusterInstanceGroupRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ModifyClusterInstanceGroupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/modifyClusterSecurity:
    post:
      summary: Modify Cloudera AI workbench cluster security.
      description: Modify a Cloudera AI workbench cluster security.
      operationId: modifyClusterSecurity
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModifyClusterSecurityRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ModifyClusterSecurityResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/modifyMlServingApp:
    post:
      summary: Modify instance groups for a Cloudera AI Inference Service cluster.
      description: Modify instance groups for a Cloudera AI Inference Service cluster.
      operationId: modifyMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModifyMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ModifyMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/modifyWorkspaceLoadBalancer:
    post:
      summary: Modify Cloudera AI workbench loadbalancer.
      description: Modify a Cloudera AI workbench loadbalancer.
      operationId: modifyWorkspaceLoadBalancer
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModifyWorkspaceLoadBalancerRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ModifyWorkspaceLoadBalancerResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/refreshModelRegistryConfigmap:
    post:
      summary: Refreshes the model registry configmap of the workbench.
      description: Refreshes the model registry configmap of the workbench from the control plane.
      operationId: refreshModelRegistryConfigmap
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RefreshModelRegistryConfigmapRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RefreshModelRegistryConfigmapResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/requestWorkflowCancellation:
    post:
      summary: Request a workflow cancellation.
      description: Request a long running workflow cancellation by resource ID and workflow type.
      operationId: requestWorkflowCancellation
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RequestWorkflowCancellationRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RequestWorkflowCancellationResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/restoreWorkspace:
    post:
      summary: Restore a Cloudera AI workbench.
      description: Create a new workbench based on an existing workbench backup snapshot.
      operationId: restoreWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RestoreWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RestoreWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/resumeWorkspace:
    post:
      summary: Resume Cloudera AI workbench.
      description: Resume a Cloudera Machine Learnings workbench.
      operationId: resumeWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ResumeWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ResumeWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/revokeMlServingAppAccess:
    post:
      summary: Revokes access to a Cloudera AI Inference Service cluster.
      description: Revokes an AWS user permissions on a Cloudera AI Inference Service cluster.
      operationId: revokeMlServingAppAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RevokeMlServingAppAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RevokeMlServingAppAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/revokeModelRegistryAccess:
    post:
      summary: RevokeModelRegistryAccess Cloudera AI Model Registry.
      description: Revokes an AWS user to perform Kubernetes operations on a Cloudera AI model registry via EKS.
      operationId: revokeModelRegistryAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RevokeModelRegistryAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RevokeModelRegistryAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/revokeWorkspaceAccess:
    post:
      summary: RevokeWorkspaceAccess Cloudera AI workbench.
      description: Revokes an AWS user to perform Kubernetes operations on a Cloudera AI workbench via EKS.
      operationId: revokeWorkspaceAccess
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RevokeWorkspaceAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RevokeWorkspaceAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/rollbackModelRegistryUpgrade:
    post:
      summary: Rollback a model registry upgrade. Restore prior model registry.
      description: Rollback a model registry upgrade. Restore prior model registry.
      operationId: rollbackModelRegistryUpgrade
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RollbackModelRegistryUpgradeRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RollbackModelRegistryUpgradeResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/suspendWorkspace:
    post:
      summary: Suspend Cloudera AI workbench.
      description: Suspend a Cloudera AI workbench.
      operationId: suspendWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SuspendWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SuspendWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/upgradeMlServingApp:
    post:
      summary: Upgrade a Cloudera AI Inference Service instance.
      description: Upgrade a Cloudera AI Inference Service instance to the latest available version.
      operationId: upgradeMlServingApp
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeMlServingAppRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeMlServingAppResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/upgradeModelRegistry:
    post:
      summary: Upgrade a model registry.
      description: Upgrade a model registry.
      operationId: upgradeModelRegistry
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeModelRegistryRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeModelRegistryResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/ml/upgradeWorkspace:
    post:
      summary: Upgrade Cloudera AI workbench.
      description: Upgrades a Cloudera AI workbench to the latest available version.
      operationId: upgradeWorkspace
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeWorkspaceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeWorkspaceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
definitions:
  Error:
    type: object
    description: An object returned on an error.
    properties:
      code:
        type: string
        description: The error code.
      message:
        type: string
        description: The error message.
  RootVolume:
    type: object
    description: Configuration for instance root device volume.
    required:
      - size
    properties:
      size:
        type: integer
        format: int64
        description: The volume size in GB.
  GetLogsRequest:
    type: object
    description: GetLogsRequest for getting logs for a request ID.
    required:
      - requestID
    properties:
      requestID:
        type: string
        description: Unique Key to identify a set of logs.
      fetchAll:
        type: boolean
        description: Flag to fetch all logs.
      pageSize:
        type: integer
        format: int32
        description: Limit the number of logs.
      offset:
        type: integer
        format: int32
        description: offset from which the logs should be fetched.
      workspaceCrn:
        type: string
        description: Deprecated. Please begin to use resourceCrn, as this will soon be unsupported
        x-deprecated: true
  GetLogsResponse:
    type: object
    description: GetLogsResponse contains all the logs for a given request id.
    required:
      - auditLogs
    properties:
      auditLogs:
        description: Contains all the logs for a given request id.
        $ref: '#/definitions/AuditLogs'
  AuditLogs:
    type: object
    description: AuditLogs contains all the logs for a given request id.
    required:
      - requestID
      - count
      - logs
    properties:
      requestID:
        type: string
        description: The request ID associated with a long-running operation to fetch the logs for.
      count:
        type: integer
        format: int32
        description: Total number of logs associated with the request id.
      logs:
        type: array
        items:
          $ref: '#/definitions/AuditLog'
        description: Contains all the logs for a given request id.
  AuditLog:
    type: object
    description: Audit log represents an individual log.
    required:
      - createdDate
      - log
    properties:
      createdDate:
        type: string
        format: date-time
        description: Time at which the log is created.
      log:
        type: string
        description: Log description.
  GetAuditEventsRequest:
    type: object
    description: GetAuditEventsRequest to get all audit events for a given workbench crn.
    properties:
      workspaceCrn:
        type: string
        description: Deprecated, please begin to use Resource crn, as this will soon be unsupported.
        x-deprecated: true
      resourceCrn:
        type: string
        description: Resource crn for which audit events to be fetched. Resource can be workbench or model registry.
  GetAuditEventsResponse:
    type: object
    description: GetAuditEventsResponse containes all the audit events for a given workbench crn.
    required:
      - auditEvents
    properties:
      auditEvents:
        description: Contains all the audit events for a given workbench crn.
        $ref: '#/definitions/AuditEvents'
  AuditEvents:
    type: object
    description: AuditEvents contains all the audit events for a given workbench crn.
    required:
      - workspaceCrn
      - events
    properties:
      workspaceCrn:
        type: string
        description: workbench crn unique for the set of audit events.
      events:
        type: array
        items:
          $ref: '#/definitions/AuditEvent'
        description: AuditEvent belong to the workbench crn.
  AuditEvent:
    type: object
    description: Audit event descibes an performed or performing in a given workbench.
    required:
      - workspaceCrn
      - userCrn
      - requestID
      - action
      - createdDate
    properties:
      workspaceCrn:
        type: string
        description: workbench crn where the event observed.
      userCrn:
        type: string
        description: UserCrn to track which user has caused the event.
      requestID:
        type: string
        description: Unique request ID to keep track of event.
      action:
        type: string
        description: Action the user has generated.
      createdDate:
        type: string
        format: date-time
        description: Time at creation of event.
  Autoscaling:
    type: object
    description: Configuration for instance auto scaling.
    required:
      - minInstances
      - maxInstances
    properties:
      minInstances:
        type: integer
        format: int32
        description: The minimum number of instance for auto scaling.
      maxInstances:
        type: integer
        format: int32
        description: The maximum number of instance for auto scaling.
      enabled:
        type: boolean
        description: The boolean flag to enable the auto scaling.
  InstanceGroup:
    type: object
    description: Contains the necessary info for an instance group.
    required:
      - instanceType
    properties:
      instanceType:
        type: string
        description: The cloud provider instance type for the node instance.
      instanceTier:
        type: string
        description: The tier of the instance i.e. on-demand/spot.
      instanceCount:
        type: integer
        format: int32
        description: The initial number of instance node.
      name:
        type: string
        description: The unique name for the instance or resource group of the workbench.
      ingressRules:
        type: array
        items:
          type: string
        description: The networking rules for the ingress.
      rootVolume:
        description: The root volume of the instance.
        $ref: '#/definitions/RootVolume'
      autoscaling:
        description: The auto scaling configuration.
        $ref: '#/definitions/Autoscaling'
  WorkspaceInstanceGroup:
    type: object
    description: Instance group information to show in workbench details.
    required:
      - instanceType
      - instanceCount
      - instanceGroupName
      - minInstances
      - maxInstances
      - instances
      - tags
    properties:
      instanceType:
        type: string
        description: The cloud provider instance type for the node instance.
      instanceCount:
        type: integer
        format: int32
        description: The initial number of instance node.
      instanceGroupName:
        type: string
        description: The system-assigned name of the instance group.
      minInstances:
        type: integer
        format: int32
        description: The minimum number of instances that can be deployed to this instance group. If the value is 0, the group might be empty.
      maxInstances:
        type: integer
        format: int32
        description: The maximum number of instances that can be deployed to this instance group.
      instances:
        type: array
        items:
          $ref: '#/definitions/Instance'
        description: Instances in the instance group.
      tags:
        type: array
        items:
          $ref: '#/definitions/Tag'
        description: Tags are key/value pairs that are applied to all tag-able resources deployed in the workbench's cloud environment.
      cpu:
        type: string
        description: Number of CPUs attached to this instance type.
      gpu:
        type: string
        description: Number of GPUs attached to this instance type.
      memory:
        type: string
        description: Memory in GiB attached to this instance type.
      rootVolumeSize:
        type: integer
        format: int64
        description: Root volume size in GiB attached to this instance type.
      name:
        type: string
        description: The unique name for the instance or resource group of the workbench.
  Instance:
    type: object
    description: Represents each instance in an instance group.
    required:
      - instanceId
      - availabilityZone
    properties:
      instanceId:
        type: string
        description: Unique instance Id generated by the cloud provider.
      availabilityZone:
        type: string
        description: Availability zone the instance belongs to.
  Tag:
    type: object
    description: Contains a single tag entry associated with a workbench.
    required:
      - key
      - value
    properties:
      key:
        type: string
        description: The name for the tag.
      value:
        type: string
        description: The value for the tag.
  ProvisionTag:
    type: object
    description: Contains a single tag entry that will be configured on cloud resources associated with a workbench.
    required:
      - key
      - value
    properties:
      key:
        type: string
        description: The name for the tag.
      value:
        type: string
        description: The value for the tag.
  ProvisionK8sRequest:
    type: object
    description: Request object for workbench provision. Required in public cloud.
    required:
      - instanceGroups
      - environmentName
    properties:
      instanceGroups:
        type: array
        items:
          $ref: '#/definitions/InstanceGroup'
        description: The instance groups.
      environmentName:
        type: string
        description: The name of the environment for the workbench to create.
      tags:
        type: array
        items:
          $ref: '#/definitions/ProvisionTag'
        description: Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera.
      network:
        description: The overlay network for an AWS Kubernetes cluster's CNI.
        $ref: '#/definitions/OverlayNetwork'
  ModelRegistryProvisionK8sRequest:
    type: object
    description: Request object for provisioning model registry.
    properties:
      tags:
        type: array
        items:
          $ref: '#/definitions/ProvisionTag'
        description: Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera.
      network:
        description: The overlay network for an AWS Kubernetes cluster's CNI.
        $ref: '#/definitions/OverlayNetwork'
  OverlayNetwork:
    type: object
    description: Contains the information about overlay network.
    properties:
      plugin:
        type: string
        description: 'The plugin specifies specific cni vendor, ex: calico, weave etc.'
      topology:
        description: The options for overlay topology.
        $ref: '#/definitions/Topology'
  Topology:
    type: object
    description: Contains the information about topology.
    properties:
      subnets:
        type: array
        items:
          type: string
        description: The options for subnets.
  ExistingDatabaseConfig:
    type: object
    description: Configurations for bringing an existing database for model metrics
    properties:
      existingDatabaseHost:
        type: string
        description: Optionally provide a Postgresql database host to export model metrics to.
      existingDatabasePort:
        type: string
        description: Optionally provide a Postgresql database port to export model metrics to.
      existingDatabaseName:
        type: string
        description: Optionally provide a Postgresql database name to export model metrics to.
      existingDatabaseUser:
        type: string
        description: Optionally provide a Postgresql database user to use when exporting model metrics.
      existingDatabasePassword:
        type: string
        description: Optionally provide a Postgresql database password to use when exporting model metrics.
        x-sensitive: true
  DeleteInstanceGroupMlServingAppRequest:
    type: object
    description: Request object for the DeleteInstanceGroupMlServingApp method.
    required:
      - appCrn
      - instanceGroupName
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service from which instance group is to be deleted.
      instanceGroupName:
        type: string
        description: The system-assigned name of the instance group to be deleted from the Cloudera AI Inference Service instance.
  DeleteInstanceGroupMlServingAppResponse:
    type: object
    description: Response object for the DeleteInstanceGroupMlServingApp method.
  AddInstanceGroupsMlServingAppRequest:
    type: object
    description: Request object for AddInstanceGroupsMlServingApp method.
    required:
      - appCrn
      - instanceGroups
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service instance to which the instance groups will be added.
      instanceGroups:
        type: array
        items:
          $ref: '#/definitions/InstanceGroup'
        description: The instance groups to be added to the Cloudera AI Inference Service instance.
  AddInstanceGroupsMlServingAppResponse:
    type: object
    description: Response object for AddInstanceGroupsMlServingApp method.
  CreateWorkspaceRequest:
    type: object
    description: Request object for the CreateWorkspace method.
    required:
      - environmentName
      - workspaceName
    properties:
      environmentName:
        type: string
        description: The environment for the workbench to create.
      workspaceName:
        type: string
        description: The name of the workbench to create.
      provisionK8sRequest:
        description: The request for Kubernetes workbench provision. Required in public cloud.
        $ref: '#/definitions/ProvisionK8sRequest'
      usePublicLoadBalancer:
        type: boolean
        description: The boolean flag to request public load balancer. By default, private load balancer is used.
      disableTLS:
        type: boolean
        description: The boolean flag to disable TLS setup for workbench. By default, the TLS is enabled.
      enableMonitoring:
        type: boolean
        description: The boolean flag is used to enable monitoring. By default, monitoring is disabled.
      enableGovernance:
        type: boolean
        description: Enables Cloudera AI governance by integrating with Cloudera Atlas. By default, this flag is disabled.
      existingNFS:
        type: string
        description: Optionally use an existing NFS by providing the hostname and desired path (Azure and Private Cloud only).
      loadBalancerIPWhitelists:
        type: array
        items:
          type: string
        description: The whitelist of IPs for load balancer.
      nfsVersion:
        type: string
        description: The NFS Protocol version of the NFS server we are using for Azure and Private Cloud.
      enableModelMetrics:
        type: boolean
        description: Enables the model metrics service for exporting metrics for models to a metrics store.
      existingDatabaseConfig:
        description: Optional configurations for an existing Postgres to export model metrics to.
        $ref: '#/definitions/ExistingDatabaseConfig'
      whitelistAuthorizedIPRanges:
        type: boolean
        description: Whether to whitelist only 'authorizedIPRanges' given or all public IPs.
      authorizedIPRanges:
        type: array
        items:
          type: string
        description: The whitelist of CIDR blocks which can access the API server.
      skipValidation:
        type: boolean
        description: Skip pre-flight validations if requested.
      privateCluster:
        type: boolean
        description: Whether to create a private cluster.
      subnetsForLoadBalancers:
        type: array
        items:
          type: string
        description: The list of subnets used for the load balancer that Cloudera AI creates.
      staticSubdomain:
        type: string
        description: The static subdomain to be used for the workbench.
      cdswMigrationMode:
        type: string
        description: Toggle for cdsw migration preflight validation
      outboundTypes:
        type: array
        items:
          $ref: '#/definitions/OutboundTypes'
        description: Outbound Types provided for the workbench.
      resourcePoolConfig:
        description: The resource pool configuration for quota management.
        $ref: '#/definitions/ResourcePoolConfig'
      enableEnhancedPerformance:
        type: boolean
        description: Enable Enhanced Performance Mode to maximize throughput and IOPS for root volumes attached to worker nodes.
  OutboundTypes:
    type: string
    description: List of possible Outbound types.
    enum:
      - UNKNOWN
      - OUTBOUND_TYPE_UDR
  RestoreWorkspaceRequest:
    type: object
    description: Request object for RestoreWorkspace method.
    properties:
      newWorkspaceParameters:
        description: The parameters required for a new Cloudera AI workbench.
        $ref: '#/definitions/CreateWorkspaceRequest'
      backupCrn:
        type: string
        description: The CRN of the backup snapshot to used for restoring.
      useStaticSubdomain:
        type: boolean
        description: A boolean value to check if subdomain must be used or not.
      restoreJobTimeoutMinutes:
        type: integer
        format: int32
        description: The timeout to restore the backup snapshots, in minutes.
  CreateWorkspaceResponse:
    type: object
    description: Response object for the CreateWorkspace method.
  RestoreWorkspaceResponse:
    type: object
    description: Response object for the RestoreWorkspace method.
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the Cloudera AI workbench being provisioned.
  ListWorkspacesRequest:
    type: object
    description: Request object for the ListWorkspaces method.
    properties:
      queryOptions:
        type: array
        items:
          type: string
        description: Additional query options.
  ListWorkspacesResponse:
    type: object
    description: Response object for the ListWorkspaces method.
    properties:
      workspaces:
        type: array
        items:
          $ref: '#/definitions/WorkspaceSummary'
        description: The list of workbenches.
  ListWorkspaceBackupsQueryOptions:
    type: object
    description: Query options object for ListWorkspaceBackups method.
    properties:
      expandEnvironmentMetadata:
        type: boolean
        description: When set to true, will return the metadata of the environment where the backed-up workbench is/was present.
  ListWorkspaceBackupsRequest:
    type: object
    description: Request object for ListWorkspaceBackups method.
    properties:
      environmentName:
        type: string
        description: The environment for the workbench to list backups for.
      workspaceName:
        type: string
        description: The name of the workbench to list backups for.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to list backups for. If this field is specified, environmentName and workspaceName are ignored.
      queryOptions:
        description: Additional query options to enhance/mutate the API response.
        $ref: '#/definitions/ListWorkspaceBackupsQueryOptions'
  BackupDetail:
    type: object
    description: Backup Detail response object for listing backups.
    properties:
      backupCrn:
        type: string
        description: The CRN of the backup snapshot.
      backupName:
        type: string
        description: The name of the backup snapshot.
      createdAt:
        type: string
        format: date-time
        description: The creation time of the backup snapshot.
      creatorCrn:
        type: string
        description: The CRN of the creator.
      workspaceVersionAtBackup:
        type: string
        description: The version of the backed-up workbench at the time of backup.
      backupStatus:
        type: string
        description: The status of the backup.
  ListWorkspaceBackupsResponse:
    type: object
    description: Response object for ListWorkspaceBackups method.
    properties:
      backups:
        type: array
        items:
          $ref: '#/definitions/BackupDetail'
        description: The list of backups along with their details.
  UpgradeState:
    type: object
    description: Response object for the workbench summary.
    properties:
      state:
        type: string
        description: The current upgrade state of the workbench.
      reason:
        type: string
        description: The reason for the current state.
  BackupMetadata:
    type: object
    description: Backup metadata response object for the workbench summary.
    properties:
      backupVaultName:
        type: string
        description: The backup vault name.
      lastSuccessfulBackupTime:
        type: string
        format: date-time
        description: The time when the last successful backup was taken.
      isSuccessfulBackupAvailable:
        type: boolean
        description: Whether successful backups are available for the workbench.
      lastBackupStatus:
        type: string
        description: The status of the last backup initiated.
      numberOfAvailableBackups:
        type: integer
        format: int64
        description: The number of backups available.
  WorkspaceSummary:
    type: object
    description: A Cloudera AI workbench which includes the deployed configuration details.
    required:
      - instanceName
      - environmentName
      - instanceStatus
      - instanceUrl
      - environmentCrn
      - crn
      - k8sClusterName
      - creatorCrn
      - version
      - httpsEnabled
      - filesystemID
      - cloudPlatform
      - monitoringEnabled
    properties:
      instanceName:
        type: string
        description: The name of the workbench.
      environmentName:
        type: string
        description: The name of the workbench's environment.
      instanceStatus:
        type: string
        description: The workbench's current status.
      instanceUrl:
        type: string
        description: URL of the workbench's user interface.
      environmentCrn:
        type: string
        description: CRN of the environment.
      crn:
        type: string
        description: The CRN of the workbench.
      k8sClusterName:
        type: string
        description: The Kubernetes cluster name.
      creatorCrn:
        type: string
        description: The CRN of the creator of the workbench.
      version:
        type: string
        description: The version of Cloudera AI that was installed on the workbench.
      httpsEnabled:
        type: boolean
        description: Indicates if HTTPs communication was enabled on this workbench when provisioned.
      filesystemID:
        type: string
        description: A filesystem ID referencing the filesystem that was created on the cloud provider environment that this workbench uses.
      cloudPlatform:
        type: string
        description: The cloud platform of the environment that was used to create this workbench.
      monitoringEnabled:
        type: boolean
        description: If usage monitoring is enabled or not on this workbench.
      loadBalancerIPWhitelists:
        type: array
        items:
          type: string
        description: The whitelist of IPs for load balancer.
      creationDate:
        type: string
        format: date-time
        description: Creation date of workbench.
      failureMessage:
        type: string
        description: Failure message from the most recent failure that has occurred during workbench provisioning.
      healthInfoLists:
        type: array
        items:
          $ref: '#/definitions/HealthInfo'
        description: The health info information of the workbench.
      upgradeState:
        description: The upgrade state contains the workbench upgrade information.
        $ref: '#/definitions/UpgradeState'
      nfsVersion:
        type: string
        description: NFS Version of the filesystem.
      backupMetadata:
        description: The Backup Metadata for the workbench.
        $ref: '#/definitions/BackupMetadata'
      clusterID:
        type: string
        description: The Cluster ID for the workbench.
      isPrivate:
        type: boolean
        description: The value to indicate if the cluster is private or not.
      isRestored:
        type: boolean
        description: The value to indicate if the workbench is restored one or not
  Workspace:
    type: object
    description: A ML workbench, which includes the cluster and storage.
    required:
      - instanceName
      - environmentName
      - instanceStatus
      - instanceUrl
      - environmentCrn
      - crn
      - k8sClusterName
      - creatorCrn
      - version
      - httpsEnabled
      - endpointPublicAccess
      - filesystemID
      - tags
      - instanceGroups
      - cloudPlatform
      - monitoringEnabled
    properties:
      instanceName:
        type: string
        description: The name of the workbench.
      environmentName:
        type: string
        description: The name of the workbench's environment.
      instanceStatus:
        type: string
        description: The workbench's current status.
      instanceUrl:
        type: string
        description: URL of the workbench's user interface.
      environmentCrn:
        type: string
        description: CRN of the environment.
      crn:
        type: string
        description: The CRN of the workbench.
      k8sClusterName:
        type: string
        description: The Kubernetes cluster name.
      creatorCrn:
        type: string
        description: The CRN of the creator of the workbench.
      version:
        type: string
        description: The version of Cloudera AI that was installed on the workbench.
      httpsEnabled:
        type: boolean
        description: To Display if Https is enabled or not.
      endpointPublicAccess:
        type: boolean
        description: To check if the cluster is publicly accessible or not.
      filesystemID:
        type: string
        description: filesystemID used by the workbench
      tags:
        type: array
        items:
          $ref: '#/definitions/Tag'
        description: Tags provided by the user at the time of workbench creation.
      instanceGroups:
        type: array
        items:
          $ref: '#/definitions/WorkspaceInstanceGroup'
        description: The instance groups.
      cloudPlatform:
        type: string
        description: The cloud platform of the environment that was used to create this workbench.
      monitoringEnabled:
        type: boolean
        description: If usage monitoring is enabled or not on this workbench.
      loadBalancerIPWhitelists:
        type: array
        items:
          type: string
        description: IP whitelist for loadBalancer.
      creationDate:
        type: string
        format: date-time
        description: Creation date of workbench.
      healthInfoLists:
        type: array
        items:
          $ref: '#/definitions/HealthInfo'
        description: The health info information of the workbench.
      failureMessage:
        type: string
        description: Failure message from the most recent failure that has occurred during workbench provisioning.
      clusterBaseDomain:
        type: string
        description: The basedomain of the cluster.
      modelMetricsEnabled:
        type: boolean
        description: Whether model metrics is enabled.
      governanceEnabled:
        type: boolean
        description: Whether governance is enabled.
      subnets:
        type: array
        items:
          type: string
        description: The subnets of the workbench.
      whitelistAuthorizedIPRanges:
        type: boolean
        description: Whether to whitelist only 'authorizedIPRanges' given or all public IPs.
      authorizedIPRanges:
        type: array
        items:
          type: string
        description: The whitelist of CIDR blocks which can access the API server.
      nfsVersion:
        type: string
        description: NFS Version of the filesystem.
      subnetsForLoadBalancers:
        type: array
        items:
          type: string
        description: The list of subnets used for the load balancer that Cloudera AI creates.
      upgradeState:
        description: The upgrade state contains the workbench upgrade information.
        $ref: '#/definitions/UpgradeState'
      backupMetadata:
        description: The Backup MetaData for this workbench
        $ref: '#/definitions/BackupMetadata'
      clusterID:
        type: string
        description: The Cluster ID for the workbench.
      isPrivate:
        type: boolean
        description: The value to indicate if the cluster is private or not.
      resourcePoolName:
        type: string
        description: Resource Pool for the workbench.
      parentResourcePoolName:
        type: string
        description: Parent Resource Pool for the workbench.
      quota:
        description: Quota configured for the workbench.
        $ref: '#/definitions/ResourceQuota'
      availableQuota:
        description: Available Quota for the workbench.
        $ref: '#/definitions/ResourceQuota'
      isRestored:
        type: boolean
        description: The value to indicate if the workbench is restored one or not
  UpgradeWorkspaceRequest:
    type: object
    description: Request object for the UpgradeWorkspace method.
    properties:
      environmentName:
        type: string
        description: The environment of the workbench.
      workspaceName:
        type: string
        description: The name of the workbench.
      mlVersion:
        type: string
        description: The version of workbench to upgrade to.
      workspaceCrn:
        type: string
        description: The CRN of the workbench. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.
  UpgradeWorkspaceResponse:
    type: object
    description: Response object for the UpgradeWorkspace method.
  DescribeWorkspaceRequest:
    type: object
    description: Request object for the DescribeWorkspace method.
    properties:
      environmentName:
        type: string
        description: The environment for the workbench to describe.
      workspaceName:
        type: string
        description: The name of the workbench to describe.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to describe. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.
  DescribeWorkspaceResponse:
    type: object
    description: Response object for the DescribeWorkspace method.
    required:
      - workspace
    properties:
      workspace:
        description: The workbench.
        $ref: '#/definitions/Workspace'
  DescribeModelRegistryRequest:
    type: object
    description: Request object for the DescribeModelRegistry method.
    required:
      - modelRegistryCrn
    properties:
      modelRegistryCrn:
        type: string
        description: The CRN of the Model Registry to describe.
  DescribeModelRegistryResponse:
    type: object
    description: Response object for the DescribeModelRegistry method.
    required:
      - modelRegistry
    properties:
      modelRegistry:
        description: The registry.
        $ref: '#/definitions/ModelRegistry'
  DeleteInstanceGroupRequest:
    type: object
    description: Request object for the DeleteInstanceGroup method.
    required:
      - workspaceCrn
      - instanceGroupName
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench from which instance group is to be deleted.
      instanceGroupName:
        type: string
        description: The system-assigned name of the instance group to be deleted from the workbench.
  DeleteInstanceGroupResponse:
    type: object
    description: Response object for the DeleteInstanceGroup method.
  DeleteWorkspaceRequest:
    type: object
    description: Request object for the DeleteWorkspace method.
    required:
      - force
    properties:
      force:
        type: boolean
        description: Force delete a workbench even if errors occur during deletion. Force delete removes the guarantee that resources in your cloud account will be cleaned up.
      removeStorage:
        type: boolean
        description: The remove storage flag indicates weather to keep the backing workbench filesystem storage or remove it during delete.
      environmentName:
        type: string
        description: The environment for the workbench to delete.
      workspaceName:
        type: string
        description: The name of the workbench to delete.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to delete. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.
  DeleteWorkspaceResponse:
    type: object
    description: Response object for the DeleteWorkspace method.
  GrantWorkspaceAccessRequest:
    type: object
    description: Request object for the GrantWorkspaceAccess method.
    properties:
      arn:
        type: string
        description: 'The aws user ARN to grant access to the corresponding EKS cluster. (Deprecated: Use identifier instead).'
        x-deprecated: true
      environmentName:
        type: string
        description: The environment that the workbench is a member of.
      workspaceName:
        type: string
        description: The name of the workbench to grant access to.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to grant access to. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.
      identifier:
        type: string
        description: The cloud provider user id which will be granted access to the workbench's Kubernetes cluster.
  GrantWorkspaceAccessResponse:
    type: object
    description: Response object for the GrantWorkspaceAccess method.
    required:
      - kubeconfig
    properties:
      kubeconfig:
        type: string
        description: The Kubernetes config file
        x-sensitive: true
  RevokeWorkspaceAccessRequest:
    type: object
    description: Request object for the RevokeWorkspace method.
    properties:
      arn:
        type: string
        description: 'The aws user ARN to revoke access to the corresponding EKS cluster. (Deprecated: Use identifier instead).'
        x-deprecated: true
      environmentName:
        type: string
        description: The environment that the workbench is a member of.
      workspaceName:
        type: string
        description: The name of the workbench to revoke access to.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to revoke access to. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.
      identifier:
        type: string
        description: The cloud provider user id which will be granted access to the workbench's Kubernetes cluster.
  RevokeWorkspaceAccessResponse:
    type: object
    description: Response object for the RevokeWorkspaceAccess method.
  ListWorkspaceAccessRequest:
    type: object
    description: Request object for the ListWorkspace method.
    properties:
      environmentName:
        type: string
        description: The environment that the workbench is a member of.
      workspaceName:
        type: string
        description: The name of the workbench to list access.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to list access. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.
  ListWorkspaceAccessResponse:
    type: object
    description: Response object for the ListWorkspaceAccess method.
    required:
      - users
    properties:
      users:
        type: array
        items:
          type: string
          x-sensitive: true
        description: The list of users that have access.
        x-sensitive: true
  GetKubeconfigRequest:
    type: object
    description: Request object for the GetKubeconfig method.
    properties:
      environmentName:
        type: string
        description: The environment that the workbench is a member of.
      workspaceName:
        type: string
        description: The name of the workbench to list access.
      workspaceCrn:
        type: string
        description: The CRN of the workbench to list access.
  GetMlServingAppKubeconfigRequest:
    type: object
    description: Request object for the GetMlServingAppKubeconfig method.
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service instance for retrieving the kubeconfig.
  GetModelRegistryKubeconfigRequest:
    type: object
    description: Request object for GetModelRegistryKubeconfig.
    properties:
      modelRegistryCrn:
        type: string
        description: CRN of the Model Registry
  GetModelRegistryKubeconfigResponse:
    type: object
    description: GetModelRegistryKubeconfigResponse response provides model registry kube config.
    properties:
      kubeConfig:
        type: string
        description: KubeConfig of the model registry cluster
  GetKubeconfigResponse:
    type: object
    description: Response object for the GetKubeconfig method.
    required:
      - kubeconfig
    properties:
      kubeconfig:
        type: string
        description: The list of users that have access.
        x-sensitive: true
  GetMlServingAppKubeconfigResponse:
    type: object
    description: Response object for the GetMlServingAppKubeconfig method.
    required:
      - kubeconfig
    properties:
      kubeconfig:
        type: string
        description: The kubeconfig of the Cloudera AI Inference Kubernetes cluster.
        x-sensitive: true
  GetLatestWorkspaceVersionRequest:
    type: object
    description: Request object for GetLatestWorkspaceVersion.
  GetLatestWorkspaceVersionResponse:
    type: object
    description: Response object for GetLatestWorkspaceVersion.
    required:
      - version
    properties:
      version:
        type: string
        description: The latest version of a workbench that is used when deploying Cloudera AI workbenches.
  HealthInfo:
    type: object
    description: Healthinfo object contains the health information of a resource.
    required:
      - resourceName
      - isHealthy
      - updatedAt
      - message
      - details
    properties:
      resourceName:
        type: string
        description: The resource name being checked.
      isHealthy:
        type: boolean
        description: The boolean that indicates the health status.
      updatedAt:
        type: string
        format: date-time
        description: The timestamp for the heartbeat.
      message:
        type: string
        description: The message to show for the health info.
      details:
        type: array
        items:
          type: string
        description: The detail of the health info.
  ModifyClusterInstanceGroupRequest:
    type: object
    description: Request object for ModifyClusterInstanceGroup.
    required:
      - workspaceCrn
      - instanceGroupName
      - min
      - max
      - instanceType
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench cluster to modify.
      instanceGroupName:
        type: string
        description: The system-assigned name of the instance group in the workbench cluster to be modified.
      min:
        type: integer
        format: int32
        description: The desired autoscaling min of the workbench cluster instance group.
      max:
        type: integer
        format: int32
        description: The desired autoscaling min of the workbench cluster instance group.
      instanceType:
        type: string
        description: The desired instance type of the workbench cluster instance group.
  AddInstanceGroupsRequest:
    type: object
    description: Request object for AddInstanceGroups.
    required:
      - workspaceCrn
      - instanceGroups
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench to which the instance groups are to be added.
      instanceGroups:
        type: array
        items:
          $ref: '#/definitions/InstanceGroup'
        description: The instance groups that we want to add to the workbench.
  AddInstanceGroupsResponse:
    type: object
    description: Response object for AddInstanceGroups.
  ModifyClusterInstanceGroupResponse:
    type: object
    description: Response object for ModifyClusterInstanceGroup.
  ModifyClusterSecurityRequest:
    type: object
    description: Request object for ModifyClusterSecurity.
    required:
      - workspaceCrn
      - allowlistAuthorizedIPRanges
      - authorizedIPRanges
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench cluster to modify.
      allowlistAuthorizedIPRanges:
        type: boolean
        description: Whether to allow only authorized IP ranges given or all public IPs.
      authorizedIPRanges:
        type: array
        items:
          type: string
        description: The allowlist of CIDR blocks which can access the API server.
  ModifyClusterSecurityResponse:
    type: object
    description: Response object for ModifyClusterSecurity.
  ModifyWorkspaceLoadBalancerRequest:
    type: object
    description: Request object for ModifyWorkspaceLoadBalancer.
    required:
      - workspaceCrn
      - loadBalancerIPAllowLists
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench cluster to modify.
      loadBalancerIPAllowLists:
        type: array
        items:
          type: string
        description: The allowlist of CIDR blocks which can access the loadbalancer.
  ModifyWorkspaceLoadBalancerResponse:
    type: object
    description: Response object for ModifyWorkspaceLoadBalancer.
  SuspendWorkspaceRequest:
    type: object
    description: Request object for SuspendWorkspace.
    required:
      - workspaceCrn
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench to suspend.
  SuspendWorkspaceResponse:
    type: object
    description: Response object for SuspendWorkspace.
  ResumeWorkspaceRequest:
    type: object
    description: Request object for ResumeWorkspace.
    required:
      - workspaceCrn
    properties:
      workspaceCrn:
        type: string
        description: The CRN of the workbench to resume.
  ResumeWorkspaceResponse:
    type: object
    description: Response object for ResumeWorkspace.
  BackupWorkspaceRequest:
    type: object
    description: The request object for Cloudera AI workbench backup.
    required:
      - workspaceCrn
      - backupName
    properties:
      workspaceCrn:
        type: string
        description: CRN of the workbench to backup.
      backupName:
        type: string
        description: Backup name.
      backupJobTimeoutMinutes:
        type: integer
        format: int32
        description: The timeout(in minutes) to use for the execution of the backup jobs.
      skipValidation:
        type: boolean
        description: Skip pre-flight validations if requested.
  BackupWorkspaceResponse:
    type: object
    description: The response object for Cloudera AI workbench backup.
    properties:
      backupCrn:
        type: string
        description: CRN of the backup generated.
      vaultName:
        type: string
        description: Name of the vault where backup related volumes are stored.
  DeleteBackupRequest:
    type: object
    description: The request object for DeleteBackup operation.
    required:
      - backupCrn
    properties:
      backupCrn:
        type: string
        description: The CRN of the backup to be deleted.
      skipValidation:
        type: boolean
        description: Skip pre-flight validations if requested.
  DeleteBackupResponse:
    type: object
    description: The response object for DeleteBackup operation.
    properties:
      workflowId:
        type: string
        description: The ID of the delete-backup workflow.
  WorkflowMetadata:
    type: object
    description: The workflow metadata.
    properties:
      resourceId:
        type: string
        description: The unique identifier of the resource.
      workflowIndex:
        type: integer
        format: int64
        description: The workflow index. Monotonically increases for each subsequent workflow for a resource.
      workflowType:
        type: string
        description: The workflow type.
      workflowId:
        type: string
        description: The workflow identifier.
      lastKnownStatus:
        type: string
        description: The last known status of the workflow.
  RequestWorkflowCancellationRequest:
    type: object
    description: Request object for RequestWorkflowCancellation.
    properties:
      resourceId:
        type: string
        description: The unique identifier of the resource.
      workflowType:
        type: string
        description: The workflow type.
  RequestWorkflowCancellationResponse:
    type: object
    description: Response object for RequestWorkflowCancellation.
    properties:
      workflowMetadata:
        type: array
        items:
          $ref: '#/definitions/WorkflowMetadata'
        description: The list of workflow metedata for cancelled workflows.
  CreateModelRegistryRequest:
    type: object
    description: Request object for creating model registry.
    properties:
      namespace:
        type: string
        description: The namespace of the model registry.
      s3AccessKey:
        type: string
        description: The S3 access key of Ozone.
        x-sensitive: true
      s3SecretKey:
        type: string
        description: The S3 secret key of Ozone.
        x-sensitive: true
      s3Bucket:
        type: string
        description: The s3Bucket of Ozone.
      s3Endpoint:
        type: string
        description: The endpoint of Ozone.
        x-no-paramfile: true
      creatorCrn:
        type: string
        description: The creator of model registry.
      environmentCrn:
        type: string
        description: The environment CRN of model registry.
      environmentName:
        type: string
        description: The environment for the model registry to create.
      usePublicLoadBalancer:
        type: boolean
        description: The boolean flag to request a public load balancer. By default, a private load balancer is used.
      subnetsForLoadBalancers:
        type: array
        items:
          type: string
        description: The list of subnets used for the load balancer that Cloudera AI creates.
      outboundTypes:
        type: array
        items:
          $ref: '#/definitions/OutboundTypes'
        description: Outbound Types provided for the cluster.
      skipValidation:
        type: boolean
        description: Skip pre-flight validations if requested.
      privateCluster:
        type: boolean
        description: Whether to create a private cluster.
      provisionK8sRequest:
        description: The request for Kubernetes cluster provision. Required in public cloud.
        $ref: '#/definitions/ModelRegistryProvisionK8sRequest'
      backupCrn:
        type: string
        description: The CRN of the backup that this model registry is created from.
      whitelistAuthorizedIPRanges:
        type: boolean
        description: Whether to whitelist only authorizedIPRanges given or all public IPs.
      authorizedIPRanges:
        type: array
        items:
          type: string
        description: The whitelist of CIDR blocks which can access the API server.
  CreateModelRegistryResponse:
    type: object
    description: Response for creating model registry request.
  ListModelRegistriesRequest:
    type: object
    description: Request object for deleting model registry.
  ListModelRegistriesResponse:
    type: object
    description: List of all available model registries.
    properties:
      modelRegistries:
        type: array
        items:
          $ref: '#/definitions/ModelRegistry'
        description: The list of model registry.
  ModelRegistry:
    type: object
    description: Model registry object
    properties:
      id:
        type: integer
        format: int64
        description: The id of model registry.
      namespace:
        type: string
        description: The namespace of model registry.
      s3Bucket:
        type: string
        description: The s3 bucket of model registry.
      s3Endpoint:
        type: string
        description: The Ozone endpoint of model registry.
      creator:
        type: string
        description: The creator of model registry.
      status:
        type: string
        description: The status of model registry.
      environmentCrn:
        type: string
        description: The environment CRN of model registry.
      createdAt:
        type: string
        format: date-time
        description: The creation time of model registry.
      crn:
        type: string
        description: ModelRegistry CRN.
      workspaceCrn:
        type: string
        description: Deprecated. workbench CRN. This field is no longer used.
        x-deprecated: true
      environmentName:
        type: string
        description: Environment name.
      workspaceName:
        type: string
        description: Deprecated, please refer to serviceName. workbench name.
        x-deprecated: true
      machineUserCrn:
        type: string
        description: The machine user CRN of the model registry.
      serviceName:
        type: string
        description: The service name of model registry.
      version:
        type: string
        description: The version of the model registry.
      domain:
        type: string
        description: The domain of the model registry
      endpointPublicAccess:
        type: boolean
        description: To indicate if the model registry standalone API endpoint is publicly accessible or not.
  DeleteModelRegistryRequest:
    type: object
    description: Request for deleting model registry.
    properties:
      id:
        type: string
        description: Deprecated, please use modelRegistryCrn. The environment CRN of the model registry.
        x-deprecated: true
      workspaceCrn:
        type: string
        description: Deprecated. The workbench CRN of the model registry (Public cloud only).
        x-deprecated: true
      force:
        type: boolean
        description: Force delete a model registry workbench even if errors occur during deletion. Force delete removes the guarantee that resources in your cloud account will be cleaned up. By default, force is set to false.
      modelRegistryCrn:
        type: string
        description: CRN of the model registry to be deleted.
  DeleteModelRegistryResponse:
    type: object
    description: Delete model registry response.
  UpgradeModelRegistryRequest:
    type: object
    description: Request for upgrading model registry.
    properties:
      crn:
        type: string
        description: The CRN of the model registry to be upgraded.
  UpgradeModelRegistryResponse:
    type: object
    description: Response for upgrading model registry.
    properties:
      crn:
        type: string
        description: The CRN of the model registry after upgrade.
  RollbackModelRegistryUpgradeRequest:
    type: object
    description: Request for rollback model registry upgrade.
    properties:
      crn:
        type: string
        description: The CRN of the model registry.
  RollbackModelRegistryUpgradeResponse:
    type: object
    description: Response for rollback model registry request.
  RefreshModelRegistryConfigmapRequest:
    type: object
    description: Request for refreshing workbench's model registry configmap.
    properties:
      workspaceCrn:
        type: string
        description: workbench CRN.
  RefreshModelRegistryConfigmapResponse:
    type: object
    description: Response for refreshing workbench's model registry configmap.
  ResourceQuota:
    type: object
    description: Resource quota configuration for quota management.
    required:
      - cpuQuota
      - memoryQuota
    properties:
      cpuQuota:
        type: string
        description: The quota for CPU resource.
      memoryQuota:
        type: string
        description: The quota for memory resource.
      gpuQuota:
        type: string
        description: The quota for gpu resource.
  ResourcePoolConfig:
    type: object
    description: Resource pool configuration for quota management.
    properties:
      parentPoolName:
        type: string
        description: The name of the parent resource pool.
      workspaceQuota:
        description: The resource quota.
        $ref: '#/definitions/QuotaConfig'
  QuotaConfig:
    type: object
    description: Quota configuration for quota management.
    required:
      - cpuQuota
      - memoryQuota
    properties:
      cpuQuota:
        type: string
        description: The quota for CPU resource.
      memoryQuota:
        type: string
        description: The quota for memory resource.
      gpuQuota:
        type: string
        description: The quota for gpu resource.
  GrantModelRegistryAccessRequest:
    type: object
    description: Request object for the GrantModelRegistryAccess method.
    properties:
      resourceCrn:
        type: string
        description: The CRN of the Model Registry to grant access to.
      identifier:
        type: string
        description: The cloud provider user id, such as ARN, which will be granted access to the model registry's Kubernetes cluster.
  GrantModelRegistryAccessResponse:
    type: object
    description: Response object for the GrantModelRegistryAccess method.
    required:
      - kubeconfig
    properties:
      kubeconfig:
        type: string
        description: The Kubernetes config file
        x-sensitive: true
  RevokeModelRegistryAccessRequest:
    type: object
    description: Request object for the RevokeModelRegistry method.
    properties:
      resourceCrn:
        type: string
        description: The CRN of the Model Registry to grant access to.
      identifier:
        type: string
        description: The cloud provider user id, such as ARN, which will be granted access to the model registry's Kubernetes cluster.
  RevokeModelRegistryAccessResponse:
    type: object
    description: Response object for the RevokeModelRegistryAccess method.
  ListModelRegistryAccessRequest:
    type: object
    description: Request object for the ListModelRegistryAccess method.
    properties:
      resourceCrn:
        type: string
        description: The CRN of the Model Registry to list access.
  ListModelRegistryAccessResponse:
    type: object
    description: Response object for the ListModelRegistryAccess method.
    required:
      - users
    properties:
      users:
        type: array
        items:
          type: string
          x-sensitive: true
        description: The list of users that have access.
        x-sensitive: true
  CreateMlServingAppRequest:
    type: object
    description: Request object for the CreateMlServingApp method.
    required:
      - appName
      - environmentCrn
    properties:
      appName:
        type: string
        description: The name of the Cloudera AI Inference Service to be created.
      environmentCrn:
        type: string
        description: The environment CRN.
      clusterCrn:
        type: string
        description: The cluster CRN of an existing cluster where Cloudera AI Inference Service instance will be deployed.
      provisionK8sRequest:
        description: The request for Kubernetes cluster provisioning. Required in public cloud.
        $ref: '#/definitions/MlServingProvisionK8sRequest'
      usePublicLoadBalancer:
        type: boolean
        description: The boolean flag to request a public load balancer. By default, a private load balancer is used.
      skipValidation:
        type: boolean
        description: Skip pre-flight validations if requested.
      loadBalancerIPWhitelists:
        type: array
        items:
          type: string
        description: The whitelist of IPs for load balancer.
      subnetsForLoadBalancers:
        type: array
        items:
          type: string
        description: The list of subnets to be used for the load balancer.
      staticSubdomain:
        type: string
        description: The static subdomain to be used for the Cloudera AI Inference Service instance.
      ozoneS3Creds:
        description: Ozone credentials for the Cloudera On-Premise cluster.
        $ref: '#/definitions/MlServingOzoneCreds'
  MlServingOzoneCreds:
    type: object
    description: Request object for the MlServingOzoneCreds method.
    properties:
      s3AccessID:
        type: string
        description: The Ozone S3 access key ID name.
      s3SecretAccessKey:
        type: string
        description: The Ozone S3 secret access key name.
        x-sensitive: true
      s3EndPointUrl:
        type: string
        description: The Ozone S3 end point.
      s3CaCertBundle:
        type: string
        description: The Ozone S3 CA bundle.
  CreateMlServingAppResponse:
    type: object
    description: Response object for the CreateMlServingApp method.
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service created.
  UpgradeMlServingAppRequest:
    type: object
    description: Request object for the UpgradeMlServingApp method.
    required:
      - appCrn
    properties:
      appCrn:
        type: string
        description: The Cloudera AI Inference Service CRN.
  UpgradeMlServingAppResponse:
    type: object
    description: Response object for the UpgradeMlServingApp method.
  DeleteMlServingAppRequest:
    type: object
    description: Request object for the DeleteMlServingApp method.
    required:
      - appCrn
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service to be deleted.
      force:
        type: boolean
        description: Forcefully deletes the Cloudera AI Inference service, bypassing any errors encountered during the deletion process. Please note that using force delete removes the assurance that resources in your cloud account will be properly cleaned up. By default, force is set to false.
  DeleteMlServingAppResponse:
    type: object
    description: Response object for the DeleteMlServingApp method.
  MlServingProvisionK8sRequest:
    type: object
    description: Request object for provisioning Cloudera AI Inference Service instance groups.
    required:
      - environmentCrn
    properties:
      environmentCrn:
        type: string
        description: The CRN of the environment for the cluster to create.
      instanceGroups:
        type: array
        items:
          $ref: '#/definitions/InstanceGroup'
        description: The instance groups.
      tags:
        type: array
        items:
          $ref: '#/definitions/ProvisionTag'
        description: Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera.
      network:
        description: The overlay network for an AWS Kubernetes cluster's CNI.
        $ref: '#/definitions/OverlayNetwork'
  ListMlServingAppsRequest:
    type: object
    description: Request object for the ListMlServingApps method.
    properties:
      queryOptions:
        type: array
        items:
          type: string
        description: Additional query options.
  ListMlServingAppsResponse:
    type: object
    description: Response object for the ListMlServingApps method.
    properties:
      apps:
        type: array
        items:
          $ref: '#/definitions/MlServingApp'
        description: The list of Apps.
  DescribeMlServingAppRequest:
    type: object
    description: Request object for the DescribeMlServingApp method.
    required:
      - appCrn
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service.
  DescribeMlServingAppResponse:
    type: object
    description: Response object for the DescribeMlServingApp method.
    properties:
      app:
        description: The Cloudera AI Inference Service instance.
        $ref: '#/definitions/MlServingApp'
  MlServingApp:
    type: object
    description: The Cloudera AI Inference Service instance.
    required:
      - cloudPlatform
    properties:
      cloudPlatform:
        type: string
        description: The cloud platform of the environment that was used to create this instance.
      appName:
        type: string
        description: The name of the Cloudera AI Inference Service instance.
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service instance.
      environmentCrn:
        type: string
        description: The CRN of the environment.
      environmentName:
        type: string
        description: The name of the environment.
      namespace:
        type: string
        description: The namespace used for this service.
      ownerEmail:
        type: string
        description: The email of the user who created this service.
      mlServingVersion:
        type: string
        description: The Cloudera AI Inference Service version running on this instance.
      isPrivateCluster:
        type: boolean
        description: Is this service installed on a private cluster.
      creationDate:
        type: string
        format: date-time
        description: Creation date of Cloudera AI Inference Service instance.
      cluster:
        description: The Kubernetes cluster information.
        $ref: '#/definitions/KubernetesCluster'
      status:
        type: string
        description: The status of the Cloudera AI Inference Service instance.
      usePublicLoadBalancer:
        type: boolean
        description: Indicates if this Cloudera AI Inference Service instance uses a public load balancer.
      httpsEnabled:
        type: boolean
        description: Indicates if HTTPs communication was enabled on this application when it was provisioned.
      subnetsForLoadBalancers:
        type: array
        items:
          type: string
        description: The list of subnets used for the load balancer.
      loadBalancerIPWhitelists:
        type: string
        description: The allowed list of IPs for the load balancer.
  KubernetesCluster:
    type: object
    description: The Kubernetes cluster information
    properties:
      clusterName:
        type: string
        description: The name of the Kubernetes cluster.
      domainName:
        type: string
        description: The domain name for the cluster.
      liftieID:
        type: string
        description: The identifier in Cloudera Data Platform Compute Service corresponding to this Kubernetes cluster.
      isPublic:
        type: boolean
        description: 'Deprecated: Please use isPrivateCluster instead, as this will soon be unsupported.'
        x-deprecated: true
      ipAllowlist:
        type: string
        description: 'Deprecated: Please use loadBalancerIPWhitelists instead, as this will soon be unsupported.'
        x-deprecated: true
      baseDomain:
        type: string
        description: The base domain for this cluster.
      subnets:
        type: string
        description: The subnets associated with this cluster.
      authorizedIpRanges:
        type: string
        description: The allow list of CIDR blocks which can access the API server.
      authorizedIpRangesAllowList:
        type: boolean
        description: Whether to allow only 'authorizedIPRanges' given or all public IPs.
      tags:
        type: array
        items:
          $ref: '#/definitions/Tag'
        description: Tags provided by the user at the time of app creation.
      instanceGroups:
        type: array
        items:
          $ref: '#/definitions/WorkspaceInstanceGroup'
        description: The instance groups.
      clusterCrn:
        type: string
        description: The cluster CRN of the kubernetes cluster.
  ListRelevantInstancesRequest:
    type: object
    description: Request object for the ListRelevantInstances method.
    required:
      - region
      - instanceCategory
      - cloudProvider
      - requestInfo
    properties:
      region:
        type: string
        description: Specifies the name of the region for which instance support details are requested.
      instanceCategory:
        type: string
        description: Defines the category of the instance (e.g., CPU, GPU) relevant for the query in the specified region.
      cloudProvider:
        type: string
        description: Identifies the cloud provider (e.g., AWS, Azure) for which to list supported instances.
      requestInfo:
        description: Specifies the requested resource inputs eg (CPU/GPU, model, memory etc).
        $ref: '#/definitions/RequestResourceInfo'
  ListRelevantInstancesResponse:
    type: object
    description: Response object for the ListRelevantInstances method.
    required:
      - instanceDetails
    properties:
      instanceDetails:
        type: array
        items:
          $ref: '#/definitions/InstanceDetails'
        description: Contains a list of instance details, including CPU, GPU, memory, and name, for supported instances in the queried region.
  ListInstanceTypeConfigurationRequest:
    type: object
    description: Request object for the ListInstanceTypeConfiguration method.
    required:
      - region
      - instanceCategory
      - cloudProvider
      - instanceType
    properties:
      region:
        type: string
        description: Specifies the name of the region for which instance support details are requested.
      instanceCategory:
        type: string
        description: Defines the category of the instance (e.g., CPU, GPU) relevant for the query in the specified region.
      cloudProvider:
        type: string
        description: Identifies the cloud provider (e.g., AWS, Azure) for which to list supported instances.
      instanceType:
        type: string
        description: Identifies the instance type.
  ListInstanceTypeConfigurationResponse:
    type: object
    description: Response object for the ListInstanceTypeConfiguration method.
    required:
      - instanceDetails
    properties:
      instanceDetails:
        type: array
        items:
          $ref: '#/definitions/InstanceDetails'
        description: Contains a list of instance details, including CPU, GPU, memory, and name, for queried supported instance type in the queried region.
  RequestResourceInfo:
    type: object
    description: Instance Details
    properties:
      gpuModel:
        type: string
        description: The model of the GPU, entails the complete name by the provider.
      gpuType:
        type: string
        description: The gpu type, eg A100
      cpu:
        type: string
        description: The number of CPU cores.
      gpu:
        type: string
        description: The number of GPUs.
      memory:
        type: string
        description: The memory size of the resource.
      gpuMemory:
        type: string
        description: The GPU memory size of the resource.
      computeCapability:
        type: string
        description: The compute capability of the GPU.
      interconnectType:
        type: string
        description: The interconnect type between 2 resources.
  InstanceDetails:
    type: object
    description: Instance Details
    required:
      - cpu
      - gpu
      - memory
      - name
      - category
    properties:
      cpu:
        type: string
        description: The number of CPU cores available for the instance in the region.
      gpu:
        type: string
        description: The number of GPUs available for the instance in the region.
      memory:
        type: string
        description: The amount of memory (RAM) available for the instance in the region, typically measured in GB.
      name:
        type: string
        description: A unique name or identifier for the instance type in the region.
      category:
        type: string
        description: Name of the CPU/GPU category to which it belongs.
      gpuModel:
        type: string
        description: GPU model.
      gpuType:
        type: string
        description: GPU model type.
      gpuMemory:
        type: string
        description: Memory capacity of the GPU.
      computeCapability:
        type: string
        description: Compute capability of the GPU.
      interconnectType:
        type: string
        description: Type of interconnect between GPUs.
  GrantMlServingAppAccessRequest:
    type: object
    description: Request object for the GrantMlServingAppAccess method.
    properties:
      resourceCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service instance to which access is to be granted.
      identifier:
        type: string
        description: The cloud provider user id, such as ARN, which will be granted access to the Cloudera AI Inference Service Kubernetes cluster.
  GrantMlServingAppAccessResponse:
    type: object
    description: Response object for the GrantMlServingAppAccess method.
    required:
      - kubeconfig
    properties:
      kubeconfig:
        type: string
        description: The Kubernetes config file
        x-sensitive: true
  RevokeMlServingAppAccessRequest:
    type: object
    description: Request object for the RevokeMlServingAppAccess method.
    properties:
      resourceCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service instance to revoke access.
      identifier:
        type: string
        description: The cloud provider user ID, such as ARN, from which access to the Cloudera AI Inference Service Kubernetes cluster needs to be revoked.
  RevokeMlServingAppAccessResponse:
    type: object
    description: Response object for the RevokeMlServingAppAccess method.
  ListMlServingAppAccessRequest:
    type: object
    description: Request object for the ListMlServingAppAccess method.
    properties:
      resourceCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service to list access.
  ListMlServingAppAccessResponse:
    type: object
    description: Response object for the ListMlServingAppAccess method.
    required:
      - users
    properties:
      users:
        type: array
        items:
          type: string
          x-sensitive: true
        description: The list of users that have access.
        x-sensitive: true
  ModifyMlServingAppRequest:
    type: object
    description: Request object for the ModifyMlServingApp method.
    required:
      - appCrn
      - instanceGroupName
      - min
      - max
      - instanceType
    properties:
      appCrn:
        type: string
        description: The CRN of the Cloudera AI Inference Service to be modified.
      instanceGroupName:
        type: string
        description: The system-assigned name of the instance group to be modified.
      min:
        type: integer
        format: int32
        description: The desired minimum number of instances in the instance group.
      max:
        type: integer
        format: int32
        description: The desired maximum number of instances in the instance group.
      instanceType:
        type: string
        description: The desired instance type of the instance group.
  ModifyMlServingAppResponse:
    type: object
    description: Response object for ModifyMlServingApp method.
x-audit: true