Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
UpdateDataRetention
Increases or decreases the stream's data retention period by the value that you specify.
To indicate whether you want to increase or decrease the
data retention period, specify the Operation parameter in the request body.
In the request, you must specify either the StreamName or the StreamARN.
Note
The retention period that you specify replaces the current value.
This operation requires permission for the KinesisVideo:UpdateDataRetention action.
Changing the data retention period affects the data in the stream as follows:
-
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
-
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
Request Syntax
POST /updateDataRetention HTTP/1.1 Content-type: application/json { "CurrentVersion": "string", "DataRetentionChangeInHours":number, "Operation": "string", "StreamARN": "string", "StreamName": "string" }
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- CurrentVersion
-
The version of the stream whose retention period you want to change. To get the version, call either the
DescribeStreamor theListStreamsAPI.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9]+Required: Yes
- DataRetentionChangeInHours
-
The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
- Operation
-
Indicates whether you want to increase or decrease the retention period.
Type: String
Valid Values:
INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTIONRequired: Yes
- StreamARN
-
The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Required: No
- StreamName
-
The name of the stream whose retention period you want to change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_.-]+Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientLimitExceededException
-
Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
HTTP Status Code: 400
- InvalidArgumentException
-
The value for this input parameter is invalid.
HTTP Status Code: 400
- NotAuthorizedException
-
The caller is not authorized to perform this operation.
HTTP Status Code: 401
- ResourceInUseException
-
The stream is currently not available for this operation.
HTTP Status Code: 400
- ResourceNotFoundException
-
Amazon Kinesis Video Streams can't find the stream that you specified.
HTTP Status Code: 404
- VersionMismatchException
-
The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
