Get Legal Hold

backup_get_legal_hold

R Documentation

This action returns details for a specified legal hold¶

Description¶

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Usage¶

backup_get_legal_hold(LegalHoldId)

Arguments¶

LegalHoldId: [required] The ID of the legal hold.

Value¶

A list with the following syntax:

list(
  Title = "string",
  Status = "CREATING"|"ACTIVE"|"CANCELING"|"CANCELED",
  Description = "string",
  CancelDescription = "string",
  LegalHoldId = "string",
  LegalHoldArn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  CancellationDate = as.POSIXct(
    "2015-01-01"
  ),
  RetainRecordUntil = as.POSIXct(
    "2015-01-01"
  ),
  RecoveryPointSelection = list(
    VaultNames = list(
      "string"
    ),
    ResourceIdentifiers = list(
      "string"
    ),
    DateRange = list(
      FromDate = as.POSIXct(
        "2015-01-01"
      ),
      ToDate = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$get_legal_hold(
  LegalHoldId = "string"
)