list_all_job_libraries¶

EtlJobsApi.list_all_job_libraries(role_id, action=None, limit=None, offset=None, sortorder=None, sortby=None, projection_expression=None, filter_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

List shared job libraries or KB sync status

Omit action (or any value other than sync-kb) to list libraries the caller can access. Default offset 1, limit 100 (max 1000), sortby LastModifiedTime, sortorder desc. action=sync-kb returns Jobs knowledge base ingestion status (Jobs AI must be enabled). No request body.

Parameters:

role_id (str) – Amorphic role ID of the requesting user. Must be a role the authenticated user belongs to. (required)
action (str) – sync-kb returns knowledge base sync status. Omit or any other value lists libraries.
limit (int) – List only. Page size. Default 100, maximum 1000.
offset (int) – List only. 1-based page offset. Default 1.
sortorder (str) – List only. Sort direction. Default desc. Any value other than desc is treated as ascending.
sortby (str) – List only. Field to sort by. Default LastModifiedTime. The field must exist on every library item.
projection_expression (str) – List only. Comma-separated fields to include. Allowed values are LibraryId, LibraryName, AccessType, LibraryDescription, CreationTime, LastModifiedTime, LastModifiedBy, CreatedBy, Keywords.
filter_expression (str) – List only. Comma-separated field:value filters. LibraryName supports wildcard matching.
_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:

ListAllJobLibraries200Response

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /jobs/libs

Parameter examples¶

Name	In	Example
`role_id`	header	`"custom-role-123e4567-e89b-12d3-a456-426614174000"`
`action`	query	`"sync-kb"`
`projectionExpression`	query	`"LibraryId,LibraryName,AccessType"`
`filterExpression`	query	`"LibraryName:spark*"`

Success (HTTP 200)¶

Paginated library list, or KB sync status when action=sync-kb.

List libraries

{
  "libraries": [
    {
      "LibraryId": "123e4567-e89b-12d3-a456-426614174000",
      "LibraryName": "spark_utils",
      "LibraryDescription": "Shared Spark helpers",
      "AccessType": "owner",
      "LastModifiedTime": "2026-08-19 10:02:00"
    }
  ],
  "next_available": "no",
  "count": 1,
  "total_count": 1
}

KB sync status

{
  "Status": "COMPLETE",
  "KnowledgeBaseId": "ABCDEFGHIJ",
  "DataSourceId": "XXXXXXXXXX",
  "IngestionJobId": "YYYYYYYYYY",
  "LastSyncedAt": "2026-08-19T10:00:00Z"
}

Errors¶

Documented error codes: IPV-1050, IPV-1006, AI-1004, AUTH-1001, AUTH-1011, GE-1034.

HTTP 400

Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1050 (limit over maximum), IPV-1006 (invalid projectionExpression), AI-1004 (Jobs AI not enabled for sync-kb), 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"
}

Limit exceeds maximum

{
  "Message": "IPV-1050 - Out of range for items per page, Limit is 1000"
}

HTTP 500

Backend failure. Body is {“Message”: “<CODE> - <text>”}. Codes: GE-1034 (KB status retrieval failed).

Unexpected backend failure

{
  "Message": "GE-1034 - Unable to process the request"
}