groups

Accessed as client.admin.quota.groups; the async client mirrors it.

SyncAsync

AdminQuotaGroups

The admin.quota.groups namespace.

rules

rules: AdminQuotaGroupsRules = AdminQuotaGroupsRules(client)

users

users: AdminQuotaGroupsUsers = AdminQuotaGroupsUsers(client)

create

create(*, name: str | None = None, rules: list[CreateQuotaRuleOptions] | None = None) -> QuotaGroup

Create a new quota group.

Parameters:

Name	Type	Description	Default
`name`	`str \| None`	Name of the quota group to create	`None`
`rules`	`list[CreateQuotaRuleOptions] \| None`	Rules to add to the newly created group. If a rule does not exist, it will be created.	`None`

Returns:

Type	Description
`QuotaGroup`	QuotaGroup.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`ConflictError`	APIError is error format response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminCreateQuotaGroup

delete

delete(quotagroup: str) -> None

Delete a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to delete	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminDeleteQuotaGroup

get

get(quotagroup: str) -> QuotaGroup

Get information about the quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to query	required

Returns:

Type	Description
`QuotaGroup`	QuotaGroup.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminGetQuotaGroup

list

list() -> list[QuotaGroup]

List the available quota groups.

Returns:

Type	Description
`list[QuotaGroup]`	QuotaGroupList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminListQuotaGroups

AsyncAdminQuotaGroups

The admin.quota.groups namespace.

rules

rules: AsyncAdminQuotaGroupsRules = AsyncAdminQuotaGroupsRules(client)

users

users: AsyncAdminQuotaGroupsUsers = AsyncAdminQuotaGroupsUsers(client)

create

create(*, name: str | None = None, rules: list[CreateQuotaRuleOptions] | None = None) -> QuotaGroup

Create a new quota group.

Parameters:

Name	Type	Description	Default
`name`	`str \| None`	Name of the quota group to create	`None`
`rules`	`list[CreateQuotaRuleOptions] \| None`	Rules to add to the newly created group. If a rule does not exist, it will be created.	`None`

Returns:

Type	Description
`QuotaGroup`	QuotaGroup.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`ConflictError`	APIError is error format response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminCreateQuotaGroup

delete

delete(quotagroup: str) -> None

Delete a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to delete	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminDeleteQuotaGroup

get

get(quotagroup: str) -> QuotaGroup

Get information about the quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to query	required

Returns:

Type	Description
`QuotaGroup`	QuotaGroup.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminGetQuotaGroup

list

list() -> list[QuotaGroup]

List the available quota groups.

Returns:

Type	Description
`list[QuotaGroup]`	QuotaGroupList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminListQuotaGroups