complete_dataset_registration

DatasetsApi.complete_dataset_registration(id, role_id, complete_registration, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Complete dataset registration

Completes the registration of a dataset by creating its backend infrastructure (Glue table, Redshift table, DynamoDB table, or Iceberg/Hudi/DeltaLake table) based on TargetLocation. The caller must be an owner of the dataset. The dataset’s RegistrationStatus must NOT already be “completed” — calling this on a fully registered dataset returns GE-1034. Required request body field: DatasetSchema (array of column definitions). Other fields are conditionally required based on the dataset’s TargetLocation: - Redshift: SortType, DistType, SortKeys, DistKey, PrimaryKeys, UniqueColumns, IsIdentityNeeded, IdentityAttributeValues, DataConversionParams - DynamoDB: PartitionKey (required), SortKey (optional), StorageType, LocalSecondaryIndexes, GlobalSecondaryIndexes - LF/S3Athena (Iceberg): handled via IcebergTableOptions on the dataset record - LF/S3Athena (Hudi): PrimaryKey, PrecombineKey - All targets with TableUpdate=update: RecordKeys + LatestRecordIndicator required On success, asynchronous operations are triggered (LF access grants, DQ constraints, NL2SQL schema sync, observability etc).

Parameters:

  • id (str) – Dataset ID to complete registration for (required)

  • role_id (str) – IAM role identifier for the calling user (required)

  • complete_registration (CompleteRegistration) – (required)

  • content_type (str) – Must be application/json

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

CompleteDatasetRegistrationResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /datasets/{id}

Success (HTTP 200)

Registration completed successfully

Errors

HTTP 400

Invalid input or dataset state

Dataset not found

{
  "Message": "Invalid DatasetID - abc12345-1234-1234-1234-abcdef123456, resource not found."
}

DatasetSchema is empty or missing

{
  "Message": "Invalid parameter - DatasetSchema, value either missing or is invalid."
}

Dataset already completed registration

{
  "Message": "Dataset registration is already completed for abc12345-1234-1234-1234-abcdef123456"
}

User is not an owner

{
  "Message": "User action is not permitted"
}

HTTP 500

Internal failure during registration

Backend infrastructure creation failed

{
  "Message": "Failed to complete dataset registration due to error - ..."
}