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

ListBackupAccessPointsByResource

Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.

Request Syntax


POST /backup-access-point/resource/ResourceArn?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of items to be returned.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ResourceArn

The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

BackupAccessPoints

A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.

Type: Array of ListAccessPointsMember objects

NextToken

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

ServiceUnavailableException

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

Context
Type

HTTP Status Code: 500