delete_data_permissions_on_dataset¶
- DatasetsApi.delete_data_permissions_on_dataset(dfname, id, role_id, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Delete a Lake Formation data filter on a dataset
Starts async deletion of the data filter identified by dfname (revokes grants and removes the Lake Formation filter). Caller must be owner or editor. Not supported for TBAC-enabled datasets. dfname must exist for the dataset or IPV-1046 is returned. AUTH-1011 if the caller lacks access.
- Parameters:
dfname (str) – Existing data filter name for this dataset (Lake Formation Name / SystemName from list). Rejected with IPV-1046 if not found. (required)
id (str) – Dataset ID that owns the data filter. (required)
role_id (str) – Amorphic role ID used for authorization. Must be a role the user belongs to with owner or editor permission on the dataset. (required)
content_type (str) – Optional for DELETE; include application/json if a client always sends Content-Type.
_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:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: DELETE /datasets/{id}/data-permissions/{dfname}
Success (HTTP 200)¶
Async delete workflow started. Message is “Data Permission delete process started”.
Request / response example
{
"Message": "Data Permission delete process started"
}
Errors¶
Documented error codes: IPV-1046, AUTH-1011, GE-1034.
HTTP 400
Validation or authorization failure. Codes include IPV-1046 (unknown dfname), AUTH-1011 (not authorized to delete), GE-1034 for TBAC datasets.
dfname does not exist for dataset
{
"Message": "IPV-1046 - Invalid value - sales_monthly_orders_missing, parameter cannot be updated."
}
Caller cannot delete data permissions
{
"Message": "AUTH-1011 - User admin is not authorized to perform this operation"
}
HTTP 500
Backend/generic failure.