storagegateway_describe_storedi_scsi_volumes: Returns the description of the gateway volumes specified in...

Description Usage Arguments Value Request syntax Examples

View source: R/storagegateway_operations.R

Description

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Usage

1

Arguments

VolumeARNs

[required] An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use list_volumes to get volume ARNs for a gateway.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
list(
  StorediSCSIVolumes = list(
    list(
      VolumeARN = "string",
      VolumeId = "string",
      VolumeType = "string",
      VolumeStatus = "string",
      VolumeAttachmentStatus = "string",
      VolumeSizeInBytes = 123,
      VolumeProgress = 123.0,
      VolumeDiskId = "string",
      SourceSnapshotId = "string",
      PreservedExistingData = TRUE|FALSE,
      VolumeiSCSIAttributes = list(
        TargetARN = "string",
        NetworkInterfaceId = "string",
        NetworkInterfacePort = 123,
        LunNumber = 123,
        ChapEnabled = TRUE|FALSE
      ),
      CreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      VolumeUsedInBytes = 123,
      KMSKey = "string",
      TargetName = "string"
    )
  )
)

Request syntax

1
2
3
4
5
svc$describe_storedi_scsi_volumes(
  VolumeARNs = list(
    "string"
  )
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# Returns the description of the gateway volumes specified in the request
# belonging to the same gateway.
svc$describe_storedi_scsi_volumes(
  VolumeARNs = list(
    "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  )
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.