Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncreaseStreamRetentionPeriodCommand

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).

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.

example

Use a bare-bones client and the command you need to make an API call.

import { KinesisClient, IncreaseStreamRetentionPeriodCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
// const { KinesisClient, IncreaseStreamRetentionPeriodCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
const client = new KinesisClient(config);
const command = new IncreaseStreamRetentionPeriodCommand(input);
const response = await client.send(command);
see

IncreaseStreamRetentionPeriodCommandInput for command's input shape.

see

IncreaseStreamRetentionPeriodCommandOutput for command's response shape.

see

config for KinesisClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: IncreaseStreamRetentionPeriodCommandInput

Readonly middlewareStack