Amazonka.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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

This operation 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

data DescribeBandwidthRateLimit

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

See: newDescribeBandwidthRateLimit smart constructor.

Constructors

DescribeBandwidthRateLimit'

Fields

• gatewayARN :: Text

Instances

ToJSON DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

toJSON :: DescribeBandwidthRateLimit -> Value

toEncoding :: DescribeBandwidthRateLimit -> Encoding

toJSONList :: [DescribeBandwidthRateLimit] -> Value

toEncodingList :: [DescribeBandwidthRateLimit] -> Encoding

ToHeaders DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

toHeaders :: DescribeBandwidthRateLimit -> [Header]

ToPath DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

toPath :: DescribeBandwidthRateLimit -> ByteString

ToQuery DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

toQuery :: DescribeBandwidthRateLimit -> QueryString

AWSRequest DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Associated Types

type AWSResponse DescribeBandwidthRateLimit

Methods

request :: (Service -> Service) -> DescribeBandwidthRateLimit -> Request DescribeBandwidthRateLimit

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBandwidthRateLimit -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBandwidthRateLimit)))

Generic DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Associated Types

type Rep DescribeBandwidthRateLimit :: Type -> Type

Methods

from :: DescribeBandwidthRateLimit -> Rep DescribeBandwidthRateLimit x

to :: Rep DescribeBandwidthRateLimit x -> DescribeBandwidthRateLimit

Read DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

readsPrec :: Int -> ReadS DescribeBandwidthRateLimit

readList :: ReadS [DescribeBandwidthRateLimit]

readPrec :: ReadPrec DescribeBandwidthRateLimit

readListPrec :: ReadPrec [DescribeBandwidthRateLimit]

Show DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

showsPrec :: Int -> DescribeBandwidthRateLimit -> ShowS

show :: DescribeBandwidthRateLimit -> String

showList :: [DescribeBandwidthRateLimit] -> ShowS

NFData DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

rnf :: DescribeBandwidthRateLimit -> ()

Eq DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

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

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

Hashable DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

hashWithSalt :: Int -> DescribeBandwidthRateLimit -> Int

hash :: DescribeBandwidthRateLimit -> Int

type AWSResponse DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

type AWSResponse DescribeBandwidthRateLimit = DescribeBandwidthRateLimitResponse

type Rep DescribeBandwidthRateLimit

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

type Rep DescribeBandwidthRateLimit = D1 ('MetaData "DescribeBandwidthRateLimit" "Amazonka.StorageGateway.DescribeBandwidthRateLimit" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeBandwidthRateLimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeBandwidthRateLimit

Arguments

:: Text

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:

DescribeBandwidthRateLimit, describeBandwidthRateLimit_gatewayARN - Undocumented member.

Request Lenses

describeBandwidthRateLimit_gatewayARN :: Lens' DescribeBandwidthRateLimit Text

Undocumented member.

Destructuring the Response

data DescribeBandwidthRateLimitResponse

A JSON object containing the following fields:

See: newDescribeBandwidthRateLimitResponse smart constructor.

Constructors

DescribeBandwidthRateLimitResponse'

Fields

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

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

• gatewayARN :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeBandwidthRateLimitResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Associated Types

type Rep DescribeBandwidthRateLimitResponse :: Type -> Type

Methods

from :: DescribeBandwidthRateLimitResponse -> Rep DescribeBandwidthRateLimitResponse x

to :: Rep DescribeBandwidthRateLimitResponse x -> DescribeBandwidthRateLimitResponse

Read DescribeBandwidthRateLimitResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

readsPrec :: Int -> ReadS DescribeBandwidthRateLimitResponse

readList :: ReadS [DescribeBandwidthRateLimitResponse]

readPrec :: ReadPrec DescribeBandwidthRateLimitResponse

readListPrec :: ReadPrec [DescribeBandwidthRateLimitResponse]

Show DescribeBandwidthRateLimitResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

showsPrec :: Int -> DescribeBandwidthRateLimitResponse -> ShowS

show :: DescribeBandwidthRateLimitResponse -> String

showList :: [DescribeBandwidthRateLimitResponse] -> ShowS

NFData DescribeBandwidthRateLimitResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

rnf :: DescribeBandwidthRateLimitResponse -> ()

Eq DescribeBandwidthRateLimitResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

Methods

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

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

type Rep DescribeBandwidthRateLimitResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimit

type Rep DescribeBandwidthRateLimitResponse = D1 ('MetaData "DescribeBandwidthRateLimitResponse" "Amazonka.StorageGateway.DescribeBandwidthRateLimit" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeBandwidthRateLimitResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "averageDownloadRateLimitInBitsPerSec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "averageUploadRateLimitInBitsPerSec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBandwidthRateLimitResponse

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:

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.

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.

DescribeBandwidthRateLimit, describeBandwidthRateLimitResponse_gatewayARN - Undocumented member.

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

Response Lenses

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

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

describeBandwidthRateLimitResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text)

Undocumented member.

describeBandwidthRateLimitResponse_httpStatus :: Lens' DescribeBandwidthRateLimitResponse Int

The response's http status code.