report_jobs_status
Creates, updates, deletes, gets or lists a report_jobs_status resource.
Overview
| Name | report_jobs_status |
| Type | Resource |
| Id | sumologic.dashboards.report_jobs_status |
Fields
The following fields are returned by SELECT queries:
- getAsyncReportGenerationStatus
The status of the report generation job.
| Name | Datatype | Description |
|---|---|---|
error | object | |
status | string | Whether or not the request is in progress (InProgress), has completed successfully (Success), or has completed with an error (Failed). |
statusMessage | string | Additional status message generated if the status is not Failed. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
getAsyncReportGenerationStatus | select | jobId, region | Get the status of an asynchronous report generation request for the given job identifier. On success, use the [getReportGenerationResult] endpoint to get the result of the report generation job. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
jobId | string | The identifier of the asynchronous report generation job. |
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
SELECT examples
- getAsyncReportGenerationStatus
Get the status of an asynchronous report generation request for the given job identifier. On success, use the [getReportGenerationResult] endpoint to get the result of the report generation job.
SELECT
error,
status,
statusMessage
FROM sumologic.dashboards.report_jobs_status
WHERE jobId = '{{ jobId }}' -- required
AND region = '{{ region }}' -- required
;