pub struct DescribeStreamConsumer { /* private fields */ }
Expand description
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
sourceimpl DescribeStreamConsumer
impl DescribeStreamConsumer
sourcepub async fn send(
self
) -> Result<DescribeStreamConsumerOutput, SdkError<DescribeStreamConsumerError>>
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.
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 that the consumer is registered with. 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 that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
sourcepub fn consumer_name(self, input: impl Into<String>) -> Self
pub fn consumer_name(self, input: impl Into<String>) -> Self
The name that you gave to the consumer.
sourcepub fn set_consumer_name(self, input: Option<String>) -> Self
pub fn set_consumer_name(self, input: Option<String>) -> Self
The name that you gave to the consumer.
sourcepub fn consumer_arn(self, input: impl Into<String>) -> Self
pub fn consumer_arn(self, input: impl Into<String>) -> Self
The ARN returned by Kinesis Data Streams when you registered the consumer.
sourcepub fn set_consumer_arn(self, input: Option<String>) -> Self
pub fn set_consumer_arn(self, input: Option<String>) -> Self
The ARN returned by Kinesis Data Streams when you registered the consumer.
Trait Implementations
sourceimpl Clone for DescribeStreamConsumer
impl Clone for DescribeStreamConsumer
sourcefn clone(&self) -> DescribeStreamConsumer
fn clone(&self) -> DescribeStreamConsumer
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for DescribeStreamConsumer
impl Send for DescribeStreamConsumer
impl Sync for DescribeStreamConsumer
impl Unpin for DescribeStreamConsumer
impl !UnwindSafe for DescribeStreamConsumer
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more