| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Kinesis.DescribeStreamConsumer
Description
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.
Synopsis
- data DescribeStreamConsumer = DescribeStreamConsumer' {
- consumerARN :: Maybe Text
- streamARN :: Maybe Text
- consumerName :: Maybe Text
- newDescribeStreamConsumer :: DescribeStreamConsumer
- describeStreamConsumer_consumerARN :: Lens' DescribeStreamConsumer (Maybe Text)
- describeStreamConsumer_streamARN :: Lens' DescribeStreamConsumer (Maybe Text)
- describeStreamConsumer_consumerName :: Lens' DescribeStreamConsumer (Maybe Text)
- data DescribeStreamConsumerResponse = DescribeStreamConsumerResponse' {}
- newDescribeStreamConsumerResponse :: Int -> ConsumerDescription -> DescribeStreamConsumerResponse
- describeStreamConsumerResponse_httpStatus :: Lens' DescribeStreamConsumerResponse Int
- describeStreamConsumerResponse_consumerDescription :: Lens' DescribeStreamConsumerResponse ConsumerDescription
Creating a Request
data DescribeStreamConsumer Source #
See: newDescribeStreamConsumer smart constructor.
Constructors
| DescribeStreamConsumer' | |
Fields
| |
Instances
newDescribeStreamConsumer :: DescribeStreamConsumer Source #
Create a value of DescribeStreamConsumer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumerARN:DescribeStreamConsumer', describeStreamConsumer_consumerARN - The ARN returned by Kinesis Data Streams when you registered the
consumer.
$sel:streamARN:DescribeStreamConsumer', describeStreamConsumer_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.
$sel:consumerName:DescribeStreamConsumer', describeStreamConsumer_consumerName - The name that you gave to the consumer.
Request Lenses
describeStreamConsumer_consumerARN :: Lens' DescribeStreamConsumer (Maybe Text) Source #
The ARN returned by Kinesis Data Streams when you registered the consumer.
describeStreamConsumer_streamARN :: Lens' DescribeStreamConsumer (Maybe Text) Source #
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.
describeStreamConsumer_consumerName :: Lens' DescribeStreamConsumer (Maybe Text) Source #
The name that you gave to the consumer.
Destructuring the Response
data DescribeStreamConsumerResponse Source #
See: newDescribeStreamConsumerResponse smart constructor.
Constructors
| DescribeStreamConsumerResponse' | |
Fields
| |
Instances
newDescribeStreamConsumerResponse Source #
Arguments
| :: Int | |
| -> ConsumerDescription | |
| -> DescribeStreamConsumerResponse |
Create a value of DescribeStreamConsumerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeStreamConsumerResponse', describeStreamConsumerResponse_httpStatus - The response's http status code.
$sel:consumerDescription:DescribeStreamConsumerResponse', describeStreamConsumerResponse_consumerDescription - An object that represents the details of the consumer.
Response Lenses
describeStreamConsumerResponse_httpStatus :: Lens' DescribeStreamConsumerResponse Int Source #
The response's http status code.
describeStreamConsumerResponse_consumerDescription :: Lens' DescribeStreamConsumerResponse ConsumerDescription Source #
An object that represents the details of the consumer.