trigger_datalab_resource_access_update

DatalabsApi.trigger_datalab_resource_access_update(id, role_id, datalab_resource_access_input, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update resources attached to a datalab

Replaces the datasets, domains and parameters attached to a datalab. The change is applied in the background - poll the GET operation until the status shows it has completed, as a further update is rejected while one is still in progress. Requires editor access or higher.

Parameters:

  • id (str) – Identifier of the datalab. (required)

  • role_id (str) – User role id (required)

  • datalab_resource_access_input (DatalabResourceAccessInput) – (required)

  • content_type (str) – Must be application/json.

  • _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:

UpdateDatalabResourceAccessResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /datalabs/{id}/resourceaccess

Success (HTTP 200)

Successful API response

Request / response example

{
  "Message": "Initiated resource access updates for Data Lab."
}

Errors

Documented error codes: GE-1033, IPV-1008, GE-1034, DLB-1002.

HTTP 400

Invalid input

An earlier resource access update is still running

{
  "Message": "GE-1033 - Cannot complete requested operation, resource access update is already in progress state"
}

One of the three access lists omitted

{
  "Message": "IPV-1008 - Invalid request body, missing key(s) - DatasetAccess,ParameterAccess,DomainAccess"
}

Read access requested on a tag-controlled dataset

{
  "Message": "GE-1034 - Cannot provide read access to tag based access controlled datasets."
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "DLB-1002 - Datalab b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f doesn't exist"
}