List Snapshots

redshiftserverless_list_snapshots

R Documentation

Returns a list of snapshots

Description

Returns a list of snapshots.

Usage

redshiftserverless_list_snapshots(endTime, maxResults, namespaceArn,
  namespaceName, nextToken, ownerAccount, startTime)

Arguments

endTime

The timestamp showing when the snapshot creation finished.

maxResults

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

namespaceArn

The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

namespaceName

The namespace from which to list all snapshots.

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.

ownerAccount

The owner Amazon Web Services account of the snapshot.

startTime

The time when the creation of the snapshot was initiated.

Value

A list with the following syntax:

list(
  nextToken = "string",
  snapshots = list(
    list(
      accountsWithProvisionedRestoreAccess = list(
        "string"
      ),
      accountsWithRestoreAccess = list(
        "string"
      ),
      actualIncrementalBackupSizeInMegaBytes = 123.0,
      adminPasswordSecretArn = "string",
      adminPasswordSecretKmsKeyId = "string",
      adminUsername = "string",
      backupProgressInMegaBytes = 123.0,
      currentBackupRateInMegaBytesPerSecond = 123.0,
      elapsedTimeInSeconds = 123,
      estimatedSecondsToCompletion = 123,
      kmsKeyId = "string",
      namespaceArn = "string",
      namespaceName = "string",
      ownerAccount = "string",
      snapshotArn = "string",
      snapshotCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      snapshotName = "string",
      snapshotRemainingDays = 123,
      snapshotRetentionPeriod = 123,
      snapshotRetentionStartTime = as.POSIXct(
        "2015-01-01"
      ),
      status = "AVAILABLE"|"CREATING"|"DELETED"|"CANCELLED"|"FAILED"|"COPYING",
      totalBackupSizeInMegaBytes = 123.0
    )
  )
)

Request syntax

svc$list_snapshots(
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  maxResults = 123,
  namespaceArn = "string",
  namespaceName = "string",
  nextToken = "string",
  ownerAccount = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  )
)