update_data_classification

DatasetsApi.update_data_classification(id, role_id, data_classification_put, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update data classification

Updates an existing data classification. Both Description and DisplayName are optional — only provided fields are updated. LastModifiedTime and LastModifiedBy are always set automatically. {id} represents the DataClassificationName of the classification to update. Usage examples: PUT /datasets/dataclassifications/testclassification — updates fields on the “testclassification” classification.

Parameters:

  • id (str) – DataClassificationName of the classification to update. (required)

  • role_id (str) – The active Amorphic role ID of the caller. (required)

  • data_classification_put (DataClassificationPut) – (required)

  • content_type (str)

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

Status

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /datasets/dataclassifications/{id}

Request

Request / response example

{
  "Description": "Updated description for sensitive data",
  "DisplayName": "testclassification - Updated"
}

Success (HTTP 200)

Data classification updated successfully.

Request / response example

{
  "Message": "Successfully updated dataclassification",
  "DataClassificationName": "testclassification"
}

Errors

Documented error codes: IPV-1002, GE-1008.

HTTP 400

Classification not found (IPV-1002) or invalid input.

Request / response example

{
  "Message": "IPV-1002 - Invalid DataClassificationName - testclassification, resource not found."
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}