Struct aws_sdk_kinesis::client::fluent_builders::ListStreamConsumers [−][src]
pub struct ListStreamConsumers<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to ListStreamConsumers
.
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.
Implementations
impl<C, M, R> ListStreamConsumers<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> ListStreamConsumers<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<ListStreamConsumersOutput, SdkError<ListStreamConsumersError>> where
R::Policy: SmithyRetryPolicy<ListStreamConsumersInputOperationOutputAlias, ListStreamConsumersOutput, ListStreamConsumersError, ListStreamConsumersInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<ListStreamConsumersOutput, SdkError<ListStreamConsumersError>> where
R::Policy: SmithyRetryPolicy<ListStreamConsumersInputOperationOutputAlias, ListStreamConsumersOutput, ListStreamConsumersError, ListStreamConsumersInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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 AWS Service Namespaces.
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 AWS Service Namespaces.
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.
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
.
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.
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
.
The maximum number of consumers that you want a single call of
ListStreamConsumers
to return.
The maximum number of consumers that you want a single call of
ListStreamConsumers
to return.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for ListStreamConsumers<C, M, R>
impl<C, M, R> Send for ListStreamConsumers<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for ListStreamConsumers<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for ListStreamConsumers<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for ListStreamConsumers<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more