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

Description

 
Synopsis

Documentation

data ConsumerDescription Source #

An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

See: newConsumerDescription smart constructor.

Constructors

ConsumerDescription' 

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
     
  • streamARN :: Text

    The ARN of the stream with which you registered the consumer.

Instances

Instances details
Eq ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

Read ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

Show ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

Generic ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

Associated Types

type Rep ConsumerDescription :: Type -> Type #

NFData ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

Methods

rnf :: ConsumerDescription -> () #

Hashable ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

FromJSON ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

type Rep ConsumerDescription Source # 
Instance details

Defined in Amazonka.Kinesis.Types.ConsumerDescription

type Rep ConsumerDescription = D1 ('MetaData "ConsumerDescription" "Amazonka.Kinesis.Types.ConsumerDescription" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ConsumerDescription'" '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) :*: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConsumerDescription Source #

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

$sel:consumerARN:ConsumerDescription', consumerDescription_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:ConsumerDescription', consumerDescription_consumerStatus - A consumer can't read data while in the CREATING or DELETING states.

$sel:consumerCreationTimestamp:ConsumerDescription', consumerDescription_consumerCreationTimestamp -

$sel:streamARN:ConsumerDescription', consumerDescription_streamARN - The ARN of the stream with which you registered the consumer.

consumerDescription_consumerName :: Lens' ConsumerDescription Text Source #

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

consumerDescription_consumerARN :: Lens' ConsumerDescription 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.

consumerDescription_consumerStatus :: Lens' ConsumerDescription ConsumerStatus Source #

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

consumerDescription_streamARN :: Lens' ConsumerDescription Text Source #

The ARN of the stream with which you registered the consumer.