list_dataset_dependent_resources

DatasetsApi.list_dataset_dependent_resources(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Lists all the resources that are dependent on dataset

Returns resources that depend on the dataset (views, jobs, ETL, dashboards, etc.), grouped by ResourceType. Caller needs any access on the dataset via role_id. Not paginated — response is the full dependency set (DependentResources may be an empty array). There is no limit, offset, or nextToken.

Parameters:

  • id (str) – Dataset ID to inspect for dependents. (required)

  • role_id (str) – Amorphic role ID used for authorization. (required)

  • _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:

DependentResources

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasets/{id}/dependentresources

Success (HTTP 200)

Full dependency set for the dataset (not paginated). Body is DependentResources; DependentResources may be an empty array.

Request / response example

{
  "DependentResources": [
    {
      "ResourceType": "Views",
      "Resources": [
        {
          "ViewName": "sales_orders_v",
          "Domain": "sales",
          "ViewId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
        }
      ]
    },
    {
      "ResourceType": "Jobs",
      "Resources": [
        {
          "JobName": "daily_orders_etl",
          "JobId": "job-123",
          "AccessType": "read-only"
        }
      ]
    }
  ]
}

Errors

Documented error codes: IPV-1002, AUTH-1011, DS-1004.

HTTP 400

Validation or authorization failure. IPV-1002 (unknown DatasetId), AUTH-1011 (caller has no access on the dataset), DS-1004 (dataset metadata missing DatasetName/Domain).

Dataset id does not exist

{
  "Message": "IPV-1002 - Invalid DatasetId - 49e02003-289e-41e9-a9f2-28a733349481, resource not found."
}

Caller has no access on the dataset

{
  "Message": "AUTH-1011 - User admin is not authorized to view resource details"
}

Dataset metadata missing required fields

{
  "Message": "DS-1004 - Inconsistent metadata for dataset details {...}"
}

HTTP 500

Backend/generic failure.