Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRecoveryPoints

Returns an array of recovery points.

Request Syntax


{
   "endTime": number,
   "maxResults": number,
   "namespaceArn": "string",
   "namespaceName": "string",
   "nextToken": "string",
   "startTime": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTime

The time when creation of the recovery point finished.

Type: Timestamp

Required: No

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

Type: Integer

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

Required: No

namespaceArn

The Amazon Resource Name (ARN) of the namespace from which to list recovery points.

Type: String

Required: No

namespaceName

The name of the namespace to list recovery points for.

Type: String

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

Pattern: ^[a-z0-9-]+$

Required: No

nextToken

If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.

Type: String

Required: No

startTime

The time when the recovery point's creation was initiated.

Type: Timestamp

Required: No

Response Syntax


{
   "nextToken": "string",
   "recoveryPoints": [ 
      { 
         "namespaceArn": "string",
         "namespaceName": "string",
         "recoveryPointCreateTime": "string",
         "recoveryPointId": "string",
         "totalSizeInMegaBytes": number,
         "workgroupName": "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.

nextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

recoveryPoints

The returned recovery point objects.

Type: Array of RecoveryPoint objects

Errors

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

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400