Network.AWS.DynamoDB.UpdateTimeToLive

The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification ; it may take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException .

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

Important: DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

Creating a Request

updateTimeToLive

Arguments

:: Text

uttlTableName

-> TimeToLiveSpecification

uttlTimeToLiveSpecification

-> UpdateTimeToLive

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

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

• uttlTableName - The name of the table to be configured.
• uttlTimeToLiveSpecification - Represents the settings used to enable or disable Time to Live for the specified table.

data UpdateTimeToLive

Represents the input of an UpdateTimeToLive operation.

See: updateTimeToLive smart constructor.

Instances

Eq UpdateTimeToLive

Methods

(==) :: UpdateTimeToLive -> UpdateTimeToLive -> Bool

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

Data UpdateTimeToLive

Methods

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

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

toConstr :: UpdateTimeToLive -> Constr

dataTypeOf :: UpdateTimeToLive -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateTimeToLive

Methods

readsPrec :: Int -> ReadS UpdateTimeToLive

readList :: ReadS [UpdateTimeToLive]

readPrec :: ReadPrec UpdateTimeToLive

readListPrec :: ReadPrec [UpdateTimeToLive]

Show UpdateTimeToLive

Methods

showsPrec :: Int -> UpdateTimeToLive -> ShowS

show :: UpdateTimeToLive -> String

showList :: [UpdateTimeToLive] -> ShowS

Generic UpdateTimeToLive

Associated Types

type Rep UpdateTimeToLive :: * -> *

Methods

from :: UpdateTimeToLive -> Rep UpdateTimeToLive x

to :: Rep UpdateTimeToLive x -> UpdateTimeToLive

Hashable UpdateTimeToLive

Methods

hashWithSalt :: Int -> UpdateTimeToLive -> Int

hash :: UpdateTimeToLive -> Int

ToJSON UpdateTimeToLive

Methods

toJSON :: UpdateTimeToLive -> Value

toEncoding :: UpdateTimeToLive -> Encoding

toJSONList :: [UpdateTimeToLive] -> Value

toEncodingList :: [UpdateTimeToLive] -> Encoding

NFData UpdateTimeToLive

Methods

rnf :: UpdateTimeToLive -> ()

AWSRequest UpdateTimeToLive

Associated Types

type Rs UpdateTimeToLive :: *

Methods

request :: UpdateTimeToLive -> Request UpdateTimeToLive

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

ToHeaders UpdateTimeToLive

Methods

toHeaders :: UpdateTimeToLive -> [Header]

ToPath UpdateTimeToLive

Methods

toPath :: UpdateTimeToLive -> ByteString

ToQuery UpdateTimeToLive

Methods

toQuery :: UpdateTimeToLive -> QueryString

type Rep UpdateTimeToLive

type Rep UpdateTimeToLive = D1 * (MetaData "UpdateTimeToLive" "Network.AWS.DynamoDB.UpdateTimeToLive" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" False) (C1 * (MetaCons "UpdateTimeToLive'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uttlTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_uttlTimeToLiveSpecification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * TimeToLiveSpecification))))

type Rs UpdateTimeToLive

type Rs UpdateTimeToLive = UpdateTimeToLiveResponse

Request Lenses

uttlTableName :: Lens' UpdateTimeToLive Text

The name of the table to be configured.

uttlTimeToLiveSpecification :: Lens' UpdateTimeToLive TimeToLiveSpecification

Represents the settings used to enable or disable Time to Live for the specified table.

Destructuring the Response

updateTimeToLiveResponse

Arguments

:: Int

uttlrsResponseStatus

-> UpdateTimeToLiveResponse

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

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

• uttlrsTimeToLiveSpecification - Represents the output of an UpdateTimeToLive operation.
• uttlrsResponseStatus - -- | The response status code.

data UpdateTimeToLiveResponse

See: updateTimeToLiveResponse smart constructor.

Instances

Eq UpdateTimeToLiveResponse

Methods

(==) :: UpdateTimeToLiveResponse -> UpdateTimeToLiveResponse -> Bool

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

Data UpdateTimeToLiveResponse

Methods

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

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

toConstr :: UpdateTimeToLiveResponse -> Constr

dataTypeOf :: UpdateTimeToLiveResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateTimeToLiveResponse

Methods

readsPrec :: Int -> ReadS UpdateTimeToLiveResponse

readList :: ReadS [UpdateTimeToLiveResponse]

readPrec :: ReadPrec UpdateTimeToLiveResponse

readListPrec :: ReadPrec [UpdateTimeToLiveResponse]

Show UpdateTimeToLiveResponse

Methods

showsPrec :: Int -> UpdateTimeToLiveResponse -> ShowS

show :: UpdateTimeToLiveResponse -> String

showList :: [UpdateTimeToLiveResponse] -> ShowS

Generic UpdateTimeToLiveResponse

Associated Types

type Rep UpdateTimeToLiveResponse :: * -> *

Methods

from :: UpdateTimeToLiveResponse -> Rep UpdateTimeToLiveResponse x

to :: Rep UpdateTimeToLiveResponse x -> UpdateTimeToLiveResponse

NFData UpdateTimeToLiveResponse

Methods

rnf :: UpdateTimeToLiveResponse -> ()

type Rep UpdateTimeToLiveResponse

type Rep UpdateTimeToLiveResponse = D1 * (MetaData "UpdateTimeToLiveResponse" "Network.AWS.DynamoDB.UpdateTimeToLive" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" False) (C1 * (MetaCons "UpdateTimeToLiveResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uttlrsTimeToLiveSpecification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TimeToLiveSpecification))) (S1 * (MetaSel (Just Symbol "_uttlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

uttlrsTimeToLiveSpecification :: Lens' UpdateTimeToLiveResponse (Maybe TimeToLiveSpecification)

Represents the output of an UpdateTimeToLive operation.

uttlrsResponseStatus :: Lens' UpdateTimeToLiveResponse Int

• - | The response status code.