openapi: 3.2.0
info:
  version: 0.9.163
  title: Cloudera Data Warehouse [EXPERIMENTAL] Dw API
  license:
    name: Apache 2.0
  description: Install and manage Cloudera Data Warehouse clusters.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
tags:
- name: Dw
paths:
  /api/v1/dw/listClusters:
    post:
      x-no-compatibility-guarantee: true
      summary: List Cloudera Data Warehouse clusters
      description: List Cloudera Data Warehouse clusters.
      operationId: listClusters
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClustersResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListClustersRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeCluster:
    post:
      x-no-compatibility-guarantee: true
      summary: Describe a Cloudera Data Warehouse cluster
      description: Describe a Cloudera Data Warehouse cluster.
      operationId: describeCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createClusterDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Create a diagnostic job for the given cluster
      description: Creates a diagnostic job for the given cluster. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see --download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see --destination). General metadata about the diagnostics will also be included as the bundle-info.json file.
      operationId: createClusterDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClusterDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listClusterDiagnosticDataJobs:
    post:
      x-mutating: false
      x-paging-default-max-items: 100
      x-form-factors: public
      summary: Get a list of diagnostic jobs for the given cluster
      description: Lists diagnostic jobs for the given cluster. The output includes a list of jobs along with their current status and metadata related to each job.
      operationId: listClusterDiagnosticDataJobs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClusterDiagnosticDataJobsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListClusterDiagnosticDataJobsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeClusterDiagnosticDataJob:
    post:
      x-mutating: false
      x-form-factors: public
      summary: Describes a diagnostic job for the given Cluster
      description: Describes a diagnostic job for the given Cluster. The output includes a list of jobs along with their current status and some metadata related to each job.
      operationId: describeClusterDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeClusterDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeClusterDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteClusterDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Deletes a diagnostic job for the given cluster
      description: Deletes a diagnostic job for the given cluster. The job can be deleted even when its status is "Running".
      operationId: deleteClusterDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteClusterDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteClusterDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeKubeconfig:
    post:
      x-form-factors: public
      summary: Get Kubeconfig for a Cloudera Data Warehouse cluster
      description: Get Kubeconfig for a Cloudera Data Warehouse cluster.
      operationId: describeKubeconfig
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeKubeconfigResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeKubeconfigRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeAllowedInstanceTypes:
    post:
      x-mutating: false
      x-form-factors: public
      summary: Get allowed compute instance types for both AWS and Azure cluster types and…
      description: Get allowed compute instance types for both AWS and Azure cluster types and their default values.
      operationId: describeAllowedInstanceTypes
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAllowedInstanceTypesResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAllowedInstanceTypesRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeServerSetting:
    post:
      x-form-factors: private
      summary: Get the DWX server settings
      description: Get the DWX server settings. This method can be used from DWX Private Cloud version 1.4.1.
      operationId: describeServerSetting
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeServerSettingResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeServerSettingRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateServerSetting:
    post:
      x-form-factors: private
      summary: Update the DWX server settings
      description: 'Update the DWX server settings. The input list of server settings will be updated accordingly (turns on if enabled: true is set, turns off if enabled: false is set). Some settings need further actions to be taken (e.g. recreating a Virtual Warehouse), this is indicated in the server setting list returned by the describeServerSetting functionality. This method can be used from DWX Private Cloud version 1.4.1.'
      operationId: updateServerSetting
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateServerSettingResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServerSettingRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/resetServerSettings:
    post:
      x-form-factors: private
      summary: Restores the DWX server settings to the default values
      description: Restores the DWX server settings to the default values. Some settings need further actions to be taken (e.g. recreating a Virtual Warehouse), this is indicated in the server settings list returned by the describeServerSetting functionality.
      operationId: resetServerSettings
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetServerSettingsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetServerSettingsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listEvents:
    post:
      x-form-factors: public,private
      x-mutating: false
      summary: Get the list of events
      description: 'Get the list of events for the given Operation or a specific Service (Cluster, Database Catalog, Virtual Warehouse, or Data Visualization App). Events can belong to a particular Operation which might span across multiple Services. This happens if the given operation affects one or more Services e.g.: restore-cluster. It is also possible to return the events only for a given Service, in this case it is enough to pass the Id of a Service (e.g.: env-sq7hfv, warehouse-1696571829-pps2, compute-1696571962-8dd8, impala-1696572085-cn44).'
      operationId: listEvents
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEventsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEventsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateSshKey:
    post:
      x-form-factors: public
      summary: Update the SSH Key for a Cloudera Data Warehouse cluster
      operationId: updateSshKey
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSshKeyResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSshKeyRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/renewCertificates:
    post:
      summary: Renew certificates for a Cloudera Data Warehouse public cloud cluster
      description: Renew certificate for a Cloudera Data Warehouse public cloud cluster.
      operationId: renewCertificates
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenewCertificatesResponse'
        405:
          description: Operation not allowed on non-public cloud clusters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenewCertificatesRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createCluster:
    post:
      x-no-compatibility-guarantee: true
      summary: Create a Cloudera Data Warehouse cluster
      description: Create a Cloudera Data Warehouse cluster.
      operationId: createCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createAwsCluster:
    post:
      x-mutating: true
      summary: Create an AWS cluster in the Cloudera Data Warehouse
      description: Create an AWS cluster in the Cloudera Data Warehouse environment with the provided settings.
      operationId: createAwsCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAwsClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAwsClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createAzureCluster:
    post:
      x-mutating: true
      summary: Create an Azure cluster in the Cloudera Data Warehouse
      description: Create an Azure cluster in the Cloudera Data Warehouse environment with the provided settings.
      operationId: createAzureCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAzureClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAzureClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createPrivateCluster:
    post:
      x-form-factors: private
      x-no-compatibility-guarantee: true
      x-mutating: true
      summary: Create a a Private Cloud cluster in the Cloudera Data Warehouse
      description: Create a Private Cloud cluster in the Cloudera Data Warehouse environment with the provided settings.
      operationId: createPrivateCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePrivateClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrivateClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteCluster:
    post:
      x-no-compatibility-guarantee: true
      summary: Delete a Cloudera Data Warehouse cluster
      description: Delete a Cloudera Data Warehouse cluster.
      operationId: deleteCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateCluster:
    post:
      x-mutating: true
      summary: Updates the Cloudera Data Warehouse cluster
      description: Update the Cloudera Data Warehouse cluster.
      operationId: updateCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/backupCluster:
    post:
      x-mutating: true
      x-no-compatibility-guarantee: true
      summary: Creates a backup from the cluster configuration and settings
      description: Creates a backup from the configuration and settings, including all the connected DbCatalogs, Virtual Warehouses and Data Visualisation Apps. The returned data may be used to restore all the entities by using the "restore-cluster" command. The CDW doesn't provide centralized management of the backups. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html
      operationId: backupCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/restoreCluster:
    post:
      x-mutating: true
      x-no-compatibility-guarantee: true
      summary: Restores the cluster from a backup data made by "backup-cluster" command
      description: Restores the cluster from a backup data made by "backup-cluster" command. The operation restores the default DbCatalog configuration, the Virtual Warehouses and the Data Visualisation Apps. Learn more at https://docs.cloudera.com/data-warehouse/cloud/backup-and-restore/topics/dw-environment-reactivation.html
      operationId: restoreCluster
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreClusterResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreClusterRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createDataVisualization:
    post:
      summary: Creates a Cloudera Data Visualization
      description: Creates a Cloudera Data Visualization.
      operationId: createDataVisualization
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataVisualizationResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataVisualizationRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listDataVisualizations:
    post:
      summary: Lists Cloudera Data Visualization in the provided CDW cluster
      description: Lists Cloudera Data Visualization in the provided CDW cluster.
      operationId: listDataVisualizations
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataVisualizationsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataVisualizationsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteDataVisualization:
    post:
      summary: Asynchronous operation that deletes a Cloudera Data Visualization.
      description: Asynchronous operation that deletes a Cloudera Data Visualization. When the DV is in deleting state, we can still use describe-data-visualization to check the status. Once it is deleted, the describe-data-visualization would return a not found error.
      operationId: deleteDataVisualization
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataVisualizationResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDataVisualizationRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeDataVisualization:
    post:
      summary: Describes a Cloudera Data Visualization
      description: Describes a Cloudera Data Visualization.
      operationId: describeDataVisualization
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDataVisualizationResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDataVisualizationRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateDataVisualization:
    post:
      x-mutating: true
      summary: Asynchronous operation that updates the configuration of a Cloudera Data…
      description: Asynchronous operation that updates the configuration of a Cloudera Data Visualization. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
      operationId: updateDataVisualization
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDataVisualizationResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataVisualizationRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/getDataVisualizationUpgradeVersion:
    post:
      summary: Gets latest version and latest compatible version for Cloudera Data…
      description: Gets latest version and latest compatible version for Cloudera Data Visualization.
      operationId: getDataVisualizationUpgradeVersion
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataVisualizationUpgradeVersionResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDataVisualizationUpgradeVersionRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/upgradeDataVisualization:
    post:
      summary: Asynchronous operation that upgrades a Cloudera Data Visualization to a…
      description: Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
      operationId: upgradeDataVisualization
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeDataVisualizationResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeDataVisualizationRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/registerSecret:
    post:
      x-form-factors: public
      x-mutating: true
      summary: Registers a reference to a secret stored in the vault of the cloud provider
      description: Registers a reference to a secret stored in the vault of the cloud provider and stores its metadata in the database. The secret is used to connect to an external data source.
      operationId: registerSecret
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterSecretResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterSecretRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createSecret:
    post:
      x-form-factors: private
      x-mutating: true
      summary: Creates a secret in the user's kubernetes cluster
      description: Creates a secret in the user's kubernetes cluster and stores its metadata in the database. The secret is used to connect to an external data source.
      operationId: createSecret
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSecretResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSecretRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listSecrets:
    post:
      x-form-factors: public,private
      x-mutating: false
      summary: Lists all secrets
      description: Lists all the cloud provider secrets in a particular environment.
      operationId: listSecrets
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSecretsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSecretsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteSecret:
    post:
      x-form-factors: public,private
      x-mutating: true
      summary: Deletes a secret
      description: Deletes a secret from the database.
      operationId: deleteSecret
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSecretResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSecretRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createConnector:
    post:
      x-no-compatibility-guarantee: true
      summary: Creates a Connector
      description: Creates a new Connector in the specified cluster.
      operationId: createConnector
      responses:
        '200':
          description: Connector created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      x-form-factors: public,private
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createConnectorTestJob:
    post:
      x-no-compatibility-guarantee: true
      summary: Test Trino Connector in a CDW cluster
      description: Test Trino Connector in a CDW cluster.
      operationId: createConnectorTestJob
      responses:
        '200':
          description: Connection test job created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorTestJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      x-form-factors: public,private
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorTestJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listConnectorTestJobs:
    post:
      x-no-compatibility-guarantee: true
      summary: List test connector jobs
      description: List test connector jobs.
      operationId: listConnectorTestJobs
      responses:
        '200':
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorTestJobsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      x-form-factors: public,private
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConnectorTestJobsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listConnectors:
    post:
      x-no-compatibility-guarantee: true
      summary: Lists Database Connectors
      description: Lists Database Connectors.
      operationId: listConnectors
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      x-form-factors: public,private
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConnectorsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteConnector:
    post:
      x-no-compatibility-guarantee: true
      summary: Deletes a Database connector
      description: Deletes a Database connector.
      operationId: deleteConnector
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteConnectorResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      x-form-factors: public,private
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConnectorRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateConnector:
    post:
      x-mutating: true
      x-form-factors: public,private
      summary: Updates the Cloudera Data Warehouse connector
      description: Update the Cloudera Data Warehouse connector.
      operationId: updateConnector
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConnectorResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectorRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createDbc:
    post:
      x-no-compatibility-guarantee: true
      x-deprecated: true
      summary: Create a Database Catalog
      description: 'DEPRECATED: Create a Database Catalog. The Database Catalog creation is deprecated and will be removed in subsequent releases. The Default Database Catalog is getting created during the cluster activation (create-cluster).'
      operationId: createDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listDbcs:
    post:
      x-no-compatibility-guarantee: true
      summary: List Database Catalogs
      description: List Database Catalogs.
      operationId: listDbcs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDbcsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDbcsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeDbc:
    post:
      x-no-compatibility-guarantee: true
      summary: Describe a Database Catalog
      description: Describe a Database Catalog.
      operationId: describeDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteDbc:
    post:
      x-no-compatibility-guarantee: true
      summary: Delete a Database Catalog
      description: Delete a Database Catalog.
      operationId: deleteDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/rebuildDbc:
    post:
      x-no-compatibility-guarantee: true
      summary: Rebuild a Database Catalog
      description: Rebuild a Database Catalog. Please use this feature for Database Catalogs which are in inconsistent or erroneous state. Running/Stopped Database Catalogs are safe to rebuild as well. This is a Beta feature. If a rebuild has been initiated, try to avoid rebuilding it again until it is completed or in erroneous state.
      operationId: rebuildDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RebuildDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RebuildDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/suspendDbc:
    post:
      x-mutating: true
      summary: Suspends a running Database Catalog
      description: Suspends a running Database Catalog. Has no effect if the DBC is already suspended.
      operationId: suspendDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuspendDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuspendDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/startDbc:
    post:
      x-mutating: true
      summary: Start a Database Catalog
      description: Start a Database Catalog.
      operationId: startDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeDbcConfig:
    post:
      x-mutating: false
      summary: Describes the Database Catalog current configuration
      description: Describes the Database Catalog current configuration.
      operationId: describeDbcConfig
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDbcConfigResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDbcConfigRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateDbcConfig:
    post:
      x-mutating: true
      summary: Update a Database Catalog configuration
      description: Update a Database Catalog configuration.
      operationId: updateDbcConfig
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDbcConfigResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDbcConfigRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createDbcDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Create a diagnostic job for the given database catalog
      description: Creates a diagnostic job for the given database catalog. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see --download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see --destination). General metadata about the diagnostics will also be included as the bundle-info.json file.
      operationId: createDbcDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDbcDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDbcDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listDbcDiagnosticDataJobs:
    post:
      x-mutating: false
      x-paging-default-max-items: 100
      x-form-factors: public
      summary: Get a list of diagnostic jobs for the given Database Catalog
      description: Lists diagnostic jobs for the given Database Catalog. The output includes a list of jobs along with their current status and metadata related to each job.
      operationId: listDbcDiagnosticDataJobs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDbcDiagnosticDataJobsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDbcDiagnosticDataJobsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeDbcDiagnosticDataJob:
    post:
      x-mutating: false
      x-form-factors: public
      summary: Describes a diagnostic job for the given Database Catalog
      description: Describes a diagnostic job for the given Database Catalog. The output includes a list of jobs along with their current status and some metadata related to each job.
      operationId: describeDbcDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDbcDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDbcDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteDbcDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Deletes a diagnostic job for the given Database Catalog
      description: Deletes a diagnostic job for the given Database Catalog. The job can be deleted even when its status is "Running".
      operationId: deleteDbcDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDbcDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDbcDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listDbcEvents:
    post:
      x-mutating: false
      summary: Get the list of events for the given Database Catalog
      description: Get the list of events for the given Database Catalog.
      operationId: listDbcEvents
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDbcEventsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDbcEventsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createVw:
    post:
      x-no-compatibility-guarantee: true
      summary: Create a Virtual Warehouse
      description: Create a Virtual Warehouse.
      operationId: createVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listVws:
    post:
      x-no-compatibility-guarantee: true
      summary: List Virtual Warehouses
      description: List Virtual Warehouses.
      operationId: listVws
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVwsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListVwsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeVw:
    post:
      x-no-compatibility-guarantee: true
      summary: Describe a Virtual Warehouse
      description: Describe a Virtual Warehouse.
      operationId: describeVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateVwConfig:
    post:
      x-mutating: true
      summary: Update a Virtual Warehouse configuration
      description: Update a Virtual Warehouse configuration.
      operationId: updateVwConfig
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVwConfigResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVwConfigRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteVw:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: true
      summary: Delete a Virtual Warehouse
      description: Delete a Virtual Warehouse.
      operationId: deleteVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/rebuildVw:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: true
      summary: Rebuild a Virtual Warehouse
      description: Rebuild a Virtual Warehouse. Please use this feature for Virtual Warehouses which are in inconsistent or erroneous state. Running/Stopped Virtual Warehouses are safe to rebuild as well. This is a Beta feature. If a rebuild has been initiated, try to avoid rebuilding it again until it is completed or in erroneous state.
      operationId: rebuildVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RebuildVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RebuildVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/startVw:
    post:
      x-mutating: true
      summary: Starts a suspended Virtual Warehouse
      description: Starts a suspended Virtual Warehouse. Has no effect if the VW is already started.
      operationId: startVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/suspendVw:
    post:
      x-mutating: true
      summary: Suspends a running Virtual Warehouse
      description: Suspends a running Virtual Warehouse. Has no effect if the VW is already suspended.
      operationId: suspendVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuspendVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuspendVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createVwDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Create a diagnostic job for the given Virtual Warehouse
      description: Creates a job for the given Virtual Warehouse. The diagnostic data job is useful for troubleshooting purposes. The job collects logs and metrics (see --hive-download-options, --impala-download-options to see available options) which are going to be bundled into a single file and will be available at the desired location (see --destination). General metadata about the diagnostics will also be included as the bundle-info.json file.
      operationId: createVwDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVwDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVwDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listVwDiagnosticDataJobs:
    post:
      x-mutating: false
      x-paging-default-max-items: 100
      x-form-factors: public
      summary: Get a list of diagnostic jobs for the given Virtual Warehouse
      description: Lists diagnostic jobs for the given Virtual Warehouse. The output includes a list of jobs along with their current status and metadata related to each job.
      operationId: listVwDiagnosticDataJobs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVwDiagnosticDataJobsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListVwDiagnosticDataJobsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeVwDiagnosticDataJob:
    post:
      x-mutating: false
      x-form-factors: public
      summary: Describe a diagnostic jobs for the given Virtual Warehouse
      description: Describes a diagnostic job for the given Virtual Warehouse. The output includes a list of jobs along with their current status and metadata related to each job.
      operationId: describeVwDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeVwDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeVwDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteVwDiagnosticDataJob:
    post:
      x-mutating: true
      x-form-factors: public
      summary: Delete a diagnostic job for the given Virtual Warehouse
      description: Delete a diagnostic job for the given Virtual Warehouse. The job can be deleted even when its status is "Running".
      operationId: deleteVwDiagnosticDataJob
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteVwDiagnosticDataJobResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVwDiagnosticDataJobRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listVwEvents:
    post:
      x-mutating: false
      summary: Get the list of events for the given Virtual Warehouse
      description: Get the list of events for the given Virtual Warehouse.
      operationId: listVwEvents
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVwEventsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListVwEventsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listLatestVersions:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: false
      summary: Lists the latest version of the product (if available) for all catalogs in the…
      description: Lists the latest version of the product (if available) for all catalogs in the environment.
      operationId: listLatestVersions
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLatestVersionsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLatestVersionsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeVwConfig:
    post:
      x-mutating: false
      summary: Describes the current configuration of a Hive or Impala Virtual Warehouse
      description: Describes the current configuration of a Hive or Impala Virtual Warehouse.
      operationId: describeVwConfig
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeVwConfigResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeVwConfigRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeConfig:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: false
      summary: Describe a service configuration
      description: Describe a service configuration.
      operationId: describeConfig
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeConfigDiff:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: false
      summary: Get differences between two service configurations
      description: Get differences between two service configurations.
      operationId: describeConfigDiff
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigDiffResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigDiffRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listDbcConfigs:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: false
      summary: Get the configuration history of a Database Catalog
      description: Get the configuration history of a Database Catalog.
      operationId: listDbcConfigs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDbcConfigsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDbcConfigsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listVwConfigs:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: false
      summary: Get the configuration history of a Virtual Warehouse
      description: Get the configuration history of a Virtual Warehouse.
      operationId: listVwConfigs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVwConfigsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListVwConfigsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateVw:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: true
      summary: Update the configuration of a Virtual Warehouse
      description: Update the configuration of a Virtual Warehouse.
      operationId: updateVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateDbc:
    post:
      x-no-compatibility-guarantee: true
      x-mutating: true
      summary: Update the configuration of a Database Catalog
      description: Update the configuration of a Database Catalog.
      operationId: updateDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/addUser:
    post:
      x-mutating: true
      summary: Adds the given user to the cluster
      description: Adds the given user to the cluster. Please note that the user must pre-exist.
      operationId: addUser
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddUserResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUserRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteUser:
    post:
      x-mutating: true
      summary: Deletes the given user from the cluster
      description: Deletes the given user from the cluster. Please note that the user itself won't be deleted, only removed from the cluster.
      operationId: deleteUser
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUserRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listUsers:
    post:
      x-mutating: false
      summary: Lists the users who have access to the cluster
      description: Lists the users who have access to the cluster.
      operationId: listUsers
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListUsersRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/upgradeDbc:
    post:
      x-mutating: true
      summary: Upgrades the Database Catalog to a compatible version
      description: Upgrades the Database Catalog to a compatible version.
      operationId: upgradeDbc
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeDbcResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeDbcRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/upgradeVw:
    post:
      x-mutating: true
      summary: Upgrades the Virtual Warehouse to a compatible version
      description: Upgrades the Virtual Warehouse to a compatible version.
      operationId: upgradeVw
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeVwResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeVwRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/getUpgradeVwVersions:
    post:
      x-mutating: false
      summary: Gets the latest version and latest compatible version for Virtual Warehouse
      description: Gets the latest version and latest compatible version for Virtual Warehouse.
      operationId: getUpgradeVwVersions
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUpgradeVwVersionsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUpgradeVwVersionsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/getUpgradeDbcVersions:
    post:
      x-mutating: false
      summary: Gets the latest version and latest compatible version for Database Catalog
      description: Gets the latest version and latest compatible version for Database Catalog.
      operationId: getUpgradeDbcVersions
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUpgradeDbcVersionsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUpgradeDbcVersionsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/healthCheck:
    post:
      x-mutating: false
      summary: Check the health of the API
      description: Check the health of the API.
      operationId: healthCheck
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthCheckRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createBackup:
    post:
      summary: Creates a backup for the data warehouse
      description: Creates an on-demand backup for the data warehouse including Kubernetes objects, persistent volumes, etc. Backup requests are processed asynchronously and instantaneously.
      operationId: createBackup
      x-right: dw/createBackup
      x-mutating: true
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteBackup:
    post:
      summary: Deletes a data warehouse backup
      description: Deletes an existing data warehouse backup. The call returns immediately.
      operationId: deleteBackup
      x-right: dw/deleteBackup
      x-mutating: true
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBackupRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeBackup:
    post:
      summary: Describes the backup
      description: Returns the description of an existing data warehouse backup.
      operationId: describeBackup
      x-right: dw/describeBackup
      x-mutating: false
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBackupRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/restoreBackup:
    post:
      summary: Restores backup
      description: Restores the state of the data warehouse from an existing backup.
      operationId: restoreBackup
      x-right: dw/restoreBackup
      x-mutating: true
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreBackupRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/describeRestore:
    post:
      summary: Describes the restore
      description: Returns the description of a data warehouse restore operation.
      operationId: describeRestore
      x-right: dw/describeRestore
      x-mutating: false
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRestoreResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeRestoreRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listBackupEntities:
    post:
      summary: Lists potential backup entities associated with the data warehouse
      description: Lists potential backup entities associated with the data warehouse.
      operationId: listBackupEntities
      x-right: dw/listBackupEntities
      x-mutating: false
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupEntitiesResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupEntitiesRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listBackups:
    post:
      summary: Lists backups
      description: Lists backups associated with the data warehouse.
      operationId: listBackups
      x-right: dw/listBackups
      x-mutating: false
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listRestores:
    post:
      summary: Lists restores
      description: Lists restores associated with the data warehouse.
      operationId: listRestores
      x-right: dw/listRestores
      x-mutating: false
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRestoresResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRestoresRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/getLogs:
    post:
      summary: Gets job logs
      description: Given the CRN, returns the corresponding job logs.
      operationId: getLogs
      x-right: dw/getLogs
      x-mutating: false
      x-form-factors: private
      x-no-compatibility-guarantee: true
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLogsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetLogsRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/listResourceTemplates:
    post:
      summary: Get default resource allocation templates
      description: This command provides a predefined set of available resource configuration in CDW. Users allowed to tailor these default CPU and Memory settings according their needs using the 'update-resource' command. Setting up these values correctly is crucial when creating a Hive / Impala and DataViz instances using the 'create-vw' / 'create-data-visualisation' commands. The 'id' of the response object has to be supplied in the 'create-vw' / 'create-data-visualisation' command 'template' field respectively, in order to specify the chosen resource allocation size. Please note, the 'default' fields in the response denotes default supplied value if the 'template' not specified in the create commands. These templates are versioned, so users are able to roll-back to a particular version. Existing resources not affected by roll-back. Learn more about each of the resource allocations with the 'describe-resource' command.
      operationId: listResourceTemplates
      x-mutating: false
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResourceTemplatesResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListResourceTemplatesRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/createResourceTemplate:
    post:
      summary: Create a resource allocation template
      description: This command's purpose is to facilitate the creation of resource templates in CDW. Users are allowed to tailor default CPU and Memory settings according to their needs. Setting up these values correctly is crucial when creating Hive / Impala and DataViz instances using the 'create-vw' / 'create-data-visualisation' commands. The 'id' of the response object must be supplied in the 'create-vw' / 'create-data-visualisation' command 'template' field to specify the chosen resource allocation size. Please note, that the 'default' fields in the response denote the default supplied value if the 'template' is not specified in the create commands. These templates are versioned so that users can rollback to a particular version. Existing resources are not affected by rollback. Learn more about each resource allocation with the 'describe-resource' command.
      operationId: createResourceTemplate
      x-mutating: true
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResourceTemplateResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateResourceTemplateRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/updateResourceTemplate:
    post:
      summary: Update a resource allocation template
      description: This command's purpose is to facilitate the update of resource templates in CDW. Users are allowed to tailor default CPU and Memory settings according to their needs. Setting up these values correctly is crucial when creating Hive / Impala and DataViz instances using the 'create-vw' / 'create-data-visualisation' commands. The 'id' of the response object must be supplied in the 'create-vw' / 'create-data-visualisation' command 'template' field to specify the chosen resource allocation size. Please note, that the 'default' fields in the response denote the default supplied value if the 'template' is not specified in the create commands. These templates are versioned so that users can rollback to a particular version. Existing resources are not affected by rollback. Learn more about each resource allocation with the 'describe-resource' command.
      operationId: updateResourceTemplate
      x-mutating: true
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateResourceTemplateResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateResourceTemplateRequest'
        required: true
      tags:
      - Dw
  /api/v1/dw/deleteResourceTemplate:
    post:
      summary: Delete a resource allocation template
      description: This command's purpose is to facilitate the delete of resource templates in CDW.
      operationId: deleteResourceTemplate
      x-mutating: true
      x-form-factors: private
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResourceTemplateResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteResourceTemplateRequest'
        required: true
      tags:
      - Dw
components:
  schemas:
    UpdateResourceTemplateResponse:
      type: object
      description: The response object for the updateResourceTemplate method.
      x-mutating: false
      x-form-factors: private
      properties:
        templateId:
          type: string
          description: The id of the updated template.
    GetUpgradeVwVersionsResponse:
      type: object
      description: Response object for the getUpgradeVwVersions method.
      properties:
        latestVersion:
          type: string
          description: The latest available CDW version.
        compatibleVersion:
          type: string
          description: The latest compatible CDW version.
        latestCDPVersion:
          type: string
          description: The latest available CDP version.
        compatibleCDPVersion:
          type: string
          description: The latest compatible CDP version.
    ApplicationResourcesBreakdown:
      type:
      - object
      - 'null'
      description: Breakdown of the service memory requirements.
      x-mutating: false
      x-form-factors: private
      properties:
        xms:
          type:
          - string
          - 'null'
          description: Java VM configuration for -Xms (initial and minimum heap size).
        xmx:
          type: string
          description: Java VM configuration for -Xmx (maximum heap size).
        xss:
          type:
          - string
          - 'null'
          description: Java VM configuration for -Xss (thread stack size).
        maxDirectMemorySize:
          type:
          - string
          - 'null'
          description: Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers).
    Connector:
      x-form-factors: public,private
      type: object
      description: Represents the details of a connector used to integrate external systems or data sources with Cloudera Data Warehouse. A connector defines the configuration, and connection properties required to establish and manage connectivity.
      properties:
        crn:
          type: string
          description: The CRN of the connector.
        id:
          type: string
          description: Unique per-cluster connector ID.
        name:
          type: string
          description: Display name.
        template:
          type: string
          description: The template of the connector.
        config:
          type: object
          description: 'The connector configuration in key-value format. For example, { "connector.name": "hive", "fs.cache.directories": "/data/trino/fs_cache_hive", "fs.cache.enabled": "true", "fs.cache.max-disk-usage-percentages": "30", "fs.cache.preferred-hosts-count": "2", "fs.cache.ttl": "7d", "hive.allow-drop-table": "true", "hive.collect-column-statistics-on-write": "false", "hive.metastore.uri": "thrift://metastore-service.{{ .Values.warehouseId }}.svc.cluster.local:9083", "hive.non-managed-table-writes-enabled": "true", "hive.security": "{{ .Values.authorizationMode }}", "ranger.audit_config": "ranger-hive-audit.xml", "ranger.hadoop_config": "core-site.xml", "ranger.policy_mgr_ssl_config": "ranger-policymgr-ssl.xml", "ranger.security_config": "ranger-hive-security.xml", "ranger.service_name": "{{ .Values.rangerHiveSvcName }}" }.'
          additionalProperties:
            type: string
        description:
          type: string
          description: User-provided description.
        createdBy:
          type: string
          description: The CRN of the user who created the connector.
        createdAt:
          type: integer
          format: int64
          description: The timestamp when the connector was created.
        updatedAt:
          type: integer
          format: int64
          description: The timestamp when the connector was last updated.
        updatedBy:
          type: string
          description: The CRN of the user who last updated the connector.
    SuspendDbcResponse:
      type: object
      description: The response object for the suspendDbc method.
    GetLogsResponse:
      type: object
      x-form-factors: private
      description: Response object for the get logs request.
      required:
      - logs
      properties:
        logs:
          type: string
          description: Contains the logs of the operation.
          x-skip-logging: true
    HealthCheckRequest:
      type: object
      description: Request object for the healthCheck method.
    ConfigBlockDiff:
      type: object
      description: Differences between two ConfigBlocks.
      properties:
        id:
          type: string
          description: ID of the ConfigBlock.
        contentDiff:
          description: Differences between the contents.
          $ref: '#/components/schemas/ConfigContentDiff'
    AddUserResponse:
      type: object
      description: Response object for the addUser method.
    UpdateDbcRequest:
      type: object
      description: Request object for the updateDbc method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        resourceTemplateId:
          type: string
          description: The resource template of the Database Catalog.
        config:
          description: The service configuration to update the DBC with. This will be applied on top of the existing configuration so there's no need to list configurations that stay the same.
          $ref: '#/components/schemas/ServiceConfigReq'
    AutoscalingOptionsResponse:
      type: object
      description: Auto-scaling configuration for a Virtual Warehouse.
      properties:
        minClusters:
          type: integer
          format: int32
          description: Minimum number of available Executor Groups.
        maxClusters:
          type: integer
          format: int32
          description: Maximum number of available Executor Groups.
        disableAutoSuspend:
          type: boolean
          description: Turn off auto suspend for Virtual Warehouse.
        autoSuspendTimeoutSeconds:
          type: integer
          format: int32
          description: Auto suspend threshold for Virtual Warehouse.
        hiveScaleWaitTimeSeconds:
          type: integer
          format: int32
          description: Wait time before a scale event happens.
        hiveDesiredFreeCapacity:
          type: integer
          format: int32
          description: Desired free capacity.
        impalaHighAvailabilityMode:
          x-deprecated: true
          type: string
          enum:
          - ACTIVE_PASSIVE
          - ACTIVE_ACTIVE
          - DISABLED
          description: DEPRECATED in favor of the top level impalaHASettings object. High Availability mode.
        impalaScaleUpDelaySeconds:
          type: integer
          format: int32
          description: Scale up the scaling up threshold in seconds.
        impalaScaleDownDelaySeconds:
          type: integer
          format: int32
          description: Scale down threshold in seconds.
        impalaEnableShutdownOfCoordinator:
          x-deprecated: true
          type: boolean
          description: DEPRECATED in favor of the top level impalaHASettings object. Whether a shutdown of the coordinator is enabled.
        impalaNumOfActiveCoordinators:
          x-deprecated: true
          type: integer
          format: int32
          description: DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators.
        impalaShutdownOfCoordinatorDelaySeconds:
          x-deprecated: true
          type: integer
          format: int32
          description: DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens.
        impalaEnableCatalogHighAvailability:
          x-deprecated: true
          type: boolean
          description: DEPRECATED in favor of the top level impalaHASettings object. Denotes whether a backup instance for Impala catalog is enabled.
        impalaExecutorGroupSets:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetsResponse'
          description: Configurations of executor groups sets for workload aware autoscaling.
    DescribeServerSettingItemRequiresUpdate:
      type: string
      description: Indicates an update requirement for the change to take effect. `ENVIRONMENT` - Means that the environments need to be updated/recreated for the setting change to take effect. `DBC` - Means that the Database Catalogs need an update/recreation. `IMPALA` - Means that the Impala Virtual Warehouses need the update/recreation. `HIVE` - Means that the Hive Virtual Warehouses need the update/recreation. `TRINO` - Means that the Trino Virtual Warehouses need the update/recreation. `VIZ` - Means that the Dataviz need the update/recreation. `CDW_HUE` - Means that the CDW Hues need an update/recreation.
      x-form-factors: private
      enum:
      - ENVIRONMENT
      - DBC
      - IMPALA
      - HIVE
      - TRINO
      - VIZ
      - CDW_HUE
    AddUserRequest:
      type: object
      description: Request object for the addUser method.
      required:
      - clusterId
      - userId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to which the user must be added.
        userId:
          type: string
          description: A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).
    BackupClusterResponse:
      type: object
      description: Response object for the backupCluster method.
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        operationId:
          type: string
          description: The ID of the backup operation.
        timestamp:
          type: string
          format: date-time
          description: The date of the creation.
        data:
          x-sensitive: true
          type: string
          description: The backup data.
        md5:
          x-sensitive: true
          type: string
          description: The md5 hash of the encoded data.
    DescribeServerSettingResponse:
      type: object
      description: Response object for the describeServerSetting method.
      x-form-factors: private
      properties:
        settings:
          type: array
          items:
            $ref: '#/components/schemas/DescribeServerSettingItem'
          description: The list of the server settings.
    UpdateVwRequest:
      type: object
      description: Request object for the updateVw method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        tShirtSize:
          type: string
          description: Name of T-shirt size to use, which will determine the number of nodes.
          enum:
          - xsmall
          - small
          - medium
          - large
          - waa
        nodeCount:
          type: integer
          format: int32
          default: 0
          description: Nodes per compute cluster. If specified, forces 'template' to be 'custom'
        config:
          description: The service configuration to update the VW with. This will be applied on top of the existing configuration so there's no need to list configurations that stay the same.
          $ref: '#/components/schemas/ServiceConfigReq'
        autoscaling:
          description: Autoscaling settings for the Virtual Warehouse.
          $ref: '#/components/schemas/AutoscalingOptionsUpdateRequest'
        impalaHaSettings:
          description: High Availability settings update for the Impala Virtual Warehouse.
          $ref: '#/components/schemas/ImpalaHASettingsUpdateRequest'
        queryIsolationOptions:
          description: Query isolation settings for Hive Virtual Warehouses.
          $ref: '#/components/schemas/QueryIsolationOptionsRequest'
        hiveAuthenticationMode:
          type:
          - string
          - 'null'
          x-deprecated: true
          x-form-factors: private
          description: 'DEPRECATED - Sets the authentication mode to use by Hive Server: * `LDAP` * `KERBEROS` If not set then the authentication mode will not be changed during update.'
        platformJwtAuth:
          type:
          - boolean
          - 'null'
          description: Value of 'true' automatically configures the Virtual Warehouse to support JWTs issues by the CDP JWT token provider.  Value of 'false' does not enable JWT auth on the Virtual Warehouse.  If this field is not specified, it defaults to 'false'.
        impalaQueryLog:
          type:
          - boolean
          - 'null'
          x-form-factors: public
          description: Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not.
        logHiveQueries:
          x-form-factors: private
          type:
          - boolean
          - 'null'
          description: Denotes whether the Hive Virtual Warehouse stores Hive query information for all completed queries in the sys.query_history system table. You can query this table using SQL to monitor and optimize the Hive engine.
        hiveServerHaMode:
          type:
          - string
          - 'null'
          x-form-factors: private
          description: 'If specified, modifies Hive Server High Availability mode in Private Cloud: * `DISABLED` - Disables Hive Server high availability. * `ACTIVE_PASSIVE` - Runs two Hive Server instances, one active and one passive. Hive session failover is not supported in this setup.'
        associatedConnectors:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ConnectorData'
          description: Map of connector ID to connector information for the VW.
        additionalQuota:
          x-form-factors: private
          $ref: '#/components/schemas/QuotaRequest'
          description: Setting the quota for the 3rd party services injected into the Virtual Warehouse namespace.
    UpdateServerSettingRequest:
      type: object
      description: Request object for the updateServerSetting method.
      x-form-factors: private
      properties:
        settings:
          type: array
          items:
            $ref: '#/components/schemas/UpdateServerSettingItem'
          description: The list of the server setting updates.
    DescribeKubeconfigResponse:
      type: object
      description: Response object for the describeKubeconfig method.
      properties:
        kubeconfig:
          type: string
          description: The kubeconfig.
    GetUpgradeVwVersionsRequest:
      type: object
      description: Request object for the getUpgradeVwVersions method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: The ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: The ID of the Virtual Warehouse.
    CreateConnectorResponse:
      x-form-factors: public,private
      type: object
      description: Response for the createConnector call.
      properties:
        result:
          description: The ID of the newly created Connector.
          $ref: '#/components/schemas/Connector'
    DescribeVwDiagnosticDataJobRequest:
      type: object
      description: Request object for the describeVwDiagnosticDataJobRequest method.
      x-form-factors: public
      required:
      - clusterId
      - vwId
      - jobId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        jobId:
          type: string
          description: ID of the diagnostic job.
    AutoscalingOptionsCreateRequest:
      type: object
      description: Auto-scaling configuration for a Virtual Warehouse.
      properties:
        minClusters:
          type: integer
          format: int32
          default: 1
          description: Sets the minimum number of Executor Groups.
        maxClusters:
          type: integer
          format: int32
          default: 5
          description: 'Sets the maximum number of Executor Groups the Virtual Warehouse can scale up to. This value defines the upper boundary for autoscaling. The total node capacity is determined by this number multiplied by the number of nodes in the selected `--t-shirt-size`. NOTE: On Azure, all IPs for the maximum node count are pre-allocated. If you use the same `--instance-type` for multiple Virtual Warehouses, they will share the same underlying nodepool and its limit is calculated as the sum of all nodes required by the corresponding Virtual Warehouses.'
        disableAutoSuspend:
          type: boolean
          description: Turn off auto suspend for Virtual Warehouse.
        autoSuspendTimeoutSeconds:
          type: integer
          format: int32
          description: Auto suspend threshold for Virtual Warehouse.
        hiveScaleWaitTimeSeconds:
          type: integer
          format: int32
          description: Set wait time before a scale event happens. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided.
        hiveDesiredFreeCapacity:
          type: integer
          format: int32
          description: Set Desired free capacity. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided.
        impalaHighAvailabilityMode:
          x-deprecated: true
          type: string
          enum:
          - ACTIVE_PASSIVE
          - ACTIVE_ACTIVE
          - DISABLED
          description: DEPRECATED in favor of the top level impalaHASettings object. Set High Availability mode. If not provided the default will apply. This value is disregarded for Hive.
        impalaScaleUpDelaySeconds:
          type: integer
          format: int32
          description: Scale up the scaling up threshold in seconds. If not provided defaults will apply.
        impalaScaleDownDelaySeconds:
          type: integer
          format: int32
          description: Scale down threshold in seconds. If not provided defaults will apply.
        impalaEnableShutdownOfCoordinator:
          x-deprecated: true
          type: boolean
          description: 'DEPRECATED: in favor of the top level impalaHASettings object. Enables a shutdown of the coordinator.'
        impalaShutdownOfCoordinatorDelaySeconds:
          x-deprecated: true
          type: integer
          format: int32
          description: DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens.
        impalaNumOfActiveCoordinators:
          x-deprecated: true
          type: integer
          format: int32
          description: DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators.
        impalaEnableCatalogHighAvailability:
          x-deprecated: true
          type: boolean
          description: DEPRECATED in favor of the top level impalaHASettings object. Enables a backup instance for Impala catalog to ensure high availability.
        impalaExecutorGroupSets:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetsCreateRequest'
          description: Configures executor group sets for workload aware autoscaling.
        trinoDisableAutoScaling:
          type: boolean
          description: Disables Auto-scaling for Trino VW.
          default: true
        trinoMaxWorkerCount:
          type: integer
          format: int32
          description: Maximum number of worker nodes in a Trino VW.
          default: 10
        trinoMinWorkerCount:
          type: integer
          format: int32
          description: Minimum number of worker nodes in a Trino VW.
          default: 1
        trinoShutdownGracePeriod:
          type: integer
          format: int32
          description: Grace period in seconds before shutting down Trino workers.
          default: 300
        trinoScaleDownDelaySeconds:
          type: integer
          format: int32
          description: Scale down threshold in seconds. If not provided, the defaults will apply.
          default: 30
        trinoScaleUpDelaySeconds:
          type: integer
          format: int32
          description: Scale up threshold in seconds. If not provided defaults will apply.
          default: 15
    UpgradeVersions:
      type: object
      description: Details of upgrade versions.
      properties:
        latestVersion:
          type: string
          description: Latest available Data Visualization version.
    ListVwDiagnosticDataJobsResponse:
      type: object
      description: Response object for the listVwDiagnosticDataJobsRequest method.
      x-form-factors: public
      properties:
        jobs:
          type: array
          description: The list of the jobs belonging to the particular Virtual Warehouse.
          items:
            $ref: '#/components/schemas/VwDiagnosticDataJob'
          x-paging-result: true
        nextToken:
          type: string
          x-paging-output-token: true
          description: The token to use when requesting the next set of results. If there are no additional results, the string is empty.
    DescribeVwConfigRequest:
      type: object
      description: Request object for the describeVwConfig method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
    DeleteConnectorResponse:
      x-form-factors: public,private
      type: object
      description: Response object for the deleteConnector method.
    ApplicationConfigReq:
      type: object
      description: Configurations for an application inside a service.
      properties:
        configBlocks:
          type: array
          description: List of ConfigBlocks for the application.
          items:
            $ref: '#/components/schemas/ConfigBlockReq'
    ListDbcsResponse:
      type: object
      description: Response object for the listDbcs method.
      properties:
        dbcs:
          type: array
          items:
            $ref: '#/components/schemas/DbcSummary'
          description: The list of Database Catalogs.
    QueryIsolationOptionsResponse:
      type: object
      description: Configurations for Query Isolation.
      properties:
        maxQueries:
          type: integer
          format: int32
          description: Maximum Concurrent Isolated Queries
        maxNodesPerQuery:
          type: integer
          format: int32
          description: Maximum Nodes Per Isolated Query
    DbcSummary:
      type: object
      description: A Database Catalog.
      properties:
        crn:
          type: string
          description: The CRN of the Database Catalog.
        id:
          type: string
          description: The ID of the Database Catalog.
        name:
          type: string
          description: The name of the Database Catalog.
        resourceTemplateId:
          type: string
          description: The resource template of the Database Catalog.
        status:
          type: string
          description: 'Status of the Database Catalog. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error.'
        statusChangedAt:
          type: string
          format: date-time
          description: Timestamp of the last status change of the Database Catalog.
        creator:
          $ref: '#/components/schemas/ActorResponse'
          description: The creator of the Database Catalog.
        creationDate:
          type: string
          format: date-time
          description: Creation date of Database Catalog.
        resourcePool:
          type: string
          description: The name of the Resource Pool the Database Catalog is in.
          x-form-factors: private
        resources:
          type:
          - object
          - 'null'
          x-form-factors: private
          description: The actual resources used by the Database Catalog.
          additionalProperties:
            $ref: '#/components/schemas/ApplicationResources'
    CreateDataVisualizationRequest:
      type: object
      description: Request object for the createDataVisualization call.
      required:
      - clusterId
      - name
      - config
      properties:
        clusterId:
          type: string
          description: ID of cluster where Cloudera Data Visualization should be created.
        name:
          type: string
          description: Name of the Cloudera Data Visualization
        config:
          description: The LDAP admin and user group configuration for Cloudera Data Visualization.
          $ref: '#/components/schemas/VizConfig'
        imageVersion:
          type: string
          description: Version of the Cloudera Data Visualization.
          x-form-factors: public
        resourceTemplate:
          type: string
          description: The name of the available resource template to use for the Cloudera Data Visualization.
        resourcePool:
          type: string
          description: The Resource Pool of the Cloudera Data Visualization.
          x-form-factors: private
    ImpalaExecutorGroupSetUpdateRequest:
      type: object
      description: Re-configure independently scaling set of uniformly sized executor groups.
      properties:
        execGroupSize:
          type: integer
          format: int32
          description: Set number of executors per executor group.
        minExecutorGroups:
          type: integer
          format: int32
          description: Set minimum number of executor groups allowed.
        maxExecutorGroups:
          type: integer
          format: int32
          description: Set maximum number of executor groups allowed.
        autoSuspendTimeoutSeconds:
          type: integer
          format: int32
          description: Set auto suspend threshold. If not provided defaults will apply.
        disableAutoSuspend:
          type: boolean
          description: Turn off auto suspend. If not provided defaults will apply.
        triggerScaleUpDelay:
          type: integer
          format: int32
          description: Set scale up threshold in seconds. If not provided defaults will apply.
        triggerScaleDownDelay:
          type: integer
          format: int32
          description: Set scale down threshold in seconds. If not provided defaults will apply.
        deleteGroupSet:
          type: boolean
          description: Delete the executor group set.
    UpdateDbcResponse:
      type: object
      description: Response object for the updateDbc method.
    UpdateApplicationResources:
      type: object
      description: The resource requirements of a component.
      x-mutating: true
      x-form-factors: private
      properties:
        cpu:
          type: number
          format: float
          description: Overall CPU requirements.
        memory:
          type: string
          description: Overall memory requirements.
        breakdown:
          description: Breakdown of the service memory requirements.
          $ref: '#/components/schemas/UpdateApplicationResourcesBreakdown'
        ephemeralStorage:
          type:
          - string
          - 'null'
          description: Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod.
        localStorageSize:
          description: Local disk size requirements.
          $ref: '#/components/schemas/UpdateApplicationResourcesLocalStorageSize'
    ListUsersRequest:
      type: object
      description: Request object for the listUsers method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster for which the users must be retrieved.
    ReplicaStatus:
      x-form-factors: public,private
      type: object
      description: Status information on the current state of replicas in the virtual warehouse.
      properties:
        totalExecutorReplicas:
          type: integer
          format: int32
          description: Total number of executor replicas scheduled for the virtual warehouse. This number contains the number of executor replicas in pending state, as well as the replicas that are already running. If this number is zero, then the executor functionality is stopped.
          x-omitempty: false
        readyExecutorReplicas:
          type: integer
          format: int32
          description: Total number of ready executor replicas in the virtual warehouse. This number only contains the healthy executor replicas that have already started up and are ready to accept requests. If this number is less than the totalExecutorReplicas, then the virtual warehouse might still be starting up or there might be a problem scheduling these replicas.
          x-omitempty: false
        totalCoordinatorReplicas:
          type: integer
          format: int32
          description: Total number of coordinator replicas scheduled for the virtual warehouse. This number contains the number of coordinator replicas in pending state, as well as the replicas that are already running. If this number is zero, then the coordinator functionality is stopped.
          x-omitempty: false
        readyCoordinatorReplicas:
          type: integer
          format: int32
          description: Total number of ready coordinator replicas in the virtual warehouse. This number only contains the healthy executor replicas that have already started up and are ready to accept requests. If this number is less than the totalCoordinatorReplicas, then the virtual warehouse might still be starting up or there might be a problem scheduling these replicas.
          x-omitempty: false
    UpdateVwResponse:
      type: object
      description: Response object for the updateVw method.
      properties:
        message:
          type: string
          description: Success message
        warning:
          type: string
          description: Warning message during Virtual Warehouse update
    DescribeClusterResponse:
      type: object
      description: Response object for the describeCluster method.
      properties:
        cluster:
          description: The cluster.
          $ref: '#/components/schemas/ClusterSummaryResponse'
    DescribeDataVisualizationRequest:
      type: object
      description: Request object for the describeDataVisualization method.
      required:
      - clusterId
      - dataVisualizationId
      properties:
        clusterId:
          type: string
          description: ID of the Cloudera Data Visualization's cluster.
        dataVisualizationId:
          type: string
          description: ID of the Cloudera Data Visualization
    EventResponse:
      type: object
      description: Represents a Event
      properties:
        event:
          type: string
          description: The code name of the event
        message:
          type: string
          description: Detailed message
        timestamp:
          type: string
          format: date-time
          description: The timestamp of the event
    UpdateDataVisualizationResponse:
      type: object
      description: Response object for the updateDataVisualization method.
      properties:
        status:
          type: string
          description: The status of asynchronous update configuration request for Cloudera Data Visualization. To find the latest status please use describe-data-visualization.
    Restore:
      type: object
      x-form-factors: private
      description: Restore entry
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
        backupCrn:
          type: string
          description: The CRN of the backup.
        restoreCreationTime:
          type: string
          description: The time when the restore was created.
        restoreUpdatedTime:
          type: string
          description: The updated time of the restore.
        excludedResources:
          type: array
          description: The list of resources to be excluded in restore.
          items:
            type: string
        includedNamespaces:
          type: array
          description: The list of namespaces to be included in restore.
          items:
            type: string
        successConditions:
          type: array
          description: The list of conditions to be met for a successful restore.
          items:
            type: string
        restorePhase:
          type: string
          description: The phase of the restore operation.
        restoreJobState:
          type: string
          description: The current state of the restore job.
        restoreJob:
          type: string
          description: The restore job name.
        warnings:
          type: array
          description: The warnings from restore job.
          items:
            $ref: '#/components/schemas/Message'
        errors:
          type: array
          description: The errors from restore job.
          items:
            $ref: '#/components/schemas/Message'
    ListResourceTemplatesResponse:
      type: object
      description: The response object for the listResourceTemplates method.
      x-mutating: false
      x-form-factors: private
      properties:
        templates:
          type: array
          description: Array of the resource templates.
          items:
            $ref: '#/components/schemas/ResourceTemplateResponse'
    ResourceTemplateResponse:
      type: object
      x-mutating: false
      x-form-factors: private
      description: Resource template.
      properties:
        id:
          type: string
          description: Identifier of the template.
        name:
          type: string
          description: Name of the template.
        version:
          type: integer
          format: int32
          description: Version number.
        entityType:
          type: string
          description: 'The type of the entity, which can be one of the following: Hive, Impala, Hue, DataViz.'
        description:
          type: string
          description: Short description.
        isDefault:
          type: boolean
          description: Denotes whether it is the default template or not.
    DeleteBackupResponse:
      type: object
      x-form-factors: private
      description: Response object for the delete backup request.
      required:
      - deleteBackupCrn
      properties:
        deleteBackupCrn:
          type: string
          description: The CRN of the delete backup custom resource.
    CreateClusterDiagnosticDataJobResponse:
      type: object
      description: Response object for the createClusterDiagnosticDataJob method.
      x-form-factors: public
      properties:
        id:
          type: string
          description: Identifier for each bundle collection.
        status:
          type: string
          description: Status of the diagnostics collection request.
        url:
          type: string
          description: This URL points to a download location if the destination is DOWNLOAD.
        labels:
          type: object
          description: Additional key-value pair attributes associated with the Diagnostic Data Job.
          additionalProperties:
            type: string
    CreateBackupResponse:
      type: object
      x-form-factors: private
      description: Response object for the create backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN the backup.
    GetDataVisualizationUpgradeVersionResponse:
      type: object
      description: Response object for the getDataVisualizationUpgradeVersion method.
      properties:
        upgradeVersions:
          description: Details of upgrade versions.
          $ref: '#/components/schemas/UpgradeVersions'
    ListVwEventsResponse:
      type: object
      description: Response object for the listVwEvents method.
      properties:
        events:
          type: array
          description: The list of the events belonging to the particular Virtual Warehouse
          items:
            $ref: '#/components/schemas/EventResponse'
    CreateClusterRequest:
      type: object
      description: Request object for the createCluster method.
      required:
      - environmentCrn
      properties:
        environmentCrn:
          type: string
          description: The CRN of the environment for the cluster to create.
        useOverlayNetwork:
          type: boolean
          description: Using an overlay network will save IP addresses in the VPC by using a private IP address range for Pods in the cluster.
        databaseBackupRetentionPeriod:
          type: integer
          format: int32
          default: 30
          description: PostgreSQL server backup retention days.
        whitelistIpCIDRs:
          x-form-factors: public,private
          type: string
          description: This field is still available for Private Cloud deployments, however it'll be removed for Public Cloud in the next DWX release. Please use the use 'whitelistK8sClusterAccessIpCIDRs' in combination of 'whitelistWorkloadAccessIpCIDRs' on Public Cloud. Comma separated list of IP address CIDRs to whitelist.
        whitelistK8sClusterAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for kubernetes cluster access.
        whitelistWorkloadAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for workload access.
        usePrivateLoadBalancer:
          type: boolean
          description: Set up load balancer with private IP address. In AWS it is created in private subnets. In Azure an internal load balancer gets created. Make sure there is connectivity between your client network and the network (VPC/VNet) where CDW environment is deployed.
        usePublicWorkerNode:
          type: boolean
          description: Set up worker node with public IP address. In AWS it is created in public subnets.
        enableStorageRoles:
          type: boolean
          description: DEPRECATED - Enable Storage Roles
          default: false
          x-deprecated: true
          x-form-factors: public
          x-entitlement: CDW_STORAGE_ROLES
        customRegistryOptions:
          description: Options for custom ACR/ECR registries.
          $ref: '#/components/schemas/CustomRegistryOptions'
        awsOptions:
          description: Options for activating an AWS environment.
          $ref: '#/components/schemas/AwsActivationOptions'
          x-form-factors: public
        azureOptions:
          description: Options for activating an Azure environment.
          $ref: '#/components/schemas/AzureActivationOptions'
          x-form-factors: public
        privateCloudOptions:
          description: Options for activating a Private Cloud environment.
          $ref: '#/components/schemas/PrivateCloudActivationOptions'
          x-form-factors: private
        customSubdomain:
          type: string
          description: Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME.
    ListConnectorsRequest:
      x-form-factors: public,private
      type: object
      description: Request for listing connectors configured in Cloudera Data Warehouse.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to list.
    UpdateClusterRequest:
      type: object
      description: Request object for the updateCluster method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to update.
        description:
          type: string
          description: Cluster description.
        whitelistIpCIDRs:
          x-form-factors: public,private
          type: array
          items:
            type: string
          description: 'List of IP address CIDRs to whitelist. NOTE: CDW is in process of rolling out a new feature to whitelist IP CIDR separately for Kubernetes Clusters and Loadbalancers on CDP Public Cloud. For an existing cluster, if different IP CIDR has been already applied to LoadBalancer and the Kubernetes cluster through the DWX UI, then updating the IP CIDR of such cluster is not supported from CLI. In the upcoming release, the CLI will support this feature. Please make use of UI for the same.'
        whitelistK8sClusterAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for kubernetes cluster access.
        whitelistWorkloadAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for workload access.
        awsUpdate:
          type: object
          description: Additional properties for AWS clusters.
          properties:
            externalBuckets:
              type: object
              description: External bucket definition.
              additionalProperties:
                description: External bucket access information.
                $ref: '#/components/schemas/UpdateClusterExternalBucketAccessInfo'
        azureUpdate:
          type: object
          description: Additional properties for Azure clusters.
          properties:
            renewCertificate:
              type: boolean
              default: false
              description: Renew Azure cluster certificate.
        observabilityConfig:
          x-deprecated: true
          description: 'DEPRECATED: This feature wil be removed in subsequent releases. Cluster observability configurations to update. You can forward logs from environments activated in Cloudera Data Warehouse (CDW) to observability and monitoring systems such as Datadog, New Relic, or Splunk. Please refer to the following Cloudera documentation for more info. https://docs.cloudera.com/data-warehouse/cloud/monitoring/topics/dw-observability-log-forwarding.html'
          $ref: '#/components/schemas/UpdateClusterObservabilityConfig'
    DescribeConfigDiffResponse:
      type: object
      description: Response object for the describeConfigDiff method.
      properties:
        config:
          description: The service configuration.
          $ref: '#/components/schemas/ServiceConfigDiff'
    CreateDataVisualizationResponse:
      type: object
      description: Response object for the createDataVisualization method.
      properties:
        dataVisualizationId:
          type: string
          description: ID of the new Cloudera Data Visualization.
    ListClusterDiagnosticDataJobsResponse:
      type: object
      description: Response object for the listClusterDiagnosticDataJobs method.
      x-form-factors: public
      properties:
        jobs:
          type: array
          description: The list of jobs belonging to the particular cluster.
          items:
            $ref: '#/components/schemas/ClusterDiagnosticDataJob'
          x-paging-result: true
        nextToken:
          type: string
          x-paging-output-token: true
          description: The token to use when requesting the next set of results. If there are no additional results, the string is empty.
    DescribeVwDiagnosticDataJobResponse:
      type: object
      description: Response object for the describeVwDiagnosticDataJobRequest method.
      x-form-factors: public
      properties:
        job:
          description: The job belonging to the particular Virtual Warehouse.
          $ref: '#/components/schemas/VwDiagnosticDataJob'
    ListRestoresRequest:
      type: object
      x-form-factors: private
      description: Request object for the list restores request.
      properties:
        jobStates:
          type: array
          items:
            type: string
          description: The job states to filter by.
        backupCrn:
          type: string
          description: CRN of the backup.
    ImpalaExecutorGroupSetResponse:
      type: object
      description: Describes configurations for an executor group set.
      properties:
        groupSetPrefix:
          type: string
          description: Name of resource pool for this executor group set.
          x-omitempty: false
        execGroupSize:
          type: integer
          format: int32
          description: Number of executors per executor group.
          x-omitempty: false
        minExecutorGroups:
          type: integer
          format: int32
          description: Minimum number of executor groups allowed.
          x-omitempty: false
        maxExecutorGroups:
          type: integer
          format: int32
          description: Maximum number of executor groups allowed.
          x-omitempty: false
        autoSuspendTimeoutSeconds:
          type: integer
          format: int32
          description: Auto suspend threshold.
          x-omitempty: false
        disableAutoSuspend:
          type: boolean
          description: Denotes whether auto suspend is turned off.
          x-omitempty: false
        triggerScaleUpDelay:
          type: integer
          format: int32
          description: Scale up threshold in seconds.
          x-omitempty: false
        triggerScaleDownDelay:
          type: integer
          format: int32
          description: Scale down threshold in seconds.
          x-omitempty: false
    ListVwConfigsResponse:
      type: object
      description: Response object for the listVwConfigs method.
      properties:
        configHistory:
          type: array
          description: Configuration history of a service.
          items:
            $ref: '#/components/schemas/ConfigHistoryItem'
    DeleteClusterDiagnosticDataJobRequest:
      type: object
      description: Request object for the deleteClusterDiagnosticDataJob method.
      x-form-factors: public
      required:
      - clusterId
      - jobId
      properties:
        clusterId:
          type: string
          description: ID of the Cluster.
        jobId:
          type: string
          description: ID of the diagnostic job.
    UpdateVwConfigResponse:
      type: object
      description: Response object for the updateVwConfig method.
    CustomRegistryOptions:
      type: object
      description: Options for custom ACR, ECR registry.
      properties:
        registryType:
          enum:
          - ACR
          - ECR
          type: string
          description: Custom registry type.
        repositoryUrl:
          type: string
          description: URL of the custom image repository.
          x-no-paramfile: true
    ActorResponse:
      type: object
      description: A CDP actor (user or machine user).
      properties:
        crn:
          type: string
          description: Actor CRN.
        email:
          type: string
          description: Email address for users.
        workloadUsername:
          type: string
          description: Username for users.
        machineUsername:
          type: string
          description: Username for machine users.
    SimpleBackup:
      type: object
      x-form-factors: private
      description: A simple backup entry for listBackup usage
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
        backupName:
          type: string
          description: The display name of the backup.
        backupCreationTime:
          type: string
          description: The time when the backup was created.
    ImpalaExecutorGroupSetsUpdateRequest:
      type: object
      description: Re-configure executor group sets for workload aware autoscaling.
      properties:
        small:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetUpdateRequest'
          description: Re-configure small executor group set for workload aware autoscaling.
        custom1:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetUpdateRequest'
          description: Re-configure first optional custom executor group set for workload aware autoscaling.
        custom2:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetUpdateRequest'
          description: Re-configure second optional custom executor group set for workload aware autoscaling.
        custom3:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetUpdateRequest'
          description: Re-configure third optional custom executor group set for workload aware autoscaling.
        large:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetUpdateRequest'
          description: Re-configure large executor group set for workload aware autoscaling.
    RebuildVwRequest:
      type: object
      description: Request object for the rebuildVw method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse to rebuild.
    UpgradeVwRequest:
      type: object
      description: Request object for the upgradeVw method.
      required:
      - clusterId
      - vwId
      - dbcId
      - imageVersion
      properties:
        clusterId:
          type: string
          description: The ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: The ID of the Virtual Warehouse.
        dbcId:
          type: string
          description: The ID of Database Catalog that the Virtual Warehouse is attached to.
        imageVersion:
          type: string
          description: The version to which the Virtual Warehouse should be upgraded.
        resourcePool:
          type: string
          description: The name of the Resource Pool the Cloudera Data Visualization will be assigned to.
          x-form-factors: private
    ListVwsRequest:
      type: object
      description: Request object for the listVws method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: ID of cluster to list.
        filter:
          description: Filter object for listVws method.
          $ref: '#/components/schemas/VwFilter'
    CreateAwsClusterNonTransparentProxyRequest:
      type: object
      description: 'Activation options for an AWS environment to enable non-transparent proxy. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html'
      properties:
        use:
          type: boolean
          description: Switch using the default non-transparent proxy on/off.
          x-omitempty: false
        bypassedDomains:
          type: array
          description: Domains where the proxy is getting by-passed.
          x-omitempty: false
          items:
            type: string
            description: Domain.
    CreateResourceTemplateRequest:
      type: object
      description: Request object for the createResourceTemplate method.
      x-mutating: true
      x-form-factors: private
      properties:
        id:
          type: string
          description: 'DEPRECATED: ID of the template. This field is unused and always empty. Subject of removal.'
          x-deprecated: true
        name:
          type: string
          description: Name of the template.
        description:
          type: string
          description: Description of the template.
        entityType:
          type: string
          description: 'Entity type for which the template will be created. (Possible values: impala, hive, trino, hue, dbc, viz).'
        resources:
          type: object
          description: The resource values of the template.
          additionalProperties:
            $ref: '#/components/schemas/CreateApplicationResources'
    RebuildDbcRequest:
      type: object
      description: Request object for the rebuildDbc method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog to rebuild.
    ListDbcConfigsRequest:
      type: object
      description: Request object for the listDbcConfigs method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
    ListClustersResponse:
      type: object
      description: Response object for the listClusters method.
      properties:
        clusters:
          type: array
          items:
            $ref: '#/components/schemas/ClusterSummaryResponse'
          description: The list of clusters.
    DeleteConnectorRequest:
      x-form-factors: public,private
      type: object
      description: Request object for the deleteConnectorById method.
      required:
      - clusterId
      - connectorId
      properties:
        clusterId:
          type: string
          description: The ID of the Database Catalog's cluster.
        connectorId:
          type: string
          description: The ID of the Database connector to delete.
    ConfigBlockResp:
      type: object
      description: A piece of configuration stored in the same place (e.g. same file or environment variables).
      properties:
        id:
          type: string
          description: ID of the ConfigBlock. Unique within an ApplicationConfig.
        content:
          description: Contents of a ConfigBlock.
          $ref: '#/components/schemas/ConfigContentResp'
    DescribeDbcConfigRequest:
      type: object
      description: Request object for the describeDbcConfig method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
    ResetServerSettingsResponse:
      type: object
      description: Response object for the resetServerSettings method.
      x-form-factors: private
      properties:
        status:
          type: string
          description: Reset status.
    ImpalaHASettingsOptionsResponse:
      type: object
      description: Impala High Availability settings for a Virtual Warehouse.
      properties:
        highAvailabilityMode:
          $ref: '#/components/schemas/ImpalaHighAvailabilityMode'
          description: High Availability mode. DISABLED - Impala coordinator and Database Catalog high availability is disabled. ACTIVE_PASSIVE - Multiple coordinators (one active, one passive) and Database Catalogs (one active, one passive) are run. ACTIVE_ACTIVE - Multiple coordinators (both active) and Database Catalogs (one active, one passive) are run.
        enableShutdownOfCoordinator:
          type: boolean
          description: Whether a shutdown of the coordinator is enabled.
        numOfActiveCoordinators:
          type: integer
          format: int32
          description: Number of the active coordinators.
        shutdownOfCoordinatorDelaySeconds:
          type: integer
          format: int32
          description: Delay in seconds before the shutdown of coordinator event happens.
        enableCatalogHighAvailability:
          type: boolean
          description: Denotes whether a backup instance for Impala catalog is enabled.
        enableStatestoreHighAvailability:
          type: boolean
          description: Denotes whether a backup instance for Impala Statestore is enabled.
        impalaEnableGlobalAdmissionController:
          type: boolean
          description: Denotes whether the Impala Global Admission Controller is enabled.
    ListVwConfigsRequest:
      type: object
      description: Request object for the listVwConfigs method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
    RegisterSecretResponse:
      type: object
      description: Response object for registering secret.
      properties:
        result:
          description: Result of the operation.
          $ref: '#/components/schemas/Secret'
    ConfigContentReq:
      type: object
      description: Contents of a ConfigBlock.
      properties:
        keyValues:
          type: object
          description: Key-value type configurations.
          additionalProperties:
            description: Key-value type configurations.
            type: string
            x-no-paramfile: true
        text:
          type: string
          description: Text type configuration.
        json:
          type: string
          description: JSON type configuration.
    SimpleRestore:
      type: object
      x-form-factors: private
      description: A simple Restore entry for listRestore Usage
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
        backupCrn:
          type: string
          description: The CRN of the backup.
        restoreCreationTime:
          type: string
          description: The time when the restore was created.
        includedNamespaces:
          type: array
          description: The list of namespaces to be included in restore.
          items:
            type: string
    ListVwsResponse:
      type: object
      description: Response object for the listVws method.
      properties:
        vws:
          type: array
          items:
            $ref: '#/components/schemas/VwSummary'
          description: The list of Virtual Warehouses.
    BackupClusterRequest:
      type: object
      description: Request object for the backupCluster method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
    AzureOptionsResponse:
      type: object
      description: Response object of the cluster Azure settings.
      properties:
        subnetId:
          type: string
          description: ID of Azure subnet where the cluster is deployed.
        enableAZ:
          type: boolean
          description: Denotes whether the Azure Availability Zones for the cluster is enabled or not.
          default: false
        outboundType:
          type: string
          description: The current outbound type setting.
        aksPodCIDR:
          type: string
          description: Pod CIDR setting for Azure CNI networking.
        logAnalyticsWorkspaceId:
          type: string
          description: Workspace ID for Azure log analytics.
        privateSQLSubnetName:
          type: string
          description: Name of the delegated subnet where the private SQL should be deployed.
        privateDNSZoneSQL:
          type: string
          description: Private DNS zone ID for the PostgreSQL server.
        enablePrivateSQL:
          type: boolean
          default: false
          description: Denotes whether the private SQL is enabled for the cluster.
        privateDNSZoneAKS:
          type: string
          description: The resource ID of the private DNS zone for the AKS cluster.
        enablePrivateAKS:
          type: boolean
          default: false
          description: Denotes whether the AKS cluster is in private mode.
        userAssignedManagedIdentity:
          type: string
          description: The resource ID of the managed identity used by the AKS cluster.
    DeleteUserResponse:
      type: object
      description: Response object for the deleteUser method.
    CreateApplicationResourcesBreakdown:
      type:
      - object
      - 'null'
      description: Breakdown of the service memory requirements like Xms, Xss etc.
      x-mutating: false
      x-form-factors: private
      properties:
        xms:
          type:
          - string
          - 'null'
          description: Java VM configuration for -Xms (initial and minimum heap size).
        xmx:
          type: string
          description: Java VM configuration for -Xmx (maximum heap size).
        xss:
          type:
          - string
          - 'null'
          description: Java VM configuration for -Xss (thread stack size).
        maxDirectMemorySize:
          type:
          - string
          - 'null'
          description: Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers).
    AwsActivationOptions:
      type: object
      description: Options for activating an AWS environment.
      properties:
        enablePrivateEKS:
          type: boolean
          description: Use this option to set up AWS EKS cluster in private only mode with restricted access only from internal/peered networks. Ensure you have ccmv2 setup functional to achieve this integration.
          default: false
        workerSubnetIds:
          type: array
          description: IDs of AWS subnets where the cluster worker nodes should be deployed.
          items:
            type: string
        lbSubnetIds:
          type: array
          description: IDs of AWS subnets where the cluster load balancer should be deployed.
          items:
            type: string
        customAmiId:
          type: string
          description: Custom AMI ID.
        nodeRoleCDWManagedPolicyArn:
          type: string
          description: Managed Policy Arn to be attached to the Node Instance Role.
        enableSpotInstances:
          type: boolean
          description: Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. If the aws-options is not provided it defaults to false.
          default: false
        reducedPermissionMode:
          type: boolean
          description: Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role.
        nonTransparentProxy:
          description: 'Non-transparent proxy settings. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html'
          $ref: '#/components/schemas/AwsActivationOptionsNonTransparentProxy'
    GetConnectorTestJob:
      x-form-factors: public,private
      type: object
      description: Test connector job details.
      properties:
        jobId:
          type: string
          description: The ID of the test job.
        jobStartTime:
          type: string
          format: date-time
          description: The start time of the test job.
        jobFinishTime:
          type: string
          format: date-time
          description: The finish time of the test job.
        outputLog:
          type: string
          description: The output log of the test job.
        status:
          type: string
          description: Represents the possible status values of a test connector job.
          enum:
          - Starting
          - Succeeded
          - Failed
          - Running
          - Unknown
          - Deleted
        labels:
          type: object
          description: Additional key-value pair attributes associated with the test connector job.
          additionalProperties:
            type: string
    CreateResourceTemplateResponse:
      type: object
      description: The response object for the createResourceTemplate method.
      x-mutating: false
      x-form-factors: private
      properties:
        templateId:
          type: string
          description: The id of the new template.
    RestoreClusterResponse:
      type: object
      description: Response object for the restoreCluster method.
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        operationId:
          type: string
          description: The ID of the restore operation.
        action:
          type: string
          description: 'The cluster action. Possible actions: Create, Skip'
        message:
          type: string
          description: The description of the cluster action.
        dbcRestorePlans:
          type: array
          description: Information about the restore-plan of the DbCatalogs.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        hueRestorePlans:
          type: array
          description: Information about the restore-plan of Hue.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        hiveRestorePlans:
          type: array
          description: Information about the restore-plan of the Hive Virtual Warehouses.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        impalaRestorePlans:
          type: array
          description: Information about the restore-plan of the Impala Virtual Warehouses.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        trinoRestorePlans:
          type: array
          description: Information about the restore-plan of the Trino Virtual Warehouses.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        vizRestorePlans:
          type: array
          description: Information about the restore-plan of the Data Visualization Apps.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        cdwHueRestorePlans:
          type: array
          description: The plan for the restoration of the Hue Query Editors.
          items:
            $ref: '#/components/schemas/RestoreClusterEntityPlan'
        dwxSecretsRestorePlans:
          type: array
          description: The plan for the restoration of the DWX Secrets.
          items:
            type: string
    QuotaRequest:
      x-form-factors: private
      type: object
      description: Quota in requests for the Virtual Warehouse.
      properties:
        cpu:
          type: number
          format: float
          description: CPU quota in cores.
        memory:
          type: integer
          format: int32
          description: Memory quota in MB.
    AwsOptionsNonTransparentProxyResponse:
      type: object
      description: 'Non-transparent proxy settings. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html'
      properties:
        use:
          type: boolean
          description: Denotes whether the proxy settings turned on/off.
          x-omitempty: false
        bypassedDomains:
          type: array
          description: Domains where the proxy is getting by-passed.
          items:
            type: string
            description: Domain.
    UpdateSshKeyRequest:
      type: object
      description: Request object for the updateSshKey method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to update the SSH Key.
    ClusterSummaryResponse:
      type: object
      description: A Cloudera Data Warehouse cluster.
      properties:
        crn:
          type: string
          description: The CRN of the cluster.
        id:
          type: string
          description: The ID of the cluster.
        environmentCrn:
          type: string
          description: The CRN of the environment where the cluster is located.
        name:
          type: string
          description: Name of the cluster (same as the name of the environment).
        status:
          type: string
          description: 'Status of the cluster. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error.'
        creator:
          $ref: '#/components/schemas/ActorResponse'
          description: The creator of the cluster.
        creationDate:
          type: string
          format: date-time
          description: Creation date of cluster.
        cloudPlatform:
          type: string
          description: The cloud platform of the environment that was used to create this cluster.
        version:
          type: string
          description: The version of the deployed CDW cluster.
        productSupport:
          x-form-factors: public,private
          $ref: '#/components/schemas/ClusterSummaryProductSupportResponse'
          description: 'Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support/support-lifecycle-policy.html.'
        enableSpotInstances:
          x-form-factors: public
          type: boolean
          description: Denotes whether the spot instances have been enabled for the cluster. This value is only available for AWS and Azure clusters.
        awsOptions:
          $ref: '#/components/schemas/AwsOptionsResponse'
          description: Response object of AWS related cluster options.
          x-form-factors: public
        azureOptions:
          $ref: '#/components/schemas/AzureOptionsResponse'
          description: Response object of Azure related cluster options.
          x-form-factors: public
        description:
          type: string
          description: Cluster description.
        whitelistK8sClusterAccessIpCIDRs:
          type: string
          description: List of IP address CIDRs to whitelist for kubernetes cluster access.
        whitelistWorkloadAccessIpCIDRs:
          type: string
          description: List of IP address CIDRs to whitelist for workload access.
        useOverlayNetwork:
          type: boolean
          default: false
          description: Denotes whether the overlay network is being used for the cluster.
        enablePrivateLoadBalancer:
          type: boolean
          default: false
          description: Denotes whether the private load balancer is enabled for the cluster.
        resourcePool:
          type: string
          description: The name of the Resource Pool the cluster is in.
          x-form-factors: private
        externalBuckets:
          type: array
          description: External buckets attached to the environment.
          items:
            $ref: '#/components/schemas/ExternalBucket'
    Backup:
      type: object
      x-form-factors: private
      description: Backup entry
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
        backupCreationTime:
          type: string
          description: The time when the backup was created.
        backupName:
          type: string
          description: The display name of the backup.
        backupUpdatedTime:
          type: string
          description: The time when the backup was updated.
        backupPhase:
          type: string
          description: The phase of the backup operation.
        backupJobState:
          type: string
          description: The current state of the backup job.
        backupJob:
          type: string
          description: The backup job name.
        includedNamespaces:
          type: array
          description: The list of namespaces to be included in backup.
          items:
            type: string
        warnings:
          type: array
          description: The warnings from backup job.
          items:
            $ref: '#/components/schemas/Message'
        errors:
          type: array
          description: The errors from backup job.
          items:
            $ref: '#/components/schemas/Message'
    RebuildDbcResponse:
      type: object
      description: Response object for the rebuildDbc method.
    ApplicationResourcesLocalStorageSize:
      type:
      - object
      - 'null'
      description: Storage related information.
      x-mutating: false
      x-form-factors: private,public
      properties:
        scratch:
          type: string
          description: Local disk space used for writing scratch data.
        cache:
          type: string
          description: Local disk space used for writing cache data.
        overhead:
          type: string
          description: Local disk space used for writing other temporary data, tools, etc.
    ListDataVisualizationsResponse:
      type: object
      description: Response object for the listDataVisualizations method.
      properties:
        dataVisualizations:
          type: array
          items:
            $ref: '#/components/schemas/DataVisualizationSummary'
          description: The list of Cloudera Data Visualizations.
    UpdateConnectorRequest:
      x-form-factors: public,private
      type: object
      description: Request object for the updateConnector method.
      required:
      - clusterId
      - connectorId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to update.
        connectorId:
          type: string
          description: The ID of the connector to update.
        description:
          type: string
          description: Cluster description.
        name:
          type: string
          description: The name of the connector.
        template:
          type: string
          description: The template of the connector.
        config:
          type: object
          description: Key-value type configurations.
          additionalProperties:
            type: string
    CreateConnectorTestJobResponse:
      x-form-factors: public,private
      type: object
      description: Response for the createConnectorTestJob call.
      properties:
        jobId:
          type: string
          description: The ID of the created test job.
    DescribeConfigDiffRequest:
      type: object
      description: Request object for the describeConfigDiff method.
      required:
      - clusterId
      - fromConfigId
      - toConfigId
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        fromConfigId:
          type: string
          description: ID of the old service configuration.
        toConfigId:
          type: string
          description: ID of the new service configuration.
    ListResourceTemplatesRequest:
      type: object
      description: Request object for the listResourceTemplates method.
      x-mutating: false
      x-form-factors: private
    ImpalaOptionsCreateRequest:
      type: object
      description: Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala.
      properties:
        spillToS3Uri:
          type: string
          description: Set S3 URI in "s3://bucket/path" format and enable spilling to S3. If this is set, "scratchSpaceLimit" cannot be set. Spilling to a remote storage is not supported on Azure, it is available on AWS and PvC platforms. If your workload results in large volumes of intermediate data being written, it is recommended to configure the heavy spilling queries to use a remote storage location rather than the local one since Impala occasionally needs to use persistent storage for writing intermediate files during large sorts, joins, aggregations, or analytic function operations. Note that this value is ignored if the Impala version does not support spilling to S3.
        scratchSpaceLimit:
          x-entitlement: CDW_IMPALA_EBS_SCRATCH_SPACE
          type: integer
          format: int32
          description: Defines the limit for scratch space in GiB needed by Impala for spilling queries. If this is set, "spillToS3Uri" cannot be set. The valid values are between 1-16000 for AWS and 1-16684 for Azure. It will choose the first valid value for which the total disk space is greater than or equal to the specified scratch space limit. The valid scratch space limit values per node in GiBs for AWS are [300, 634, 968, 1302, 1636, 1970, 2304, 2638, 2972, 6550, 7000, 8000, 9000, 10000, 11000, 12000, 13000, 14000, 15000, 16000]. Valid values for Azure are [300, 684, 812, 1068, 1324, 1836, 2348, 3372, 4396, 8492, 16684].
    UpdateDataVisualizationRequest:
      type: object
      description: Request object for the updateDataVisualization method.
      required:
      - clusterId
      - dataVisualizationId
      properties:
        clusterId:
          type: string
          description: ID of the Cloudera Data Visualization's cluster.
        dataVisualizationId:
          type: string
          description: ID of the Cloudera Data Visualization.
        config:
          description: The service configuration to update the DataVisualization with. This will be applied on top of the existing configuration so there's no need to list configurations that stay the same.
          $ref: '#/components/schemas/VizConfig'
    RestoreBackupResponse:
      type: object
      x-form-factors: private
      description: Response object for the restore backup request.
      required:
      - restoreCrn
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
        message:
          type: string
          description: Additional message from the restore process.
        restorePlan:
          type: object
          description: The plan for the restoration without cluster metadata in case of rebuild.
          properties:
            dbc:
              type: array
              description: The plan for the restoration of the DB Catalogs.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            hue:
              type: array
              description: The plan for the restoration of the Hue.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            hive:
              type: array
              description: The plan for the restoration of the Hive Virtual Warehouses.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            impala:
              type: array
              description: The plan for the restoration of the Impala Virtual Warehouses.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            trino:
              type: array
              description: The plan for the restoration of the Trino Virtual Warehouses.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            viz:
              type: array
              description: The plan for the restoration of the Data Visualization Apps.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            cdwHue:
              type: array
              description: The plan for the restoration of the Hue Query Editors.
              items:
                $ref: '#/components/schemas/RestoreClusterEntityPlan'
            dwxSecrets:
              type: array
              description: The plan for the restoration of the DWX Secrets.
              items:
                type: string
    DescribeClusterDiagnosticDataJobResponse:
      type: object
      description: Response object for the describeClusterDiagnosticDataJob method.
      x-form-factors: public
      properties:
        job:
          description: The job belonging to the particular Cluster.
          $ref: '#/components/schemas/ClusterDiagnosticDataJob'
    ExternalBucket:
      type: object
      description: External bucket details.
      properties:
        name:
          type: string
          description: Name of the bucket.
        accessInfo:
          $ref: '#/components/schemas/ExternalBucketAccessInfo'
          description: AccessInfo of the bucket.
    DescribeClusterDiagnosticDataJobRequest:
      type: object
      description: Request object for the describeClusterDiagnosticDataJob method.
      x-form-factors: public
      required:
      - clusterId
      - jobId
      properties:
        clusterId:
          type: string
          description: ID of the Cluster.
        jobId:
          type: string
          description: ID of the diagnostic job.
    ServiceConfigDiff:
      type: object
      description: Differences between two service configurations.
      properties:
        isChanged:
          type: boolean
          description: Has any of the configurations changed?
        commonConfigsDiff:
          description: Differences between the common configurations.
          $ref: '#/components/schemas/ApplicationConfigDiff'
        applicationConfigsDiffs:
          type: object
          description: Differences between the application specific configurations.
          additionalProperties:
            description: Differences between the application specific configurations.
            $ref: '#/components/schemas/ApplicationConfigDiff'
    ListSecretsRequest:
      type: object
      description: Request object for listing secrets.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
    AwsOptionsResponse:
      type: object
      description: Response object of the cluster AWS settings.
      properties:
        subnetIds:
          type: array
          description: IDs of AWS subnets where the cluster has been deployed.
          items:
            type: string
        workerSubnetIds:
          type: array
          description: IDs of AWS subnets where the cluster worker nodes should be deployed.
          items:
            type: string
        lbSubnetIds:
          type: array
          description: IDs of AWS subnets where the cluster load balancer should be deployed.
          items:
            type: string
        availabilityZones:
          type: array
          items:
            type: string
          description: List of availability zones that the cluster is restricted to use.
        customAmiId:
          type: string
          description: Id of the Custom Amazon Machine Image
        reducedPermissionMode:
          type: boolean
          description: Denotes whether the Reduced Permission mode is enabled.
        nonTransparentProxy:
          description: Non-transparent proxy settings.
          $ref: '#/components/schemas/AwsOptionsNonTransparentProxyResponse'
        kmsKey:
          type: string
          description: KMS key used in encryption of EBS, EFS, RDS and EKS Secrets.
    ImpalaHASettingsUpdateRequest:
      type: object
      description: High Availability settings update options for the Impala Virtual Warehouse.
      properties:
        shutdownOfCoordinatorDelaySeconds:
          type: integer
          format: int32
          description: Delay in seconds before the shutdown of coordinator event happens.
        numOfActiveCoordinators:
          type: integer
          format: int32
          description: The number of active coordinators.
        impalaEnableGlobalAdmissionController:
          type: boolean
          description: Set whether the Impala Global Admission Controller is enabled. This feature can only be used with high-availability mode ACTIVE_ACTIVE.
    CreateAzureClusterRequest:
      type: object
      description: Request object for the createAzureCluster method.
      required:
      - environmentCrn
      - userAssignedManagedIdentity
      - subnetName
      properties:
        environmentCrn:
          type: string
          description: The CRN of the environment for the cluster to create.
        userAssignedManagedIdentity:
          type: string
          description: Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation.
        subnetName:
          type: string
          description: Name of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation.
        useOverlayNetworking:
          type: boolean
          description: With overlay network nodes get an IP address from the Azure virtual network subnet. Pods receive an IP address from a logically different address space to the Azure virtual network subnet of the nodes.
        databaseBackupRetentionPeriod:
          type: integer
          format: int32
          default: 30
          description: PostgreSQL server backup retention days.
        whitelistK8sClusterAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for kubernetes cluster access.
        whitelistWorkloadAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for workload access.
        useInternalLoadBalancer:
          type: boolean
          description: Set up load balancer with private IP address. An internal load balancer gets created. Make sure there is connectivity between your client network and the network VNet where CDW environment is deployed.
        customRegistryOptions:
          description: Options for custom ACR/ECR registries.
          $ref: '#/components/schemas/CustomRegistryOptions'
        customSubdomain:
          type: string
          description: Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME.
        enableAZ:
          type: boolean
          description: Enables Azure Availability Zones for the cluster deployment.
        enableSpotInstances:
          type: boolean
          description: Whether to enable spot instances for Virtual warehouses. It cannot be updated later. Defaults to false.
          default: false
        logAnalyticsWorkspaceId:
          type: string
          description: Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics.
        outboundType:
          type: string
          description: Network outbound type. This setting controls the egress traffic for cluster nodes in Azure Kubernetes Service. Please refer to the following AKS documentation on the Azure portal. https://learn.microsoft.com/en-us/azure/aks/egress-outboundtype, https://learn.microsoft.com/en-us/azure/aks/nat-gateway
          enum:
          - LoadBalancer
          - UserAssignedNATGateway
          - UserDefinedRouting
        aksPodCIDR:
          type: string
          description: Pod CIDR required for Azure CNI networking. Please refer to the following Azure documentation, https://docs.microsoft.com/en-us/azure/aks/azure-cni-overlay.
        enablePrivateSQL:
          type: boolean
          description: Enables private SQL for the cluster deployment.
          default: false
        privateSQLSubnetName:
          type: string
          description: Name of the delegated subnet where the private SQL should be deployed.
        privateDNSZoneSQL:
          type: string
          description: Private DNS zone ID for the PostgreSQL server.
        privateDNSZoneAKS:
          type: string
          description: Private DNS zone AKS resource ID.
        enablePrivateAks:
          type: boolean
          description: Enable Azure Private AKS mode.
          default: false
    CreateApplicationResourcesLocalStorageSize:
      type:
      - object
      - 'null'
      description: Storage related information.
      x-mutating: false
      x-form-factors: private
      properties:
        scratch:
          type: string
          description: Local disk space used for writing scratch data.
        cache:
          type: string
          description: Local disk space used for writing cache data.
        overhead:
          type: string
          description: Local disk space used for writing other temporary data, tools, etc.
    UpgradeVwResponse:
      type: object
      description: Response object for the upgradeVw method.
      properties:
        status:
          type: string
          description: 'The upgrade status. Possible values are: Upgrading, Error, Failed.'
        message:
          type: string
          description: The upgrade message.
        timedOut:
          type: boolean
          description: True if the upgrade timed out, false or omitted otherwise.
        serviceUnhealthy:
          type: boolean
          description: True, if the service is in unhealthy state, false or omitted otherwise.
        warning:
          type: string
          description: Warning message during Virtual Warehouse upgrade.
    KeyPairCredentials:
      x-form-factors: private
      type: object
      description: Certificate and private key pair credentials, that could be used ie mutual TLS connections therefore these must belong together.
      required:
      - certificate
      - privateKey
      properties:
        certificate:
          type: string
          description: The content of certificate PEM file.
        privateKey:
          type: string
          description: The content of private key PEM file.
    DeleteDataVisualizationResponse:
      type: object
      description: Response object for the deleteDataVisualization method.
      properties:
        status:
          type: string
          description: The status of asynchronous delete request for Cloudera Data Visualization. To find the latest status please use describe-data-visualization. Once the Data Visualization is deleted, the describe-data-visualization would return a not found error.
    CreateClusterDiagnosticDataJobRequest:
      type: object
      description: Request object for the createClusterDiagnosticDataJob method.
      x-form-factors: public
      required:
      - clusterId
      - destination
      properties:
        clusterId:
          type: string
          description: ID of the Cluster.
        destination:
          type: string
          description: Destination of the diagnostics collection.
          enum:
          - UPLOAD_TO_CLOUDERA
          - DOWNLOAD
        startTime:
          type: string
          format: date-time
          description: The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.
        endTime:
          type: string
          format: date-time
          description: The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.
        caseNumber:
          type: string
          description: Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.
        bundleMetadata:
          type: object
          additionalProperties:
            type: string
          description: Additional user-defined metadata information that is attached to the resulting bundle-info.json when posting the bundle.
        force:
          type: boolean
          default: false
          description: Forced recreation of the diagnostic job.
    VizConfig:
      type: object
      description: Configurations for a Cloudera Data Visualization
      properties:
        userGroups:
          type: array
          items:
            type: string
          description: User groups to allow user access to Data Visualization for selected users
        adminGroups:
          type: array
          items:
            type: string
          description: Admin groups to allow configuration access to Data Visualization for selected users
    ListBackupEntitiesRequest:
      type: object
      x-form-factors: private
      description: Request object for the list backup entities request.
    SuspendVwResponse:
      type: object
      description: The response object for the suspendVw method.
      properties:
        message:
          type: string
          description: Success message
        warning:
          type: string
          description: Warning message during Virtual Warehouse suspend
    UpdateVwConfigRequest:
      type: object
      description: Request object for the updateVwConfig method.
      required:
      - clusterId
      - vwId
      - component
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        component:
          type: string
          description: Configuration component to update. Hive components are [DasWebapp, Hiveserver2, QueryCoordinator, QueryExecutor, StandaloneQueryExecutor, TokenAuth, Hue]. Impala components are [Hue, ImpalaAutoscaler, ImpalaCatalogd, ImpalaCoordinator, ImpalaExecutor, ImpalaProxy, ImpalaStatestored, ImpalaTokenAuth, ImpalaAdmissiond].
          enum:
          - DasWebapp
          - Hiveserver2
          - QueryCoordinator
          - QueryExecutor
          - StandaloneQueryExecutor
          - TokenAuth
          - Hue
          - ImpalaAutoscaler
          - ImpalaCatalogd
          - ImpalaCoordinator
          - ImpalaExecutor
          - ImpalaProxy
          - ImpalaStatestored
          - ImpalaTokenAuth
          - ImpalaAdmissiond
        set:
          description: Configuration files of the selected component to update.
          type: array
          items:
            type: object
            $ref: '#/components/schemas/ConfigBlock'
    CreateSecretResponse:
      x-form-factors: private
      type: object
      description: Response object for creating secret.
      properties:
        result:
          description: Result of the operation.
          $ref: '#/components/schemas/Secret'
    DescribeRestoreRequest:
      type: object
      x-form-factors: private
      description: Request object for the describe restore request.
      required:
      - restoreCrn
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
    ClusterSummaryProductSupportResponse:
      x-form-factors: public,private
      type: object
      description: 'Support lifecycle details of the given Cluster version (see version field). Learn more at Support lifecycle site: https://www.cloudera.com/services-and-support/support-lifecycle-policy.html.'
      properties:
        status:
          type: string
          description: 'Status of the support lifecycle. *COVERED*: The Cluster version has active support. *EXPIRED*: The Cluster version is no-longer supported. *UNKNOWN*: The Cluster version is missing or incorrect.'
        expiryDate:
          type: string
          format: date-time
          description: Shows the expiration date of the support for this Cluster version.
        message:
          type: string
          description: Message.
    SuspendVwRequest:
      type: object
      description: The request object for the suspendVw method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: The ID of the Virtual Warehouse cluster.
        vwId:
          type: string
          description: The ID of the Virtual Warehouse to suspend.
    DescribeClusterRequest:
      type: object
      description: Request object for the describeCluster method. Use only one of environmentName, clusterCrn and clusterId.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to describe.
    ImpalaOptionsResponse:
      type: object
      description: Impala specific settings.
      properties:
        spillToS3Uri:
          type: string
          description: Impala spill to S3 URI.
        scratchSpaceLimit:
          type: integer
          format: int32
          description: Maximum scratch space used for spilling to disk.
          x-omitempty: false
    CreatePrivateClusterResponse:
      x-form-factors: private
      type: object
      description: Response object for the createPrivateCluster method.
      properties:
        clusterId:
          type: string
          description: ID of new Private Cloud cluster.
    DiagnosticDataJobStatus:
      type: string
      description: Represents the possible status values of a Diagnostic Data Job.
      x-form-factors: public
      enum:
      - Starting
      - Succeeded
      - Failed
      - Running
      - Unknown
      - Deleted
    ServiceConfigReq:
      type: object
      description: Configurations for a service (DBC or VW)
      properties:
        commonConfigs:
          description: Configurations that are applied to every application in the service.
          $ref: '#/components/schemas/ApplicationConfigReq'
        applicationConfigs:
          type: object
          description: Application specific configurations.
          additionalProperties:
            description: Application specific configurations.
            $ref: '#/components/schemas/ApplicationConfigReq'
        ldapGroups:
          type: array
          items:
            type: string
          description: LDAP Groupnames to be enabled for auth.
        enableSSO:
          type: boolean
          description: Should SSO be enabled for this VW.
    HealthCheckResponse:
      type: object
      description: Response object for the healthCheck method.
      properties:
        message:
          type: string
          description: HealthCheck status text.
    UpdateServerSettingItem:
      type: object
      description: A DWX server setting update.
      x-form-factors: private
      properties:
        configurationKey:
          type: string
          description: The identifier of the setting.
        enabled:
          type: boolean
          description: The state of the setting.
    AutoscalingOptionsUpdateRequest:
      type: object
      description: Auto-scaling configuration for a Virtual Warehouse. Provide those values only that you want to update.
      properties:
        minClusters:
          type: integer
          format: int32
          default: 0
          description: Sets the minimum number of Executor Groups. Zero means the minClusters will not be updated.
        maxClusters:
          type: integer
          format: int32
          default: 0
          description: 'Sets the maximum number of Executor Groups the Virtual Warehouse can scale up to. Zero means that this value will not be updated. This value defines the upper boundary for autoscaling. The total node capacity is determined by this number multiplied by the number of nodes in the selected `--t-shirt-size`. NOTE: On Azure, all IPs for the maximum node count are pre-allocated. If you use the same `--instance-type` for multiple Virtual Warehouses, they will share the same underlying nodepool and its limit is calculated as the sum of all nodes required by the corresponding Virtual Warehouses.'
        disableAutoSuspend:
          type: boolean
          description: Turn off auto suspend for Virtual Warehouse.
        autoSuspendTimeoutSeconds:
          type: integer
          format: int32
          description: Auto suspend threshold for Virtual Warehouse.
        hiveScaleWaitTimeSeconds:
          type: integer
          format: int32
          description: Set wait time before a scale event happens. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided. If "hiveScaleWaitTimeSeconds" provided, then the "hiveDesiredFreeCapacity" will be explicityly set to 0.
        hiveDesiredFreeCapacity:
          type: integer
          format: int32
          description: Set Desired free capacity. Either "hiveScaleWaitTimeSeconds" or "hiveDesiredFreeCapacity" can be provided.
        impalaScaleUpDelaySeconds:
          type: integer
          format: int32
          description: Scale up the scaling up threshold in seconds.
        impalaScaleDownDelaySeconds:
          type: integer
          format: int32
          description: Scale down threshold in seconds.
        impalaShutdownOfCoordinatorDelaySeconds:
          x-deprecated: true
          type: integer
          format: int32
          description: DEPRECATED in favor of the top level impalaHASettings object. Delay in seconds before the shutdown of coordinator event happens.
        impalaNumOfActiveCoordinators:
          x-deprecated: true
          type: integer
          format: int32
          description: DEPRECATED in favor of the top level impalaHASettings object. Number of the active coordinators.
        impalaExecutorGroupSets:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetsUpdateRequest'
          description: Re-configures executor group sets for workload aware autoscaling.
    ListBackupsResponse:
      type: object
      x-form-factors: private
      description: Response object for the list backups request.
      required:
      - backups
      properties:
        backups:
          type: array
          description: List of backups.
          items:
            $ref: '#/components/schemas/SimpleBackup'
    ListEventsResponse:
      x-form-factors: public,private
      type: object
      description: Response object for the listEvents method.
      properties:
        events:
          type: array
          description: List of the events.
          items:
            $ref: '#/components/schemas/Event'
    ImpalaExecutorGroupSetCreateRequest:
      type: object
      description: Configure independently scaling set of uniformly sized executor groups.
      properties:
        execGroupSize:
          type: integer
          format: int32
          description: Set number of executors per executor group.
          x-omitempty: false
        minExecutorGroups:
          type: integer
          format: int32
          description: Set minimum number of executor groups allowed.
          x-omitempty: false
        maxExecutorGroups:
          type: integer
          format: int32
          description: Set maximum number of executor groups allowed.
          x-omitempty: false
        autoSuspendTimeoutSeconds:
          type: integer
          format: int32
          description: Set auto suspend threshold. If not provided defaults will apply.
        disableAutoSuspend:
          type: boolean
          description: Turn off auto suspend. If not provided defaults will apply.
        triggerScaleUpDelay:
          type: integer
          format: int32
          description: Set scale up threshold in seconds. If not provided defaults will apply.
        triggerScaleDownDelay:
          type: integer
          format: int32
          description: Set scale down threshold in seconds. If not provided defaults will apply.
    DeleteClusterRequest:
      type: object
      description: Request object for the deleteCluster method.
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to delete.
        force:
          type: boolean
          default: false
          description: 'Force delete means CDW will delete the cluster even if there are attached DB Catalogs and Virtual Warehouses. All managed data will be lost and will not be recoverable. Force delete attempts all steps of the deletion even if previous steps have failed. NOTICE: Be aware that a Force delete may not remove all resources due to cloud provider constraints. Should this happen, it is responsibility of the user to ensure the impacted resources are deleted on the cloud provider.'
      required:
      - clusterId
    Quota:
      x-form-factors: private
      type: object
      description: Quota for the Virtual Warehouse.
      properties:
        cpu:
          type: number
          format: float
          description: CPU quota in cores.
        memory:
          type: integer
          format: int32
          description: Memory quota in MB.
    DeleteClusterDiagnosticDataJobResponse:
      type: object
      description: Response object for the deleteClusterDiagnosticDataJob method.
      x-form-factors: public
    ListConnectorsResponse:
      x-form-factors: public,private
      type: object
      description: Response object for the listConnectors method. This object contains the list of all connectors configured in the specified Cloudera Data Warehouse cluster.
      properties:
        connectors:
          type: array
          items:
            $ref: '#/components/schemas/Connector'
          description: The list of Database Connectors.
    UpgradeDataVisualizationResponse:
      type: object
      description: Response object for the upgradeDataVisualization method.
      properties:
        status:
          type: string
          description: The status of asynchronous upgrade request for Cloudera Data Visualization. To find the latest status please use describe-data-visualization.
    Secret:
      type: object
      description: Details of a single DWX secret.
      properties:
        secretName:
          type: string
          description: The user-facing name of the secret.
        secretProviderKey:
          type: string
          description: The provider key name associated with the secret.
        createdBy:
          type: string
          description: The CRN of the user who created the secret.
        properties:
          type: object
          description: The properties of the secret.
          properties:
            cloudProvider:
              type: string
              description: The cloud provider associated with the secret.
            version:
              type: string
              description: The version of the secret.
            azureVaultName:
              type: string
              description: The name of the Azure Key Vault.
    UpdateApplicationResourcesLocalStorageSize:
      type:
      - object
      - 'null'
      description: Storage related information.
      x-mutating: true
      x-form-factors: private
      properties:
        scratch:
          type: string
          description: Local disk space used for writing scratch data.
        cache:
          type: string
          description: Local disk space used for writing cache data.
        overhead:
          type: string
          description: Local disk space used for writing other temporary data, tools, etc.
    UpdateSshKeyResponse:
      type: object
      description: Response object for the updateSshKey method.
      properties:
        status:
          type: string
          description: The status of the cluster.
        message:
          type: string
          description: A message describing the outcome of the SSH Key update process.
    ListDbcEventsResponse:
      type: object
      description: Response object for the listDbcEvents method.
      properties:
        events:
          type: array
          description: The list of the events belonging to the particular Database Catalog
          items:
            $ref: '#/components/schemas/EventResponse'
    ExternalBucketAccessInfo:
      type: object
      description: External bucket definition.
      properties:
        accessMode:
          type: string
          description: Specifies whether the external bucket will be added in read-only or read-write mode.
          enum:
          - READ
          - READWRITE
        kmsCmkArn:
          type: string
          description: Enable server side encryption with the specified KMS CMK ARN. If the value is empty or unspecified, default server side encryption will be used when the access mode is read-write. Otherwise this value is ignored.
    StringDiff:
      type: object
      description: Difference between two strings.
      required:
      - from
      - to
      properties:
        from:
          type: string
          description: The old value.
        to:
          type: string
          description: The new value.
    CreateAzureClusterResponse:
      type: object
      description: Response object for the createCluster method.
      properties:
        clusterId:
          type: string
          description: ID of new Azure cluster.
    ListLatestVersionsRequest:
      type: object
      description: Request object of the listLatestVersions call.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster from which the version information must be collected.
    Event:
      x-form-factors: public,private
      type: object
      description: Represents a Event.
      properties:
        operationId:
          type: string
          description: The ID of the operation to which the event belongs.
        serviceId:
          type: string
          description: The ID of the service to which the event belongs.
        event:
          type: string
          description: The name of the event.
        message:
          type: string
          description: Detailed message.
        timestamp:
          type: string
          format: date-time
          description: The timestamp of the event.
    CreateDbcDiagnosticDataJobRequest:
      type: object
      description: Request object for the createDbcDiagnosticDataJob method.
      x-form-factors: public
      required:
      - clusterId
      - dbcId
      - destination
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        destination:
          type: string
          description: Destination of the diagnostics collection.
          enum:
          - UPLOAD_TO_CLOUDERA
          - DOWNLOAD
        startTime:
          type: string
          format: date-time
          description: The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.
        endTime:
          type: string
          format: date-time
          description: The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.
        caseNumber:
          type: string
          description: Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.
        bundleMetadata:
          type: object
          additionalProperties:
            type: string
          description: Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle.
        force:
          type: boolean
          default: false
          description: Forced recreation of the diagnostic job.
    ImpalaHighAvailabilityMode:
      type: string
      enum:
      - ACTIVE_PASSIVE
      - ACTIVE_ACTIVE
      - DISABLED
      description: Set Impala High Availability mode. If not provided, the default will apply. DISABLED - Disables Impala coordinator and Database Catalog high availability. ACTIVE_PASSIVE - Runs multiple coordinators (one active, one passive) and Database Catalogs (one active, one passive). ACTIVE_ACTIVE - Runs multiple coordinators (both active) and Database Catalogs (one active, one passive). If Unified Analytics is enabled, then this cannot be set to ACTIVE_ACTIVE.
    Message:
      type: object
      x-form-factors: private
      description: The message object used to display warnings and errors during DRS workflows
      properties:
        text:
          type: string
          description: The text message of the warning/error.
        timestamp:
          type: string
          description: The time when the warning/error is hit.
        namespace:
          type: string
          description: The namespace that has the warning/error.
    ApplicationConfigDiff:
      type: object
      description: Differences between two ApplicationConfigs.
      required:
      - isChanged
      properties:
        isChanged:
          type: boolean
          description: Has any of the configurations changed?
        configBlocksDiffs:
          description: Differences between the two sets of ConfigBlocks.
          $ref: '#/components/schemas/ConfigBlocksDiffs'
    DescribeDataVisualizationResponse:
      type: object
      description: Response object for the describeDataVisualization method.
      properties:
        dataVisualization:
          description: The Cloudera Data Visualization.
          $ref: '#/components/schemas/DataVisualizationSummary'
    DeleteResourceTemplateResponse:
      type: object
      description: The response object for the deleteResourceTemplate method.
      x-mutating: false
      x-form-factors: private
      properties:
        templateId:
          type: string
          description: The id of the deleted template.
    ConfigContentResp:
      type: object
      description: Contents of a ConfigBlock.
      properties:
        keyValues:
          type: object
          description: Key-value type configurations.
          additionalProperties:
            description: Key-value type configurations.
            type: string
        text:
          type: string
          description: Text type configuration.
        json:
          type: string
          description: JSON type configuration.
    UpgradeDbcResponse:
      type: object
      description: Response object of the upgradeDbc call.
      properties:
        status:
          type: string
          description: 'The upgrade status. Possible values are: Upgrading, Error, Failed.'
        message:
          type: string
          description: The Upgrade message.
        timedOut:
          type: boolean
          description: True if the upgrade timed out, false or omitted otherwise.
        serviceUnhealthy:
          type: boolean
          description: True, if the service is in unhealthy state, false or omitted otherwise.
    DescribeConfigResponse:
      type: object
      description: Response object for the describeConfig method.
      properties:
        config:
          description: The service configuration.
          $ref: '#/components/schemas/ServiceConfigResp'
    AllowedInstanceTypes:
      type: object
      description: Allowed compute instance type values and default compute instance type value.
      properties:
        default:
          type: array
          description: Default value for the compute instance type usage. This setting is Cluster-wide.
          items:
            type: string
        allowed:
          type: array
          description: Allowed values for the instance type. This setting is Cluster-wide.
          items:
            type: string
        hive:
          x-form-factors: public
          description: Allowed instance types for Hive Virtual Warehouses.
          $ref: '#/components/schemas/AllowedInstanceTypesWithDefault'
        impala:
          x-form-factors: public
          description: Allowed instance types for Impala Virtual Warehouses.
          $ref: '#/components/schemas/AllowedInstanceTypesWithDefault'
        trino:
          x-form-factors: public
          description: Allowed instance types for Trino Virtual Warehouses.
          $ref: '#/components/schemas/AllowedInstanceTypesWithDefault'
    DescribeDbcResponse:
      type: object
      description: Response object for the describeDbc method.
      properties:
        dbc:
          description: The Database Catalog.
          $ref: '#/components/schemas/DbcSummary'
    DeleteVwDiagnosticDataJobRequest:
      type: object
      description: Request object for the deleteVwDiagnosticDataJobRequest method.
      x-form-factors: public
      required:
      - clusterId
      - vwId
      - jobId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        jobId:
          type: string
          description: ID of the diagnostic job.
    ListConnectorTestJobsRequest:
      x-form-factors: public,private
      type: object
      description: Request for the listConnectorTestJobs call.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        jobId:
          type: string
          description: The ID of the specific job to fetch (optional).
    ListVwDiagnosticDataJobsRequest:
      type: object
      description: Request object for the listVwDiagnosticDataJobsRequest method.
      x-form-factors: public
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        status:
          description: Filter for job type
          $ref: '#/components/schemas/DiagnosticDataJobStatus'
        pageSize:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          x-paging-page-size: true
          description: The size of each page.
        startingToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
          x-paging-input-token: true
    CreateDbcResponse:
      type: object
      description: Response object for the createDbc method.
      properties:
        dbcId:
          type: string
          description: ID of the new Database Catalog.
    DescribeDbcDiagnosticDataJobRequest:
      type: object
      description: Request object for the describeDbcDiagnosticDataJobRequest method.
      x-form-factors: public
      required:
      - clusterId
      - dbcId
      - jobId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        jobId:
          type: string
          description: ID of the diagnostic job.
    DeleteDbcResponse:
      type: object
      description: Response object for the deleteDbc method.
    ImpalaHASettingsCreateRequest:
      type: object
      description: High Availability settings for the Impala Virtual Warehouse. The values are disregarded for Hive.
      properties:
        highAvailabilityMode:
          $ref: '#/components/schemas/ImpalaHighAvailabilityMode'
          description: Set High Availability mode. If not provided, the default will apply. DISABLED - Disables Impala coordinator and Database Catalog high availability. ACTIVE_PASSIVE - Runs multiple coordinators (one active, one passive) and Database Catalogs (one active, one passive). ACTIVE_ACTIVE - Runs multiple coordinators (both active) and Database Catalogs (one active, one passive). If Unified Analytics is enabled, then this cannot be set to ACTIVE_ACTIVE.
        enableShutdownOfCoordinator:
          type: boolean
          description: Enables a shutdown of the coordinator. If Unified Analytics is enabled, then this setting is explicitly disabled (ignored) and should not be provided.
        shutdownOfCoordinatorDelaySeconds:
          type: integer
          format: int32
          description: Delay in seconds before the shutdown of coordinator event happens.
        numOfActiveCoordinators:
          type: integer
          format: int32
          description: The number of active coordinators.
        enableCatalogHighAvailability:
          type: boolean
          description: Enables a backup instance for Impala catalog to ensure high availability.
        enableStatestoreHighAvailability:
          type: boolean
          description: Enables a backup instance for Impala Statestore to ensure high availability.
        impalaEnableGlobalAdmissionController:
          type: boolean
          description: Set whether the Impala Global Admission Controller is enabled. This feature can only be used with high-availability mode ACTIVE_ACTIVE.
    RebuildVwResponse:
      type: object
      description: Response object for the rebuildVw method.
      properties:
        warning:
          type: string
          description: Warning message during Virtual Warehouse rebuild
    CreateBackupRequest:
      type: object
      x-form-factors: private
      description: Request object for the create backup request.
      properties:
        backupName:
          type: string
          description: Specified name for the backup. If not set, the name will be blank.
        namespaceNames:
          type: array
          description: A list of namespace of the potential candidates for backup. If not set, all of the Data Warehouse namespaces will be backed up.
          items:
            type: string
    VwDiagnosticDataJob:
      type: object
      description: Represents a Diagnostic Data Job.
      x-form-factors: public
      properties:
        jobId:
          type: string
          description: The unique identifier of the Diagnostic Data Job.
        startTime:
          type: string
          format: date-time
          description: The start time of the Diagnostic Data Job.
        endTime:
          type: string
          format: date-time
          description: The finish time of the Diagnostic Data Job.
        url:
          type: string
          description: If the request is for download, this URL points to download location.
        status:
          description: The job status.
          $ref: '#/components/schemas/DiagnosticDataJobStatus'
        labels:
          type: object
          description: Additional key-value pair attributes associated with the Diagnostic Data Job.
          additionalProperties:
            type: string
    ListConnectorTestJobsResponse:
      x-form-factors: public,private
      type: object
      description: Response for the listConnectorTestJobs call.
      properties:
        results:
          type: array
          description: List of test connector jobs.
          items:
            $ref: '#/components/schemas/GetConnectorTestJob'
    CreateVwDiagnosticDataJobResponse:
      type: object
      description: Response object for the createVwDiagnosticDataJob method.
      x-form-factors: public
      properties:
        id:
          type: string
          description: Identifier for each bundle collection.
        status:
          type: string
          description: Status of the diagnostics collection request.
        url:
          type: string
          description: This URL points to a download location if the destination is DOWNLOAD.
        labels:
          type: object
          description: Additional key-value pair attributes associated with the Diagnostic Data Job.
          additionalProperties:
            type: string
    StartDbcResponse:
      type: object
      description: Response object for the restartDbc method.
    ServiceConfigResp:
      type: object
      description: Configurations for a service (DBC or VW)
      properties:
        commonConfigs:
          description: Configurations that are applied to every application in the service.
          $ref: '#/components/schemas/ApplicationConfigResp'
        applicationConfigs:
          type: object
          description: Application specific configurations.
          additionalProperties:
            description: Application specific configurations.
            $ref: '#/components/schemas/ApplicationConfigResp'
        ldapGroups:
          type: array
          items:
            type: string
          description: List of LDAP Groupnames to be enabled for auth.
        enableSSO:
          type: boolean
          description: Should SSO be enabled for this VW. This cannot be changed later.
    RestoreBackupRequest:
      type: object
      x-form-factors: private
      description: Request object for the restore backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
        namespaceNames:
          type: array
          description: A list of namespaces of the potential candidates for restore. If not set, all of the Data Warehouse namespaces within the backup CRN will be restored.
          items:
            type: string
        rebuild:
          description: Rebuilds the Database Catalogs, Cloudera Data Visualizations, Hive Virtual Warehouses and Impala Virtual Warehouses restored from the backup. This option cannot be used for automatic backups.
          type: boolean
    DescribeServerSettingRequest:
      type: object
      description: Request object for the describeServerSetting method.
      x-form-factors: private
    DescribeRestoreResponse:
      type: object
      x-form-factors: private
      description: Response object for the describe restore request.
      required:
      - restore
      properties:
        restore:
          $ref: '#/components/schemas/Restore'
          description: The restore details.
    StartDbcRequest:
      type: object
      description: Request object for the restartDbc method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: The ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: The ID of the Database Catalog to restart.
        forceRefresh:
          type: boolean
          description: Enforce refreshing configurations.
    CreateConnectorRequest:
      x-form-factors: public,private
      type: object
      description: Request object to create a new connector for integrating external systems or data sources with Cloudera Data Warehouse.
      required:
      - name
      - template
      properties:
        name:
          type: string
          description: The name of the connector.
        template:
          type: string
          description: The template of the connector.
        clusterId:
          type: string
          description: THe ID of the Database Catalog's cluster.
        config:
          type: object
          description: 'The connector configuration in key-value format. For example, { "connector.name": "iceberg", "fs.cache.directories": "/data/trino/fs_cache_iceberg", "fs.cache.enabled": "true", "fs.cache.max-disk-usage-percentages": "30", "fs.cache.preferred-hosts-count": "2", "fs.cache.ttl": "7d", "hive.metastore.uri": "thrift://metastore-service.{{ .Values.warehouseId }}.svc.cluster.local:9083", "iceberg.catalog.type": "hive_metastore", "iceberg.security": "{{ .Values.authorizationMode }}", "ranger.audit_config": "ranger-hive-audit.xml", "ranger.hadoop_config": "core-site.xml", "ranger.policy_mgr_ssl_config": "ranger-policymgr-ssl.xml", "ranger.security_config": "ranger-hive-security.xml", "ranger.service_name": "{{ .Values.rangerHiveSvcName }}" }'
          additionalProperties:
            type: string
        description:
          type: string
          description: User-provided description.
    VwSummary:
      type: object
      description: A Virtual Warehouse.
      properties:
        crn:
          type: string
          description: The CRN of the Virtual Warehouse.
        id:
          type: string
          description: The ID of the Virtual Warehouse.
        name:
          type: string
          description: The name of the Virtual Warehouse.
        vwType:
          description: The type of the Virtual Warehouse.
          $ref: '#/components/schemas/VwType'
        instanceType:
          x-form-factors: public
          type: string
          description: The underlying instance type for this Virtual Warehouse.
        imageVersion:
          type: string
          description: Version of the Virtual Warehouse.
        dbcId:
          type: string
          description: ID of Database Catalog that the Virtual Warehouse is attached to.
        status:
          type: string
          description: 'Status of the Virtual Warehouse. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error.'
        statusChangedAt:
          type: string
          format: date-time
          description: Timestamp of the last status change of the Virtual Warehouse.
        creator:
          $ref: '#/components/schemas/ActorResponse'
          description: The creator of the Virtual Warehouse.
        creationDate:
          type: string
          format: date-time
          description: Creation date of Virtual Warehouse.
        configId:
          type: string
          description: ID of the configuration.
        cdhVersion:
          type: string
          description: CDH image version.
        numOfCores:
          type: integer
          format: int32
          description: Number of cores of the Virtual Warehouse.
        memoryCapacity:
          type: integer
          format: int32
          description: Memory size of the Virtual Warehouse in MB.
        nodeCount:
          type: integer
          format: int32
          description: Size of the Virtual Warehouse (node count per compute cluster).
        availabilityZone:
          type: string
          description: Availability zone in which the Virtual Warehouse is running.
        endpoints:
          type: object
          description: Endpoints for accessing the Virtual Warehouse.
          properties:
            hiveJdbc:
              type: string
              description: JDBC URL for Hive Virtual Warehouses.
            hiveKerberosJdbc:
              type: string
              x-form-factors: private
              description: JDBC URL with Kerberos authentication for Hive Virtual Warehouses in Private Cloud.
            impalaJdbc:
              type: string
              description: JDBC URL for Impala Virtual Warehouses.
            impalaKerberosJdbc:
              type: string
              x-form-factors: private
              description: JDBC URL for Impala Virtual Warehouses with Kerberos authentication.
            impalaShell:
              type: string
              description: Command to use impala-shell for Impala Virtual Warehouses.
            kerberosImpalaShell:
              type: string
              x-form-factors: private
              description: Command to use impala-shell for Impala Virtual Warehouses with Kerberos authentication.
            trinoCli:
              type: string
              description: Command-line client that connects to Trino Virtual Warehouse to execute SQL queries.
            hue:
              type: string
              description: URL of Hue for both Hive and Impala Virtual Warehouses.
            das:
              type: string
              description: URL of Data Analytics Studio for Hive Virtual Warehouses.
            hostname:
              type: string
              description: Hostname for clients to use when connecting to the VW.
            port:
              type: integer
              format: int32
              description: Port for clients to use when connecting to the VW.
            jwtConnectionString:
              type: string
              description: Generic semi-colon delimited list of key-value pairs that contain all necessary information for clients to construct a connection to this Virtual Warehouse using JWTs as the authentication method.
            jwtTokenGenUrl:
              type: string
              description: When platform JWT authentication is enabled, contains a URL where a JWT token can be generated by the CDP JWT token provider.
        supportedAuthMethods:
          type: object
          description: Describes which authentication methods are supported on this Virtual Warehouse.
          required:
          - ldap
          - jwt
          - sso
          properties:
            ldap:
              type: boolean
              description: Indicates if username/password access to this Virtual Warehouse is supported.
            jwt:
              type: boolean
              description: Indicates if JWT auth is supported on this Virtual Warehouse.
            sso:
              type: boolean
              description: Indicates if SSO auth is supported on this Virtual Warehouse.
        jwtAuth:
          type: object
          description: Details related to JWT Authentication settings on this Virtual Warehouse.
          properties:
            provider:
              type: string
              description: If JWT auth is enabled on the Virtual Warehouse, describes the type of provider.  If set to "CDP", then the CDP JWT auth provider is configured.  If set to "CUSTOM", then another JWT provider is configured.  If empty or missing, then JWT auth is not enabled on this Virtual Warehouse.
        impalaQueryLog:
          type: boolean
          x-form-factors: public
          description: Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not.
        logHiveQueries:
          x-form-factors: private
          type: boolean
          description: Denotes whether the Hive Virtual Warehouse stores Hive query information for all completed queries in the sys.query_history system table. You can query this table using SQL to monitor and optimize the Hive engine.
        tags:
          type: array
          description: Tags associated with the resources.
          items:
            $ref: '#/components/schemas/TagResponse'
        compactor:
          type: boolean
          description: Denotes whether the Hive Virtual Warehouse is a compactor or not.
        viz:
          type: boolean
          description: Denotes whether the Virtual Warehouse has Data Visualisation or not.
        autoscalingOptions:
          description: The current settings stored for autoscaling.
          $ref: '#/components/schemas/AutoscalingOptionsResponse'
        impalaOptions:
          description: Current Impala settings.
          $ref: '#/components/schemas/ImpalaOptionsResponse'
        impalaHaSettingsOptions:
          description: Current Impala High Availability settings.
          $ref: '#/components/schemas/ImpalaHASettingsOptionsResponse'
        queryIsolationOptions:
          description: The current settings stored for query-isolation.
          $ref: '#/components/schemas/QueryIsolationOptionsResponse'
        replicaStatus:
          x-form-factors: public,private
          description: Status information on the current state of replicas in the virtual warehouse.
          $ref: '#/components/schemas/ReplicaStatus'
        resourcePool:
          type: string
          description: The name of the Resource Pool the Virtual Warehouse is in.
          x-form-factors: private
        additionalQuota:
          x-form-factors: private
          $ref: '#/components/schemas/Quota'
          description: Setting the quota for the 3rd party services injected into the Virtual Warehouse namespace.
        hiveAuthenticationMode:
          type:
          - string
          - 'null'
          x-deprecated: true
          x-form-factors: private
          description: 'DEPRECATED - Authentication mode used by Hive Server: * `LDAP` * `KERBEROS`'
        ebsLLAPSpillGB:
          type: integer
          format: int32
          description: Provides EBS gp3 volume as temporary storage space for Hive LLAP cache, and improves query performance. Configurable only at Virtual Warehouse creation. Using EBS volumes incurs additional costs.
        hiveServerHaMode:
          type:
          - string
          - 'null'
          x-form-factors: private
          description: 'Hive Server High Availability mode in Private Cloud: * `DISABLED` - Hive Server high availability is disabled. * `ACTIVE_PASSIVE` - Hive Server high availability is enabled with one active and one passive instances. Hive session failover is not supported in this setup.'
        resources:
          type:
          - object
          - 'null'
          x-form-factors: private
          description: The actual resources used by the Virtual Warehouse.
          additionalProperties:
            $ref: '#/components/schemas/ApplicationResources'
        associatedConnectors:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ConnectorData'
          description: Map of connector ID to connector information for the Virtual Warehouse.
          x-omitempty: true
    QueryIsolationOptionsRequest:
      type: object
      description: Configurations for Query Isolation.
      properties:
        maxQueries:
          type: integer
          format: int32
          default: 0
          description: Maximum Concurrent Isolated Queries. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled.
        maxNodesPerQuery:
          type: integer
          format: int32
          default: 0
          description: Maximum Nodes Per Isolated Query. If not provided, 0 will be applied. The 0 value means the query isoltaion functionality will be disabled.
    UpgradeDataVisualizationRequest:
      type: object
      description: Request object for the upgradeDataVisualization method.
      required:
      - clusterId
      - dataVisualizationId
      - imageVersion
      properties:
        clusterId:
          type: string
          description: ID of the Cloudera Data Visualization's cluster.
        dataVisualizationId:
          type: string
          description: ID of the Cloudera Data Visualization.
        imageVersion:
          type: string
          description: Image version of the Cloudera Data Visualization to upgrade to.
        resourcePool:
          type: string
          description: The name of the Resource Pool the Cloudera Data Visualization will be assigned to.
          x-form-factors: private
    CreateVwDiagnosticDataJobRequest:
      type: object
      description: Request object for the createVwDiagnosticDataJob method.
      x-form-factors: public
      required:
      - clusterId
      - vwId
      - destination
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        destination:
          type: string
          description: Destination of the diagnostics collection.
          enum:
          - UPLOAD_TO_CLOUDERA
          - DOWNLOAD
        startTime:
          type: string
          format: date-time
          description: The resulting bundle will contain logs/metrics after the specified start time. If not indicated, then 30 minutes ago from now is taken as the start time.
        endTime:
          type: string
          format: date-time
          description: The resulting bundle will contain logs/metrics before the specified end time. If not indicated, then the current time is taken as the end time.
        caseNumber:
          type: string
          description: Optional support case number in case of UPLOAD_TO_CLOUDERA destination, otherwise only act as additional data.
        bundleMetadata:
          type: object
          additionalProperties:
            type: string
          description: Additional user-defined metadata information which is attached to resulting bundle-info.json when posting the bundle.
        force:
          type: boolean
          default: false
          description: Forced recreation of the diagnostic job.
    DescribeVwResponse:
      type: object
      description: Response object for the describeVw method.
      properties:
        vw:
          description: The Virtual Warehouse.
          $ref: '#/components/schemas/VwSummary'
    ListVwEventsRequest:
      type: object
      description: Request object for the listVwEvents method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
        limit:
          type: integer
          format: int32
          description: Limit the number of returned rows. If not specified all the events will be returned. Please note the DWX only stores the last 50 events.
        ascending:
          type: boolean
          default: false
          description: Provide the result in ascending order, default is descending.
    TagRequest:
      description: A key/value pair that can be attached to some resources.
      type: object
      required:
      - key
      - value
      properties:
        key:
          type: string
          description: The tag's name.
        value:
          type: string
          description: The associated value of the tag.
    ListBackupEntitiesResponse:
      type: object
      x-form-factors: private
      description: Response object for the list backup entities request.
      required:
      - items
      properties:
        items:
          type: array
          description: A list of available namespaces for backup, corresponding to the CDW entities.
          items:
            type: string
    ApplicationResources:
      type: object
      description: The resource requirements of a component.
      x-mutating: false
      x-form-factors: private
      properties:
        cpu:
          type: number
          format: float
          description: Overall CPU requirements.
        memory:
          type: string
          description: Overall memory requirements.
        breakdown:
          description: Breakdown of the service memory requirements.
          $ref: '#/components/schemas/ApplicationResourcesBreakdown'
        ephemeralStorage:
          type:
          - string
          - 'null'
          description: Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod.
        localStorageSize:
          description: Local disk size requirements.
          $ref: '#/components/schemas/ApplicationResourcesLocalStorageSize'
    UpdateClusterExternalBucketAccessInfo:
      type: object
      description: Cluster external bucket definition to update.
      properties:
        accessMode:
          type: string
          description: Specifies whether the external bucket will be added in read-only or read-write mode.
          enum:
          - READ
          - READWRITE
        kmsCmkArn:
          type: string
          description: Enable server side encryption with the specified KMS CMK ARN. If the value is empty or unspecified, default server side encryption will be used when the access mode is read-write. Otherwise this value is ignored.
    GetDataVisualizationUpgradeVersionRequest:
      type: object
      description: Request object for the getDataVisualizationUpgradeVersion method.
      required:
      - clusterId
      - dataVisualizationId
      properties:
        clusterId:
          type: string
          description: ID of the Cloudera Data Visualization's cluster.
        dataVisualizationId:
          type: string
          description: ID of the Cloudera Data Visualization.
    ListRestoresResponse:
      type: object
      x-form-factors: private
      description: Response object for the list restores request.
      required:
      - restores
      properties:
        restores:
          type: array
          description: List of restores for the control plane.
          items:
            $ref: '#/components/schemas/SimpleRestore'
    VwType:
      type: string
      enum:
      - hive
      - impala
      - trino
      description: 'Type of Virtual Warehouse: ''hive'', ''impala'', ''trino''.'
    DeleteUserRequest:
      type: object
      description: Request object for the deleteUser method.
      required:
      - clusterId
      - userId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster from which the user must be deleted.
        userId:
          type: string
          description: A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).
    DeleteResourceTemplateRequest:
      type: object
      description: Request object for the deleteResourceTemplate method.
      x-mutating: true
      x-form-factors: private
      properties:
        templateId:
          type: string
          description: The ID of the template.
        templateVersion:
          type: integer
          format: int32
          description: Version of the template.
    ListBackupsRequest:
      type: object
      x-form-factors: private
      description: Request object for the list backups request.
      properties:
        backupName:
          type: string
          description: Specified name for the backup. If not present, this filter is not used.
        jobStates:
          type: array
          items:
            type: string
          description: The job states we need to filter by. If not present, this filter is not used.
        includeAutomaticBackups:
          type: boolean
          description: Decides whether automatic (system-generated) backups should be listed or not. Value is true by default.
    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.
    DeleteDbcDiagnosticDataJobResponse:
      type: object
      description: Response object for the deleteDbcDiagnosticDataJobRequest method.
      x-form-factors: public
    AllowedInstanceTypesWithDefault:
      x-form-factors: public
      type: object
      description: Allowed Virtual Warehouse compute instance types and their defaults.
      properties:
        default:
          type: string
          description: Default value for the compute instance type usage. This instance type will be used in the 'create-vw' command's 'instance-type' field in case it has to be customized. The default value also depends on the cloud platform of the Cluster (AWS/Azure).
        allowed:
          type: array
          description: Allowed values for the compute instance type usage. One of these values can be used in the 'create-vw' command's 'instance-type' field .
          items:
            type: string
    DeleteSecretResponse:
      type: object
      description: Response object for deleting secret.
      properties:
        result:
          type: object
          description: Result of the operation.
          properties:
            secretName:
              type: string
              description: Name of the secret.
    UpdateServerSettingResponse:
      type: object
      description: Response object for the updateServerSetting method.
      x-form-factors: private
      properties:
        status:
          type: string
          description: Update status.
    UpdateResourceTemplateRequest:
      type: object
      description: Request object for the updateResourceTemplate method.
      x-mutating: true
      x-form-factors: private
      properties:
        templateId:
          type: string
          description: The ID of the template.
        name:
          type: string
          description: Name of the template.
        description:
          type: string
          description: Description of the template.
        resources:
          type: object
          description: The resource values of the template.
          additionalProperties:
            $ref: '#/components/schemas/UpdateApplicationResources'
    DeleteVwDiagnosticDataJobResponse:
      type: object
      description: Response object for the deleteVwDiagnosticDataJobRequest method.
      x-form-factors: public
    AzureActivationOptions:
      type: object
      description: Options for activating an Azure environment.
      properties:
        userAssignedManagedIdentity:
          type: string
          description: Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation.
        subnetId:
          type: string
          description: ID of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation.
        enableAZ:
          type: boolean
          description: Enables Azure Availability Zones for the cluster deployment.
        enableSpotInstances:
          type: boolean
          description: Whether to enable spot instances for Virtual warehouses. It cannot be updated later. If the AzureActivationOptions is not provided it defaults to false.
          default: false
        logAnalyticsWorkspaceId:
          type: string
          description: Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics.
        outboundType:
          type: string
          description: Network outbound type. This setting controls the egress traffic for cluster nodes in Azure Kubernetes Service. Please refer to the following AKS documentation on the Azure portal. https://learn.microsoft.com/en-us/azure/aks/egress-outboundtype, https://learn.microsoft.com/en-us/azure/aks/nat-gateway
          enum:
          - LoadBalancer
          - UserAssignedNATGateway
          - UserDefinedRouting
        aksPodCIDR:
          type: string
          description: Pod CIDR required for Azure CNI networking. Please refer to the following Azure documentation, https://docs.microsoft.com/en-us/azure/aks/azure-cni-overlay.
        enablePrivateSQL:
          type: boolean
          description: Enables private SQL for the cluster deployment.
          default: false
        privateSQLSubnetName:
          type: string
          description: Name of the delegated subnet where the private SQL should be deployed.
        privateDNSZoneSQL:
          type: string
          description: Private DNS zone ID for the PostgreSQL server.
        privateDNSZoneAKS:
          type: string
          description: Private DNS zone AKS resource ID.
        enablePrivateAks:
          type: boolean
          description: Enable Azure Private AKS mode.
          default: false
    StartVwRequest:
      type: object
      description: The request object for the startVw method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: The ID of the Virtual Warehouse cluster.
        vwId:
          type: string
          description: The ID of the Virtual Warehouse.
        forceRefresh:
          type: boolean
          description: Enforce refreshing configurations.
    ImpalaExecutorGroupSetsResponse:
      type: object
      description: Describes executor group sets for workload aware autoscaling.
      properties:
        small:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetResponse'
          description: Describes small executor group set for workload aware autoscaling.
        custom1:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetResponse'
          description: Describes first custom executor group set for workload aware autoscaling.
        custom2:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetResponse'
          description: Describes second custom executor group set for workload aware autoscaling.
        custom3:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetResponse'
          description: Describes third custom executor group set for workload aware autoscaling.
        large:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetResponse'
          description: Describes large executor group set for workload aware autoscaling.
    CreateDbcRequest:
      type: object
      description: Request object for the createDbc method.
      required:
      - clusterId
      - name
      properties:
        clusterId:
          type: string
          description: ID of cluster where Database Catalog should be created.
        name:
          type: string
          description: Name of the Database Catalog.
        loadDemoData:
          type: boolean
          description: Load demo data into the Database Catalog?
        imageVersion:
          type: string
          description: Version of the Database Catalog.
          default: ''
          x-form-factors: public
        resourceTemplateId:
          type: string
          description: The resource template of the Database Catalog.
        isDefault:
          type: boolean
          x-deprecated: true
          description: 'NOTE: creating Default Database Catalogs is deprecated and explicitly disabled. Denotes if Default Database Catalog creation needed.'
          default: false
    CreateConnectorTestJobRequest:
      x-form-factors: public,private
      type: object
      description: Request for the createConnectorTestJob call.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        connectorId:
          type: string
          description: The ID of the connector to test.
        connectorName:
          type: string
          description: The name of the connector to test.
        config:
          type: object
          description: Key-value type configurations.
          additionalProperties:
            type: string
    ConfigBlocksDiffs:
      type: object
      description: Differences between two sets of ConfigBlocks.
      required:
      - isChanged
      properties:
        isChanged:
          type: boolean
          description: Has any of the config blocks changed?
        added:
          type: array
          description: Config blocks that are only present in the new configuration.
          items:
            $ref: '#/components/schemas/ConfigBlockResp'
        removed:
          type: array
          description: Config blocks that are only present in the old configuration.
          items:
            $ref: '#/components/schemas/ConfigBlockResp'
        same:
          type: array
          description: Config blocks that are the same in both configurations.
          items:
            $ref: '#/components/schemas/ConfigBlockResp'
        changed:
          type: array
          description: Config blocks that are different between the two configurations.
          items:
            $ref: '#/components/schemas/ConfigBlockDiff'
    UpdateConnectorResponse:
      x-form-factors: public,private
      type: object
      description: Response object for the updateConnector method.
    UpdateClusterResponse:
      type: object
      description: Response object for the updateCluster method.
    CreatePrivateClusterRequest:
      x-form-factors: private
      type: object
      description: Request object for the createPrivateCluster method.
      required:
      - environmentCrn
      properties:
        environmentCrn:
          type: string
          description: The CRN of the environment for the cluster to create.
        storageClass:
          type: string
          description: The storage class for the Local Storage Operator.
        dedicatedExecutorNodes:
          x-deprecated: true
          type: boolean
          description: 'DEPRECATED: As of 1.5.5, this feature flag can be set as an advanced configuration. Enable to use dedicated nodes exclusively for executors and coordinators, and improve performance. You can enable this only if you reserved nodes while adding a CDP Private Cloud containerized ECS cluster. When disabled, non-compute pods such as MetaStore and Data Visualization can also use the reserved nodes.'
          default: false
        dbClientCredentials:
          $ref: '#/components/schemas/KeyPairCredentials'
          description: A certificate and private key pair belonging together for mutual SSL handshake when Database Catalog (aka DBC) connects to the metastore database.
        customKerberosPrincipalHostname:
          type: string
          description: Optional hostname parameter. If not empty, this hostname will be used in the Kerberos service principal required by Cloudera Data Warehouse on Premises runtime components (Database Catalog, Virtual Warehouses).
    DbcDiagnosticDataJob:
      type: object
      description: Represents a Diagnostic Data Job
      x-form-factors: public
      properties:
        jobId:
          type: string
          description: The unique identifier of the Diagnostic Data Job.
        startTime:
          type: string
          format: date-time
          description: The start time of the Diagnostic Data Job.
        endTime:
          type: string
          format: date-time
          description: The finish time of the Diagnostic Data Job.
        url:
          type: string
          description: This URL points to a download location if the destination is DOWNLOAD.
        status:
          description: The job status.
          $ref: '#/components/schemas/DiagnosticDataJobStatus'
        labels:
          type: object
          description: Additional key-value pair attributes associated with the Diagnostic Data Job.
          additionalProperties:
            type: string
    DescribeVwConfigResponse:
      type: object
      description: Response object for the describeVwConfig method.
      properties:
        config:
          description: The Virtual Warehouse configuration.
          $ref: '#/components/schemas/ServiceConfigResp'
    UpgradeDbcRequest:
      type: object
      description: Request object for the upgradeDbc method.
      required:
      - clusterId
      - dbcId
      - imageVersion
      properties:
        clusterId:
          type: string
          description: The ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: The ID of the Database Catalog.
        imageVersion:
          type: string
          description: The version to which the Database Catalog should be upgraded.
    RenewCertificatesRequest:
      type: object
      description: Request object for the renewCertificates method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the public cloud cluster to renew certificates for.
    ListDbcConfigsResponse:
      type: object
      description: Response object for the listDbcConfigs method.
      properties:
        configHistory:
          type: array
          description: Configuration history of a service.
          items:
            $ref: '#/components/schemas/ConfigHistoryItem'
    ListClustersRequest:
      type: object
      description: Request object for the listClusters method.
      properties:
        environmentCrn:
          type: string
          description: Filter returned clusters for the belonging Environment CRN.
        clusterId:
          type: string
          description: Filter returned clusters by cluster ID.
        name:
          type: string
          description: Filter returned clusters by name.
        status:
          type: string
          description: Filter returned clusters by cluster status.
          enum:
          - Creating
          - Created
          - Accepted
          - Starting
          - Running
          - Stopping
          - Stopped
          - Updating
          - PreUpdate
          - PreUpgrade
          - Restarting
          - Deleting
          - Upgrading
          - Waiting
          - Error
          - Failed
        cloudPlatform:
          x-form-factors: public
          type: string
          description: Filter returned clusters by hosting platform.
          enum:
          - AWS
          - AZURE
    TagResponse:
      description: A key/value pair attached to some resources.
      type: object
      required:
      - key
      - value
      properties:
        key:
          type: string
          description: The tag's name.
        value:
          type: string
          description: The associated value of the tag.
    DeleteSecretRequest:
      type: object
      description: Request object for deleting secret.
      required:
      - clusterId
      - secretName
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        secretName:
          type: string
          description: Name of the secret.
    VwFilter:
      type: object
      description: Filter object for Virtual Warehouses.
      properties:
        vwType:
          description: Virtual Warehouse type.
          $ref: '#/components/schemas/VwType'
        dbcId:
          type: string
          description: Filter Virtual Warehouses by Database Catalog Id.
        compactor:
          type: boolean
          description: Filter Virtual Warehouses whether it is a Compactor or not.
        viz:
          type: boolean
          description: Filter the Virtual Warehouses based on whether it has Data Visualisation.
    DeleteVwResponse:
      type: object
      description: Response object for the deleteVw method.
      properties:
        warning:
          type: string
          description: Warning message during Virtual Warehouse deletion
    DescribeDbcRequest:
      type: object
      description: Request object for the describeDbc method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
    ConfigBlockReq:
      type: object
      description: A piece of configuration stored in the same place (e.g. same file or environment variables).
      required:
      - id
      - content
      properties:
        id:
          type: string
          description: ID of the ConfigBlock. Unique within an ApplicationConfig.
        content:
          description: Contents of a ConfigBlock.
          $ref: '#/components/schemas/ConfigContentReq'
    DeleteVwRequest:
      type: object
      description: Request object for the deleteVw method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse to delete.
    ConfigHistoryItem:
      type: object
      description: An entry in the configuration history of a service.
      properties:
        serviceId:
          type: string
          description: DBC or VW ID that this configuration belongs to.
        configId:
          type: string
          description: ID of the configuration.
        from:
          type: string
          format: date-time
          description: When was this configuration used from.
    ListDbcDiagnosticDataJobsResponse:
      type: object
      description: Response object for the listDbcDiagnosticDataJobsRequest method.
      x-form-factors: public
      properties:
        jobs:
          type: array
          description: The list of the jobs belonging to the particular Database Catalog
          items:
            $ref: '#/components/schemas/DbcDiagnosticDataJob'
          x-paging-result: true
        nextToken:
          type: string
          x-paging-output-token: true
          description: The token to use when requesting the next set of results. If there are no additional results, the string is empty.
    RestoreClusterRequest:
      type: object
      description: Request object for the restoreCluster method.
      required:
      - clusterId
      - data
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        data:
          type: string
          description: Backup data of configuration received by calling "backup-cluster" command.
    RestoreClusterEntityPlan:
      type: object
      description: Entity status after the restore operation.
      properties:
        ref:
          type: string
          description: The reference of the entity in the backup data.
        id:
          type: string
          description: The ID of the entity.
        action:
          type: string
          description: 'The action associated with the plan. Possible actions: Create, Update, Skip'
        message:
          type: string
          description: The description of the plan.
    UpdateDbcConfigResponse:
      type: object
      description: Response object for the updateDbcConfig method.
    ListLatestVersionsResponse:
      type: object
      description: Response object of the listLatestVersions call.
      properties:
        idToLatestVersionsMap:
          type: object
          description: Map containing the latest image versions for each Virtual Warehouse found in the cluster.
          additionalProperties:
            type: string
    ListDataVisualizationsRequest:
      type: object
      description: Request object for the listDataVisualizations method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: ID of cluster to list Cloudera Data Visualizations.
    ConfigContentDiff:
      type: object
      description: Difference between two ConfigContents.
      properties:
        keyValues:
          description: Different between keyValues of two ConfigContents.
          $ref: '#/components/schemas/KeyValuesDiff'
    ResetServerSettingsRequest:
      type: object
      description: Request object for the resetServerSettings method.
      x-form-factors: private
    ListDbcDiagnosticDataJobsRequest:
      type: object
      description: Request object for the listDbcDiagnosticDataJobsRequest method.
      x-form-factors: public
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        status:
          description: Filter for job type
          $ref: '#/components/schemas/DiagnosticDataJobStatus'
        pageSize:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          x-paging-page-size: true
          description: The size of each page.
        startingToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
          x-paging-input-token: true
    AwsActivationOptionsNonTransparentProxy:
      type: object
      description: 'Activation options for an AWS environment to enable non-transparent proxy. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html'
      properties:
        use:
          type: boolean
          description: Switch using the default non-transparent proxy on/off.
          x-omitempty: false
        bypassedDomains:
          type: array
          x-omitempty: false
          description: Domains where the proxy is getting by-passed.
          items:
            type: string
            description: Domain.
    DescribeBackupResponse:
      type: object
      x-form-factors: private
      description: Response object for the describe backup request.
      required:
      - backup
      properties:
        backup:
          $ref: '#/components/schemas/Backup'
          description: The backup details.
    UpdateClusterObservabilityConfig:
      type: object
      description: Cluster observability settings to update.
      properties:
        logsForwardingConfig:
          type: string
          description: Create the log forwarding configuration in a valid fluentd format. Then that configuration is later inserted into a larger fluentd configuration.
        proxyCABundle:
          type: string
          description: Set the proxy CA certificates (PEM Bundle). If you use a TLS-terminating proxy server to inspect outbound internet traffic, you need to provide the proxy server's CA certificates bundle in PEM bundle format when you configure log forwarding.
    DescribeServerSettingItem:
      type: object
      description: A DWX server setting.
      x-form-factors: private
      properties:
        configurationName:
          type: string
          description: The name of the setting in human readable format.
        configurationKey:
          type: string
          description: The identifier of the setting.
        enabled:
          type: boolean
          description: The state of the setting.
        description:
          type: string
          description: The description of the setting.
        requiresUpdate:
          type: array
          items:
            $ref: '#/components/schemas/DescribeServerSettingItemRequiresUpdate'
          description: Indicates update requirements for the change to take effect.
    ConfigBlock:
      type: object
      description: Set values for a configuration file of a service.
      properties:
        configFile:
          type: string
          x-no-param-file: true
          description: Configuration file to update.
        keyValue:
          type: object
          description: Set values for key-value format configuration file e.g. ENV, PROPERTIES, FLAGFILE, HADOOP_XML typed file.
          additionalProperties:
            type: string
        content:
          description: Set values for text format configuration file e.g. TEXT, JSON, YAML, XML typed file.
          type: string
    DeleteClusterResponse:
      type: object
      description: Response object for the deleteCluster method.
    DescribeAllowedInstanceTypesResponse:
      type: object
      properties:
        aws:
          description: Instance type settings that are being used during cluster creation command on the AWS platform
          $ref: '#/components/schemas/AllowedInstanceTypes'
        azure:
          description: Instance type settings that are being used during cluster creation command on the Azure platform
          $ref: '#/components/schemas/AllowedInstanceTypes'
      description: Response object for the describeAllowedInstanceTypes method.
    CloudUserReference:
      type: object
      description: Cloud user definition object.
      required:
      - userId
      properties:
        userId:
          type: string
          description: A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).
    StartVwResponse:
      type: object
      description: The response object for the startVw method.
    DescribeKubeconfigRequest:
      type: object
      description: Request object for the describeKubeconfig method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: The ID of the cluster to describe.
    SuspendDbcRequest:
      type: object
      description: The request object for the suspendDbc method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: The ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: The ID of the Database Catalog to suspend.
    ConnectorData:
      type:
      - object
      - 'null'
      description: Information about a connector associated with a Virtual Warehouse.
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name of the connector
          x-omitempty: true
        configId:
          type:
          - string
          - 'null'
          description: The config UUID of the connector
          x-omitempty: true
      x-omitempty: true
    GetLogsRequest:
      type: object
      x-form-factors: private
      description: Request object for the get logs request.
      required:
      - crn
      properties:
        crn:
          type: string
          description: The CRN of the backup, restore or backup deletion.
    CreateVwResponse:
      type: object
      description: Response object for the createVw method.
      properties:
        vwId:
          type: string
          description: ID of the new Virtual Warehouse.
    CreateAwsClusterResponse:
      type: object
      description: Response object for the createAwsCluster method.
      properties:
        clusterId:
          type: string
          description: ID of new AWS cluster.
    UpdateApplicationResourcesBreakdown:
      type:
      - object
      - 'null'
      description: Breakdown of the service memory requirements.
      x-mutating: true
      x-form-factors: private
      properties:
        xms:
          type:
          - string
          - 'null'
          description: Java VM configuration for -Xms (initial and minimum heap size).
        xmx:
          type: string
          description: Java VM configuration for -Xmx (maximum heap size).
        xss:
          type:
          - string
          - 'null'
          description: Java VM configuration for -Xss (thread stack size).
        maxDirectMemorySize:
          type:
          - string
          - 'null'
          description: Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers).
    DeleteDataVisualizationRequest:
      type: object
      description: Request object for the deleteDataVisualization method.
      required:
      - clusterId
      - dataVisualizationId
      properties:
        clusterId:
          type: string
          description: ID of the Cloudera Data Visualization's cluster.
        dataVisualizationId:
          type: string
          description: ID of the Cloudera Data Visualization to delete from the cluster.
    ImpalaExecutorGroupSetsCreateRequest:
      type: object
      description: Configure executor group sets for workload aware autoscaling.
      properties:
        small:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetCreateRequest'
          description: Configure small executor group set for workload aware autoscaling.
          x-omitempty: false
        custom1:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetCreateRequest'
          description: Configure first optional custom executor group set for workload aware autoscaling.
        custom2:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetCreateRequest'
          description: Configure second optional custom executor group set for workload aware autoscaling.
        custom3:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetCreateRequest'
          description: Configure third optional custom executor group set for workload aware autoscaling.
        large:
          $ref: '#/components/schemas/ImpalaExecutorGroupSetCreateRequest'
          description: Configure large executor group set for workload aware autoscaling.
          x-omitempty: false
    KeyValuesDiff:
      type: object
      description: Different between keyValues of two ConfigContents.
      properties:
        added:
          type: object
          description: Keys that are only present in the new configuration.
          additionalProperties:
            type: string
            description: Keys that are only present in the new configuration.
        removed:
          type: object
          description: Keys that are only present in the old configuration.
          additionalProperties:
            type: string
            description: Keys that are only present in the old configuration.
        same:
          type: object
          description: Keys that are present in both configurations.
          additionalProperties:
            description: Keys that are present in both configurations.
            type: string
        changed:
          type: object
          description: Keys with different values.
          additionalProperties:
            description: Keys with different values.
            $ref: '#/components/schemas/StringDiff'
    ListDbcEventsRequest:
      type: object
      description: Request object for the listDbcEvents method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        limit:
          type: integer
          format: int32
          description: Limit the number of returned rows. If not specified all the events will be returned. Please note the DWX only stores the last 50 events.
        ascending:
          type: boolean
          default: false
          description: Provide the result in ascending order, default is descending.
    ListEventsRequest:
      x-form-factors: public,private
      type: object
      description: Request object for the listEvents method.
      properties:
        operationId:
          type: string
          description: Filters events based on the operation ID. Either operation ID or service ID is required.
        serviceId:
          type: string
          description: Filters events based on the service ID. It can be Cluster ID, Database Catalog ID, Virtual Warehouse ID or Data Visualization App ID.
        event:
          type: string
          description: 'Filters events based on the event. Case-insensitive filter, it matches sub-strings as well. Filtering for "comp" will return all the events containing the "comp" sub-string e.g.: "Completed".'
        limit:
          type: integer
          format: int32
          description: Limit the number of returned rows. If not specified then the recent 20 events will be returned. The maximum is 500.
        ascending:
          type: boolean
          default: false
          description: Provide the result in ascending order, default is descending.
    ListSecretsResponse:
      type: object
      description: Response object for listing secrets.
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Secret'
          description: The list of secrets.
    ListUsersResponse:
      type: object
      description: Response object for the listUsers method.
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/CloudUserReference'
          description: The list of users allowed to access the given cluster.
    PrivateCloudActivationOptions:
      type: object
      description: Options for activating a Private Cloud environment.
      x-form-factors: private
      properties:
        storageClass:
          type: string
          description: The storage class for the Local Storage Operator.
        dedicatedExecutorNodes:
          x-deprecated: true
          type: boolean
          description: 'DEPRECATED: As of 1.5.5, this feature flag can be set as an advanced configuration. Enable to use dedicated nodes exclusively for executors and coordinators, and improve performance. You can enable this only if you reserved nodes while adding a CDP Private Cloud containerized ECS cluster. When disabled, non-compute pods such as MetaStore and Data Visualization can also use the reserved nodes.'
          default: false
        dbClientCredentials:
          $ref: '#/components/schemas/KeyPairCredentials'
          description: A certificate and private key pair belonging together for mutual SSL handshake when Database Catalog (aka DBC) connects to the metastore database.
        customKerberosPrincipalHostname:
          type: string
          description: Optional hostname parameter. If not empty, this hostname will be used in the Kerberos service principal required by Cloudera Data Warehouse on Premises runtime components (Database Catalog, Virtual Warehouses).
    ListDbcsRequest:
      type: object
      description: Request object for the listDbcs method.
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: ID of cluster to list.
    CreateApplicationResources:
      type: object
      description: The resource requirements of a component.
      x-mutating: false
      x-form-factors: private
      properties:
        cpu:
          type: number
          format: float
          description: Overall CPU requirements.
        memory:
          type: string
          description: Overall memory requirements.
        breakdown:
          description: Breakdown of the service memory requirements.
          $ref: '#/components/schemas/CreateApplicationResourcesBreakdown'
        ephemeralStorage:
          type:
          - string
          - 'null'
          description: Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod.
        localStorageSize:
          description: Local disk size requirements.
          $ref: '#/components/schemas/CreateApplicationResourcesLocalStorageSize'
    DescribeVwRequest:
      type: object
      description: Request object for the describeVw method.
      required:
      - clusterId
      - vwId
      properties:
        clusterId:
          type: string
          description: ID of the Virtual Warehouse's cluster.
        vwId:
          type: string
          description: ID of the Virtual Warehouse.
    DescribeAllowedInstanceTypesRequest:
      type: object
      description: Request object for the describeAllowedInstanceTypes method.
    DescribeBackupRequest:
      type: object
      x-form-factors: private
      description: Request object for the describe backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
    DeleteDbcRequest:
      type: object
      description: Request object for the deleteDbc method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog to delete.
    UpdateDbcConfigRequest:
      type: object
      description: Request object for the updateDbcConfig method.
      required:
      - clusterId
      - dbcId
      - component
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        component:
          type: string
          description: Database Catalog configuration component to update.
          enum:
          - DasEventProcessor
          - DatabusProducer
          - HueQueryProcessor
          - Metastore
        set:
          description: Configuration files of the selected component to update.
          type: array
          items:
            type: object
            $ref: '#/components/schemas/ConfigBlock'
    DeleteBackupRequest:
      type: object
      x-form-factors: private
      description: Request object for the delete backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
    CreateClusterResponse:
      type: object
      description: Response object for the createCluster method.
      properties:
        clusterId:
          type: string
          description: ID of new cluster.
    ListClusterDiagnosticDataJobsRequest:
      type: object
      description: Request object for the listClusterDiagnosticDataJobs method.
      x-form-factors: public
      required:
      - clusterId
      properties:
        clusterId:
          type: string
          description: ID of the Cluster.
        status:
          description: Filter for job status, only those jobs will be returned which have the given status.
          $ref: '#/components/schemas/DiagnosticDataJobStatus'
        pageSize:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          x-paging-page-size: true
          description: The size of each page.
        startingToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
          x-paging-input-token: true
    DescribeConfigRequest:
      type: object
      description: Request object for the describeConfig method.
      required:
      - clusterId
      - configId
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        configId:
          type: string
          description: ID of the service (Database Catalog or Virtual Warehouse).
    DescribeDbcDiagnosticDataJobResponse:
      type: object
      description: Response object for the describeDbcDiagnosticDataJobRequest method.
      x-form-factors: public
      properties:
        job:
          description: The job belonging to the particular Database Catalog
          $ref: '#/components/schemas/DbcDiagnosticDataJob'
    DescribeDbcConfigResponse:
      type: object
      description: Response object for the describeDbcConfig method.
      properties:
        config:
          description: The Database Catalog configuration.
          $ref: '#/components/schemas/ServiceConfigResp'
    CreateDbcDiagnosticDataJobResponse:
      type: object
      description: Response object for the createDbcDiagnosticDataJob method.
      x-form-factors: public
      properties:
        id:
          type: string
          description: Identifier for each bundle collection.
        status:
          type: string
          description: Status of the diagnostics collection request.
        url:
          type: string
          description: This URL points to a download location if the destination is DOWNLOAD.
        labels:
          type: object
          description: Additional key-value pair attributes associated with the Diagnostic Data Job.
          additionalProperties:
            type: string
    GetUpgradeDbcVersionsRequest:
      type: object
      description: Request object for the getUpgradeDbcVersions method.
      required:
      - clusterId
      - dbcId
      properties:
        clusterId:
          type: string
          description: The ID of the Database Catalog's cluster.
        dbcId:
          type: string
          description: The ID of the Database Catalog.
    GetUpgradeDbcVersionsResponse:
      type: object
      description: Response object for the getUpgradeDbcVersions method.
      properties:
        latestVersion:
          type: string
          description: The latest available CDW version.
        compatibleVersion:
          type: string
          description: The latest compatible CDW version.
        latestCDPVersion:
          type: string
          description: The latest available CDP version.
        compatibleCDPVersion:
          type: string
          description: The latest compatible CDP version.
    CreateVwRequest:
      type: object
      description: Request object for the createVw method.
      required:
      - clusterId
      - dbcId
      - vwType
      - name
      properties:
        clusterId:
          type: string
          description: ID of cluster where Virtual Warehouse should be created.
        dbcId:
          type: string
          description: ID of Database Catalog that the Virtual Warehouse should be attached to.
        vwType:
          description: Type of Virtual Warehouse to be created.
          $ref: '#/components/schemas/VwType'
        name:
          type: string
          description: Name of the Virtual Warehouse.
        instanceType:
          x-form-factors: public
          type: string
          description: Instance type for this Virtual Warehouse. To learn what instance types are allowed to be used for a Hive or an Impala Virtual Warehouse, please use the 'describe-allowed-instance-types' command. The command output will list the usable instance types in its 'hive' and 'impala' fields accordingly.
        imageVersion:
          type: string
          description: version of the Virtual Warehouse.
          default: ''
          x-form-factors: public
        tShirtSize:
          type: string
          description: Name of T-shirt size to use, which will determine the number of nodes.
          enum:
          - xsmall
          - small
          - medium
          - large
          - waa
        nodeCount:
          type: integer
          format: int32
          default: 0
          description: Nodes per compute cluster. If specified, forces 'template' to be 'custom'
        availabilityZone:
          type: string
          description: This feature works only for AWS cluster type. An availability zone to host compute instances. If not specified, defaults to a randomly selected availability zone inferred from available subnets. In order to query possible options, see "availabilityZones" field of describe-cluster or list-clusters command response.
        impalaOptions:
          description: Impala specific options. It cannot be provided for Virtual Warehouse types other than Impala.
          $ref: '#/components/schemas/ImpalaOptionsCreateRequest'
        impalaHaSettings:
          description: High Availability settings for the Impala Virtual Warehouse. NOTE that in --autoscaling object you should avoid using the same deprecated properties because only the --impala-ha-setting properties will be considered if any of its values are set.
          $ref: '#/components/schemas/ImpalaHASettingsCreateRequest'
        autoscaling:
          description: Autoscaling settings for the Virtual Warehouse.
          $ref: '#/components/schemas/AutoscalingOptionsCreateRequest'
        config:
          description: Configuration settings for the Virtual Warehouse.
          $ref: '#/components/schemas/ServiceConfigReq'
        queryIsolationOptions:
          description: Query isolation settings for the Virtual Warehouse. For Impala this value will be considered only if Unified Analytics is enabled.
          $ref: '#/components/schemas/QueryIsolationOptionsRequest'
        tags:
          type: array
          description: Tags associated with the resources.
          items:
            $ref: '#/components/schemas/TagRequest'
        resourcePool:
          type: string
          description: The Resource Pool of the Virtual Warehouse.
          x-form-factors: private
        additionalQuota:
          x-form-factors: private
          $ref: '#/components/schemas/QuotaRequest'
          description: Setting the quota for the 3rd party services injected into the Virtual Warehouse namespace.
        hiveAuthenticationMode:
          type:
          - string
          - 'null'
          x-deprecated: true
          x-form-factors: private
          description: 'DEPRECATED - Sets the authentication mode to use by Hive Server: * `LDAP` * `KERBEROS` Default: `LDAP` if not specified'
        platformJwtAuth:
          type: boolean
          default: false
          description: Value of 'true' automatically configures the Virtual Warehouse to support JWTs issues by the CDP JWT token provider.  Value of 'false' does not enable JWT auth on the Virtual Warehouse.  If this field is not specified, it defaults to 'false'.
        impalaQueryLog:
          type: boolean
          x-form-factors: public
          description: Denotes whether the Virtual Warehouse has the Impala Query Log enabled or not.
        logHiveQueries:
          x-form-factors: private
          type:
          - boolean
          - 'null'
          description: Denotes whether the Hive Virtual Warehouse stores Hive query information for all completed queries in the sys.query_history system table. You can query this table using SQL to monitor and optimize the Hive engine.
        ebsLLAPSpillGB:
          type: integer
          format: int32
          description: Provides EBS gp3 volume as temporary storage space for Hive LLAP cache, and improves query performance. Configurable only at Virtual Warehouse creation. Using EBS volumes incurs additional costs.
        hiveServerHaMode:
          type:
          - string
          - 'null'
          x-form-factors: private
          description: 'Set Hive Server High Availability mode in Private Cloud: * `DISABLED` (default) - Disables Hive Server high availability. * `ACTIVE_PASSIVE` - Runs two Hive Server instances, one active and one passive. Hive session failover is not supported in this setup.'
    DeleteDbcDiagnosticDataJobRequest:
      type: object
      description: Request object for the deleteDbcDiagnosticDataJobRequest method.
      x-form-factors: public
      required:
      - clusterId
      - dbcId
      - jobId
      properties:
        clusterId:
          type: string
          description: ID of cluster.
        dbcId:
          type: string
          description: ID of the Database Catalog.
        jobId:
          type: string
          description: ID of the diagnostic job.
    RenewCertificatesResponse:
      type: object
      description: Response object for the renewCertificates method.
    ApplicationConfigResp:
      type: object
      description: Configurations for an application inside a service.
      properties:
        configBlocks:
          type: array
          description: List of ConfigBlocks for the application.
          items:
            $ref: '#/components/schemas/ConfigBlockResp'
    DataVisualizationSummary:
      type: object
      description: A Cloudera Data Visualization.
      properties:
        id:
          type: string
          description: The ID of the Cloudera Data Visualization.
        name:
          type: string
          description: The name of the Cloudera Data Visualization.
        status:
          type: string
          description: 'Status of the Cloudera Data Visualization. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error.'
        imageVersion:
          type: string
          description: Current image version of the Cloudera Data Visualization
        creatorCrn:
          type: string
          description: The CRN of the user who created the Cloudera Data Visualization
        size:
          type: string
          description: The template size for the Cloudera Data Visualization
        resourcePool:
          type: string
          description: The name of the Resource Pool the Cloudera Data Visualization is in.
          x-form-factors: private
        userGroups:
          type: array
          items:
            type: string
          description: User groups that are allowed to access the Data Visualization.
        adminGroups:
          type: array
          items:
            type: string
          description: Admin groups that are allowed to access the Data Visualization.
    CreateAwsClusterRequest:
      type: object
      description: Request object for the createAwsCluster method.
      required:
      - environmentCrn
      properties:
        environmentCrn:
          type: string
          description: The CRN of the environment for the cluster to create.
        useOverlayNetwork:
          type: boolean
          description: Using an overlay network will save IP addresses in the VPC by using a private IP address range for Pods in the cluster.
        databaseBackupRetentionPeriod:
          type: integer
          format: int32
          default: 30
          description: PostgreSQL server backup retention days.
        whitelistK8sClusterAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for kubernetes cluster access.
        whitelistWorkloadAccessIpCIDRs:
          type: array
          items:
            type: string
          description: List of IP address CIDRs to whitelist for workload access.
        usePrivateLoadBalancer:
          type: boolean
          description: Set up load balancer with private IP address. In AWS it is created in private subnets. In Azure an internal load balancer gets created. Make sure there is connectivity between your client network and the network (VPC/VNet) where CDW environment is deployed.
        usePublicWorkerNode:
          type: boolean
          description: Set up worker node with public IP address. In AWS it is created in public subnets.
        enablePrivateEKS:
          type: boolean
          description: Use this option to set up AWS EKS cluster in private only mode with restricted access only from internal/peered networks. Ensure you have ccmv2 setup functional to achieve this integration.
          default: false
        customRegistryOptions:
          description: Options for custom ACR/ECR registries.
          $ref: '#/components/schemas/CustomRegistryOptions'
        customSubdomain:
          type: string
          description: Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME.
        workerSubnetIds:
          type: array
          description: IDs of AWS subnets where the cluster worker nodes should be deployed.
          items:
            type: string
        lbSubnetIds:
          type: array
          description: IDs of AWS subnets where the cluster load balancer should be deployed.
          items:
            type: string
        customAmiId:
          type: string
          description: Custom AMI ID.
        nodeRoleCDWManagedPolicyArn:
          type: string
          description: Managed Policy Arn to be attached to the Node Instance Role.
        enableSpotInstances:
          type: boolean
          description: Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. Defaults to false.
          default: false
        reducedPermissionMode:
          type: boolean
          description: Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role.
        nonTransparentProxy:
          description: 'Non-transparent proxy settings. Read more: https://docs.cloudera.com/data-warehouse/cloud/aws-environments/topics/dw-aws-use-non-transparent-proxy.html'
          $ref: '#/components/schemas/CreateAwsClusterNonTransparentProxyRequest'
    RegisterSecretRequest:
      type: object
      description: Request object for creating secret.
      properties:
        secretName:
          type: string
          description: Name of the secret.
        clusterId:
          type: string
          description: The ID of the cluster.
        secretProviderKey:
          type: string
          description: Key of the Secret Provider.
        azureVaultName:
          type: string
          description: Name of the Azure vault.
    CreateSecretRequest:
      x-form-factors: private
      type: object
      description: Request object for creating secret.
      properties:
        clusterId:
          type: string
          description: The ID of the cluster.
        secretName:
          type: string
          description: Name of the secret.
        secretValue:
          x-sensitive: true
          type: string
          description: Value of the secret.
    ClusterDiagnosticDataJob:
      type: object
      description: Represents a Diagnostic Data Job.
      x-form-factors: public
      properties:
        jobId:
          type: string
          description: The unique identifier of the Diagnostic Data Job.
        startTime:
          type: string
          format: date-time
          description: The start time of the Diagnostic Data Job.
        endTime:
          type: string
          format: date-time
          description: The finish time of the Diagnostic Data Job.
        url:
          type: string
          description: This URL points to a download location if the destination is DOWNLOAD.
        status:
          description: The job status.
          $ref: '#/components/schemas/DiagnosticDataJobStatus'
        labels:
          type: object
          description: Additional key-value pair attributes associated with the Diagnostic Data Job.
          additionalProperties:
            type: string
x-endpoint-name: dw
x-products: CDP
x-form-factors: public,private
x-cdp-releases: PUBLIC
x-audit: true