list_stream_consumers¶
Operation¶
list_stream_consumers
async
¶
list_stream_consumers(request: ListStreamConsumersInput | ListStreamConsumersInputDict, /, *, plugins: list[Plugin] | None = None) -> ListStreamConsumersOutput
list_stream_consumers(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStreamConsumersInputDict]) -> ListStreamConsumersOutput
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 5 transactions per second per stream.
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 |
|---|---|
ListStreamConsumersOutput
|
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¶
ListStreamConsumersInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListStreamConsumersInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of consumers that you want a single call of
ListStreamConsumers to return. The default value is 100. If you
specify a value greater than 100, at most 100 results are returned.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
When the number of consumers that are registered with the data stream is
greater than the default value for the MaxResults parameter, or if you
explicitly specify a value for MaxResults that is less than the number
of consumers that are registered with the data stream, the response
includes a pagination token named NextToken. You can specify this
NextToken value in a subsequent call to ListStreamConsumers to list
the next set of registered consumers.
Don't specify StreamName or StreamCreationTimestamp if you specify
NextToken because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults parameter when
you specify NextToken. If you specify a MaxResults value that is
less than the number of consumers that the operation returns if you
don't specify MaxResults, the response will contain a new NextToken
value. You can use the new NextToken value in a subsequent call to the
ListStreamConsumers operation to list the next set of consumers.
Warning
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListStreamConsumers, you have 300 seconds
to use that value. If you specify an expired token in a call to
ListStreamConsumers, you get ExpiredNextTokenException.
stream_arn
class-attribute
instance-attribute
¶
stream_arn: str | None = ...
The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
stream_creation_timestamp
class-attribute
instance-attribute
¶
stream_creation_timestamp: datetime | None = ...
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
Dictionaries¶
ListStreamConsumersInputDict
¶
Bases: TypedDict
Dictionary form of ListStreamConsumersInput.
Attributes¶
max_results
instance-attribute
¶
max_results: int | None
The maximum number of consumers that you want a single call of
ListStreamConsumers to return. The default value is 100. If you
specify a value greater than 100, at most 100 results are returned.
next_token
instance-attribute
¶
next_token: str | None
When the number of consumers that are registered with the data stream is
greater than the default value for the MaxResults parameter, or if you
explicitly specify a value for MaxResults that is less than the number
of consumers that are registered with the data stream, the response
includes a pagination token named NextToken. You can specify this
NextToken value in a subsequent call to ListStreamConsumers to list
the next set of registered consumers.
Don't specify StreamName or StreamCreationTimestamp if you specify
NextToken because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults parameter when
you specify NextToken. If you specify a MaxResults value that is
less than the number of consumers that the operation returns if you
don't specify MaxResults, the response will contain a new NextToken
value. You can use the new NextToken value in a subsequent call to the
ListStreamConsumers operation to list the next set of consumers.
Warning
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListStreamConsumers, you have 300 seconds
to use that value. If you specify an expired token in a call to
ListStreamConsumers, you get ExpiredNextTokenException.
stream_arn
instance-attribute
¶
The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
stream_creation_timestamp
instance-attribute
¶
stream_creation_timestamp: datetime | None
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
Output¶
ListStreamConsumersOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListStreamConsumersOutput structure.
Attributes¶
consumers
class-attribute
instance-attribute
¶
An array of JSON objects. Each object represents one registered consumer.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
When the number of consumers that are registered with the data stream is
greater than the default value for the MaxResults parameter, or if you
explicitly specify a value for MaxResults that is less than the number
of registered consumers, the response includes a pagination token named
NextToken. You can specify this NextToken value in a subsequent call
to ListStreamConsumers to list the next set of registered consumers.
For more information about the use of this pagination token when calling
the ListStreamConsumers operation, see
ListStreamConsumersInput$NextToken.
Warning
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListStreamConsumers, you have 300 seconds
to use that value. If you specify an expired token in a call to
ListStreamConsumers, you get ExpiredNextTokenException.
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.