GetRecoveryPointRestoreMetadata
Returns a set of metadata key-value pairs that were used to create the backup.
Request Syntax
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/restore-metadata?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- BackupVaultAccountId
-
The account ID of the specified backup vault.
Pattern:
^[0-9]{12}$ - backupVaultName
-
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 AWS Region where they are created.
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$Required: Yes
- recoveryPointArn
-
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.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"RecoveryPointArn": "string",
"ResourceType": "string",
"RestoreMetadata": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BackupVaultArn
-
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.Type: String
- RecoveryPointArn
-
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.Type: String
- ResourceType
-
The resource type of the recovery point.
Type: String
Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$ - RestoreMetadata
-
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.
Type: String to string map
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
