get_shared_job_library_details¶
- EtlJobsApi.get_shared_job_library_details(id, role_id, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Get shared job library details
Returns the library the caller can access. Optional projectionExpression limits fields to LibraryId, LibraryName, AccessType, LibraryDescription, CreationTime, LastModifiedTime, LastModifiedBy, CreatedBy, Keywords. Missing library is returned as 500. 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)
projection_expression (str) – Comma-separated fields to include. Invalid names are rejected.
_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: GET /jobs/libs/{id}
Parameter examples¶
Name |
In |
Example |
|---|---|---|
|
path |
|
|
header |
|
|
query |
|
Success (HTTP 200)¶
Library metadata, including AccessType for the caller.
Request / response example
{
"LibraryId": "123e4567-e89b-12d3-a456-426614174000",
"LibraryName": "spark_utils",
"LibraryDescription": "Shared Spark helpers",
"AccessType": "owner",
"Keywords": [
"spark"
],
"LastModifiedTime": "2026-08-19 10:02:00"
}
Errors¶
Documented error codes: IPV-1006, AUTH-1001, AUTH-1011, IPV-1002, GE-1034.
HTTP 400
Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1006 (invalid projectionExpression), 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.
Library not found
{
"Message": "IPV-1002 - Invalid LibraryId - 123e4567-e89b-12d3-a456-426614174000, resource not found."
}
Unexpected backend failure
{
"Message": "GE-1034 - Unable to process the request"
}