Skip to content

Lists the active backup plans for the account

Description

Lists the active backup plans for the account.

Usage

backup_list_backup_plans(NextToken, MaxResults, IncludeDeleted)

Arguments

  • 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.

  • MaxResults

    The maximum number of items to be returned.

  • IncludeDeleted

    A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Value

A list with the following syntax:

list(
  NextToken = "string",
  BackupPlansList = list(
    list(
      BackupPlanArn = "string",
      BackupPlanId = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      DeletionDate = as.POSIXct(
        "2015-01-01"
      ),
      VersionId = "string",
      BackupPlanName = "string",
      CreatorRequestId = "string",
      LastExecutionDate = as.POSIXct(
        "2015-01-01"
      ),
      AdvancedBackupSettings = list(
        list(
          ResourceType = "string",
          BackupOptions = list(
            "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$list_backup_plans(
  NextToken = "string",
  MaxResults = 123,
  IncludeDeleted = TRUE|FALSE
)