describe_stream_consumer¶
Operation¶
describe_stream_consumer
async
¶
describe_stream_consumer(request: DescribeStreamConsumerInput | DescribeStreamConsumerInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeStreamConsumerOutput
describe_stream_consumer(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStreamConsumerInputDict]) -> DescribeStreamConsumerOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeStreamConsumerOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeStreamConsumerInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeStreamConsumerInput structure.
Attributes¶
consumer_arn
class-attribute
instance-attribute
¶
consumer_arn: str | None = ...
The ARN returned by Kinesis Data Streams when you registered the consumer.
consumer_name
class-attribute
instance-attribute
¶
consumer_name: str | None = ...
The name that you gave to the consumer.
stream_arn
class-attribute
instance-attribute
¶
stream_arn: str | None = ...
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.
Dictionaries¶
DescribeStreamConsumerInputDict
¶
Bases: TypedDict
Dictionary form of DescribeStreamConsumerInput.
Attributes¶
consumer_arn
instance-attribute
¶
consumer_arn: str | None
The ARN returned by Kinesis Data Streams when you registered the consumer.
consumer_name
instance-attribute
¶
consumer_name: str | None
The name that you gave to the consumer.
stream_arn
instance-attribute
¶
stream_arn: str | None
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.
Output¶
DescribeStreamConsumerOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeStreamConsumerOutput structure.
Attributes¶
consumer_description
instance-attribute
¶
consumer_description: ConsumerDescription
An object that represents the details of the consumer.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.