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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume, and tape gateway types.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Synopsis

data DescribeBandwidthRateLimit = DescribeBandwidthRateLimit' {
- gatewayARN :: Text
}
newDescribeBandwidthRateLimit :: Text -> DescribeBandwidthRateLimit
describeBandwidthRateLimit_gatewayARN :: Lens' DescribeBandwidthRateLimit Text
data DescribeBandwidthRateLimitResponse = DescribeBandwidthRateLimitResponse' {
}
newDescribeBandwidthRateLimitResponse :: Int -> DescribeBandwidthRateLimitResponse
describeBandwidthRateLimitResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text)
describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural)
describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural)
describeBandwidthRateLimitResponse_httpStatus :: Lens' DescribeBandwidthRateLimitResponse Int

Creating a Request

data DescribeBandwidthRateLimit Source #

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

See: newDescribeBandwidthRateLimit smart constructor.

Constructors

DescribeBandwidthRateLimit'
Fields gatewayARN :: Text

Instances

Instances details

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

newDescribeBandwidthRateLimit Source #

Arguments

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

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

Request Lenses

describeBandwidthRateLimit_gatewayARN :: Lens' DescribeBandwidthRateLimit Text Source #

Undocumented member.

Destructuring the Response

data DescribeBandwidthRateLimitResponse Source #

A JSON object containing the following fields:

See: newDescribeBandwidthRateLimitResponse smart constructor.

Constructors

DescribeBandwidthRateLimitResponse'

Fields

gatewayARN :: Maybe Text
averageUploadRateLimitInBitsPerSec :: Maybe Natural
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
averageDownloadRateLimitInBitsPerSec :: Maybe Natural
The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeBandwidthRateLimitResponse Source #

Arguments

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

Create a value of DescribeBandwidthRateLimitResponse 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:DescribeBandwidthRateLimit', describeBandwidthRateLimitResponse_gatewayARN - Undocumented member.

$sel:averageUploadRateLimitInBitsPerSec:DescribeBandwidthRateLimitResponse', describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

$sel:averageDownloadRateLimitInBitsPerSec:DescribeBandwidthRateLimitResponse', describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

$sel:httpStatus:DescribeBandwidthRateLimitResponse', describeBandwidthRateLimitResponse_httpStatus - The response's http status code.

Response Lenses

describeBandwidthRateLimitResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text) Source #

Undocumented member.

describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural) Source #

The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural) Source #

The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

describeBandwidthRateLimitResponse_httpStatus :: Lens' DescribeBandwidthRateLimitResponse Int Source #

The response's http status code.