pub struct ListStreamConsumers { /* private fields */ }
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§
source§impl ListStreamConsumers
impl ListStreamConsumers
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<ListStreamConsumers, AwsResponseRetryClassifier>, SdkError<ListStreamConsumersError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<ListStreamConsumers, AwsResponseRetryClassifier>, SdkError<ListStreamConsumersError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<ListStreamConsumersOutput, SdkError<ListStreamConsumersError>>
pub async fn send(
self
) -> Result<ListStreamConsumersOutput, SdkError<ListStreamConsumersError>>
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.
sourcepub fn into_paginator(self) -> ListStreamConsumersPaginator
pub fn into_paginator(self) -> ListStreamConsumersPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
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.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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
.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
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.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
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.
sourcepub fn stream_creation_timestamp(self, input: DateTime) -> Self
pub fn stream_creation_timestamp(self, input: DateTime) -> Self
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.
sourcepub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
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§
source§impl Clone for ListStreamConsumers
impl Clone for ListStreamConsumers
source§fn clone(&self) -> ListStreamConsumers
fn clone(&self) -> ListStreamConsumers
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more