Struct aws_sdk_kinesis::client::fluent_builders::DecreaseStreamRetentionPeriod

pub struct DecreaseStreamRetentionPeriod { /* private fields */ }

Fluent builder constructing a request to DecreaseStreamRetentionPeriod.

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

Implementations

impl DecreaseStreamRetentionPeriod

pub async fn customize(
    self
) -> Result<CustomizableOperation<DecreaseStreamRetentionPeriod, AwsResponseRetryClassifier>, SdkError<DecreaseStreamRetentionPeriodError>>

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<DecreaseStreamRetentionPeriodOutput, SdkError<DecreaseStreamRetentionPeriodError>>

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_name(self, input: impl Into<String>) -> Self

The name of the stream to modify.

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

The name of the stream to modify.

pub fn retention_period_hours(self, input: i32) -> Self

The new retention period of the stream, in hours. Must be less than the current retention period.

pub fn set_retention_period_hours(self, input: Option<i32>) -> Self

The new retention period of the stream, in hours. Must be less than the current retention period.

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

The ARN of the stream.

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

The ARN of the stream.

Trait Implementations

impl Clone for DecreaseStreamRetentionPeriod

fn clone(&self) -> DecreaseStreamRetentionPeriod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecreaseStreamRetentionPeriod

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

Formats the value using the given formatter.