Skip to content

This action returns metadata about active and previous legal holds

Description

This action returns metadata about active and previous legal holds.

Usage

backup_list_legal_holds(NextToken, MaxResults)

Arguments

  • NextToken

    The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, 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.

Value

A list with the following syntax:

list(
  NextToken = "string",
  LegalHolds = list(
    list(
      Title = "string",
      Status = "CREATING"|"ACTIVE"|"CANCELING"|"CANCELED",
      Description = "string",
      LegalHoldId = "string",
      LegalHoldArn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      CancellationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_legal_holds(
  NextToken = "string",
  MaxResults = 123
)