- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeStreamConsumerCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KinesisClient, DescribeStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
// const { KinesisClient, DescribeStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
const client = new KinesisClient(config);
const input = { // DescribeStreamConsumerInput
StreamARN: "STRING_VALUE",
ConsumerName: "STRING_VALUE",
ConsumerARN: "STRING_VALUE",
};
const command = new DescribeStreamConsumerCommand(input);
const response = await client.send(command);
// { // DescribeStreamConsumerOutput
// ConsumerDescription: { // ConsumerDescription
// ConsumerName: "STRING_VALUE", // required
// ConsumerARN: "STRING_VALUE", // required
// ConsumerStatus: "CREATING" || "DELETING" || "ACTIVE", // required
// ConsumerCreationTimestamp: new Date("TIMESTAMP"), // required
// StreamARN: "STRING_VALUE", // required
// },
// };
DescribeStreamConsumerCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ConsumerARN | string | undefined | The ARN returned by Kinesis Data Streams when you registered the consumer. |
ConsumerName | string | undefined | The name that you gave to the consumer. |
StreamARN | string | undefined | 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 . |
DescribeStreamConsumerCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ConsumerDescriptionRequired | ConsumerDescription | undefined | An object that represents the details of the consumer. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidArgumentException | client | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
| LimitExceededException | client | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. |
| ResourceNotFoundException | client | The requested resource could not be found. The stream might not be specified correctly. |
| KinesisServiceException | Base exception class for all service exceptions from Kinesis service. |