Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.

This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading

If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Creating a Request

data DescribeBandwidthRateLimitSchedule

See: newDescribeBandwidthRateLimitSchedule smart constructor.

Constructors

DescribeBandwidthRateLimitSchedule'

Fields

• gatewayARN :: Text

Instances

ToJSON DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

toJSON :: DescribeBandwidthRateLimitSchedule -> Value

toEncoding :: DescribeBandwidthRateLimitSchedule -> Encoding

toJSONList :: [DescribeBandwidthRateLimitSchedule] -> Value

toEncodingList :: [DescribeBandwidthRateLimitSchedule] -> Encoding

ToHeaders DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

toHeaders :: DescribeBandwidthRateLimitSchedule -> [Header]

ToPath DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

toPath :: DescribeBandwidthRateLimitSchedule -> ByteString

ToQuery DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

toQuery :: DescribeBandwidthRateLimitSchedule -> QueryString

AWSRequest DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Associated Types

type AWSResponse DescribeBandwidthRateLimitSchedule

Methods

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

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

Generic DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Associated Types

type Rep DescribeBandwidthRateLimitSchedule :: Type -> Type

Methods

from :: DescribeBandwidthRateLimitSchedule -> Rep DescribeBandwidthRateLimitSchedule x

to :: Rep DescribeBandwidthRateLimitSchedule x -> DescribeBandwidthRateLimitSchedule

Read DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

readsPrec :: Int -> ReadS DescribeBandwidthRateLimitSchedule

readList :: ReadS [DescribeBandwidthRateLimitSchedule]

readPrec :: ReadPrec DescribeBandwidthRateLimitSchedule

readListPrec :: ReadPrec [DescribeBandwidthRateLimitSchedule]

Show DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

showsPrec :: Int -> DescribeBandwidthRateLimitSchedule -> ShowS

show :: DescribeBandwidthRateLimitSchedule -> String

showList :: [DescribeBandwidthRateLimitSchedule] -> ShowS

NFData DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

rnf :: DescribeBandwidthRateLimitSchedule -> ()

Eq DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

(==) :: DescribeBandwidthRateLimitSchedule -> DescribeBandwidthRateLimitSchedule -> Bool

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

Hashable DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

hashWithSalt :: Int -> DescribeBandwidthRateLimitSchedule -> Int

hash :: DescribeBandwidthRateLimitSchedule -> Int

type AWSResponse DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

type AWSResponse DescribeBandwidthRateLimitSchedule = DescribeBandwidthRateLimitScheduleResponse

type Rep DescribeBandwidthRateLimitSchedule

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

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

newDescribeBandwidthRateLimitSchedule

Arguments

:: Text

DescribeBandwidthRateLimitSchedule

-> DescribeBandwidthRateLimitSchedule

Create a value of DescribeBandwidthRateLimitSchedule 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:

DescribeBandwidthRateLimitSchedule, describeBandwidthRateLimitSchedule_gatewayARN - Undocumented member.

Request Lenses

describeBandwidthRateLimitSchedule_gatewayARN :: Lens' DescribeBandwidthRateLimitSchedule Text

Undocumented member.

Destructuring the Response

data DescribeBandwidthRateLimitScheduleResponse

See: newDescribeBandwidthRateLimitScheduleResponse smart constructor.

Constructors

DescribeBandwidthRateLimitScheduleResponse'

Fields

• bandwidthRateLimitIntervals :: Maybe [BandwidthRateLimitInterval]

  An array that contains the bandwidth rate limit intervals for a tape or volume gateway.

• gatewayARN :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeBandwidthRateLimitScheduleResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Associated Types

type Rep DescribeBandwidthRateLimitScheduleResponse :: Type -> Type

Methods

from :: DescribeBandwidthRateLimitScheduleResponse -> Rep DescribeBandwidthRateLimitScheduleResponse x

to :: Rep DescribeBandwidthRateLimitScheduleResponse x -> DescribeBandwidthRateLimitScheduleResponse

Read DescribeBandwidthRateLimitScheduleResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

readsPrec :: Int -> ReadS DescribeBandwidthRateLimitScheduleResponse

readList :: ReadS [DescribeBandwidthRateLimitScheduleResponse]

readPrec :: ReadPrec DescribeBandwidthRateLimitScheduleResponse

readListPrec :: ReadPrec [DescribeBandwidthRateLimitScheduleResponse]

Show DescribeBandwidthRateLimitScheduleResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

showsPrec :: Int -> DescribeBandwidthRateLimitScheduleResponse -> ShowS

show :: DescribeBandwidthRateLimitScheduleResponse -> String

showList :: [DescribeBandwidthRateLimitScheduleResponse] -> ShowS

NFData DescribeBandwidthRateLimitScheduleResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

rnf :: DescribeBandwidthRateLimitScheduleResponse -> ()

Eq DescribeBandwidthRateLimitScheduleResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

Methods

(==) :: DescribeBandwidthRateLimitScheduleResponse -> DescribeBandwidthRateLimitScheduleResponse -> Bool

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

type Rep DescribeBandwidthRateLimitScheduleResponse

Defined in Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule

type Rep DescribeBandwidthRateLimitScheduleResponse = D1 ('MetaData "DescribeBandwidthRateLimitScheduleResponse" "Amazonka.StorageGateway.DescribeBandwidthRateLimitSchedule" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeBandwidthRateLimitScheduleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bandwidthRateLimitIntervals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BandwidthRateLimitInterval])) :*: (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBandwidthRateLimitScheduleResponse

Arguments

:: Int

$sel:httpStatus:DescribeBandwidthRateLimitScheduleResponse'

-> DescribeBandwidthRateLimitScheduleResponse

Create a value of DescribeBandwidthRateLimitScheduleResponse 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:bandwidthRateLimitIntervals:DescribeBandwidthRateLimitScheduleResponse', describeBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals - An array that contains the bandwidth rate limit intervals for a tape or volume gateway.

DescribeBandwidthRateLimitSchedule, describeBandwidthRateLimitScheduleResponse_gatewayARN - Undocumented member.

$sel:httpStatus:DescribeBandwidthRateLimitScheduleResponse', describeBandwidthRateLimitScheduleResponse_httpStatus - The response's http status code.

Response Lenses

describeBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals :: Lens' DescribeBandwidthRateLimitScheduleResponse (Maybe [BandwidthRateLimitInterval])

An array that contains the bandwidth rate limit intervals for a tape or volume gateway.

describeBandwidthRateLimitScheduleResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitScheduleResponse (Maybe Text)

Undocumented member.

describeBandwidthRateLimitScheduleResponse_httpStatus :: Lens' DescribeBandwidthRateLimitScheduleResponse Int

The response's http status code.