Catalog Config
Data Classification configuration for a Unity Catalog catalog. This message follows the "At Most One Resource" pattern: at most one CatalogConfig exists per catalog.
- Full CRUD operations are supported: Create enables Data Classification, Delete disables it
- It has no unique identifier of its own and uses its parent catalog's identifier (catalog_name)
CatalogConfig object
Data Classification configuration for a Unity Catalog catalog. This message follows the "At Most One Resource" pattern: at most one CatalogConfig exists per catalog.
- Full CRUD operations are supported: Create enables Data Classification, Delete disables it
- It has no unique identifier of its own and uses its parent catalog's identifier (catalog_name)
- namestringIDImmutable
Resource name in the format: catalogs/{catalog_name}/config.
- included_schemasobject
Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Schemas created later are not scanned until you add them to the list. Mutually exclusive with
excluded_schemas: only one may be set per request. If neitherincluded_schemasnorexcluded_schemasis set, all schemas are scanned.Show child attributesHide child attributes
- namesarray of string
Schema names, each relative to the parent catalog. Must not be empty.
- excluded_schemasobject
Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned, including schemas created later. Mutually exclusive with
included_schemas: only one may be set per request. If neitherincluded_schemasnorexcluded_schemasis set, all schemas are scanned.Show child attributesHide child attributes
- namesarray of string
Schema names, each relative to the parent catalog. Must not be empty.
- auto_tag_configsarray of objectPublic Preview
Auto-tagging configurations that apply to this catalog. Each entry overrides the metastore-level auto-tagging setting for its classification tag; tags without an entry inherit the metastore-level setting.
Show child attributesHide child attributes
- classification_tagstringPublic Preview
The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key. The built-in tags are listed at https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-classification-tags.
- auto_tagging_modestringPublic Preview
Whether auto-tagging is enabled or disabled for this classification tag.
AUTO_TAGGING_DISABLEDAUTO_TAGGING_ENABLED
Get config for a catalog GA
GET
Get the Data Classification configuration for a catalog.
API scopes: dataclassification
Parameters
- namestringRequiredpath
Resource name of the config, in the format catalogs/{catalog_name}/config.
Response
Returns the CatalogConfig object.
Create config for a catalog GA
POST
Create Data Classification configuration for a catalog.
Creates a new config resource, which enables Data Classification for the specified catalog. The catalog must not already have a config. Creating the config starts a scan of the selected schemas and schedules recurring scans.
API scopes: dataclassification
Parameters
- parentstringRequiredpath
Name of the catalog to enable, in the format catalogs/{catalog_name}.
Request body
The configuration to create.
- namestringIDImmutable
Resource name in the format: catalogs/{catalog_name}/config.
- included_schemasobject
Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Schemas created later are not scanned until you add them to the list. Mutually exclusive with
excluded_schemas: only one may be set per request. If neitherincluded_schemasnorexcluded_schemasis set, all schemas are scanned.Show child attributesHide child attributes
- namesarray of stringRequired
Schema names, each relative to the parent catalog. Must not be empty.
- excluded_schemasobject
Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned, including schemas created later. Mutually exclusive with
included_schemas: only one may be set per request. If neitherincluded_schemasnorexcluded_schemasis set, all schemas are scanned.Show child attributesHide child attributes
- namesarray of stringRequired
Schema names, each relative to the parent catalog. Must not be empty.
- auto_tag_configsarray of objectPublic Preview
Auto-tagging configurations that apply to this catalog. Each entry overrides the metastore-level auto-tagging setting for its classification tag; tags without an entry inherit the metastore-level setting.
Show child attributesHide child attributes
- classification_tagstringRequiredPublic Preview
The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key. The built-in tags are listed at https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-classification-tags.
- auto_tagging_modestringRequiredPublic Preview
Whether auto-tagging is enabled or disabled for this classification tag.
AUTO_TAGGING_DISABLEDAUTO_TAGGING_ENABLED
Response
Returns the CatalogConfig object.
Update config for a catalog GA
PATCH
Update the Data Classification configuration for a catalog.
The config must already exist for the catalog. Only the fields named in update_mask
change; the other fields keep their current values.
API scopes: dataclassification
Parameters
- namestringRequiredIDImmutablepath
Resource name in the format: catalogs/{catalog_name}/config.
- update_maskstringRequiredquery
Comma-separated list of the fields of catalog_config to update, for example
included_schemasorauto_tag_configs.
Request body
The configuration to apply to the catalog. The name field in catalog_config identifies which resource to update.
- included_schemasobject
Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Schemas created later are not scanned until you add them to the list. Mutually exclusive with
excluded_schemas: only one may be set per request. If neitherincluded_schemasnorexcluded_schemasis set, all schemas are scanned.Show child attributesHide child attributes
- namesarray of stringRequired
Schema names, each relative to the parent catalog. Must not be empty.
- excluded_schemasobject
Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned, including schemas created later. Mutually exclusive with
included_schemas: only one may be set per request. If neitherincluded_schemasnorexcluded_schemasis set, all schemas are scanned.Show child attributesHide child attributes
- namesarray of stringRequired
Schema names, each relative to the parent catalog. Must not be empty.
- auto_tag_configsarray of objectPublic Preview
Auto-tagging configurations that apply to this catalog. Each entry overrides the metastore-level auto-tagging setting for its classification tag; tags without an entry inherit the metastore-level setting.
Show child attributesHide child attributes
- classification_tagstringRequiredPublic Preview
The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key. The built-in tags are listed at https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-classification-tags.
- auto_tagging_modestringRequiredPublic Preview
Whether auto-tagging is enabled or disabled for this classification tag.
AUTO_TAGGING_DISABLEDAUTO_TAGGING_ENABLED
Response
Returns the CatalogConfig object.
Delete config for a catalog GA
DELETE
Delete Data Classification configuration for a catalog.
Deleting the config disables Data Classification for the catalog and stops its scheduled scans. Tags that auto-tagging already applied to columns are not removed. Deleting a config that does not exist succeeds.
API scopes: dataclassification
Parameters
- namestringRequiredpath
Resource name of the config, in the format catalogs/{catalog_name}/config.