Skip to content

Get Disk Snapshot

lightsail_get_disk_snapshot R Documentation

Returns information about a specific block storage disk snapshot

Description

Returns information about a specific block storage disk snapshot.

Usage

lightsail_get_disk_snapshot(diskSnapshotName)

Arguments

diskSnapshotName

[required] The name of the disk snapshot (my-disk-snapshot).

Value

A list with the following syntax:

list(
  diskSnapshot = list(
    name = "string",
    arn = "string",
    supportCode = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    location = list(
      availabilityZone = "string",
      regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
    ),
    resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    sizeInGb = 123,
    state = "pending"|"completed"|"error"|"unknown",
    progress = "string",
    fromDiskName = "string",
    fromDiskArn = "string",
    fromInstanceName = "string",
    fromInstanceArn = "string",
    isFromAutoSnapshot = TRUE|FALSE
  )
)

Request syntax

svc$get_disk_snapshot(
  diskSnapshotName = "string"
)