| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisVideo.UpdateDataRetention
Description
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.
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.
Synopsis
- data UpdateDataRetention = UpdateDataRetention' {}
- newUpdateDataRetention :: Text -> UpdateDataRetentionOperation -> Natural -> UpdateDataRetention
- updateDataRetention_streamARN :: Lens' UpdateDataRetention (Maybe Text)
- updateDataRetention_streamName :: Lens' UpdateDataRetention (Maybe Text)
- updateDataRetention_currentVersion :: Lens' UpdateDataRetention Text
- updateDataRetention_operation :: Lens' UpdateDataRetention UpdateDataRetentionOperation
- updateDataRetention_dataRetentionChangeInHours :: Lens' UpdateDataRetention Natural
- data UpdateDataRetentionResponse = UpdateDataRetentionResponse' {
- httpStatus :: Int
- newUpdateDataRetentionResponse :: Int -> UpdateDataRetentionResponse
- updateDataRetentionResponse_httpStatus :: Lens' UpdateDataRetentionResponse Int
Creating a Request
data UpdateDataRetention Source #
See: newUpdateDataRetention smart constructor.
Constructors
| UpdateDataRetention' | |
Fields
| |
Instances
newUpdateDataRetention Source #
Arguments
| :: Text | |
| -> UpdateDataRetentionOperation | |
| -> Natural | |
| -> UpdateDataRetention |
Create a value of UpdateDataRetention with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamARN:UpdateDataRetention', updateDataRetention_streamARN - The Amazon Resource Name (ARN) of the stream whose retention period you
want to change.
$sel:streamName:UpdateDataRetention', updateDataRetention_streamName - The name of the stream whose retention period you want to change.
$sel:currentVersion:UpdateDataRetention', updateDataRetention_currentVersion - The version of the stream whose retention period you want to change. To
get the version, call either the DescribeStream or the ListStreams
API.
$sel:operation:UpdateDataRetention', updateDataRetention_operation - Indicates whether you want to increase or decrease the retention period.
$sel:dataRetentionChangeInHours:UpdateDataRetention', updateDataRetention_dataRetentionChangeInHours - The retention period, in hours. The value you specify replaces the
current value. The maximum value for this parameter is 87600 (ten
years).
Request Lenses
updateDataRetention_streamARN :: Lens' UpdateDataRetention (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
updateDataRetention_streamName :: Lens' UpdateDataRetention (Maybe Text) Source #
The name of the stream whose retention period you want to change.
updateDataRetention_currentVersion :: Lens' UpdateDataRetention Text Source #
The version of the stream whose retention period you want to change. To
get the version, call either the DescribeStream or the ListStreams
API.
updateDataRetention_operation :: Lens' UpdateDataRetention UpdateDataRetentionOperation Source #
Indicates whether you want to increase or decrease the retention period.
updateDataRetention_dataRetentionChangeInHours :: Lens' UpdateDataRetention Natural Source #
The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
Destructuring the Response
data UpdateDataRetentionResponse Source #
See: newUpdateDataRetentionResponse smart constructor.
Constructors
| UpdateDataRetentionResponse' | |
Fields
| |
Instances
newUpdateDataRetentionResponse Source #
Create a value of UpdateDataRetentionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDataRetentionResponse', updateDataRetentionResponse_httpStatus - The response's http status code.
Response Lenses
updateDataRetentionResponse_httpStatus :: Lens' UpdateDataRetentionResponse Int Source #
The response's http status code.