RegisteredDataset

pydantic model openapi_client.models.registered_dataset.RegisteredDataset

Dataset metadata. In list responses (GET /datasets) only the fields in the projectionExpression are returned. In detail responses (GET /datasets/{id}) all stored fields plus computed fields (IsOwner, DatasetS3Path, ConnectionDetails, Schedules, etc.) are returned.

Fields:

• access_type (str | None)

• are_ai_services_enabled (bool | None)

• assume_role (str | None)

• column_table_constraints (Dict[str, Any] | None)

• connection_details (openapi_client.models.connection_details.ConnectionDetails | None)

• created_by (str | None)

• creation_date (str | None)

• current_version (str | None)

• data_category (str | None)

• data_category_config (openapi_client.models.registered_dataset_data_category_config.RegisteredDatasetDataCategoryConfig | None)

• data_classification (List[str] | None)

• data_metrics_collection_options (openapi_client.models.data_metrics_collection_options.DataMetricsCollectionOptions | None)

• data_permissions (List[openapi_client.models.registered_dataset_data_permissions_inner.RegisteredDatasetDataPermissionsInner] | None)

• data_profile (openapi_client.models.registered_dataset_data_profile.RegisteredDatasetDataProfile | None)

• data_source_id (str | None)

• data_stewards (List[str] | None)

• database_host (str | None)

• database_name (str | None)

• database_port (str | None)

• database_table_name (str | None)

• database_view_name (str | None)

• dataset_description (str | None)

• dataset_id (str | None)

• dataset_key_options (openapi_client.models.registered_dataset_dataset_key_options.RegisteredDatasetDatasetKeyOptions | None)

• dataset_name (str | None)

• dataset_report (openapi_client.models.registered_dataset_dataset_report.RegisteredDatasetDatasetReport | None)

• dataset_s3_path (str | None)

• dataset_schema (List[openapi_client.models.column_name_and_type.ColumnNameAndType] | None)

• dataset_status (str | None)

• dataset_type (str | None)

• datasource_id (str | None)

• datasource_name (str | None)

• datasource_type (str | None)

• display_name (str | None)

• domain (str | None)

• domain_display_name (str | None)

• dwh_table_name (str | None)

• dynamodb_table_name (str | None)

• eda_message (str | None)

• eda_staleness (str | None)

• eda_staleness_message (str | None)

• eda_status (str | None)

• error_message (str | None)

• file_delimiter (str | None)

• file_type (str | None)

• hudi_table_options (openapi_client.models.registered_dataset_hudi_table_options.RegisteredDatasetHudiTableOptions | None)

• iceberg_table_options (openapi_client.models.registered_dataset_iceberg_table_options.RegisteredDatasetIcebergTableOptions | None)

• is_active (str | None)

• is_auto_ml_enabled (bool | None)

• is_bda_extraction_enabled (bool | None)

• is_data_cleanup_enabled (bool | None)

• is_data_profiling_enabled (bool | None)

• is_data_validation_enabled (bool | None)

• is_delta_lake_table (bool | None)

• is_owner (bool | None)

• is_translate_ai_results_enabled (bool | None)

• jdbc_connection_string (str | None)

• keywords (List[str] | None)

• kms_policy (Dict[str, Any] | None)

• last_modified (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• last_refresh_completion_time (str | None)

• malware_detection_options (openapi_client.models.malware_detection_options.MalwareDetectionOptions | None)

• odbc_connection_string (str | None)

• partitioned (str | None)

• raw_description (str | None)

• read_only_file_level (bool | None)

• refresh_status (str | None)

• registration_status (str | None)

• resource_origin (str | None)

• s3_athena_table_name (str | None)

• s3_bucket_policy (Dict[str, Any] | None)

• schedules (List[openapi_client.models.registered_dataset_schedules_inner.RegisteredDatasetSchedulesInner] | None)

• ser_de (str | None)

• serde_properties (Dict[str, str] | None)

• skip_file_header (bool | None)

• skip_lz_process (bool | None)

• skip_trash (bool | None)

• sql_statement (str | None)

• sync_to_s3_options (openapi_client.models.registered_dataset_sync_to_s3_options.RegisteredDatasetSyncToS3Options | None)

• table_properties (Dict[str, str] | None)

• table_update (str | None)

• table_update_column (str | None)

• target_location (str | None)

• target_table_prep_mode (str | None)

• tenant_name (str | None)

• update_schema_status (str | None)

• view_type (str | None)

• view_versions (List[openapi_client.models.registered_dataset_view_versions_inner.RegisteredDatasetViewVersionsInner] | None)

field dataset_id: Optional[StrictStr] = None (alias 'DatasetId')

Unique dataset identifier (UUID).

field dataset_name: Optional[StrictStr] = None (alias 'DatasetName')

Name of the dataset, unique within its domain.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Human-readable display name. Defaults to DatasetName if not explicitly set.

field dataset_description: Optional[StrictStr] = None (alias 'DatasetDescription')

Free-text description of the dataset.

field data_classification: Optional[List[StrictStr]] = None (alias 'DataClassification')

Data classification labels.

field domain: Optional[StrictStr] = None (alias 'Domain')

Domain the dataset belongs to.

field domain_display_name: Optional[StrictStr] = None (alias 'DomainDisplayName')

Human-readable display name of the domain.

field partitioned: Optional[StrictStr] = None (alias 'Partitioned')

Whether the dataset table is partitioned.

field file_type: Optional[StrictStr] = None (alias 'FileType')

Source file format. May be absent for view datasets.

field target_location: Optional[StrictStr] = None (alias 'TargetLocation')

Storage backend (s3, s3athena, redshift, lf, dynamodb).

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Search keywords. May be absent or empty.

field dataset_schema: Optional[List[ColumnNameAndType]] = None (alias 'DatasetSchema')

Column definitions.

field table_update: Optional[StrictStr] = None (alias 'TableUpdate')

Data load mode (append, reload, full-refresh, etc.).

field data_metrics_collection_options: Optional[DataMetricsCollectionOptions] = None (alias 'DataMetricsCollectionOptions')

Metrics collection configuration.

field sync_to_s3_options: Optional[RegisteredDatasetSyncToS3Options] = None (alias 'SyncToS3Options')

field dwh_table_name: Optional[StrictStr] = None (alias 'DWHTableName')

Underlying Redshift/Athena table name.

field last_modified: Optional[StrictStr] = None (alias 'LastModified')

ISO timestamp of last modification.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User ID who last modified the dataset.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

ISO timestamp of last modification.

field error_message: Optional[StrictStr] = None (alias 'ErrorMessage')

Error message from last failed operation.

field table_update_column: Optional[StrictStr] = None (alias 'TableUpdateColumn')

Column used for incremental updates.

field registration_status: Optional[StrictStr] = None (alias 'RegistrationStatus')

Dataset registration state (completed, in-progress, error, etc.).

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User ID who created the dataset.

field creation_date: Optional[StrictStr] = None (alias 'CreationDate')

ISO timestamp of dataset creation.

field is_active: Optional[StrictStr] = None (alias 'IsActive')

Whether the dataset is active (“yes” or “no”).

field is_data_profiling_enabled: Optional[StrictBool] = None (alias 'IsDataProfilingEnabled')

Whether automatic data profiling is enabled.

field is_auto_ml_enabled: Optional[StrictBool] = None (alias 'IsAutoMLEnabled')

Whether AutoML model training is enabled.

field is_bda_extraction_enabled: Optional[StrictBool] = None (alias 'IsBDAExtractionEnabled')

Whether BDA extraction is enabled.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Caller’s access level on this dataset (owner, editor, or read-only).

field is_owner: Optional[StrictBool] = None (alias 'IsOwner')

Whether the caller is an owner.

field file_delimiter: Optional[StrictStr] = None (alias 'FileDelimiter')

Column delimiter for CSV/TSV files.

field skip_file_header: Optional[StrictBool] = None (alias 'SkipFileHeader')

Whether to skip the first row as header.

field connection_details: Optional[ConnectionDetails] = None (alias 'ConnectionDetails')

Redshift connection info. Detail response only; Redshift datasets only.

field schedules: Optional[List[RegisteredDatasetSchedulesInner]] = None (alias 'Schedules')

Schedules attached to this dataset.

field dataset_report: Optional[RegisteredDatasetDatasetReport] = None (alias 'DatasetReport')

field datasource_type: Optional[StrictStr] = None (alias 'DatasourceType')

Origin of data ingestion (api, jdbc, store, etc.).

field is_data_cleanup_enabled: Optional[StrictBool] = None (alias 'IsDataCleanupEnabled')

Whether automatic data cleanup is enabled.

field malware_detection_options: Optional[MalwareDetectionOptions] = None (alias 'MalwareDetectionOptions')

Malware scanning configuration.

field skip_lz_process: Optional[StrictBool] = None (alias 'SkipLZProcess')

Whether to skip Landing Zone processing.

field tenant_name: Optional[StrictStr] = None (alias 'TenantName')

Tenant name for multi-tenant deployments.

field are_ai_services_enabled: Optional[StrictBool] = None (alias 'AreAIServicesEnabled')

Whether AI services are enabled. S3 target only.

field dataset_s3_path: Optional[StrictStr] = None (alias 'DatasetS3Path')

Full S3 path for the dataset.

field dataset_status: Optional[StrictStr] = None (alias 'DatasetStatus')

Current dataset status.

field s3_athena_table_name: Optional[StrictStr] = None (alias 'S3AthenaTableName')

Athena table name.

field data_stewards: Optional[List[StrictStr]] = None (alias 'DataStewards')

User IDs designated as data stewards.

field data_category: Optional[StrictStr] = None (alias 'DataCategory')

Special data category (e.g. “spatial”).

field data_category_config: Optional[RegisteredDatasetDataCategoryConfig] = None (alias 'DataCategoryConfig')

field dataset_type: Optional[StrictStr] = None (alias 'DatasetType')

Dataset category (internal, external, view, materialized-view).

field resource_origin: Optional[StrictStr] = None (alias 'ResourceOrigin')

How the dataset was created (API, AWSConsole, etc.).

field raw_description: Optional[StrictStr] = None (alias 'RawDescription')

AI-generated description. DynamoDB list path only.

field read_only_file_level: Optional[StrictBool] = None (alias 'ReadOnlyFileLevel')

Whether caller has file-level read access. List response only when getFileLevelAccessDatasets=true.

field ser_de: Optional[StrictStr] = None (alias 'SerDe')

Serialization/deserialization library name.

field serde_properties: Optional[Dict[str, StrictStr]] = None (alias 'SerdeProperties')

User-configurable Glue SerDe parameters for s3athena/lf tables.

field table_properties: Optional[Dict[str, StrictStr]] = None (alias 'TableProperties')

Glue table parameters.

field data_source_id: Optional[StrictStr] = None (alias 'DataSourceId')

Deprecated alias for DatasourceId.

field datasource_id: Optional[StrictStr] = None (alias 'DatasourceId')

Datasource identifier if dataset is linked to a datasource.

field datasource_name: Optional[StrictStr] = None (alias 'DatasourceName')

Datasource display name.

field is_data_validation_enabled: Optional[StrictBool] = None (alias 'IsDataValidationEnabled')

Whether schema validation is enabled.

field is_translate_ai_results_enabled: Optional[StrictBool] = None (alias 'IsTranslateAIResultsEnabled')

Whether auto-translation of AI results is enabled.

field assume_role: Optional[StrictStr] = None (alias 'AssumeRole')

IAM role ARN for external dataset access.

field skip_trash: Optional[StrictBool] = None (alias 'SkipTrash')

Whether to permanently delete files. Detail response only; reload datasets only.

field target_table_prep_mode: Optional[StrictStr] = None (alias 'TargetTablePrepMode')

Target table prep mode (truncate or recreate). Detail response only; reload datasets only.

field dataset_key_options: Optional[RegisteredDatasetDatasetKeyOptions] = None (alias 'DatasetKeyOptions')

field column_table_constraints: Optional[Dict[str, Any]] = None (alias 'ColumnTableConstraints')

Column constraints. Redshift target.

field dynamodb_table_name: Optional[StrictStr] = None (alias 'DynamodbTableName')

DynamoDB table name.

field iceberg_table_options: Optional[RegisteredDatasetIcebergTableOptions] = None (alias 'IcebergTableOptions')

field hudi_table_options: Optional[RegisteredDatasetHudiTableOptions] = None (alias 'HudiTableOptions')

field database_host: Optional[StrictStr] = None (alias 'DatabaseHost')

Redshift database host.

field database_port: Optional[StrictStr] = None (alias 'DatabasePort')

Redshift database port.

field database_name: Optional[StrictStr] = None (alias 'DatabaseName')

Redshift database name.

field database_table_name: Optional[StrictStr] = None (alias 'DatabaseTableName')

Source database table name.

field jdbc_connection_string: Optional[StrictStr] = None (alias 'JdbcConnectionString')

JDBC connection string.

field odbc_connection_string: Optional[StrictStr] = None (alias 'OdbcConnectionString')

ODBC connection string.

field database_view_name: Optional[StrictStr] = None (alias 'DatabaseViewName')

Redshift view name.

field current_version: Optional[StrictStr] = None (alias 'CurrentVersion')

Current version ID for view datasets.

field sql_statement: Optional[StrictStr] = None (alias 'SqlStatement')

SQL query for view datasets.

field view_type: Optional[StrictStr] = None (alias 'ViewType')

Type of view (standard or materialized). View datasets only.

field view_versions: Optional[List[RegisteredDatasetViewVersionsInner]] = None (alias 'ViewVersions')

Version history for view datasets.

field is_delta_lake_table: Optional[StrictBool] = None (alias 'IsDeltaLakeTable')

Whether this dataset uses Delta Lake table format. LF-target Delta Lake datasets.

field refresh_status: Optional[StrictStr] = None (alias 'RefreshStatus')

Last refresh status for materialized views. Redshift materialized views only. Omitted when status is N/A.

field last_refresh_completion_time: Optional[StrictStr] = None (alias 'LastRefreshCompletionTime')

ISO timestamp of last completed refresh. Redshift materialized views only. Omitted when value is N/A.

field s3_bucket_policy: Optional[Dict[str, Any]] = None (alias 'S3BucketPolicy')

S3 bucket policy for external datasets.

field kms_policy: Optional[Dict[str, Any]] = None (alias 'KmsPolicy')

KMS key policy for external datasets.

field data_permissions: Optional[List[RegisteredDatasetDataPermissionsInner]] = None (alias 'DataPermissions')

Lake Formation data filter permissions for the dataset. LF-target datasets not created via AWSConsole.

field data_profile: Optional[RegisteredDatasetDataProfile] = None (alias 'DataProfile')

field eda_status: Optional[StrictStr] = None (alias 'EdaStatus')

Status of structured EDA profiling (for example STARTING, IN_PROGRESS, COMPLETED, FAILED, STALE).

field eda_message: Optional[StrictStr] = None (alias 'EdaMessage')

Human-readable message for structured EDA profiling state.

field eda_staleness: Optional[StrictStr] = None (alias 'EdaStaleness')

Staleness indicator for structured EDA profiling results.

field eda_staleness_message: Optional[StrictStr] = None (alias 'EdaStalenessMessage')

Human-readable message for EDA profiling staleness.

field update_schema_status: Optional[StrictStr] = None (alias 'UpdateSchemaStatus')

Status of the latest dataset schema update. Set on the datasets table when a schema update is started or finished. Compared case-insensitively for in-progress (e.g. InProgress). Other values include success and failure messages (e.g. Failed, schema update process timed out).

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of RegisteredDataset from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of RegisteredDataset from a dict

Return type:

Optional[Self]