Struct aws_sdk_kinesis::client::fluent_builders::RegisterStreamConsumer [−][src]
pub struct RegisterStreamConsumer<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
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<C, M, R> RegisterStreamConsumer<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> RegisterStreamConsumer<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<RegisterStreamConsumerOutput, SdkError<RegisterStreamConsumerError>> where
R::Policy: SmithyRetryPolicy<RegisterStreamConsumerInputOperationOutputAlias, RegisterStreamConsumerOutput, RegisterStreamConsumerError, RegisterStreamConsumerInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<RegisterStreamConsumerOutput, SdkError<RegisterStreamConsumerError>> where
R::Policy: SmithyRetryPolicy<RegisterStreamConsumerInputOperationOutputAlias, RegisterStreamConsumerOutput, RegisterStreamConsumerError, RegisterStreamConsumerInputOperationRetryAlias>,
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 that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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.
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.
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
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for RegisterStreamConsumer<C, M, R>
impl<C, M, R> Send for RegisterStreamConsumer<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for RegisterStreamConsumer<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for RegisterStreamConsumer<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for RegisterStreamConsumer<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