pub struct DeregisterStreamConsumer { /* private fields */ }
Expand description
Fluent builder constructing a request to DeregisterStreamConsumer
.
To deregister a consumer, provide its ARN. 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 deregister, 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. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per stream.
Implementations§
source§impl DeregisterStreamConsumer
impl DeregisterStreamConsumer
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<DeregisterStreamConsumer, AwsResponseRetryClassifier>, SdkError<DeregisterStreamConsumerError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<DeregisterStreamConsumer, AwsResponseRetryClassifier>, SdkError<DeregisterStreamConsumerError>>
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<DeregisterStreamConsumerOutput, SdkError<DeregisterStreamConsumerError>>
pub async fn send(
self
) -> Result<DeregisterStreamConsumerOutput, SdkError<DeregisterStreamConsumerError>>
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. If you don't know the ARN of the consumer that you want to deregister, 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. The description of a consumer contains its ARN.
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. If you don't know the ARN of the consumer that you want to deregister, 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. The description of a consumer contains its ARN.
Trait Implementations§
source§impl Clone for DeregisterStreamConsumer
impl Clone for DeregisterStreamConsumer
source§fn clone(&self) -> DeregisterStreamConsumer
fn clone(&self) -> DeregisterStreamConsumer
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more