Skip to main content
 print this page

Get dataset details

GET 
/datasets/:id

Returns full metadata for a single dataset. The caller must have at least read-only access on the dataset (via direct sharing, tag-based access, or domain-level access); otherwise AUTH-1011 is returned.

The response shape varies based on dataset attributes:

By DatasetType:

  • internal / external: Returns operational fields (ConnectionDetails, DatasetS3Path, Schedules, MalwareDetectionOptions, etc.)
  • view: Returns ViewVersions, SqlStatement, CurrentVersion, AssumeRole. Materialized views may include RefreshStatus and LastRefreshCompletionTime.

By TargetLocation:

  • redshift: Adds ConnectionDetails (host, port, JDBC/ODBC strings), parses DatasetKeyOptions and ColumnTableConstraints from stored strings to objects, marks primary key columns with is_not_null in DatasetSchema.
  • lf (Lake Formation): Adds DataPermissions array. Filters DatasetSchema to only columns the caller can see (via Athena metadata or TBAC rules). For read-only users, DataProfile is redacted.
  • s3: Adds AreAIServicesEnabled, IsTranslateAIResultsEnabled, IsBDAExtractionEnabled.
  • dynamodb: Compares DatasetSchema columns against the Glue catalog and auto-repairs Glue if columns are missing.

Special query modes:

  • request=get_eda_profiling_status: Returns only DatasetId, EdaStatus, EdaMessage, EdaStaleness, EdaStalenessMessage (bypasses full enrichment).
  • request=get_conversion_params: Returns the data_conversion_parameters.json file content. Only valid for Redshift datasets; returns GE-1034 for other targets.

Projection: When projectionExpression is provided, only the specified comma-separated field names are included in the response.

Request​

Responses​

Dataset details. Response shape depends on query parameters:

  • No request param: Full RegisteredDataset object (or projected subset).
  • request=get_eda_profiling_status: Object with DatasetId, EdaStatus, EdaMessage, EdaStaleness, EdaStalenessMessage.
  • request=get_conversion_params: Object with DataConversionParameters.
Response Headers
    Access-Control-Allow-Origin
    Access-Control-Allow-Methods
    Access-Control-Allow-Headers