Struct aws_sdk_kinesis::client::fluent_builders::DescribeStreamConsumer

pub struct DescribeStreamConsumer { /* private fields */ }

Fluent builder constructing a request to DescribeStreamConsumer.

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.

Implementations

impl DescribeStreamConsumer

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeStreamConsumer, AwsResponseRetryClassifier>, SdkError<DescribeStreamConsumerError>>

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.

pub async fn send(
    self
) -> Result<DescribeStreamConsumerOutput, SdkError<DescribeStreamConsumerError>>

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.

pub fn stream_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_stream_arn(self, input: Option<String>) -> Self

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.

pub fn consumer_name(self, input: impl Into<String>) -> Self

The name that you gave to the consumer.

pub fn set_consumer_name(self, input: Option<String>) -> Self

The name that you gave to the consumer.

pub fn consumer_arn(self, input: impl Into<String>) -> Self

The ARN returned by Kinesis Data Streams when you registered the consumer.

pub fn set_consumer_arn(self, input: Option<String>) -> Self

The ARN returned by Kinesis Data Streams when you registered the consumer.

Trait Implementations

impl Clone for DescribeStreamConsumer

fn clone(&self) -> DescribeStreamConsumer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeStreamConsumer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.