Describe Upload Buffer

storagegateway_describe_upload_buffer

R Documentation

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)

Arguments¶

GatewayARN: [required]

Value¶

A list with the following syntax:

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

Request syntax¶

svc$describe_upload_buffer(
  GatewayARN = "string"
)

Examples¶

## Not run: 
# 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"
)

## End(Not run)