get_batch_delete_datasets_status

DatasetsApi.get_batch_delete_datasets_status(dataset_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get batch delete datasets status

Returns the deletion status for datasets previously submitted via PUT /datasets/batch-delete. Pass one or more DatasetId query parameters to check their status. For each DatasetId, the response includes a Status derived from the dataset’s current registration state.

Parameters:

  • dataset_id (str) – One or more dataset IDs to check deletion status for. Pass multiple values by repeating the parameter. (required)

  • role_id (str) – Amorphic role ID the request is authorized against. (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:

List[BatchDeleteDatasetStatus]

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasets/batch-delete

Success (HTTP 200)

Returns an array of objects, each containing the DatasetId and its current deletion Status.

Request / response example

[
  {
    "DatasetId": "b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f",
    "Status": "delete-success"
  },
  {
    "DatasetId": "a2f7d3b1-8e5c-4a6f-9d1e-2b3c4d5e6f7a",
    "Status": "delete-triggered"
  },
  {
    "DatasetId": "00000000-0000-0000-0000-000000000000",
    "Status": "Doesn't Exist"
  }
]

Errors

Documented error codes: DS-1009, RTE-1001.

HTTP 400

Validation failure. Error code DS-1009 when no DatasetId query parameters are provided.

No DatasetId query parameters provided

{
  "Message": "DS-1009 - No input datasets to delete."
}

HTTP 500

Backend failure. Error code RTE-1001 for unhandled exceptions.