Network.AWS.Kinesis.DescribeStreamSummary

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.

Creating a Request

describeStreamSummary

Arguments

:: Text

dssStreamName

-> DescribeStreamSummary

Creates a value of DescribeStreamSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssStreamName - The name of the stream to describe.

data DescribeStreamSummary

See: describeStreamSummary smart constructor.

Instances

Eq DescribeStreamSummary

Methods

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

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

Data DescribeStreamSummary

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStreamSummary -> c DescribeStreamSummary

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStreamSummary

toConstr :: DescribeStreamSummary -> Constr

dataTypeOf :: DescribeStreamSummary -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStreamSummary)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStreamSummary)

gmapT :: (forall b. Data b => b -> b) -> DescribeStreamSummary -> DescribeStreamSummary

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamSummary -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamSummary -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeStreamSummary -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStreamSummary -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStreamSummary -> m DescribeStreamSummary

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamSummary -> m DescribeStreamSummary

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamSummary -> m DescribeStreamSummary

Read DescribeStreamSummary

Methods

readsPrec :: Int -> ReadS DescribeStreamSummary

readList :: ReadS [DescribeStreamSummary]

readPrec :: ReadPrec DescribeStreamSummary

readListPrec :: ReadPrec [DescribeStreamSummary]

Show DescribeStreamSummary

Methods

showsPrec :: Int -> DescribeStreamSummary -> ShowS

show :: DescribeStreamSummary -> String

showList :: [DescribeStreamSummary] -> ShowS

Generic DescribeStreamSummary

Associated Types

type Rep DescribeStreamSummary :: * -> *

Methods

from :: DescribeStreamSummary -> Rep DescribeStreamSummary x

to :: Rep DescribeStreamSummary x -> DescribeStreamSummary

Hashable DescribeStreamSummary

Methods

hashWithSalt :: Int -> DescribeStreamSummary -> Int

hash :: DescribeStreamSummary -> Int

ToJSON DescribeStreamSummary

Methods

toJSON :: DescribeStreamSummary -> Value

toEncoding :: DescribeStreamSummary -> Encoding

toJSONList :: [DescribeStreamSummary] -> Value

toEncodingList :: [DescribeStreamSummary] -> Encoding

NFData DescribeStreamSummary

Methods

rnf :: DescribeStreamSummary -> ()

AWSRequest DescribeStreamSummary

Associated Types

type Rs DescribeStreamSummary :: *

Methods

request :: DescribeStreamSummary -> Request DescribeStreamSummary

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeStreamSummary -> ClientResponse -> m (Response DescribeStreamSummary)

ToHeaders DescribeStreamSummary

Methods

toHeaders :: DescribeStreamSummary -> [Header]

ToPath DescribeStreamSummary

Methods

toPath :: DescribeStreamSummary -> ByteString

ToQuery DescribeStreamSummary

Methods

toQuery :: DescribeStreamSummary -> QueryString

type Rep DescribeStreamSummary

type Rep DescribeStreamSummary = D1 * (MetaData "DescribeStreamSummary" "Network.AWS.Kinesis.DescribeStreamSummary" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" True) (C1 * (MetaCons "DescribeStreamSummary'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dssStreamName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DescribeStreamSummary

type Rs DescribeStreamSummary = DescribeStreamSummaryResponse

Request Lenses

dssStreamName :: Lens' DescribeStreamSummary Text

The name of the stream to describe.

Destructuring the Response

describeStreamSummaryResponse

Arguments

:: Int

dssrsResponseStatus

-> StreamDescriptionSummary

dssrsStreamDescriptionSummary

-> DescribeStreamSummaryResponse

Creates a value of DescribeStreamSummaryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssrsResponseStatus - -- | The response status code.
• dssrsStreamDescriptionSummary - A StreamDescriptionSummary containing information about the stream.

data DescribeStreamSummaryResponse

See: describeStreamSummaryResponse smart constructor.

Instances

Eq DescribeStreamSummaryResponse

Methods

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

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

Data DescribeStreamSummaryResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStreamSummaryResponse -> c DescribeStreamSummaryResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStreamSummaryResponse

toConstr :: DescribeStreamSummaryResponse -> Constr

dataTypeOf :: DescribeStreamSummaryResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStreamSummaryResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStreamSummaryResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeStreamSummaryResponse -> DescribeStreamSummaryResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamSummaryResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStreamSummaryResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeStreamSummaryResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStreamSummaryResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStreamSummaryResponse -> m DescribeStreamSummaryResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamSummaryResponse -> m DescribeStreamSummaryResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStreamSummaryResponse -> m DescribeStreamSummaryResponse

Read DescribeStreamSummaryResponse

Methods

readsPrec :: Int -> ReadS DescribeStreamSummaryResponse

readList :: ReadS [DescribeStreamSummaryResponse]

readPrec :: ReadPrec DescribeStreamSummaryResponse

readListPrec :: ReadPrec [DescribeStreamSummaryResponse]

Show DescribeStreamSummaryResponse

Methods

showsPrec :: Int -> DescribeStreamSummaryResponse -> ShowS

show :: DescribeStreamSummaryResponse -> String

showList :: [DescribeStreamSummaryResponse] -> ShowS

Generic DescribeStreamSummaryResponse

Associated Types

type Rep DescribeStreamSummaryResponse :: * -> *

Methods

from :: DescribeStreamSummaryResponse -> Rep DescribeStreamSummaryResponse x

to :: Rep DescribeStreamSummaryResponse x -> DescribeStreamSummaryResponse

NFData DescribeStreamSummaryResponse

Methods

rnf :: DescribeStreamSummaryResponse -> ()

type Rep DescribeStreamSummaryResponse

type Rep DescribeStreamSummaryResponse = D1 * (MetaData "DescribeStreamSummaryResponse" "Network.AWS.Kinesis.DescribeStreamSummary" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "DescribeStreamSummaryResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_dssrsStreamDescriptionSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * StreamDescriptionSummary))))

Response Lenses

dssrsResponseStatus :: Lens' DescribeStreamSummaryResponse Int

• - | The response status code.

dssrsStreamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary

A StreamDescriptionSummary containing information about the stream.