IMPROVEMENTS:
subscriptionId
and tenantId
parameters no longer required in createAzureCredential
command to support Azure certificate based authorization.unlockUserInControlPlane
, unlockMachineUserInControlPlane
, and updateUser
commands.requestWorkflowCancellation
command.IMPROVEMENTS:
totalClusters
and totalPages
parameters to listClusters
response.maximum
parameter for listClusters
command increased from 100 to 500.backupPhase
and backupJobState
parameters to listBackups
command.restorePhase
and restoreJobState
parameters to listRestores
command.instanceType
parameter to modifyClusterInstanceGroup
command.applicationId
and secretKey
parameters no longer required in createAzureCredential
command to support Azure certificate based authorization.securityGroupIDsForKnox
and defaultSecurityGroupIDs
parameters to createAzureEnvironment
and createAWSEnvironment
commands.updateOrchestratorState
command.updateOrchestratorState
command.IMPROVEMENTS:
skipValidation
and validationOnly
parameters to backupDatalake
and restoreDatalake
commands.listItems
command is now listBackupEntities
.describeServerSetting
and updateServerSetting
commands.skipRangerHmsMetadata
, skipAtlasMetadata
, and skipRangerAudits
parameters to upgradeDatalake
command.IMPROVEMENTS:
start-cluster-vertical-scaling
command.start-datalake-vertical-scaling
command.create-backup
, restore-backup
, delete-backup
, describe-backup
, describe-restore
, list-backups
and list-restores
commands.describe-allowed-instance-types
, list-dbc-events
and list-vw-events
commands.computeInstanceTypes
and additionalInstanceTypes
parameter to create-cluster
command.workloads
, status
, clusterType
, creationTime
, deletionTime
, updateTime
, clusterStateVersion
, clusterOwner
, region
, message
, account
, availableUpgrades
, imageCatalog
, storage
to the list-clusters
command.start-free-ipa-vertical-scaling
command.install-workspace
command.IMPROVEMENTS:
type
parameter to an enum type in create-user-access-key
, create-machine-user-acess-key
, update-access-key
, get-access-key
and list-access-keys
commands.targetVersion
is no longer required for start-database-upgrade
command.precheckStoragePermission
and rangerAuditCollectionValidation
parameters to backup-datalake
and restore-datalake
commands.enableUDR
parameter in create-cluster
and cluster-summary
commands.resume-workspace
and suspend-workspace
commands.deleteInstanceGroup
command.skipValidation
and subnetsForLoadBalancers
parameters to create-workspace
command.upgradeState
, nfsVersion
and isPrivate
parameters to describe-workspace
and list-workspaces
commands.subnets
, subnetsForLoadBalancers
and clusterID
parameters to describe-workspace
command.IMPROVEMENTS:
rotate-salt-password
command to rotate SaltStack user password on FreeIPA instances.rotate-salt-password
command to rotate SaltStack user password on DataLake instances.rotate-salt-password
command to rotate SaltStack user password on Data Hub instances.IMPROVEMENTS:
renew-certificates
operation for Inbound Connection Endpoints.restoreJobTimeoutMinutes
parameter to restore-workspace
command.backupJobTimeoutMinutes
and skipValidation
parameters to backup-workspace
command.start-database-upgrade
command to upgrade the database of the Data Hub cluster.start-database-upgrade
command to upgrade the database of the Data Lake cluster.BACKWARD INCOMPATIBILITIES:
delete-inbound-connection-endpoint
and describe-inbound-connection-endpoint
commands.IMPROVEMENTS:
describe-deployment
command to get details of a deployment in the cluster.list-clusters
command to list the clusters of an environment.upgrade-deployment
command to upgrade a deployment in the cluster.databaseBackupRetentionPeriod
parameter to create-cluster
command.customRegistryOptions
parameter to create-cluster
command.customId
parameter to create-cluster
command.customSubdomain
parameter to create-cluster
command.nodeRoleCDWManagedPolicyArn
property in awsOptions
parameter of create-cluster
command.enableSpotInstances
property in awsOptions
parameter of create-cluster
command.enableSpotInstances
property as a response to describe-cluster
/list-clusters
commands.reducedPermissionMode
property in awsOptions
parameter of create-cluster
command and also in the response of describe-cluster
/list-clusters
commands.nodeCount
parameter to create-vw
command.queryIsolationOptions
parameter to create-vw
command.logAnalyticsWorkspaceId
as property of azureOptions
in response to describe-cluster
/list-clusters
commands.name
property as a response to describe-cluster
/list-clusters
commands.configId
property as a response to describe-vw
/list-vws
commands.cdhVersion
property as a response to describe-vw
/list-vws
commands.endpoints
property as a response to describe-vw
/list-vws
commands. Its sub-properties are hiveJdbc
, impalaJdbc
, impalaFENGJdbc
, impalaShell
, hue
, das
.update-aws-disk-encryption-parameters
command to update the AWS encryption key ARN for an environment.IMPROVEMENTS:
prepare-cluster-upgrade
.prepare-datalake-upgrade
.backupLocation
parameter required in backup-datalake
command.UNASSIGNED
, ASSIGNED
, PROVISIONING_CERTIFICATES
, RENEWING_CERTIFICATES
, READY
and FAILED
to state
parameter enum to create-inbound-connection-endpoint
, describe-inbound-connection-endpoint
and describe-inbound-connection-endpoint
.IMPROVEMENTS:
storageAccountName
, resourceGroup
and azureFilesFQDN
parameters to enable-service
command.IMPROVEMENTS:
backup-workspace
, delete-backup
, list-workspace-backups
, restore-workspace
and migrate-cdsw-workspace
commands.enableStorageRoles
and outboundType
parameter to create-cluster
command.customEcrRepository
parameter from create-cluster
command.enableUDR
parameter in create-cluster
command.environmentCrn
, clusterId
, name
, status
and cloudPlatform
parameters to list-clusters
command.disableAutoSuspend
, autoSuspendTimeoutSecond
, enableUnifiedAnalytics
, hiveScaleWaitTimeSeconds
, hiveDesiredFreeCapacity
, impalaHighAvailabilityMode
, impalaScaleUpDelaySeconds
, impalaScaleDownDelaySeconds
, impalaEnableShutdownOfCoordinator
, impalaShutdownOfCoordinatorDelaySeconds
, impalaNumOfActiveCoordinators
and podConfigName
parameters to autoscaling-options-create
command.disableAutoSuspend
, autoSuspendTimeoutSecond
, hiveScaleWaitTimeSeconds
, hiveDesiredFreeCapacity
, impalaScaleUpDelaySeconds
, impalaScaleDownDelaySeconds
, impalaShutdownOfCoordinatorDelaySeconds
and impalaNumOfActiveCoordinators
parameters to autoscaling-options-update
command.autoscalingOptions
, queryIsolationOptions
, capacitor
, viz
, autoscalingOptions
and queryIsolationOptions
parameters to list-vws
and describe-vw
commands.dbcId
, compactor
and viz
parameters to list-vws
command.awsOptions
and azureOptions
parameters to describe-cluster
and list-clusters
commands.enableUDR
parameter in describe-cluster
and list-cluster
commands.awsOptions
, azureOptions
and enableStorageRoles
parameters in describe-cluster
and list-cluster
commands.force
parameter to false
in delete-cluster
command.IMPROVEMENTS:
instanceGroupNames
and instances
parameters to renew-certificate
and repair-datalake
commands.download-client-certificate-encoded
, download-client-private-key-encoded
, create-inbound-connection-endpoint
, delete-inbound-connection-endpoint
, describe-inbound-connection-endpoint
and list-inbound-connection-endpoints
commands.STOPPED
, SDX_OTPUT_CHANGED
and METRICS_UNAVAILABLE
status values to cancel-nifi-version-update
, create-deployment
, terminate-deployment
, transition-flow
and update-nifi-version
commands.IMPROVEMENTS:
clusterDefinitionName
, environmentName
and clusterTemplateName
parameters from the create-aws-cluster
command.IMPROVEMENTS
customEcrRepository
attribute in favor of CustomRegistryOptions
.workloadAnalytics
to Environment
definition.downscale-freeipa
and upscale-freeipa
commands to change the number of FreeIPA nodes hence FreeIPA availability type.clouderaSSOAllLoginEnabled
to Account
definition.IMPROVEMENTS:
setPassword
command is deprecated. Use set-workload-password
in iam instead.listClusterLifecycleEvents
command.IMPROVEMENTS:
activeInfoAlertCount
parameter to describe-deployment
, describe-service
, enable-service
, list-deployments
, list-services
and update-service
commands.k8sServerVersion
parameter to describe-service
, enable-service
and update-service
commands.maxClusters
to 10
in create-vw
command.dbDas
and dbHue
parameters to create-cluster
command.create-data-visualization
, get-data-visualization-upgrade
, list-data-visualizations
, delete-data-visualization
, describe-data-visualization
and update-data-visualization
commands.databasePrivateDnsZoneId
parameter to create-aws-gov-cloud-environment
, create-aws-environment
, create-azure-environment
, create-gcp-environment
, create-private-environment
, update-aws-disk-encryption-parameters
, update-azure-encryption-resources
, update-security-access
, update-ssh-key
and update-subnet
commands.generateWorkloadUsernameByEmail
, enableScim
parameters to create-saml-provider
, list-saml-providers
, describe-saml-provider
and update-saml-provider
commands.create-scim-access-token
, list-scim-access-tokens
and delete-scim-access-token
commands.enableScim
and scimUrl
parameters to create-saml-provider
, list-saml-providers
, describe-saml-provider
and update-saml-provider
commands.provider
and imageType
parameters required for find-default-image
command.describe-upgrade-database
and upgrade-database
commands.mapReduceService
and logPath
paramters to create-policy
and create-hbase-policy
commands.sourceClusterCrn
and targetClsterCrn
parameters to list-policies
command.IMPROVEMENTS:
subnetIds
, multiAz
parameters to create-aws-cluster
command.create-
, delete-
, describe-
and list-custom-configurations
commands.multiAz
parameter to create-*-datalake
and list-datalakes
commands.privateClusterEnabled
, publicEndpointEnabled
, workloadAnalyticsEnabled
and ssdUsed
parameters to describe-service
and enable-service
commands.enablePrivateNetwork
parameter to enable-service
command.privateCloudOptions
parameter to create-cluster
command.dbMetastore
, dbDas
and dbHue
parameters to create-dbc
command.multiAz
parameter to create-aws-environment
and create-aws-gov-cloud-environment
commands.IMPROVEMENTS:
collect-*-diagnostics
, describe-*
, get-*
, list-*
, summarize-*
and validate-*
commands as non-mutating.certificate
parameter in list-agents
, register-agent
and rotate-agent-access-key
commands.create-resource-pool
, delete-resource-pool
and update-resource-pool
commands.renew-certificate
and rotate-auto-tls-certificates
commands.operationStates
, runtimeVersion
parameter to backup-datalake
, backup-datalake-status
, restore-datalake
and restore-datalake-status
commands.renew-certificate
, start-datalake
, stop-datalake
, rotate-auto-tls-certificates
commands.resize-datalake
command.awsOptions
and azureOptions
public parameters to create-cluster
command.id
, format
and content
mandatory in config.{commonConfigs|applicationConfigs}.configBlocks
for create-vw-request
and update-vw
commands.privateCloudOptions
for activate-environment-by-crn
command.workloadPasswordDetails
parameter to create-machine-user
and list-machine-users
command.fetch-database-metrics
command as non-mutating.test-enum-deserialization
and download-file
commands as non-mutating.describe-warehouse
and list-warehouses-for-env
commands.IMPROVEMENTS:
create-aws-gov-cloud-data-lake
command to create a data lake on AWS cloud.loadbalancerAllowlist
parameter to describe-service
and enable-service
commands.get-upgrade-vw-versions
and list-latest-versions
command to list product versions.add-user
, delete-user
and list-users
commands to manage users.renew-certificates
, update-cluster
and health-check
commands to manage CDW warehouses.start-vw
, pause-vw
, restart-vw
and upgrade-vw
commands to manage virtual warehouses.restart-dbc
, get-upgrade-dbc-versions
and upgrade-dbc
commands to manage database catalogs.enableSpotInstances
, enableUDR
, enablePrivateSQL
, privateDNSZoneAKS
, enablePrivateAks
, and enableUptimeSLA
parameters to create-cluster
command.update-ssh-key
available in the public form factor.check-database-connectivity
command for private form factor.create-aws-gov-cloud-environment
command to create an AWS GovCloud environment. FreeIPA server will be automatically provisioned.create-aws-gov-cloud-credential
command to create an AWS credential for GovCloud.govCloud
parameter to commands set-azure-audit-credential
, set-aws-audit-credential
, list-audit-credentials
, create-azure-credential
, create-gcp-credential
, create-aws-credential
.IMPROVEMENTS:
sync-component-versions-from-cm
command.enableLoadBalancer
parameter to create-aws-cluster
and create-azure-cluster
commands.includeNginxReport
and includeSarOutput
parameters in collect-datahub-diagnostics
command.renew-public-certificate
and rotate-private-certificates
commands, which supersede now deprecated renew-certificate
and rotate-auto-tls-certificates
commands.includeNginxReport
and includeSarOutput
parameters to collect-datalake-diagnostics
command.skipRangerHmsMetadata
, skipAtlasMetadata
, and skipRangerAudits
parameters to backup-datalake
and restore-datalake
commands.recipes
parameter to create-aws-datalake
, create-gcp-datalake
, and create-azure-datalake
commands.includeDatabase
of the restore-datalake
command.operationId
field of the update-service
command response.modify-cluster-security
, modify-cluster-instance-group
and modify-workspace-load-balancer
commands.useLegacyHelm2
parameter from create-workspace
and restore-workspace
commands.IMPROVEMENTS:
encryptionKeyArn
parameter to create-aws-environment
command.encryptionKey
parameter to create-gcp-environment
command.update-azure-encryption-resources
command.replace-recipes
command for datalake clusters.skipBackup
parameter to upgrade-datalake
command.IMPROVEMENTS:
recover-datalake
to recover datalake to the original version after a failed upgrade.smtpConfig
parameter to create-vc
command to specify SMTP configurations during virtual cluster creation.IMPROVEMENTS:
set-workload-password-policy
, unset-workload-password-policy
and unset-workload-password-min-lifetime
to configure workload password complexity policies. The existing workload password complexity configurations can be viewed by the get-account
command.filteredInvalidGroups
property to audit InteraciveLoginEvent
. The field represents a list of invalid groups that were filtered during the IdP initiated interactive login event.list-events
command.IMPROVEMENTS:
set-catalog
command.set-catalog
command.set-catalog
command.create-service-endpoints
parameter to create-aws-environment
command.sync-component-versions-from-cm
command to sync component versions from CM after a failed upgrade.update-service
command to update Cloudera Data Engineering (CDE) Service.generate-workload-auth-token
command for Private Cloud form factor.IMPROVEMENTS:
enable-ranger-raz
parameter to create-aws-datalake
, create-azure-datalake
command and the response of describe-datalake
command.BACKWARD INCOMPATIBILITIES:
cloud-provider-configuration
parameter required for create-gcp-datalake
command. This matches what we expect for similar APIs for AWS and Azure.IMPROVEMENTS:
UNREACHABLE
, NODE_FAILURE
, RECOVERY_IN_PROGRESS
, RECOVERY_REQUESTED
and RECOVERY_FAILED
.subnets
parameter of enable-service
command.encryption-key-url
and encryption-key-resource-group-name
to create-azure-environment
command.replace-recipes
to replace recipes for the given instance groups.batch-events-for-archiving
, get-batch-events-for-archiving-status
, list-events-in-archive-batch
, list-outstanding-archive-batches
and mark-archive-batches-as-successful
to support pull-based archiving.IMPROVEMENTS:
path
parameter optional when creating Hive replications.backup-id
parameter required when the backup-location-override
parameter is used in restore-datalake
command.IMPROVEMENTS:
upgrade-cluster
command to upgrade the OS or data platform on a datahub cluster.free-ipa
parameter to create-gcp-environment
command for GCP FreeIPA HA.IMPROVEMENTS:
check-environment-connectivity
and check-kubernetes-connectivity
commands for checking connectivity for Private Cloud environments.IMPROVEMENTS:
create-private-subnets
parameter for create-aws-environment
command.IMPROVEMENTS:
generate-workload-auth-token
command to generate an access token which is required for sending requests to workload APIs.IMPROVEMENTS:
isDefault
, tenantStorageRole
and tenantStorageLocation
in create-dbc
command.IMPROVEMENTS:
whitelistAuthorizedIPRanges
and authorizedIPRanges
in create-workspace
command.create-private-environment
, get-environment-setting
and set-environment-setting
command to Private Cloud.IMPROVEMENTS:
customEcrRepository
, customAmiId
in AwsActivationOptions.vmGenerationType
, logAnalyticsWorkspaceId
and dockerBridgeCidr
in AzureActivationOptions.instanceGroupName
as optional.IMPROVEMENTS:
GetClusterServiceStatus
and GetClusterHostStatus
FEATURES:
imageVersion
parameter for CreateVwRequest
and CreateDbcRequest
.FEATURES:
FEATURES:
FEATURES:
healthInfoLists
property in 0.9.38.BACKWARD INCOMPATIBILITIES:
healthInfoLists
property is renamed to healthInfos
in listWorkspaces
command response.FEATURES:
noProxyHosts
parameter for ProxyConfig and Environment related commands.datacatalog
command, users can execute operations such as launching profilers in DataCatalog.FEATURES:
removeDeleted
parameter for listServices
command.skipValidation
parameter for enableService
command.StatusType
enumeration.deleteAuditCredential
command.BACKWARD INCOMPATIBILITIES:
setWorkloadPasswordPolicy
operation is removed, with no replacement at this time.FEATURES:
updateSshKey
for updating the SSH key of a cluster.FEATURES:
getArchivingStatus
and listRecentArchiveRuns
commands.IMPROVEMENTS:
archiveAuditEvents
command is now asynchronous and returns a new taskId
field that can be used to track status.NOTES:
ArchiveBatch
object now explicitly defines a negative event count as meaning that the count is not available.FEATURES:
backupStorageLocationBase
; new field in environments: backupStorage
with provider-specific details.IMPROVEMENTS:
tags
field in CreateVwRequest
allows for specifying tags for resources.describeKubeconfig
operation for clusters returns a kubeconfig with full access to the cluster.DatalakeDetails
: cloudStorageBaseLocation
.NOTES:
ArchiveAuditEventsBatchResponse
is renamed to ArchiveBatch
. This should not affect client usage, and older client code may continue to use the prior name.FEATURES:
UpdateDatalakeRequest
: imageId
, runtime
, lockComponents
, dryRun
, showAvailableImages
, showLatestAvailableImagePerRuntime
.UpdateDatalakeResponse
: current
, upgradeCandidates
, reason
.CreateAWSDatalakeRequest
, CreateAzureDatalakeRequest
, and CreateGCPDatalakeRequest
: image
.IMPROVEMENTS:
rootVolumeSize
field in InstanceGroupRequest
is now optional.FEATURES:
NOTES:
BUG FIXES:
BACKWARD INCOMPATIBILITIES:
provisionerid
field in EnableServiceRequest
has been removed, as it was never supported. There is no replacement.IMPROVEMENTS:
RestoreDatalakeRequest
: backupLocationOverride
.NOTES:
FEATURES:
createGCPEnvironment
and createGCPCredential
createGCPCluster
andcreateGCPCluster
andFEATURES:
listDatahubDiagnostics
and cancelDatahubDiagnostics
commands, also added excludeHosts
and skipUnresponsiveHosts
parameters to collectDatahubDiagnostics
command.listDatalakeDiagnostics
and cancelDatalakeDiagnostics
commands, also added excludeHosts
and skipUnresponsiveHosts
parameters to collectDatalakeDiagnostics
command.listFreeipaDiagnostics
and cancelFreeipaDiagnostics
commands, also added excludeHosts
and skipUnresponsiveHosts
parameters to collectFreeipaDiagnostics
command.CreateAWSEnvironmentRequest
: endpointAccessGatewayScheme
and endpointAccessGatewaySubnetIds
. The same fields are also added to the Network
object.CreateWorkspaceRequest
: enableGovernance
, enableModelMetrics
.IMPROVEMENTS:
CreateClusterRequest
: usePrivateLoadBalancer
. All-private VPC cluster creation is now possible.FEATURES:
EnableServiceRequest
: tags
.CreateVcRequest
: runtimeSpotComponent
.deleteUser
operation no longer requires an entitlement.IMPROVEMENTS:
DatalakeDetails
, part of DescribeDatalakeResponse
: shape
.NOTES:
FEATURES:
collectCmDiagnostics
, getCmRoles
.collectCmDiagnostics
, getCmRoles
.IMPROVEMENTS:
NOTES:
FEATURES:
IMPROVEMENTS:
BACKWARD INCOMPATIBILITIES:
getAccount
endpoint is no longer associated with a right. This allows any user to call the endpoint, including those with no roles / rights.IMPROVEMENTS:
StartEnvironmentRequest
: withDatahubStart
.samlMetadataDocument
field in CreateSamlProviderRequest
is now optional, allowing creation of a SAML provider without providing any metadata.NOTES:
IMPROVEMENTS:
FEATURES:
renewCertificate
operationrenewCertificate
operationBACKWARD INCOMPATIBILITIES
clusterID
field of DescribeClusterRequest
required; the operation would not work without it previouslyIMPROVEMENTS:
ListVwsRequest
objectautoSuspendTimeoutSeconds
, enableHA
, disableAutoSuspend
, triggerScaleUpDelaySeconds
triggerScaleDownDelaySeconds
properties to AutoscalingOptions
objectenableFeng
, installViz
properties to CreateVwRequest
objectgetEnvironmentUserSyncState
operationFEATURES:
createAuditScaleRules
, updateAutoScaleRules
, describeAutoScaleRules
, deleteAuditScaleRules
, listAutoScaleHistory
createPrivateEndpoints
option to environment creation requestsreportDeploymentLogs
option to environment creation requestsNOTES:
NOTES:
listAccessKeys
has increased from 100 to 500.listUsers
has increased from 100 to 500.FEATURES:
collectFreeipaDiagnostics
, getFreeipaLogDescriptors
.collectDatalakeDiagnostics
, getDatalakeLogDecriptors
, rotateAutoTlsCertificates
collectDatahubDiagnostics
, getDatahubLogDecriptors
, rotateAutoTlsCertificates
FEATURES:
getKubeConfig
, listWorkspaceAccess
.IMPROVEMENTS:
Instance
objects: privateIp
and publicIp
.Instance
objects: privateIp
and publicIp
.Credential
objects: awsCredentialProperties
and azureCredentialProperties
.setWorkloadPassword
operation: actorCrn
. This enables setting a workload password for a user other than the caller.BACKWARD INCOMPATIBILITIES:
startDatalake
is deprecated and no longer works. Use environments.startEnvironment
instead.stopDatalake
is deprecated and no longer works. Use environments.stopEnvironment
instead.scale
parameter for createAWSDatalake
and createAzureDatalake
has changed type from a string to an enum.NOTES:
FEATURES:
getRepairFreeipaStatus
.getAuditCredentialPrerequisites
, listAuditCredentials
, setAWSAuditCredential
, setAzureAuditCredential
.