Skip to content

DescribeBackupVaultOutput

Source code in docs_src/capo_backup/types/describe_backup_vault_output.py
class DescribeBackupVaultOutput(TypedDict, closed=True):
    backup_vault_name: NotRequired["capo_backup.types.string.string"]
    """<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.</p>"""
    backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"""
    vault_type: NotRequired["capo_backup.types.vault_type.VaultType"]
    """<p>The type of vault described.</p>"""
    vault_state: NotRequired["capo_backup.types.vault_state.VaultState"]
    """<p>The current state of the vault.-></p>"""
    encryption_key_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"""
    creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    creator_request_id: NotRequired["capo_backup.types.string.string"]
    """<p>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>"""
    number_of_recovery_points: "capo_backup.types.long2.Long2"
    """<p>The number of recovery points that are stored in a backup vault.</p> <p>Recovery point count value displayed in the console can be an approximation. Use <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html"> <code>ListRecoveryPointsByBackupVault</code> </a> API to obtain the exact count.</p>"""
    locked: NotRequired["capo_backup.types.boolean.Boolean"]
    """<p>A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. <code>True</code> means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.</p>"""
    min_retention_days: NotRequired["capo_backup.types.long.Long"]
    """<p>The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.</p> <p>If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.</p>"""
    max_retention_days: NotRequired["capo_backup.types.long.Long"]
    """<p>The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).</p> <p>If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.</p>"""
    lock_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time when Backup Vault Lock configuration cannot be changed or deleted.</p> <p>If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.</p> <p>This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    source_backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The ARN of the source backup vault from which this restore access backup vault was created.</p>"""
    mpa_approval_team_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The ARN of the MPA approval team associated with this backup vault.</p>"""
    mpa_session_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The ARN of the MPA session associated with this backup vault.</p>"""
    latest_mpa_approval_team_update: NotRequired[
        "capo_backup.types.latest_mpa_approval_team_update.LatestMpaApprovalTeamUpdate"
    ]
    """<p>Information about the latest update to the MPA approval team association for this backup vault.</p>"""
    encryption_key_type: NotRequired[
        "capo_backup.types.encryption_key_type.EncryptionKeyType"
    ]
    """<p>The type of encryption key used for the backup vault. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.</p>"""

backup_vault_arn instance-attribute

backup_vault_arn: NotRequired[ARN]

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

backup_vault_name instance-attribute

backup_vault_name: NotRequired[string]

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

creation_date instance-attribute

creation_date: NotRequired[timestamp]

The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

creator_request_id instance-attribute

creator_request_id: NotRequired[string]

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[ARN]

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

encryption_key_type instance-attribute

encryption_key_type: NotRequired[EncryptionKeyType]

The type of encryption key used for the backup vault. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

latest_mpa_approval_team_update instance-attribute

latest_mpa_approval_team_update: NotRequired[LatestMpaApprovalTeamUpdate]

Information about the latest update to the MPA approval team association for this backup vault.

lock_date instance-attribute

lock_date: NotRequired[timestamp]

The date and time when Backup Vault Lock configuration cannot be changed or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

locked instance-attribute

locked: NotRequired[Boolean]

A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

max_retention_days instance-attribute

max_retention_days: NotRequired[Long]

The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

min_retention_days instance-attribute

min_retention_days: NotRequired[Long]

The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

mpa_approval_team_arn instance-attribute

mpa_approval_team_arn: NotRequired[ARN]

The ARN of the MPA approval team associated with this backup vault.

mpa_session_arn instance-attribute

mpa_session_arn: NotRequired[ARN]

The ARN of the MPA session associated with this backup vault.

number_of_recovery_points instance-attribute

number_of_recovery_points: Long2

The number of recovery points that are stored in a backup vault.

Recovery point count value displayed in the console can be an approximation. Use ListRecoveryPointsByBackupVault API to obtain the exact count.

source_backup_vault_arn instance-attribute

source_backup_vault_arn: NotRequired[ARN]

The ARN of the source backup vault from which this restore access backup vault was created.

vault_state instance-attribute

vault_state: NotRequired[VaultState]

The current state of the vault.->

vault_type instance-attribute

vault_type: NotRequired[VaultType]

The type of vault described.