Backup / Client / get_recovery_point_restore_metadata

get_recovery_point_restore_metadata#

Backup.Client.get_recovery_point_restore_metadata(**kwargs)#

Returns a set of metadata key-value pairs that were used to create the backup.

See also: AWS API Documentation

Request Syntax

response = client.get_recovery_point_restore_metadata(
    BackupVaultName='string',
    RecoveryPointArn='string',
    BackupVaultAccountId='string'
)
Parameters:

  • BackupVaultName (string) –

    [REQUIRED]

    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 Amazon Web Services Region where they are created.

  • RecoveryPointArn (string) –

    [REQUIRED]

    An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

  • BackupVaultAccountId (string) – The account ID of the specified backup vault.

Return type:

dict

Returns:

Response Syntax

{
    'BackupVaultArn': 'string',
    'RecoveryPointArn': 'string',
    'RestoreMetadata': {
        'string': 'string'
    },
    'ResourceType': 'string'
}

Response Structure

  • (dict) –

    • BackupVaultArn (string) –

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

    • RecoveryPointArn (string) –

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • RestoreMetadata (dict) –

      The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

      • (string) –

        • (string) –

    • ResourceType (string) –

      The resource type of the recovery point.

Exceptions