Get Instance Snapshots

lightsail_get_instance_snapshots

R Documentation

Returns all instance snapshots for the user's account

Description

Returns all instance snapshots for the user's account.

Usage

lightsail_get_instance_snapshots(pageToken)

Arguments

pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial get_instance_snapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Value

A list with the following syntax:

list(
  instanceSnapshots = list(
    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"
        )
      ),
      state = "pending"|"error"|"available",
      progress = "string",
      fromAttachedDisks = list(
        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"
            )
          ),
          addOns = list(
            list(
              name = "string",
              status = "string",
              snapshotTimeOfDay = "string",
              nextSnapshotTimeOfDay = "string",
              threshold = "string",
              duration = "string"
            )
          ),
          sizeInGb = 123,
          isSystemDisk = TRUE|FALSE,
          iops = 123,
          path = "string",
          state = "pending"|"error"|"available"|"in-use"|"unknown",
          attachedTo = "string",
          isAttached = TRUE|FALSE,
          attachmentState = "string",
          gbInUse = 123,
          autoMountStatus = "Failed"|"Pending"|"Mounted"|"NotMounted"
        )
      ),
      fromInstanceName = "string",
      fromInstanceArn = "string",
      fromBlueprintId = "string",
      fromBundleId = "string",
      isFromAutoSnapshot = TRUE|FALSE,
      sizeInGb = 123
    )
  ),
  nextPageToken = "string"
)

Request syntax

svc$get_instance_snapshots(
  pageToken = "string"
)