Get Snapshot

redshiftserverless_get_snapshot

R Documentation

Returns information about a specific snapshot

Description

Returns information about a specific snapshot.

Usage

redshiftserverless_get_snapshot(ownerAccount, snapshotArn, snapshotName)

Arguments

ownerAccount

The owner Amazon Web Services account of a snapshot shared with another user.

snapshotArn

The Amazon Resource Name (ARN) of the snapshot to return.

snapshotName

The name of the snapshot to return.

Value

A list with the following syntax:

list(
  snapshot = 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$get_snapshot(
  ownerAccount = "string",
  snapshotArn = "string",
  snapshotName = "string"
)