Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Kinesis.DescribeLimits

Contents

Creating a Request
Destructuring the Response
Response Lenses

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.

Creating a Request

data DescribeLimits Source #

See: newDescribeLimits smart constructor.

Constructors

DescribeLimits'

Instances

Instances details

Eq DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods (==) :: DescribeLimits -> DescribeLimits -> Bool # (/=) :: DescribeLimits -> DescribeLimits -> Bool #
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 #
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 #
NFData DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods rnf :: DescribeLimits -> () #
Hashable DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods hashWithSalt :: Int -> DescribeLimits -> Int # hash :: DescribeLimits -> Int #
ToJSON DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods toJSON :: DescribeLimits -> Value # toEncoding :: DescribeLimits -> Encoding # toJSONList :: [DescribeLimits] -> Value # toEncodingList :: [DescribeLimits] -> Encoding #
AWSRequest DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Associated Types type AWSResponse DescribeLimits # Methods request :: DescribeLimits -> Request DescribeLimits # response :: MonadResource m => Logger -> Service -> Proxy DescribeLimits -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeLimits))) #
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 #
type Rep DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits type Rep DescribeLimits = D1 ('MetaData "DescribeLimits" "Amazonka.Kinesis.DescribeLimits" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeLimits'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse DescribeLimits Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits type AWSResponse DescribeLimits = DescribeLimitsResponse

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 httpStatus :: Int The response's http status code. shardLimit :: Natural The maximum number of shards. openShardCount :: Natural The number of open shards.

Instances

Instances details

Eq DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods (==) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool # (/=) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool #
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 #
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 #
NFData DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits Methods rnf :: DescribeLimitsResponse -> () #
type Rep DescribeLimitsResponse Source #
Instance details Defined in Amazonka.Kinesis.DescribeLimits type Rep DescribeLimitsResponse = D1 ('MetaData "DescribeLimitsResponse" "Amazonka.Kinesis.DescribeLimits" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" '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))))

newDescribeLimitsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeLimitsResponse'`
-> Natural	`$sel:shardLimit:DescribeLimitsResponse'`
-> Natural	`$sel:openShardCount: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.

$sel:openShardCount:DescribeLimitsResponse', describeLimitsResponse_openShardCount - The number of open shards.

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.