backup_vault

Exec functions for backup vault.

async idem_aws.exec.aws.backup.backup_vault.get(hub, ctx, name: str, resource_id: str = None)

Returns the backup vault.

Parameters:

• name (str) – The name of the Idem state.

• resource_id (str) – AWS Backup vault name.

Examples

Calling this exec module function from the cli:

idem exec aws.backup.backup_vault.get name="idem_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.backup.backup_vault.get(
        ctx, name=name, resource_id=resource_id
    )

async idem_aws.exec.aws.backup.backup_vault.list_(hub, ctx, name: str = None) → Dict

Fetch a list of backup vaults from AWS.

The function returns empty list when no resource is found.

Parameters:

name (str, Optional) – The name of the Idem state for logging.

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 backup vault list in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.backup.backup_vault.list name="idem_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.backup.backup_vault.list(ctx, name)