GetRecoveryPointIndexDetailsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupClient, GetRecoveryPointIndexDetailsCommand } from "@aws-sdk/client-backup"; // ES Modules import
// const { BackupClient, GetRecoveryPointIndexDetailsCommand } = require("@aws-sdk/client-backup"); // CommonJS import
const client = new BackupClient(config);
const input = { // GetRecoveryPointIndexDetailsInput
  BackupVaultName: "STRING_VALUE", // required
  RecoveryPointArn: "STRING_VALUE", // required
};
const command = new GetRecoveryPointIndexDetailsCommand(input);
const response = await client.send(command);
// { // GetRecoveryPointIndexDetailsOutput
//   RecoveryPointArn: "STRING_VALUE",
//   BackupVaultArn: "STRING_VALUE",
//   SourceResourceArn: "STRING_VALUE",
//   IndexCreationDate: new Date("TIMESTAMP"),
//   IndexDeletionDate: new Date("TIMESTAMP"),
//   IndexCompletionDate: new Date("TIMESTAMP"),
//   IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING",
//   IndexStatusMessage: "STRING_VALUE",
//   TotalItemsIndexed: Number("long"),
// };

GetRecoveryPointIndexDetailsCommand Input

See GetRecoveryPointIndexDetailsCommandInput for more details

Parameter
Type
Description
BackupVaultName
Required
string | undefined

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
Required
string | undefined

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

GetRecoveryPointIndexDetailsCommand Output

See GetRecoveryPointIndexDetailsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BackupVaultArn
string | undefined

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.

IndexCompletionDate
Date | undefined

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.

IndexCreationDate
Date | undefined

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
Date | undefined

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.

IndexStatus
IndexStatus | undefined

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 | undefined

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

RecoveryPointArn
string | undefined

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

SourceResourceArn
string | undefined

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

TotalItemsIndexed
number | undefined

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

Throws

Name
Fault
Details
InvalidParameterValueException
client

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException
client

Indicates that a required parameter is missing.

ResourceNotFoundException
client

A resource that is required for the action doesn't exist.

ServiceUnavailableException
server

The request failed due to a temporary failure of the server.

BackupServiceException
Base exception class for all service exceptions from Backup service.