IncreaseStreamRetentionPeriod
Written by
Updated at January 14, 2022
Increases the message retention period in a stream.
Possible values: 4 hours, 12 hours, and 24 hours.
Request
The request contains data in JSON format.
{
"RetentionPeriodHours": number,
"StreamName": "string"
}
Request parameters
| Parameter | Description |
|---|---|
RetentionPeriodHours |
Message retention period, hours. Must be greater than the current time. Type: Integer Possible values 12, 24.Required: Yes. |
StreamName |
The name of a stream. Type: String Size: 1-128 characters.Possible values: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$Required: Yes |
Response
If successful, an HTTP 200 code and empty body are returned.
Errors
| Parameter | Description | HTTP code |
|---|---|---|
InvalidArgumentException |
The argument is invalid. For more information, see the error message. | 400 |
LimitExceededException |
The request limit is exceeded. | 400 |
ResourceInUseException |
The resource is being used by another operation. | 400 |
ResourceNotFoundException |
The requested resource was not found. | 400 |
Errors that are common to all methods may occur.