pub struct DescribeStream { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeStream
.
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
You can call DescribeStream
at a maximum rate of 10 times per second.
Each shard in the stream has a SequenceNumberRange
associated with it. If the SequenceNumberRange
has a StartingSequenceNumber
but no EndingSequenceNumber
, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber
and EndingSequenceNumber
are present, then that shard is closed and can no longer receive more data.
Implementations§
source§impl DescribeStream
impl DescribeStream
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<DescribeStream, AwsResponseRetryClassifier>, SdkError<DescribeStreamError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<DescribeStream, AwsResponseRetryClassifier>, SdkError<DescribeStreamError>>
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<DescribeStreamOutput, SdkError<DescribeStreamError>>
pub async fn send(
self
) -> Result<DescribeStreamOutput, SdkError<DescribeStreamError>>
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 Amazon Resource Name (ARN) for the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of shard objects to return. The upper limit is 100.
sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
The maximum number of shard objects to return. The upper limit is 100.
sourcepub fn exclusive_start_shard_id(self, input: impl Into<String>) -> Self
pub fn exclusive_start_shard_id(self, input: impl Into<String>) -> Self
The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId
in the previous operation.
sourcepub fn set_exclusive_start_shard_id(self, input: Option<String>) -> Self
pub fn set_exclusive_start_shard_id(self, input: Option<String>) -> Self
The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId
in the previous operation.
Trait Implementations§
source§impl Clone for DescribeStream
impl Clone for DescribeStream
source§fn clone(&self) -> DescribeStream
fn clone(&self) -> DescribeStream
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more