Backup / Client / get_recovery_point_index_details

get_recovery_point_index_details#

Backup.Client.get_recovery_point_index_details(**kwargs)#

This operation returns the metadata and details specific to the backup index associated with the specified recovery point.

See also: AWS API Documentation

Request Syntax

response = client.get_recovery_point_index_details(
    BackupVaultName='string',
    RecoveryPointArn='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 Region where they are created.

    Accepted characters include lowercase letters, numbers, and hyphens.

  • RecoveryPointArn (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'RecoveryPointArn': 'string',
    'BackupVaultArn': 'string',
    'SourceResourceArn': 'string',
    'IndexCreationDate': datetime(2015, 1, 1),
    'IndexDeletionDate': datetime(2015, 1, 1),
    'IndexCompletionDate': datetime(2015, 1, 1),
    'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING',
    'IndexStatusMessage': 'string',
    'TotalItemsIndexed': 123
}

Response Structure

  • (dict) –

    • 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.

    • BackupVaultArn (string) –

      An ARN that uniquely identifies the backup vault where the recovery point index is stored.

      For example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    • SourceResourceArn (string) –

      A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

    • IndexCreationDate (datetime) –

      The date and time that a backup index was 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.

    • IndexDeletionDate (datetime) –

      The date and time that a backup index was deleted, 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.

    • IndexCompletionDate (datetime) –

      The date and time that a backup index finished creation, 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.

    • IndexStatus (string) –

      This is the current status for the backup index associated with the specified recovery point.

      Statuses are: PENDING | ACTIVE | FAILED | DELETING

      A recovery point with an index that has the status of ACTIVE can be included in a search.

    • IndexStatusMessage (string) –

      A detailed message explaining the status of a backup index associated with the recovery point.

    • TotalItemsIndexed (integer) –

      Count of items within the backup index associated with the recovery point.

Exceptions

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.ServiceUnavailableException