Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StorageGateway.DescribeUploadBuffer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

Creating a Request

data DescribeUploadBuffer Source #

See: newDescribeUploadBuffer smart constructor.

Constructors

DescribeUploadBuffer'
Fields gatewayARN :: Text

Instances

Instances details

Eq DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods (==) :: DescribeUploadBuffer -> DescribeUploadBuffer -> Bool # (/=) :: DescribeUploadBuffer -> DescribeUploadBuffer -> Bool #
Read DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods readsPrec :: Int -> ReadS DescribeUploadBuffer # readList :: ReadS [DescribeUploadBuffer] # readPrec :: ReadPrec DescribeUploadBuffer # readListPrec :: ReadPrec [DescribeUploadBuffer] #
Show DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods showsPrec :: Int -> DescribeUploadBuffer -> ShowS # show :: DescribeUploadBuffer -> String # showList :: [DescribeUploadBuffer] -> ShowS #
Generic DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Associated Types type Rep DescribeUploadBuffer :: Type -> Type # Methods from :: DescribeUploadBuffer -> Rep DescribeUploadBuffer x # to :: Rep DescribeUploadBuffer x -> DescribeUploadBuffer #
NFData DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods rnf :: DescribeUploadBuffer -> () #
Hashable DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods hashWithSalt :: Int -> DescribeUploadBuffer -> Int # hash :: DescribeUploadBuffer -> Int #
ToJSON DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods toJSON :: DescribeUploadBuffer -> Value # toEncoding :: DescribeUploadBuffer -> Encoding # toJSONList :: [DescribeUploadBuffer] -> Value # toEncodingList :: [DescribeUploadBuffer] -> Encoding #
AWSRequest DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Associated Types type AWSResponse DescribeUploadBuffer # Methods request :: DescribeUploadBuffer -> Request DescribeUploadBuffer # response :: MonadResource m => Logger -> Service -> Proxy DescribeUploadBuffer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUploadBuffer))) #
ToHeaders DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods toHeaders :: DescribeUploadBuffer -> [Header] #
ToPath DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods toPath :: DescribeUploadBuffer -> ByteString #
ToQuery DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods toQuery :: DescribeUploadBuffer -> QueryString #
type Rep DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer type Rep DescribeUploadBuffer = D1 ('MetaData "DescribeUploadBuffer" "Amazonka.StorageGateway.DescribeUploadBuffer" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeUploadBuffer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeUploadBuffer Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer type AWSResponse DescribeUploadBuffer = DescribeUploadBufferResponse

newDescribeUploadBuffer Source #

Arguments

:: Text	`$sel:gatewayARN: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:

$sel:gatewayARN:DescribeUploadBuffer', describeUploadBuffer_gatewayARN - Undocumented member.

Request Lenses

describeUploadBuffer_gatewayARN :: Lens' DescribeUploadBuffer Text Source #

Undocumented member.

Destructuring the Response

data DescribeUploadBufferResponse Source #

See: newDescribeUploadBufferResponse smart constructor.

Constructors

DescribeUploadBufferResponse'

Fields

uploadBufferAllocatedInBytes :: Maybe Integer
The total number of bytes allocated in the gateway's as upload buffer.
gatewayARN :: Maybe Text
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.
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

Instances details

Eq DescribeUploadBufferResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods (==) :: DescribeUploadBufferResponse -> DescribeUploadBufferResponse -> Bool # (/=) :: DescribeUploadBufferResponse -> DescribeUploadBufferResponse -> Bool #
Read DescribeUploadBufferResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods readsPrec :: Int -> ReadS DescribeUploadBufferResponse # readList :: ReadS [DescribeUploadBufferResponse] # readPrec :: ReadPrec DescribeUploadBufferResponse # readListPrec :: ReadPrec [DescribeUploadBufferResponse] #
Show DescribeUploadBufferResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods showsPrec :: Int -> DescribeUploadBufferResponse -> ShowS # show :: DescribeUploadBufferResponse -> String # showList :: [DescribeUploadBufferResponse] -> ShowS #
Generic DescribeUploadBufferResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Associated Types type Rep DescribeUploadBufferResponse :: Type -> Type # Methods from :: DescribeUploadBufferResponse -> Rep DescribeUploadBufferResponse x # to :: Rep DescribeUploadBufferResponse x -> DescribeUploadBufferResponse #
NFData DescribeUploadBufferResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer Methods rnf :: DescribeUploadBufferResponse -> () #
type Rep DescribeUploadBufferResponse Source #
Instance details Defined in Amazonka.StorageGateway.DescribeUploadBuffer type Rep DescribeUploadBufferResponse = D1 ('MetaData "DescribeUploadBufferResponse" "Amazonka.StorageGateway.DescribeUploadBuffer" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DescribeUploadBufferResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "uploadBufferAllocatedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "diskIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "uploadBufferUsedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeUploadBufferResponse Source #

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:uploadBufferAllocatedInBytes:DescribeUploadBufferResponse', describeUploadBufferResponse_uploadBufferAllocatedInBytes - The total number of bytes allocated in the gateway's as upload buffer.

$sel:gatewayARN:DescribeUploadBuffer', describeUploadBufferResponse_gatewayARN - Undocumented member.

$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.

$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_uploadBufferAllocatedInBytes :: Lens' DescribeUploadBufferResponse (Maybe Integer) Source #

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

describeUploadBufferResponse_gatewayARN :: Lens' DescribeUploadBufferResponse (Maybe Text) Source #

Undocumented member.

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

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_uploadBufferUsedInBytes :: Lens' DescribeUploadBufferResponse (Maybe Integer) Source #

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

describeUploadBufferResponse_httpStatus :: Lens' DescribeUploadBufferResponse Int Source #

The response's http status code.