get_data_load_statistics_of_dataset

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

Get file data load statistics

Returns recent dataload execution counts and current SQS queue depths for each target location (S3, S3Athena, Redshift, Lakeformation, Dynamodb). Redshift statistics are only present when a DWH dataload queue is configured in the environment. RecentExecutions values are comma-separated strings in the format “{count},{timestamp}”. CurrentMessagesInQueue values are approximate integer counts of messages waiting in each target’s SQS queue. Usage examples: GET /datasets/dataload-statistics — returns all target location statistics.

Parameters:

  • role_id (str) – The active Amorphic role ID of the caller. (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:

DataLoadStatistics

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasets/dataload-statistics

Success (HTTP 200)

Data load statistics for each target location. RecentExecutions contains comma-separated “{count},{timestamp}” strings. CurrentMessagesInQueue contains approximate SQS queue message counts.

Request / response example

{
  "RecentExecutions": {
    "S3": "5,2024-08-11T10:30:45Z",
    "S3Athena": "3,2024-08-11T10:28:12Z",
    "Redshift": "2,2024-08-11T09:45:00Z",
    "Lakeformation": "1,2024-08-11T10:15:30Z",
    "Dynamodb": "4,2024-08-11T10:20:00Z"
  },
  "CurrentMessagesInQueue": {
    "S3": 12,
    "S3Athena": 3,
    "Redshift": 0,
    "Lakeformation": 7,
    "Dynamodb": 1
  }
}

Errors

HTTP 400

Authorization failure. Caller lacks the required role permission.

HTTP 500

Backend failure. Typically an SQS error retrieving queue message counts.