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.Types.Consumer

Description

Synopsis

Documentation

data Consumer Source #

An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

See: newConsumer smart constructor.

Constructors

Consumer'

Fields

consumerName :: Text
The name of the consumer is something you choose when you register the consumer.
consumerARN :: Text
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
consumerStatus :: ConsumerStatus
A consumer can't read data while in the CREATING or DELETING states.
consumerCreationTimestamp :: POSIX

Instances

Instances details

Eq Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods (==) :: Consumer -> Consumer -> Bool # (/=) :: Consumer -> Consumer -> Bool #
Read Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods readsPrec :: Int -> ReadS Consumer # readList :: ReadS [Consumer] # readPrec :: ReadPrec Consumer # readListPrec :: ReadPrec [Consumer] #
Show Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods showsPrec :: Int -> Consumer -> ShowS # show :: Consumer -> String # showList :: [Consumer] -> ShowS #
Generic Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Associated Types type Rep Consumer :: Type -> Type # Methods from :: Consumer -> Rep Consumer x # to :: Rep Consumer x -> Consumer #
NFData Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods rnf :: Consumer -> () #
Hashable Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods hashWithSalt :: Int -> Consumer -> Int # hash :: Consumer -> Int #
FromJSON Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer Methods parseJSON :: Value -> Parser Consumer # parseJSONList :: Value -> Parser [Consumer] #
type Rep Consumer Source #
Instance details Defined in Amazonka.Kinesis.Types.Consumer type Rep Consumer = D1 ('MetaData "Consumer" "Amazonka.Kinesis.Types.Consumer" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "Consumer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "consumerStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConsumerStatus) :*: S1 ('MetaSel ('Just "consumerCreationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newConsumer Source #

Arguments

:: Text	`$sel:consumerName:Consumer'`
-> Text	`$sel:consumerARN:Consumer'`
-> ConsumerStatus	`$sel:consumerStatus:Consumer'`
-> UTCTime	`$sel:consumerCreationTimestamp:Consumer'`
-> Consumer

Create a value of Consumer 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:consumerName:Consumer', consumer_consumerName - The name of the consumer is something you choose when you register the consumer.

$sel:consumerARN:Consumer', consumer_consumerARN - When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

$sel:consumerStatus:Consumer', consumer_consumerStatus - A consumer can't read data while in the CREATING or DELETING states.

$sel:consumerCreationTimestamp:Consumer', consumer_consumerCreationTimestamp -

consumer_consumerName :: Lens' Consumer Text Source #

The name of the consumer is something you choose when you register the consumer.

consumer_consumerARN :: Lens' Consumer Text Source #

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

consumer_consumerStatus :: Lens' Consumer ConsumerStatus Source #

A consumer can't read data while in the CREATING or DELETING states.

consumer_consumerCreationTimestamp :: Lens' Consumer UTCTime Source #