Skip to content

GetBudgetResponse

Source code in docs_src/capo_deadline/types/get_budget_response.py
class GetBudgetResponse(TypedDict, closed=True):
    budget_id: "capo_deadline.types.budget_id.BudgetId"
    """<p>The budget ID.</p>"""
    usage_tracking_resource: (
        "capo_deadline.types.usage_tracking_resource.UsageTrackingResource"
    )
    """<p>The resource that the budget is tracking usage for.</p>"""
    status: "capo_deadline.types.budget_status.BudgetStatus"
    """<p>The status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–Get a budget being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–Get an inactive budget. This can include expired, canceled, or deleted statuses.</p> </li> </ul>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the budget.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""
    approximate_dollar_limit: (
        "capo_deadline.types.consumed_usage_limit.ConsumedUsageLimit"
    )
    """<p>The consumed usage limit for the budget.</p>"""
    usages: "capo_deadline.types.consumed_usages.ConsumedUsages"
    """<p>The usages of the budget.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user or system that created this resource.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user or system that updated this resource.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the resource was updated.</p>"""
    description: NotRequired["capo_deadline.types.description.Description"]
    """<p>The description of the budget.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""
    actions: "capo_deadline.types.response_budget_action_list.ResponseBudgetActionList"
    """<p>The budget actions for the budget.</p>"""
    schedule: "capo_deadline.types.budget_schedule.BudgetSchedule"
    """<p>The budget schedule.</p>"""
    queue_stopped_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the queue stopped.</p>"""

actions instance-attribute

The budget actions for the budget.

approximate_dollar_limit instance-attribute

approximate_dollar_limit: ConsumedUsageLimit

The consumed usage limit for the budget.

budget_id instance-attribute

budget_id: BudgetId

The budget ID.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

created_by instance-attribute

created_by: CreatedBy

The user or system that created this resource.

description instance-attribute

description: NotRequired[Description]

The description of the budget.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

display_name instance-attribute

display_name: ResourceName

The display name of the budget.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

queue_stopped_at instance-attribute

queue_stopped_at: NotRequired[UpdatedAt]

The date and time the queue stopped.

schedule instance-attribute

schedule: BudgetSchedule

The budget schedule.

status instance-attribute

status: BudgetStatus

The status of the budget.

  • ACTIVE–Get a budget being evaluated.

  • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The date and time the resource was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The user or system that updated this resource.

usage_tracking_resource instance-attribute

usage_tracking_resource: UsageTrackingResource

The resource that the budget is tracking usage for.

usages instance-attribute

The usages of the budget.