update_time_to_live¶
Operation¶
update_time_to_live
¶
update_time_to_live(request: UpdateTimeToLiveInput | UpdateTimeToLiveInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateTimeToLiveInputDict]) -> UpdateTimeToLiveOutput
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.
Note
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.
Warning
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateTimeToLiveInput | UpdateTimeToLiveInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateTimeToLiveInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateTimeToLiveOutput
|
An instance of |
update_time_to_live
async
¶
update_time_to_live(request: UpdateTimeToLiveInput | UpdateTimeToLiveInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateTimeToLiveInputDict]) -> UpdateTimeToLiveOutput
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.
Note
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.
Warning
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateTimeToLiveInput | UpdateTimeToLiveInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateTimeToLiveInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateTimeToLiveOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateTimeToLiveInputDict
¶
Bases: TypedDict
Dictionary form of UpdateTimeToLiveInput.
Attributes¶
table_name
instance-attribute
¶
The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
time_to_live_specification
instance-attribute
¶
time_to_live_specification: Required[TimeToLiveSpecification | TimeToLiveSpecificationDict]
Represents the settings used to enable or disable Time to Live for the specified table.
UpdateTimeToLiveInput
dataclass
¶
Bases: _SerdeShape
Represents the input of an UpdateTimeToLive operation.
Attributes¶
table_name
class-attribute
instance-attribute
¶
table_name: str | None = ...
The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
time_to_live_specification
class-attribute
instance-attribute
¶
time_to_live_specification: TimeToLiveSpecification | None = ...
Represents the settings used to enable or disable Time to Live for the specified table.
Output¶
UpdateTimeToLiveOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateTimeToLiveOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
time_to_live_specification
class-attribute
instance-attribute
¶
time_to_live_specification: TimeToLiveSpecification | None = ...
Represents the output of an UpdateTimeToLive operation.