DescribeProtectedResource - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeProtectedResource

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon service type of the saved resource.

Request Syntax

GET /resources/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "LastBackupTime": number, "LastBackupVaultArn": "string", "LastRecoveryPointArn": "string", "LatestRestoreExecutionTimeMinutes": number, "LatestRestoreJobCreationDate": number, "LatestRestoreRecoveryPointCreationDate": number, "ResourceArn": "string", "ResourceName": "string", "ResourceType": "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.

LastBackupTime

The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

LastBackupVaultArn

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

Type: String

LastRecoveryPointArn

This is the ARN (Amazon Resource Name) of the most recent recovery point.

Type: String

LatestRestoreExecutionTimeMinutes

This is the time in minutes the most recent restore job took to complete.

Type: Long

LatestRestoreJobCreationDate

This is the creation date of the most recent restore job.

Type: Timestamp

LatestRestoreRecoveryPointCreationDate

This is the date the most recent recovery point was created.

Type: Timestamp

ResourceArn

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Type: String

ResourceName

This is the non-unique name of the resource that belongs to the specified backup.

Type: String

ResourceType

The type of Amazon resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

Type: String

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

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 Amazon SDKs, see the following: