Network.AWS.StorageGateway.DescribeBandwidthRateLimit

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

Creating a Request

describeBandwidthRateLimit

Arguments

:: Text

dbrlGatewayARN

-> DescribeBandwidthRateLimit

Creates a value of DescribeBandwidthRateLimit with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dbrlGatewayARN - Undocumented member.

data DescribeBandwidthRateLimit

A JSON object containing the of the gateway.

See: describeBandwidthRateLimit smart constructor.

Instances

Eq DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

(==) :: DescribeBandwidthRateLimit -> DescribeBandwidthRateLimit -> Bool

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

Data DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeBandwidthRateLimit -> c DescribeBandwidthRateLimit

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeBandwidthRateLimit

toConstr :: DescribeBandwidthRateLimit -> Constr

dataTypeOf :: DescribeBandwidthRateLimit -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeBandwidthRateLimit)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeBandwidthRateLimit)

gmapT :: (forall b. Data b => b -> b) -> DescribeBandwidthRateLimit -> DescribeBandwidthRateLimit

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBandwidthRateLimit -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBandwidthRateLimit -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeBandwidthRateLimit -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeBandwidthRateLimit -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeBandwidthRateLimit -> m DescribeBandwidthRateLimit

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBandwidthRateLimit -> m DescribeBandwidthRateLimit

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBandwidthRateLimit -> m DescribeBandwidthRateLimit

Read DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

readsPrec :: Int -> ReadS DescribeBandwidthRateLimit

readList :: ReadS [DescribeBandwidthRateLimit]

readPrec :: ReadPrec DescribeBandwidthRateLimit

readListPrec :: ReadPrec [DescribeBandwidthRateLimit]

Show DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

showsPrec :: Int -> DescribeBandwidthRateLimit -> ShowS

show :: DescribeBandwidthRateLimit -> String

showList :: [DescribeBandwidthRateLimit] -> ShowS

Generic DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Associated Types

type Rep DescribeBandwidthRateLimit :: Type -> Type

Methods

from :: DescribeBandwidthRateLimit -> Rep DescribeBandwidthRateLimit x

to :: Rep DescribeBandwidthRateLimit x -> DescribeBandwidthRateLimit

Hashable DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

hashWithSalt :: Int -> DescribeBandwidthRateLimit -> Int

hash :: DescribeBandwidthRateLimit -> Int

ToJSON DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

toJSON :: DescribeBandwidthRateLimit -> Value

toEncoding :: DescribeBandwidthRateLimit -> Encoding

toJSONList :: [DescribeBandwidthRateLimit] -> Value

toEncodingList :: [DescribeBandwidthRateLimit] -> Encoding

AWSRequest DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Associated Types

type Rs DescribeBandwidthRateLimit :: Type

Methods

request :: DescribeBandwidthRateLimit -> Request DescribeBandwidthRateLimit

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeBandwidthRateLimit -> ClientResponse -> m (Response DescribeBandwidthRateLimit)

ToHeaders DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

toHeaders :: DescribeBandwidthRateLimit -> [Header]

ToPath DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

toPath :: DescribeBandwidthRateLimit -> ByteString

ToQuery DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

toQuery :: DescribeBandwidthRateLimit -> QueryString

NFData DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

rnf :: DescribeBandwidthRateLimit -> ()

type Rep DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

type Rep DescribeBandwidthRateLimit = D1 (MetaData "DescribeBandwidthRateLimit" "Network.AWS.StorageGateway.DescribeBandwidthRateLimit" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" True) (C1 (MetaCons "DescribeBandwidthRateLimit'" PrefixI True) (S1 (MetaSel (Just "_dbrlGatewayARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs DescribeBandwidthRateLimit

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

type Rs DescribeBandwidthRateLimit = DescribeBandwidthRateLimitResponse

Request Lenses

dbrlGatewayARN :: Lens' DescribeBandwidthRateLimit Text

Undocumented member.

Destructuring the Response

describeBandwidthRateLimitResponse

Arguments

:: Int

dbrlrsResponseStatus

-> DescribeBandwidthRateLimitResponse

Creates a value of DescribeBandwidthRateLimitResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dbrlrsGatewayARN - Undocumented member.
• dbrlrsAverageUploadRateLimitInBitsPerSec - 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.
• dbrlrsAverageDownloadRateLimitInBitsPerSec - 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.
• dbrlrsResponseStatus - -- | The response status code.

data DescribeBandwidthRateLimitResponse

A JSON object containing the following fields:

See: describeBandwidthRateLimitResponse smart constructor.

Instances

Eq DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

(==) :: DescribeBandwidthRateLimitResponse -> DescribeBandwidthRateLimitResponse -> Bool

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

Data DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeBandwidthRateLimitResponse -> c DescribeBandwidthRateLimitResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeBandwidthRateLimitResponse

toConstr :: DescribeBandwidthRateLimitResponse -> Constr

dataTypeOf :: DescribeBandwidthRateLimitResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeBandwidthRateLimitResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeBandwidthRateLimitResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeBandwidthRateLimitResponse -> DescribeBandwidthRateLimitResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBandwidthRateLimitResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBandwidthRateLimitResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeBandwidthRateLimitResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeBandwidthRateLimitResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeBandwidthRateLimitResponse -> m DescribeBandwidthRateLimitResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBandwidthRateLimitResponse -> m DescribeBandwidthRateLimitResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBandwidthRateLimitResponse -> m DescribeBandwidthRateLimitResponse

Read DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

readsPrec :: Int -> ReadS DescribeBandwidthRateLimitResponse

readList :: ReadS [DescribeBandwidthRateLimitResponse]

readPrec :: ReadPrec DescribeBandwidthRateLimitResponse

readListPrec :: ReadPrec [DescribeBandwidthRateLimitResponse]

Show DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

showsPrec :: Int -> DescribeBandwidthRateLimitResponse -> ShowS

show :: DescribeBandwidthRateLimitResponse -> String

showList :: [DescribeBandwidthRateLimitResponse] -> ShowS

Generic DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Associated Types

type Rep DescribeBandwidthRateLimitResponse :: Type -> Type

Methods

from :: DescribeBandwidthRateLimitResponse -> Rep DescribeBandwidthRateLimitResponse x

to :: Rep DescribeBandwidthRateLimitResponse x -> DescribeBandwidthRateLimitResponse

NFData DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

Methods

rnf :: DescribeBandwidthRateLimitResponse -> ()

type Rep DescribeBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.DescribeBandwidthRateLimit

type Rep DescribeBandwidthRateLimitResponse = D1 (MetaData "DescribeBandwidthRateLimitResponse" "Network.AWS.StorageGateway.DescribeBandwidthRateLimit" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "DescribeBandwidthRateLimitResponse'" PrefixI True) ((S1 (MetaSel (Just "_dbrlrsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dbrlrsAverageUploadRateLimitInBitsPerSec") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :*: (S1 (MetaSel (Just "_dbrlrsAverageDownloadRateLimitInBitsPerSec") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_dbrlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dbrlrsGatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text)

Undocumented member.

dbrlrsAverageUploadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (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.

dbrlrsAverageDownloadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (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.

dbrlrsResponseStatus :: Lens' DescribeBandwidthRateLimitResponse Int

• - | The response status code.