update_data_load_throttling_details

DatasetsApi.update_data_load_throttling_details(role_id, data_load_throttling, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update data load throttling and Glue file processing settings

Updates the data load throttling and optional Glue file processing settings for the environment. DataLoadThrottling is required and accepts “enable” or “disable”. GlueFileProcessing is optional but can only be enabled when DataLoadThrottling is also being enabled Disabling DataLoadThrottling automatically disables GlueFileProcessing regardless of the GlueFileProcessing value provided in the request.

Parameters:

  • role_id (str) – The role ID of the user making the request (required)

  • data_load_throttling (DataLoadThrottling) – (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:

MessageStatus

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /datasets/dataload-throttling

Request

Enable both throttling and Glue file processing

{
  "DataLoadThrottling": "enable",
  "GlueFileProcessing": "enable"
}

Enable throttling without Glue file processing

{
  "DataLoadThrottling": "enable"
}

Disable throttling (also disables Glue file processing)

{
  "DataLoadThrottling": "disable"
}

Success (HTTP 200)

Successfully updated data load throttling settings

enabledBoth

{
  "Message": "Successfully enabled data load throttling and glue file processing"
}

disabledAll

{
  "Message": "Successfully disabled data load throttling and glue file processing"
}

Errors

Documented error codes: AUTH-1001, IPV-1008, IPV-1001, IPV-1041, GE-1034.

HTTP 400

Invalid input - missing or invalid DataLoadThrottling value, GlueFileProcessing enabled without DataLoadThrottling, missing role_id header, or insufficient permissions

Missing role_id header

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

DataLoadThrottling key missing from request body

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

Required parameter value is empty

{
  "Message": "IPV-1001 - Parameter DataLoadThrottling is a required value."
}

Invalid DataLoadThrottling value

{
  "Message": "IPV-1041 - Invalid parameter - DataLoadThrottling, allowed values are ['enable', 'disable']"
}

GlueFileProcessing enabled without DataLoadThrottling

{
  "Message": "GE-1034 - GlueFileProcessing cannot be enabled without enabling DataLoadThrottling."
}

HTTP 500

Failed to update data load throttling settings due to an internal error