list_job_library_dependents¶

EtlJobsApi.list_job_library_dependents(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

List resources dependent on a shared library

Returns jobs, datalabs, data pipelines, and resource-access jobs that reference the library. Empty DependentResources when none. Use before DELETE /jobs/libs/{id}. Caller must have access to the library. No query parameters. No request body.

Parameters:

id (str) – Shared library identifier. (required)
role_id (str) – Amorphic role ID of the requesting user. Must be a role the authenticated user belongs to. (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 /jobs/libs/{id}/dependentresources

Parameter examples¶

Name	In	Example
`id`	path	`"123e4567-e89b-12d3-a456-426614174000"`
`role_id`	header	`"custom-role-123e4567-e89b-12d3-a456-426614174000"`

Success (HTTP 200)¶

Dependent resource groups, or an empty array when none.

Library has dependent resources

{
  "DependentResources": [
    {
      "ResourceType": "Jobs",
      "Resources": [
        {
          "JobName": "daily_etl",
          "JobId": "job-123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    },
    {
      "ResourceType": "ResourceAccessJobs",
      "Resources": [
        {
          "JobName": "report_job",
          "JobId": "job-223e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ]
}

No dependent resources

{
  "DependentResources": []
}

Errors¶

Documented error codes: AUTH-1001, AUTH-1011, IPV-1002, GE-1034.

HTTP 400

Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: AUTH-1001 (missing role_id), AUTH-1011 (caller not authorized).

Missing role_id header

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

Caller not authorized

{
  "Message": "AUTH-1011 - User does not have sufficient permission to perform this action"
}

HTTP 500

Backend failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1002 (library not found), GE-1034.