Amazonka.StorageGateway.DescribeUploadBuffer

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.

Creating a Request

data DescribeUploadBuffer

See: newDescribeUploadBuffer smart constructor.

Constructors

DescribeUploadBuffer'

Fields

• gatewayARN :: Text

Instances

ToJSON DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

toJSON :: DescribeUploadBuffer -> Value

toEncoding :: DescribeUploadBuffer -> Encoding

toJSONList :: [DescribeUploadBuffer] -> Value

toEncodingList :: [DescribeUploadBuffer] -> Encoding

ToHeaders DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

toHeaders :: DescribeUploadBuffer -> [Header]

ToPath DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

toPath :: DescribeUploadBuffer -> ByteString

ToQuery DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

toQuery :: DescribeUploadBuffer -> QueryString

AWSRequest DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Associated Types

type AWSResponse DescribeUploadBuffer

Methods

request :: (Service -> Service) -> DescribeUploadBuffer -> Request DescribeUploadBuffer

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUploadBuffer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUploadBuffer)))

Generic DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Associated Types

type Rep DescribeUploadBuffer :: Type -> Type

Methods

from :: DescribeUploadBuffer -> Rep DescribeUploadBuffer x

to :: Rep DescribeUploadBuffer x -> DescribeUploadBuffer

Read DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

readsPrec :: Int -> ReadS DescribeUploadBuffer

readList :: ReadS [DescribeUploadBuffer]

readPrec :: ReadPrec DescribeUploadBuffer

readListPrec :: ReadPrec [DescribeUploadBuffer]

Show DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

showsPrec :: Int -> DescribeUploadBuffer -> ShowS

show :: DescribeUploadBuffer -> String

showList :: [DescribeUploadBuffer] -> ShowS

NFData DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

rnf :: DescribeUploadBuffer -> ()

Eq DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

(==) :: DescribeUploadBuffer -> DescribeUploadBuffer -> Bool

(/=) :: DescribeUploadBuffer -> DescribeUploadBuffer -> Bool

Hashable DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

hashWithSalt :: Int -> DescribeUploadBuffer -> Int

hash :: DescribeUploadBuffer -> Int

type AWSResponse DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

type AWSResponse DescribeUploadBuffer = DescribeUploadBufferResponse

type Rep DescribeUploadBuffer

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

type Rep DescribeUploadBuffer = D1 ('MetaData "DescribeUploadBuffer" "Amazonka.StorageGateway.DescribeUploadBuffer" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeUploadBuffer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeUploadBuffer

Arguments

:: Text

DescribeUploadBuffer

-> DescribeUploadBuffer

Create a value of DescribeUploadBuffer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeUploadBuffer, describeUploadBuffer_gatewayARN - Undocumented member.

Request Lenses

describeUploadBuffer_gatewayARN :: Lens' DescribeUploadBuffer Text

Undocumented member.

Destructuring the Response

data DescribeUploadBufferResponse

See: newDescribeUploadBufferResponse smart constructor.

Constructors

DescribeUploadBufferResponse'

Fields

• diskIds :: Maybe [Text]

  An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

• gatewayARN :: Maybe Text
• uploadBufferAllocatedInBytes :: Maybe Integer

  The total number of bytes allocated in the gateway's as upload buffer.

• uploadBufferUsedInBytes :: Maybe Integer

  The total number of bytes being used in the gateway's upload buffer.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeUploadBufferResponse

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Associated Types

type Rep DescribeUploadBufferResponse :: Type -> Type

Methods

from :: DescribeUploadBufferResponse -> Rep DescribeUploadBufferResponse x

to :: Rep DescribeUploadBufferResponse x -> DescribeUploadBufferResponse

Read DescribeUploadBufferResponse

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

readsPrec :: Int -> ReadS DescribeUploadBufferResponse

readList :: ReadS [DescribeUploadBufferResponse]

readPrec :: ReadPrec DescribeUploadBufferResponse

readListPrec :: ReadPrec [DescribeUploadBufferResponse]

Show DescribeUploadBufferResponse

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

showsPrec :: Int -> DescribeUploadBufferResponse -> ShowS

show :: DescribeUploadBufferResponse -> String

showList :: [DescribeUploadBufferResponse] -> ShowS

NFData DescribeUploadBufferResponse

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

rnf :: DescribeUploadBufferResponse -> ()

Eq DescribeUploadBufferResponse

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

Methods

(==) :: DescribeUploadBufferResponse -> DescribeUploadBufferResponse -> Bool

(/=) :: DescribeUploadBufferResponse -> DescribeUploadBufferResponse -> Bool

type Rep DescribeUploadBufferResponse

Defined in Amazonka.StorageGateway.DescribeUploadBuffer

type Rep DescribeUploadBufferResponse = D1 ('MetaData "DescribeUploadBufferResponse" "Amazonka.StorageGateway.DescribeUploadBuffer" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeUploadBufferResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "diskIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "uploadBufferAllocatedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "uploadBufferUsedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeUploadBufferResponse

Arguments

:: Int

$sel:httpStatus:DescribeUploadBufferResponse'

-> DescribeUploadBufferResponse

Create a value of DescribeUploadBufferResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:diskIds:DescribeUploadBufferResponse', describeUploadBufferResponse_diskIds - An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

DescribeUploadBuffer, describeUploadBufferResponse_gatewayARN - Undocumented member.

$sel:uploadBufferAllocatedInBytes:DescribeUploadBufferResponse', describeUploadBufferResponse_uploadBufferAllocatedInBytes - The total number of bytes allocated in the gateway's as upload buffer.

$sel:uploadBufferUsedInBytes:DescribeUploadBufferResponse', describeUploadBufferResponse_uploadBufferUsedInBytes - The total number of bytes being used in the gateway's upload buffer.

$sel:httpStatus:DescribeUploadBufferResponse', describeUploadBufferResponse_httpStatus - The response's http status code.

Response Lenses

describeUploadBufferResponse_diskIds :: Lens' DescribeUploadBufferResponse (Maybe [Text])

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

describeUploadBufferResponse_gatewayARN :: Lens' DescribeUploadBufferResponse (Maybe Text)

Undocumented member.

describeUploadBufferResponse_uploadBufferAllocatedInBytes :: Lens' DescribeUploadBufferResponse (Maybe Integer)

The total number of bytes allocated in the gateway's as upload buffer.

describeUploadBufferResponse_uploadBufferUsedInBytes :: Lens' DescribeUploadBufferResponse (Maybe Integer)

The total number of bytes being used in the gateway's upload buffer.

describeUploadBufferResponse_httpStatus :: Lens' DescribeUploadBufferResponse Int

The response's http status code.