delete_shared_job_library¶
- EtlJobsApi.delete_shared_job_library(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Delete a shared job library
Owner only. Deletes S3 objects, README extracts, DynamoDB metadata, and ACL when there are no dependents and the library is not update-in-progress. 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:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: DELETE /jobs/libs/{id}
Parameter examples¶
Name |
In |
Example |
|---|---|---|
|
path |
|
|
header |
|
Success (HTTP 200)¶
Library deleted.
Request / response example
{
"Message": "Successfully deleted the shared library"
}
Errors¶
Documented error codes: AUTH-1010, AUTH-1001, AUTH-1011, IPV-1002, DB-1003, GE-1034.
HTTP 400
Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: AUTH-1010 (not owner), dependent resources or update-in-progress (plain Message without code prefix).
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"
}
Owner access required
{
"Message": "AUTH-1010 - 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), DB-1003 (delete failed).
Unexpected backend failure
{
"Message": "GE-1034 - Unable to process the request"
}