Skip to content

List Indexed Recovery Points

backup_list_indexed_recovery_points R Documentation

This operation returns a list of recovery points that have an associated index, belonging to the specified account

Description

This operation returns a list of recovery points that have an associated index, belonging to the specified account.

Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

Usage

backup_list_indexed_recovery_points(NextToken, MaxResults,
  SourceResourceArn, CreatedBefore, CreatedAfter, ResourceType,
  IndexStatus)

Arguments

NextToken

The next item following a partial list of returned recovery points.

For example, if a request is made to return MaxResults number of indexed recovery points, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

MaxResults

The maximum number of resource list items to be returned.

SourceResourceArn

A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

CreatedBefore

Returns only indexed recovery points that were created before the specified date.

CreatedAfter

Returns only indexed recovery points that were created after the specified date.

ResourceType

Returns a list of indexed recovery points for the specified resource type(s).

Accepted values include:

  • EBS for Amazon Elastic Block Store

  • S3 for Amazon Simple Storage Service (Amazon S3)

IndexStatus

Include this parameter to filter the returned list by the indicated statuses.

Accepted values: PENDING | ACTIVE | FAILED | DELETING

A recovery point with an index that has the status of ACTIVE can be included in a search.

Value

A list with the following syntax: 

list(
  IndexedRecoveryPoints = list(
    list(
      RecoveryPointArn = "string",
      SourceResourceArn = "string",
      IamRoleArn = "string",
      BackupCreationDate = as.POSIXct(
        "2015-01-01"
      ),
      ResourceType = "string",
      IndexCreationDate = as.POSIXct(
        "2015-01-01"
      ),
      IndexStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING",
      IndexStatusMessage = "string",
      BackupVaultArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_indexed_recovery_points(
  NextToken = "string",
  MaxResults = 123,
  SourceResourceArn = "string",
  CreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  ResourceType = "string",
  IndexStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"
)