libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DynamoDB.UpdateTimeToLive

Description

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can 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.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

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

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.

Synopsis

Creating a Request

data UpdateTimeToLive Source #

Represents the input of an UpdateTimeToLive operation.

See: newUpdateTimeToLive smart constructor.

Constructors

UpdateTimeToLive' 

Fields

Instances

Instances details
Eq UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Read UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Show UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Generic UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Associated Types

type Rep UpdateTimeToLive :: Type -> Type #

NFData UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Methods

rnf :: UpdateTimeToLive -> () #

Hashable UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

ToJSON UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

AWSRequest UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Associated Types

type AWSResponse UpdateTimeToLive #

ToHeaders UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

ToPath UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

ToQuery UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

type Rep UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

type Rep UpdateTimeToLive = D1 ('MetaData "UpdateTimeToLive" "Amazonka.DynamoDB.UpdateTimeToLive" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "UpdateTimeToLive'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "timeToLiveSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimeToLiveSpecification)))
type AWSResponse UpdateTimeToLive Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

newUpdateTimeToLive Source #

Create a value of UpdateTimeToLive 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:tableName:UpdateTimeToLive', updateTimeToLive_tableName - The name of the table to be configured.

$sel:timeToLiveSpecification:UpdateTimeToLive', updateTimeToLive_timeToLiveSpecification - Represents the settings used to enable or disable Time to Live for the specified table.

Request Lenses

updateTimeToLive_tableName :: Lens' UpdateTimeToLive Text Source #

The name of the table to be configured.

updateTimeToLive_timeToLiveSpecification :: Lens' UpdateTimeToLive TimeToLiveSpecification Source #

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

Destructuring the Response

data UpdateTimeToLiveResponse Source #

See: newUpdateTimeToLiveResponse smart constructor.

Constructors

UpdateTimeToLiveResponse' 

Fields

Instances

Instances details
Eq UpdateTimeToLiveResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Read UpdateTimeToLiveResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Show UpdateTimeToLiveResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Generic UpdateTimeToLiveResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

Associated Types

type Rep UpdateTimeToLiveResponse :: Type -> Type #

NFData UpdateTimeToLiveResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

type Rep UpdateTimeToLiveResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateTimeToLive

type Rep UpdateTimeToLiveResponse = D1 ('MetaData "UpdateTimeToLiveResponse" "Amazonka.DynamoDB.UpdateTimeToLive" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "UpdateTimeToLiveResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeToLiveSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeToLiveSpecification)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateTimeToLiveResponse Source #

Create a value of UpdateTimeToLiveResponse 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:timeToLiveSpecification:UpdateTimeToLive', updateTimeToLiveResponse_timeToLiveSpecification - Represents the output of an UpdateTimeToLive operation.

$sel:httpStatus:UpdateTimeToLiveResponse', updateTimeToLiveResponse_httpStatus - The response's http status code.

Response Lenses