Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kinesis.DeregisterStreamConsumer

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.

This operation has a limit of five transactions per second per stream.

Creating a Request

data DeregisterStreamConsumer Source #

See: newDeregisterStreamConsumer smart constructor.

Constructors

DeregisterStreamConsumer'

Fields

consumerARN :: Maybe Text
The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
consumerName :: Maybe Text
The name that you gave to the consumer.
streamARN :: Maybe Text
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Instances

Instances details

ToJSON DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toJSON :: DeregisterStreamConsumer -> Value # toEncoding :: DeregisterStreamConsumer -> Encoding # toJSONList :: [DeregisterStreamConsumer] -> Value # toEncodingList :: [DeregisterStreamConsumer] -> Encoding #
ToHeaders DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toHeaders :: DeregisterStreamConsumer -> [Header] #
ToPath DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toPath :: DeregisterStreamConsumer -> ByteString #
ToQuery DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods toQuery :: DeregisterStreamConsumer -> QueryString #
AWSRequest DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type AWSResponse DeregisterStreamConsumer # Methods request :: (Service -> Service) -> DeregisterStreamConsumer -> Request DeregisterStreamConsumer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeregisterStreamConsumer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeregisterStreamConsumer))) #
Generic DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type Rep DeregisterStreamConsumer :: Type -> Type # Methods from :: DeregisterStreamConsumer -> Rep DeregisterStreamConsumer x # to :: Rep DeregisterStreamConsumer x -> DeregisterStreamConsumer #
Read DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods readsPrec :: Int -> ReadS DeregisterStreamConsumer # readList :: ReadS [DeregisterStreamConsumer] # readPrec :: ReadPrec DeregisterStreamConsumer # readListPrec :: ReadPrec [DeregisterStreamConsumer] #
Show DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods showsPrec :: Int -> DeregisterStreamConsumer -> ShowS # show :: DeregisterStreamConsumer -> String # showList :: [DeregisterStreamConsumer] -> ShowS #
NFData DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods rnf :: DeregisterStreamConsumer -> () #
Eq DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods (==) :: DeregisterStreamConsumer -> DeregisterStreamConsumer -> Bool # (/=) :: DeregisterStreamConsumer -> DeregisterStreamConsumer -> Bool #
Hashable DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods hashWithSalt :: Int -> DeregisterStreamConsumer -> Int # hash :: DeregisterStreamConsumer -> Int #
type AWSResponse DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer type AWSResponse DeregisterStreamConsumer = DeregisterStreamConsumerResponse
type Rep DeregisterStreamConsumer Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer type Rep DeregisterStreamConsumer = D1 ('MetaData "DeregisterStreamConsumer" "Amazonka.Kinesis.DeregisterStreamConsumer" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "DeregisterStreamConsumer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consumerARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "consumerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeregisterStreamConsumer :: DeregisterStreamConsumer Source #

Create a value of DeregisterStreamConsumer 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:

DeregisterStreamConsumer, deregisterStreamConsumer_consumerARN - The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

DeregisterStreamConsumer, deregisterStreamConsumer_consumerName - The name that you gave to the consumer.

DeregisterStreamConsumer, deregisterStreamConsumer_streamARN - The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Request Lenses

deregisterStreamConsumer_consumerARN :: Lens' DeregisterStreamConsumer (Maybe Text) Source #

The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

deregisterStreamConsumer_consumerName :: Lens' DeregisterStreamConsumer (Maybe Text) Source #

The name that you gave to the consumer.

deregisterStreamConsumer_streamARN :: Lens' DeregisterStreamConsumer (Maybe Text) Source #

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Destructuring the Response

data DeregisterStreamConsumerResponse Source #

See: newDeregisterStreamConsumerResponse smart constructor.

Constructors

DeregisterStreamConsumerResponse'

Instances

Instances details

Generic DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Associated Types type Rep DeregisterStreamConsumerResponse :: Type -> Type # Methods from :: DeregisterStreamConsumerResponse -> Rep DeregisterStreamConsumerResponse x # to :: Rep DeregisterStreamConsumerResponse x -> DeregisterStreamConsumerResponse #
Read DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods readsPrec :: Int -> ReadS DeregisterStreamConsumerResponse # readList :: ReadS [DeregisterStreamConsumerResponse] # readPrec :: ReadPrec DeregisterStreamConsumerResponse # readListPrec :: ReadPrec [DeregisterStreamConsumerResponse] #
Show DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods showsPrec :: Int -> DeregisterStreamConsumerResponse -> ShowS # show :: DeregisterStreamConsumerResponse -> String # showList :: [DeregisterStreamConsumerResponse] -> ShowS #
NFData DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods rnf :: DeregisterStreamConsumerResponse -> () #
Eq DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer Methods (==) :: DeregisterStreamConsumerResponse -> DeregisterStreamConsumerResponse -> Bool # (/=) :: DeregisterStreamConsumerResponse -> DeregisterStreamConsumerResponse -> Bool #
type Rep DeregisterStreamConsumerResponse Source #
Instance details Defined in Amazonka.Kinesis.DeregisterStreamConsumer type Rep DeregisterStreamConsumerResponse = D1 ('MetaData "DeregisterStreamConsumerResponse" "Amazonka.Kinesis.DeregisterStreamConsumer" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "DeregisterStreamConsumerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeregisterStreamConsumerResponse :: DeregisterStreamConsumerResponse Source #

Create a value of DeregisterStreamConsumerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.