Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Creating a Request

updateBandwidthRateLimit

Arguments

:: Text

ubrlGatewayARN

-> UpdateBandwidthRateLimit

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

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

• ubrlAverageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second.
• ubrlAverageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second.
• ubrlGatewayARN - Undocumented member.

data UpdateBandwidthRateLimit

A JSON object containing one or more of the following fields:

• 'UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec'
• 'UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec'

See: updateBandwidthRateLimit smart constructor.

Instances

Eq UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

(==) :: UpdateBandwidthRateLimit -> UpdateBandwidthRateLimit -> Bool

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

Data UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

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

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

toConstr :: UpdateBandwidthRateLimit -> Constr

dataTypeOf :: UpdateBandwidthRateLimit -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

readsPrec :: Int -> ReadS UpdateBandwidthRateLimit

readList :: ReadS [UpdateBandwidthRateLimit]

readPrec :: ReadPrec UpdateBandwidthRateLimit

readListPrec :: ReadPrec [UpdateBandwidthRateLimit]

Show UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

showsPrec :: Int -> UpdateBandwidthRateLimit -> ShowS

show :: UpdateBandwidthRateLimit -> String

showList :: [UpdateBandwidthRateLimit] -> ShowS

Generic UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Associated Types

type Rep UpdateBandwidthRateLimit :: Type -> Type

Methods

from :: UpdateBandwidthRateLimit -> Rep UpdateBandwidthRateLimit x

to :: Rep UpdateBandwidthRateLimit x -> UpdateBandwidthRateLimit

Hashable UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

hashWithSalt :: Int -> UpdateBandwidthRateLimit -> Int

hash :: UpdateBandwidthRateLimit -> Int

ToJSON UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

toJSON :: UpdateBandwidthRateLimit -> Value

toEncoding :: UpdateBandwidthRateLimit -> Encoding

toJSONList :: [UpdateBandwidthRateLimit] -> Value

toEncodingList :: [UpdateBandwidthRateLimit] -> Encoding

AWSRequest UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Associated Types

type Rs UpdateBandwidthRateLimit :: Type

Methods

request :: UpdateBandwidthRateLimit -> Request UpdateBandwidthRateLimit

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

ToHeaders UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

toHeaders :: UpdateBandwidthRateLimit -> [Header]

ToPath UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

toPath :: UpdateBandwidthRateLimit -> ByteString

ToQuery UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

toQuery :: UpdateBandwidthRateLimit -> QueryString

NFData UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

rnf :: UpdateBandwidthRateLimit -> ()

type Rep UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

type Rep UpdateBandwidthRateLimit = D1 (MetaData "UpdateBandwidthRateLimit" "Network.AWS.StorageGateway.UpdateBandwidthRateLimit" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateBandwidthRateLimit'" PrefixI True) (S1 (MetaSel (Just "_ubrlAverageUploadRateLimitInBitsPerSec") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: (S1 (MetaSel (Just "_ubrlAverageDownloadRateLimitInBitsPerSec") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_ubrlGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateBandwidthRateLimit

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

type Rs UpdateBandwidthRateLimit = UpdateBandwidthRateLimitResponse

Request Lenses

ubrlAverageUploadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural)

The average upload bandwidth rate limit in bits per second.

ubrlAverageDownloadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural)

The average download bandwidth rate limit in bits per second.

ubrlGatewayARN :: Lens' UpdateBandwidthRateLimit Text

Undocumented member.

Destructuring the Response

updateBandwidthRateLimitResponse

Arguments

:: Int

ubrlrsResponseStatus

-> UpdateBandwidthRateLimitResponse

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

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

• ubrlrsGatewayARN - Undocumented member.
• ubrlrsResponseStatus - -- | The response status code.

data UpdateBandwidthRateLimitResponse

A JSON object containing the of the gateway whose throttle information was updated.

See: updateBandwidthRateLimitResponse smart constructor.

Instances

Eq UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

(==) :: UpdateBandwidthRateLimitResponse -> UpdateBandwidthRateLimitResponse -> Bool

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

Data UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

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

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

toConstr :: UpdateBandwidthRateLimitResponse -> Constr

dataTypeOf :: UpdateBandwidthRateLimitResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

readsPrec :: Int -> ReadS UpdateBandwidthRateLimitResponse

readList :: ReadS [UpdateBandwidthRateLimitResponse]

readPrec :: ReadPrec UpdateBandwidthRateLimitResponse

readListPrec :: ReadPrec [UpdateBandwidthRateLimitResponse]

Show UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

showsPrec :: Int -> UpdateBandwidthRateLimitResponse -> ShowS

show :: UpdateBandwidthRateLimitResponse -> String

showList :: [UpdateBandwidthRateLimitResponse] -> ShowS

Generic UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Associated Types

type Rep UpdateBandwidthRateLimitResponse :: Type -> Type

Methods

from :: UpdateBandwidthRateLimitResponse -> Rep UpdateBandwidthRateLimitResponse x

to :: Rep UpdateBandwidthRateLimitResponse x -> UpdateBandwidthRateLimitResponse

NFData UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

Methods

rnf :: UpdateBandwidthRateLimitResponse -> ()

type Rep UpdateBandwidthRateLimitResponse

Defined in Network.AWS.StorageGateway.UpdateBandwidthRateLimit

type Rep UpdateBandwidthRateLimitResponse = D1 (MetaData "UpdateBandwidthRateLimitResponse" "Network.AWS.StorageGateway.UpdateBandwidthRateLimit" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateBandwidthRateLimitResponse'" PrefixI True) (S1 (MetaSel (Just "_ubrlrsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ubrlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ubrlrsGatewayARN :: Lens' UpdateBandwidthRateLimitResponse (Maybe Text)

Undocumented member.

ubrlrsResponseStatus :: Lens' UpdateBandwidthRateLimitResponse Int

• - | The response status code.