budget#

Exec module for managing budgets.

async idem_aws.exec.aws.budgets.budget.get(hub, ctx, name: str, resource_id: str) Dict[source]#

Retrieves the budget details.

Parameters:
  • name (str) – An Idem name of the AWS Budget.

  • resource_id (str) – Resource ID to identify the AWS Budget.

Returns:

result(bool):

Whether the result of the function has been successful (True) or not (False).

comment(list):

A list of messages.

ret(dict or None):

The AWS budget in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.budgets.budget.get name="idem_name" resource_id="budget_name"

Calling this exec module function from within a state module in pure python:

async def state_function(hub, ctx, name, resource_id, **kwargs):
    ret = await hub.exec.aws.budgets.budget.get(
        ctx, name=name, resource_id=resource_id
    )
async idem_aws.exec.aws.budgets.budget.list_(hub, ctx) Dict[source]#

Fetch a list of budgets from AWS.

The function returns empty list when no resource is found.

Returns:

result(bool):

Whether the result of the function has been successful (True) or not (False).

comment(list):

A list of messages.

ret(dict or None):

The AWS budget list in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.budgets.budget.list

Calling this exec module function from within a state module in pure python:

async def state_function(hub, ctx, name, resource_id, **kwargs):
    ret = await hub.exec.aws.budgets.budget.list(ctx)