Returns information about all block storage disks in your AWS account and region¶

Description¶

Returns information about all block storage disks in your AWS account and region.

Usage¶

lightsail_get_disks(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_disks 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(
  disks = 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"|"eu-north-1"|"eu-south-2"|"ca-central-1"|"ap-east-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"ap-southeast-3"|"ap-southeast-5"|"sa-east-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"
    )
  ),
  nextPageToken = "string"
)

Request syntax¶

svc$get_disks(
  pageToken = "string"
)