Network.AWS.KinesisVideo.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 .

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.

Creating a Request

updateDataRetention

Arguments

:: Text

udrCurrentVersion

-> UpdateDataRetentionOperation

udrOperation

-> Natural

udrDataRetentionChangeInHours

-> UpdateDataRetention

Creates a value of UpdateDataRetention with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• udrStreamARN - The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
• udrStreamName - The name of the stream whose retention period you want to change.
• udrCurrentVersion - The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
• udrOperation - Indicates whether you want to increase or decrease the retention period.
• udrDataRetentionChangeInHours - The retention period, in hours. The value you specify replaces the current value.

data UpdateDataRetention

See: updateDataRetention smart constructor.

Instances

Eq UpdateDataRetention

Methods

(==) :: UpdateDataRetention -> UpdateDataRetention -> Bool

(/=) :: UpdateDataRetention -> UpdateDataRetention -> Bool

Data UpdateDataRetention

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateDataRetention -> c UpdateDataRetention

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateDataRetention

toConstr :: UpdateDataRetention -> Constr

dataTypeOf :: UpdateDataRetention -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateDataRetention)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateDataRetention)

gmapT :: (forall b. Data b => b -> b) -> UpdateDataRetention -> UpdateDataRetention

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDataRetention -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDataRetention -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateDataRetention -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateDataRetention -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateDataRetention -> m UpdateDataRetention

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDataRetention -> m UpdateDataRetention

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDataRetention -> m UpdateDataRetention

Read UpdateDataRetention

Methods

readsPrec :: Int -> ReadS UpdateDataRetention

readList :: ReadS [UpdateDataRetention]

readPrec :: ReadPrec UpdateDataRetention

readListPrec :: ReadPrec [UpdateDataRetention]

Show UpdateDataRetention

Methods

showsPrec :: Int -> UpdateDataRetention -> ShowS

show :: UpdateDataRetention -> String

showList :: [UpdateDataRetention] -> ShowS

Generic UpdateDataRetention

Associated Types

type Rep UpdateDataRetention :: * -> *

Methods

from :: UpdateDataRetention -> Rep UpdateDataRetention x

to :: Rep UpdateDataRetention x -> UpdateDataRetention

Hashable UpdateDataRetention

Methods

hashWithSalt :: Int -> UpdateDataRetention -> Int

hash :: UpdateDataRetention -> Int

ToJSON UpdateDataRetention

Methods

toJSON :: UpdateDataRetention -> Value

toEncoding :: UpdateDataRetention -> Encoding

toJSONList :: [UpdateDataRetention] -> Value

toEncodingList :: [UpdateDataRetention] -> Encoding

NFData UpdateDataRetention

Methods

rnf :: UpdateDataRetention -> ()

AWSRequest UpdateDataRetention

Associated Types

type Rs UpdateDataRetention :: *

Methods

request :: UpdateDataRetention -> Request UpdateDataRetention

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateDataRetention -> ClientResponse -> m (Response UpdateDataRetention)

ToHeaders UpdateDataRetention

Methods

toHeaders :: UpdateDataRetention -> [Header]

ToPath UpdateDataRetention

Methods

toPath :: UpdateDataRetention -> ByteString

ToQuery UpdateDataRetention

Methods

toQuery :: UpdateDataRetention -> QueryString

type Rep UpdateDataRetention

type Rep UpdateDataRetention = D1 * (MetaData "UpdateDataRetention" "Network.AWS.KinesisVideo.UpdateDataRetention" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "UpdateDataRetention'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_udrStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_udrStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_udrCurrentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_udrOperation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * UpdateDataRetentionOperation)) (S1 * (MetaSel (Just Symbol "_udrDataRetentionChangeInHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat))))))

type Rs UpdateDataRetention

type Rs UpdateDataRetention = UpdateDataRetentionResponse

Request Lenses

udrStreamARN :: Lens' UpdateDataRetention (Maybe Text)

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

udrStreamName :: Lens' UpdateDataRetention (Maybe Text)

The name of the stream whose retention period you want to change.

udrCurrentVersion :: Lens' UpdateDataRetention Text

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

udrOperation :: Lens' UpdateDataRetention UpdateDataRetentionOperation

Indicates whether you want to increase or decrease the retention period.

udrDataRetentionChangeInHours :: Lens' UpdateDataRetention Natural

The retention period, in hours. The value you specify replaces the current value.

Destructuring the Response

updateDataRetentionResponse

Arguments

:: Int

udrrsResponseStatus

-> UpdateDataRetentionResponse

Creates a value of UpdateDataRetentionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• udrrsResponseStatus - -- | The response status code.

data UpdateDataRetentionResponse

See: updateDataRetentionResponse smart constructor.

Instances

Eq UpdateDataRetentionResponse

Methods

(==) :: UpdateDataRetentionResponse -> UpdateDataRetentionResponse -> Bool

(/=) :: UpdateDataRetentionResponse -> UpdateDataRetentionResponse -> Bool

Data UpdateDataRetentionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateDataRetentionResponse -> c UpdateDataRetentionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateDataRetentionResponse

toConstr :: UpdateDataRetentionResponse -> Constr

dataTypeOf :: UpdateDataRetentionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateDataRetentionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateDataRetentionResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateDataRetentionResponse -> UpdateDataRetentionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDataRetentionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateDataRetentionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateDataRetentionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateDataRetentionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateDataRetentionResponse -> m UpdateDataRetentionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDataRetentionResponse -> m UpdateDataRetentionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateDataRetentionResponse -> m UpdateDataRetentionResponse

Read UpdateDataRetentionResponse

Methods

readsPrec :: Int -> ReadS UpdateDataRetentionResponse

readList :: ReadS [UpdateDataRetentionResponse]

readPrec :: ReadPrec UpdateDataRetentionResponse

readListPrec :: ReadPrec [UpdateDataRetentionResponse]

Show UpdateDataRetentionResponse

Methods

showsPrec :: Int -> UpdateDataRetentionResponse -> ShowS

show :: UpdateDataRetentionResponse -> String

showList :: [UpdateDataRetentionResponse] -> ShowS

Generic UpdateDataRetentionResponse

Associated Types

type Rep UpdateDataRetentionResponse :: * -> *

Methods

from :: UpdateDataRetentionResponse -> Rep UpdateDataRetentionResponse x

to :: Rep UpdateDataRetentionResponse x -> UpdateDataRetentionResponse

NFData UpdateDataRetentionResponse

Methods

rnf :: UpdateDataRetentionResponse -> ()

type Rep UpdateDataRetentionResponse

type Rep UpdateDataRetentionResponse = D1 * (MetaData "UpdateDataRetentionResponse" "Network.AWS.KinesisVideo.UpdateDataRetention" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" True) (C1 * (MetaCons "UpdateDataRetentionResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_udrrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

udrrsResponseStatus :: Lens' UpdateDataRetentionResponse Int

• - | The response status code.