amazonka-kinesis-2.0: Amazon Kinesis SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kinesis.DescribeLimits

Description

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of one transaction per second per account.

Synopsis

Creating a Request

data DescribeLimits Source #

See: newDescribeLimits smart constructor.

Constructors

DescribeLimits' 

Instances

Instances details
ToJSON DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

toJSON :: DescribeLimits -> Value #

toEncoding :: DescribeLimits -> Encoding #

toJSONList :: [DescribeLimits] -> Value #

toEncodingList :: [DescribeLimits] -> Encoding #

ToHeaders DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

toHeaders :: DescribeLimits -> [Header] #

ToPath DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

toPath :: DescribeLimits -> ByteString #

ToQuery DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

toQuery :: DescribeLimits -> QueryString #

AWSRequest DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Associated Types

type AWSResponse DescribeLimits #

Methods

request :: (Service -> Service) -> DescribeLimits -> Request DescribeLimits #

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

Generic DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Associated Types

type Rep DescribeLimits :: Type -> Type #

Methods

from :: DescribeLimits -> Rep DescribeLimits x #

to :: Rep DescribeLimits x -> DescribeLimits #

Read DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

readsPrec :: Int -> ReadS DescribeLimits #

readList :: ReadS [DescribeLimits] #

readPrec :: ReadPrec DescribeLimits #

readListPrec :: ReadPrec [DescribeLimits] #

Show DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

showsPrec :: Int -> DescribeLimits -> ShowS #

show :: DescribeLimits -> String #

showList :: [DescribeLimits] -> ShowS #

NFData DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

rnf :: DescribeLimits -> () #

Eq DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

(==) :: DescribeLimits -> DescribeLimits -> Bool #

(/=) :: DescribeLimits -> DescribeLimits -> Bool #

Hashable DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

hashWithSalt :: Int -> DescribeLimits -> Int #

hash :: DescribeLimits -> Int #

type AWSResponse DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

type AWSResponse DescribeLimits = DescribeLimitsResponse
type Rep DescribeLimits Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

type Rep DescribeLimits = D1 ('MetaData "DescribeLimits" "Amazonka.Kinesis.DescribeLimits" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "DescribeLimits'" 'PrefixI 'False) (U1 :: Type -> Type))

newDescribeLimits :: DescribeLimits Source #

Create a value of DescribeLimits with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data DescribeLimitsResponse Source #

See: newDescribeLimitsResponse smart constructor.

Constructors

DescribeLimitsResponse' 

Fields

Instances

Instances details
Generic DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Associated Types

type Rep DescribeLimitsResponse :: Type -> Type #

Methods

from :: DescribeLimitsResponse -> Rep DescribeLimitsResponse x #

to :: Rep DescribeLimitsResponse x -> DescribeLimitsResponse #

Read DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

readsPrec :: Int -> ReadS DescribeLimitsResponse #

readList :: ReadS [DescribeLimitsResponse] #

readPrec :: ReadPrec DescribeLimitsResponse #

readListPrec :: ReadPrec [DescribeLimitsResponse] #

Show DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

showsPrec :: Int -> DescribeLimitsResponse -> ShowS #

show :: DescribeLimitsResponse -> String #

showList :: [DescribeLimitsResponse] -> ShowS #

NFData DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

rnf :: DescribeLimitsResponse -> () #

Eq DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

Methods

(==) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool #

(/=) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool #

type Rep DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeLimits

type Rep DescribeLimitsResponse = D1 ('MetaData "DescribeLimitsResponse" "Amazonka.Kinesis.DescribeLimits" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "DescribeLimitsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "shardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "openShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "onDemandStreamCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "onDemandStreamCountLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newDescribeLimitsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeLimitsResponse'

-> Natural

$sel:shardLimit:DescribeLimitsResponse'

-> Natural

DescribeLimitsResponse

-> Natural

$sel:onDemandStreamCount:DescribeLimitsResponse'

-> Natural

$sel:onDemandStreamCountLimit:DescribeLimitsResponse'

-> DescribeLimitsResponse 

Create a value of DescribeLimitsResponse 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:httpStatus:DescribeLimitsResponse', describeLimitsResponse_httpStatus - The response's http status code.

$sel:shardLimit:DescribeLimitsResponse', describeLimitsResponse_shardLimit - The maximum number of shards.

DescribeLimitsResponse, describeLimitsResponse_openShardCount - The number of open shards.

$sel:onDemandStreamCount:DescribeLimitsResponse', describeLimitsResponse_onDemandStreamCount - Indicates the number of data streams with the on-demand capacity mode.

$sel:onDemandStreamCountLimit:DescribeLimitsResponse', describeLimitsResponse_onDemandStreamCountLimit - The maximum number of data streams with the on-demand capacity mode.

Response Lenses

describeLimitsResponse_httpStatus :: Lens' DescribeLimitsResponse Int Source #

The response's http status code.

describeLimitsResponse_shardLimit :: Lens' DescribeLimitsResponse Natural Source #

The maximum number of shards.

describeLimitsResponse_openShardCount :: Lens' DescribeLimitsResponse Natural Source #

The number of open shards.

describeLimitsResponse_onDemandStreamCount :: Lens' DescribeLimitsResponse Natural Source #

Indicates the number of data streams with the on-demand capacity mode.

describeLimitsResponse_onDemandStreamCountLimit :: Lens' DescribeLimitsResponse Natural Source #

The maximum number of data streams with the on-demand capacity mode.