Struct aws_sdk_kinesis::client::fluent_builders::IncreaseStreamRetentionPeriod

pub struct IncreaseStreamRetentionPeriod { /* private fields */ }

Fluent builder constructing a request to IncreaseStreamRetentionPeriod.

Increases 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 maximum value of a stream's retention period is 8760 hours (365 days).

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

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.

Implementations

impl IncreaseStreamRetentionPeriod

pub async fn customize(
    self
) -> Result<CustomizableOperation<IncreaseStreamRetentionPeriod, AwsResponseRetryClassifier>, SdkError<IncreaseStreamRetentionPeriodError>>

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<IncreaseStreamRetentionPeriodOutput, SdkError<IncreaseStreamRetentionPeriodError>>

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 more 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 more 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 IncreaseStreamRetentionPeriod

fn clone(&self) -> IncreaseStreamRetentionPeriod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncreaseStreamRetentionPeriod

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

Formats the value using the given formatter.