trigger_shared_library_kb_synchronization¶

EtlJobsApi.trigger_shared_library_kb_synchronization(role_id, action, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Trigger knowledge base synchronization for shared libraries

Starts a Bedrock ingestion job for the shared libraries knowledge base. action must be sync-kb. Jobs AI must be enabled and the knowledge base must exist. 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) – Must be sync-kb. Any other value is rejected. (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:

SharedLibrariesKbSyncTriggerResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: PUT /jobs/libs

Parameter examples¶

Name	In	Example
`role_id`	header	`"custom-role-123e4567-e89b-12d3-a456-426614174000"`
`action`	query	`"sync-kb"`

Success (HTTP 200)¶

Ingestion job started or already managed.

Request / response example

{
  "Message": "Successfully triggered shared libraries knowledge base synchronization",
  "IngestionJobId": "YYYYYYYYYY",
  "KnowledgeBaseId": "ABCDEFGHIJ",
  "DataSourceId": "XXXXXXXXXX"
}

Errors¶

Documented error codes: GE-1010, AI-1004, AUTH-1001, AUTH-1011, GE-1034.

HTTP 400

Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: GE-1010 (action must be sync-kb), AI-1004 (Jobs AI not enabled), 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"
}

Invalid action query parameter

{
  "Message": "GE-1010 - Invalid HTTP method PUT for resource /jobs/libs"
}

HTTP 500

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

Unexpected backend failure

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