Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeBackupAccessPoint

Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point.

After a backup access point reaches the AVAILABLE status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data.

Request Syntax


GET /backup-access-point/AccessPointArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccessPointArn

The Amazon Resource Name (ARN) of the backup access point to describe.

Pattern: (arn:aws[a-z-]*:backup:[a-z-\d]+:\d{12}:accesspoint/)[\da-z]{1}[\da-z-]{1,48}[\da-z]{1}(?<!-s3alias)(?<!-ext-s3alias)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccessPointArn": "string",
   "AccessPointMetadata": { 
      "string" : "string" 
   },
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationTime": number,
   "Name": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceType": "string",
   "Status": "string",
   "StatusMessage": "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.

AccessPointArn

The Amazon Resource Name (ARN) that uniquely identifies the backup access point.

Type: String

Pattern: (arn:aws[a-z-]*:backup:[a-z-\d]+:\d{12}:accesspoint/)[\da-z]{1}[\da-z-]{1,48}[\da-z]{1}(?<!-s3alias)(?<!-ext-s3alias)

AccessPointMetadata

Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.

Type: String to string map

Key Length Constraints: Minimum length of 1.

Value Length Constraints: Minimum length of 1.

BackupVaultArn

The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.

Type: String

BackupVaultName

The name of the backup vault that contains the recovery point.

Type: String

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

CreationTime

The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

Name

The name of the backup access point.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 50.

Pattern: [\da-z]{1}[\da-z-]{1,48}[\da-z]{1}(?<!-s3alias)(?<!-ext-s3alias)

RecoveryPointArn

The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.

Type: String

Pattern: (arn:aws[a-z-]*:[a-z-\d]+:[a-z-\d]+:).+

ResourceArn

The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.

Type: String

Pattern: (arn:aws[a-z-]*:[a-z-\d]+:).+

ResourceType

The type of AWS resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.

Type: String

Status

The current status of the backup access point.

Type: String

StatusMessage

A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterValueException

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

Context
Type

HTTP Status Code: 400

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

Context
Type

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

Context
Type

HTTP Status Code: 400

ResourceNotFoundException

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

Context
Type

HTTP Status Code: 400

ServiceUnavailableException

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

Context
Type

HTTP Status Code: 500