Struct aws_sdk_kinesis::client::fluent_builders::RegisterStreamConsumer

pub struct RegisterStreamConsumer { /* private fields */ }

Fluent builder constructing a request to RegisterStreamConsumer.

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.

For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.

The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.

Implementations

impl RegisterStreamConsumer

pub async fn customize(
    self
) -> Result<CustomizableOperation<RegisterStreamConsumer, AwsResponseRetryClassifier>, SdkError<RegisterStreamConsumerError>>

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<RegisterStreamConsumerOutput, SdkError<RegisterStreamConsumerError>>

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 you want to register the consumer with. For more info, 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 you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

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

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

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

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

Trait Implementations

impl Clone for RegisterStreamConsumer

fn clone(&self) -> RegisterStreamConsumer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterStreamConsumer

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

Formats the value using the given formatter.