Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeStreamConsumer

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.

Note

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

Request Syntax


{
   "ConsumerARN": "string",
   "ConsumerName": "string",
   "StreamARN": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ConsumerARN

The ARN returned by Kinesis Data Streams when you registered the consumer.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+

Required: No

ConsumerName

The name that you gave to the consumer.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: No

StreamARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+

Required: No

Response Syntax


{
   "ConsumerDescription": { 
      "ConsumerARN": "string",
      "ConsumerCreationTimestamp": number,
      "ConsumerName": "string",
      "ConsumerStatus": "string",
      "StreamARN": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConsumerDescription

An object that represents the details of the consumer.

Type: ConsumerDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArgumentException

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

HTTP Status Code: 400

LimitExceededException

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found. The stream might not be specified correctly.

HTTP Status Code: 400