AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeStreamConsumerAsync.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public virtual DescribeStreamConsumerResponse DescribeStreamConsumer( DescribeStreamConsumerRequest request )
Container for the necessary parameters to execute the DescribeStreamConsumer service method.
| Exception | Condition |
|---|---|
| InvalidArgumentException | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
| LimitExceededException | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. |
| ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5