create_shared_job_library

EtlJobsApi.create_shared_job_library(role_id, shared_job_lib_info, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a shared job library

Creates a shared ETL library and grants the caller owner access. LibraryName and LibraryDescription are required (name is stored lowercase). Keywords default to []. Packages is accepted but not stored on create. Extra body fields are rejected.

Parameters:

  • role_id (str) – Amorphic role ID of the requesting user. Must be a role the authenticated user belongs to. (required)

  • shared_job_lib_info (SharedJobLibInfo) – (required)

  • content_type (str) – Request body media 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:

ETLLibraryPostResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /jobs/libs

Parameter examples

Name

In

Example

role_id

header

"custom-role-123e4567-e89b-12d3-a456-426614174000"

Content-Type

header

"application/json"

Success (HTTP 200)

Library created. Returns Message and libraryId.

Request / response example

{
  "Message": "Successfully created shared library",
  "libraryId": "123e4567-e89b-12d3-a456-426614174000"
}

Errors

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

HTTP 400

Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1008 (missing/invalid fields or duplicate LibraryName), GE-1009 (duplicate name), 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"
}

Unknown or invalid body field

{
  "Message": "IPV-1008 - Invalid input parameter(s) - ExtraField"
}

HTTP 500

Backend failure. Body is {“Message”: “<CODE> - <text>”}. Codes: GE-1034 (unexpected backend failure), DB-1002 (persistence failure).

Unexpected backend failure

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