---
title: "QuotaSummary"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Service Quotas API

## Fields

- `QuotaSummary.adjustable` (boolean, required)
- `QuotaSummary.capacity` (integer | null, required) — rate quotas: the bucket's capacity for value (what usage.used is out of), else null.
  - min 0
- `QuotaSummary.default` (integer, required) — The default for the organization's tier.
  - min 0
- `QuotaSummary.description` (string, required)
- `QuotaSummary.displayName` (string, required)
- `QuotaSummary.id` (string, required) — <namespace>.<name> or <namespace>.<group>.<name>.
  - maxLength 96; pattern `^[a-z]{2,32}\.[a-z][A-Za-z0-9]{2,63}(\.[a-z][A-Za-z0-9]{1,63})?$`
- `QuotaSummary.kind` (unknown, required)
  - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
- `QuotaSummary.perRegion` (boolean, required)
- `QuotaSummary.region` (string, required) — A region (us-west-1), or "" for what isn't regional.
  - pattern `^([a-z]{2}-[a-z]+-[0-9]+)?$`
- `QuotaSummary.resourceType` (string | null, required)
- `QuotaSummary.scope` (unknown, required)
  - one of `"organization"`, `"project"`, `"resource"`
- `QuotaSummary.service` (string, required) — The owning product's namespace.
- `QuotaSummary.serviceName` (string | null, required) — The owning product's name, from its registration (Widgets), or null.
- `QuotaSummary.source` (unknown, required) — Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
  - one of `"override"`, `"organizationOverride"`, `"tier"`, `"default"`
- `QuotaSummary.tier` (string | null, required) — The organization's tier when source is tier, else null.
- `QuotaSummary.unit` (string, required)
- `QuotaSummary.usage` (one of, required) — null for narrower scopes without ?scopeKey= (see usageSummary and the quota's scopes), and for a perRegion quota without ?region=.
  - one of: `null`, [Usage](/quotas-api/schemas/Usage/)
- `QuotaSummary.usageSummary` (one of, required) — When usage is null: where the scope keys (and regions) stand. Else null.
  - one of: `null`, [UsageSummary](/quotas-api/schemas/UsageSummary/)
- `QuotaSummary.value` (integer, required) — The value that applies: the organization's, a scope key without its own override's, or with ?scopeKey= that scope key's.
  - min 0
- `QuotaSummary.window` (string | null, required) — rate quotas: PT1S to PT1H.


Source: https://docs.ezghcloud.com/quotas-api/schemas/QuotaSummary/index.md
