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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

Synopsis

Creating a Request

data DescribeWorkingStorage Source #

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

See: newDescribeWorkingStorage smart constructor.

Constructors

DescribeWorkingStorage'
Fields gatewayARN :: Text

Instances

Instances details

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

newDescribeWorkingStorage Source #

Arguments

:: Text	`$sel:gatewayARN:DescribeWorkingStorage'`
-> DescribeWorkingStorage

Create a value of DescribeWorkingStorage 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:DescribeWorkingStorage', describeWorkingStorage_gatewayARN - Undocumented member.

Request Lenses

describeWorkingStorage_gatewayARN :: Lens' DescribeWorkingStorage Text Source #

Undocumented member.

Destructuring the Response

data DescribeWorkingStorageResponse Source #

A JSON object containing the following fields:

See: newDescribeWorkingStorageResponse smart constructor.

Constructors

DescribeWorkingStorageResponse'

Fields

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.
workingStorageAllocatedInBytes :: Maybe Integer
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
workingStorageUsedInBytes :: Maybe Integer
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeWorkingStorageResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeWorkingStorageResponse'`
-> DescribeWorkingStorageResponse

Create a value of DescribeWorkingStorageResponse 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:DescribeWorkingStorage', describeWorkingStorageResponse_gatewayARN - Undocumented member.

$sel:diskIds:DescribeWorkingStorageResponse', describeWorkingStorageResponse_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:workingStorageAllocatedInBytes:DescribeWorkingStorageResponse', describeWorkingStorageResponse_workingStorageAllocatedInBytes - The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

$sel:workingStorageUsedInBytes:DescribeWorkingStorageResponse', describeWorkingStorageResponse_workingStorageUsedInBytes - The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

$sel:httpStatus:DescribeWorkingStorageResponse', describeWorkingStorageResponse_httpStatus - The response's http status code.

Response Lenses

describeWorkingStorageResponse_gatewayARN :: Lens' DescribeWorkingStorageResponse (Maybe Text) Source #

Undocumented member.

describeWorkingStorageResponse_diskIds :: Lens' DescribeWorkingStorageResponse (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.

describeWorkingStorageResponse_workingStorageAllocatedInBytes :: Lens' DescribeWorkingStorageResponse (Maybe Integer) Source #

The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

describeWorkingStorageResponse_workingStorageUsedInBytes :: Lens' DescribeWorkingStorageResponse (Maybe Integer) Source #

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

describeWorkingStorageResponse_httpStatus :: Lens' DescribeWorkingStorageResponse Int Source #

The response's http status code.