quota_utilization_reports
Creates, updates, deletes, gets or lists a quota_utilization_reports resource.
Overview
| Name | quota_utilization_reports |
| Type | Resource |
| Id | aws.service_quotas.quota_utilization_reports |
Fields
The following fields are returned by SELECT queries:
- get_quota_utilization_report
| Name | Datatype | Description |
|---|---|---|
error_code | string | An error code indicating the reason for failure when the report status is FAILED. This field is only present when the status is FAILED. (pattern: <code>[a-zA-Z][a-zA-Z0-9]*</code>) |
error_message | string | A detailed error message describing the failure when the report status is FAILED. This field is only present when the status is FAILED. (pattern: <code>^.*$</code>) |
generated_at | string (date-time) | The timestamp when the report was generated, in ISO 8601 format. |
next_token | string | A token that indicates more results are available. Include this token in the next request to retrieve the next page of results. If this field is not present, you have retrieved all available results. (pattern: <code>^[a-zA-Z0-9/+]*={0,2}$</code>) |
quotas | array | A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page. |
report_id | string | The unique identifier for the quota utilization report. (pattern: <code>[0-9a-zA-Z][a-zA-Z0-9-]{1,128}</code>) |
status | string | The current status of the report generation. Possible values are: PENDING - The report generation is in progress. Retry this operation after a few seconds. IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED. COMPLETED - The report is ready and quota utilization data is available in the response. FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details. (PENDING, IN_PROGRESS, COMPLETED, FAILED) |
total_count | integer | The total number of quotas included in the report across all pages. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_quota_utilization_report | select | region | Retrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order (highest utilization first). You must first initiate a report using the StartQuotaUtilizationReport operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieve results when the report is ready. Each report contains up to 1,000 quota records per page. Use the NextToken parameter to retrieve additional pages of results. Reports are automatically deleted after 15 minutes. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_quota_utilization_report
Retrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order (highest utilization first). You must first initiate a report using the StartQuotaUtilizationReport operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieve results when the report is ready. Each report contains up to 1,000 quota records per page. Use the NextToken parameter to retrieve additional pages of results. Reports are automatically deleted after 15 minutes.
SELECT
error_code,
error_message,
generated_at,
next_token,
quotas,
report_id,
status,
total_count
FROM aws.service_quotas.quota_utilization_reports
WHERE region = '{{ region }}' -- required
;