Kinesis / Client / deregister_stream_consumer

deregister_stream_consumer#

Kinesis.Client.deregister_stream_consumer(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.deregister_stream_consumer(
    StreamARN='string',
    ConsumerName='string',
    ConsumerARN='string'
)
Parameters:

  • StreamARN (string) – 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.

  • ConsumerName (string) – The name that you gave to the consumer.

  • ConsumerARN (string) – 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.

Returns:

None

Exceptions

  • Kinesis.Client.exceptions.LimitExceededException

  • Kinesis.Client.exceptions.ResourceNotFoundException

  • Kinesis.Client.exceptions.InvalidArgumentException