paws.storage (version 0.1.12)

storagegateway_describe_upload_buffer: Returns information about the upload buffer of a gateway

Description

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Usage

storagegateway_describe_upload_buffer(GatewayARN)

Value

A list with the following syntax:

list(
  GatewayARN = "string",
  DiskIds = list(
    "string"
  ),
  UploadBufferUsedInBytes = 123,
  UploadBufferAllocatedInBytes = 123
)

Arguments

GatewayARN

[required]

Request syntax

svc$describe_upload_buffer(
  GatewayARN = "string"
)

Examples

if (FALSE) {
# Returns information about the upload buffer of a gateway including disk
# IDs and the amount of upload buffer space allocated/used.
svc$describe_upload_buffer(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
)

# Returns information about the upload buffer of a gateway including disk
# IDs and the amount of upload buffer space allocated and used.
svc$describe_upload_buffer(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
)
}