DescribeStreamConsumerRequest Class

Container for the parameters to the DescribeStreamConsumer operation. To get the description of a registered consumer, provide the ARN of the consumer. 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 describe, 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.

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

When making a cross-account call with DescribeStreamConsumer, make sure to provide the ARN of the consumer.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Kinesis.AmazonKinesisRequest
      Amazon.Kinesis.Model.DescribeStreamConsumerRequest

Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z

Syntax

public class DescribeStreamConsumerRequest : AmazonKinesisRequest
         IAmazonWebServiceRequest

The DescribeStreamConsumerRequest type exposes the following members

Constructors

	Name	Description
	DescribeStreamConsumerRequest()

Properties

Name	Type	Description
ConsumerARN	System.String	Gets and sets the property ConsumerARN. The ARN returned by Kinesis Data Streams when you registered the consumer.
ConsumerName	System.String	Gets and sets the property ConsumerName. The name that you gave to the consumer.
StreamARN	System.String	Gets and sets the property 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.

Name

Type

Description