libZSservicesZSamazonka-kinesisZSamazonka-kinesis
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Kinesis.DescribeStreamSummary

Description

Provides a summarized description of the specified Kinesis data stream without the shard list.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

DescribeStreamSummary has a limit of 20 transactions per second per account.

Synopsis

Creating a Request

data DescribeStreamSummary Source #

See: newDescribeStreamSummary smart constructor.

Constructors

DescribeStreamSummary' 

Fields

Instances

Instances details
Eq DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

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

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

Read DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

readsPrec :: Int -> ReadS DescribeStreamSummary #

readList :: ReadS [DescribeStreamSummary] #

readPrec :: ReadPrec DescribeStreamSummary #

readListPrec :: ReadPrec [DescribeStreamSummary] #

Show DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

showsPrec :: Int -> DescribeStreamSummary -> ShowS #

show :: DescribeStreamSummary -> String #

showList :: [DescribeStreamSummary] -> ShowS #

Generic DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Associated Types

type Rep DescribeStreamSummary :: Type -> Type #

Methods

from :: DescribeStreamSummary -> Rep DescribeStreamSummary x #

to :: Rep DescribeStreamSummary x -> DescribeStreamSummary #

NFData DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

rnf :: DescribeStreamSummary -> () #

Hashable DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

hashWithSalt :: Int -> DescribeStreamSummary -> Int #

hash :: DescribeStreamSummary -> Int #

ToJSON DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

toJSON :: DescribeStreamSummary -> Value #

toEncoding :: DescribeStreamSummary -> Encoding #

toJSONList :: [DescribeStreamSummary] -> Value #

toEncodingList :: [DescribeStreamSummary] -> Encoding #

AWSRequest DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Associated Types

type AWSResponse DescribeStreamSummary #

Methods

request :: DescribeStreamSummary -> Request DescribeStreamSummary #

response :: MonadResource m => Logger -> Service -> Proxy DescribeStreamSummary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStreamSummary))) #

ToHeaders DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

toHeaders :: DescribeStreamSummary -> [Header] #

ToPath DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

toPath :: DescribeStreamSummary -> ByteString #

ToQuery DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

toQuery :: DescribeStreamSummary -> QueryString #

type Rep DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

type Rep DescribeStreamSummary = D1 ('MetaData "DescribeStreamSummary" "Amazonka.Kinesis.DescribeStreamSummary" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeStreamSummary Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

type AWSResponse DescribeStreamSummary = DescribeStreamSummaryResponse

newDescribeStreamSummary Source #

Arguments

:: Text

$sel:streamName:DescribeStreamSummary'

-> DescribeStreamSummary 

Create a value of DescribeStreamSummary 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:streamName:DescribeStreamSummary', describeStreamSummary_streamName - The name of the stream to describe.

Request Lenses

describeStreamSummary_streamName :: Lens' DescribeStreamSummary Text Source #

The name of the stream to describe.

Destructuring the Response

data DescribeStreamSummaryResponse Source #

See: newDescribeStreamSummaryResponse smart constructor.

Constructors

DescribeStreamSummaryResponse' 

Fields

Instances

Instances details
Eq DescribeStreamSummaryResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

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

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

Read DescribeStreamSummaryResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

readsPrec :: Int -> ReadS DescribeStreamSummaryResponse #

readList :: ReadS [DescribeStreamSummaryResponse] #

readPrec :: ReadPrec DescribeStreamSummaryResponse #

readListPrec :: ReadPrec [DescribeStreamSummaryResponse] #

Show DescribeStreamSummaryResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

showsPrec :: Int -> DescribeStreamSummaryResponse -> ShowS #

show :: DescribeStreamSummaryResponse -> String #

showList :: [DescribeStreamSummaryResponse] -> ShowS #

Generic DescribeStreamSummaryResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Associated Types

type Rep DescribeStreamSummaryResponse :: Type -> Type #

Methods

from :: DescribeStreamSummaryResponse -> Rep DescribeStreamSummaryResponse x #

to :: Rep DescribeStreamSummaryResponse x -> DescribeStreamSummaryResponse #

NFData DescribeStreamSummaryResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

Methods

rnf :: DescribeStreamSummaryResponse -> () #

type Rep DescribeStreamSummaryResponse Source # 
Instance details

Defined in Amazonka.Kinesis.DescribeStreamSummary

type Rep DescribeStreamSummaryResponse = D1 ('MetaData "DescribeStreamSummaryResponse" "Amazonka.Kinesis.DescribeStreamSummary" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "DescribeStreamSummaryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "streamDescriptionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamDescriptionSummary)))

newDescribeStreamSummaryResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeStreamSummaryResponse'

-> StreamDescriptionSummary

$sel:streamDescriptionSummary:DescribeStreamSummaryResponse'

-> DescribeStreamSummaryResponse 

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

$sel:streamDescriptionSummary:DescribeStreamSummaryResponse', describeStreamSummaryResponse_streamDescriptionSummary - A StreamDescriptionSummary containing information about the stream.

Response Lenses

describeStreamSummaryResponse_httpStatus :: Lens' DescribeStreamSummaryResponse Int Source #

The response's http status code.

describeStreamSummaryResponse_streamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary Source #

A StreamDescriptionSummary containing information about the stream.