Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

обновить-время-до-жизни

Описание

Метод UpdateTimeToLive позволяет включить или отключить Время до истечения срока действия (TTL) для указанной таблицы. Успешное выполнение вызова UpdateTimeToLive возвращает текущее TimeToLiveSpecification. Для полного обработки изменений может потребоваться до одного часа. Любые дополнительные вызовы UpdateTimeToLive для той же таблицы в течение этого одного часа приведут к ValidationException.

TTL сравнивает текущее время в формате эпохи с временем, хранящимся в атрибуте TTL элемента. Если значение эпохи, хранящееся в атрибуте, меньше текущего времени, элемент отмечается как просроченный и впоследствии удаляется.

Примечание

Формат эпохи — это количество секунд, прошедших с 00:00:00 1 января 1970 года по UTC.

DynamoDB удаляет просроченные элементы с использованием принципа наилучшего результата, чтобы обеспечить пропускную способность для других операций с данными.

Предупреждение

DynamoDB обычно удаляет просроченные элементы в течение двух дней с момента истечения срока действия. Точная продолжительность, в течение которой элемент удаляется после истечения срока действия, зависит от характера рабочей нагрузки. Элементы, которые истекли, но не были удалены, все равно будут отображаться в операциях чтения, запросов и сканирования.

При удалении элементов они немедленно удаляются из любого локального вторичного индекса и глобального вторичного индекса таким же образом, как и стандартная операция удаления, с использованием принципа конечной согласованности.

Дополнительную информацию см. в разделе «Время до истечения срока действия» в руководстве разработчика Amazon DynamoDB.

См. также: Документация API AWS

Синтаксис

  update-time-to-live
--table-name <value>
--time-to-live-specification <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--table-name (строка)

Имя таблицы, для которой необходимо настроить параметры. Вы также можете указать Amazon Resource Name (ARN) таблицы в этом параметре.

--time-to-live-specification (структура)

Представляет настройки для включения или отключения времени до истечения срока действия для указанной таблицы.

Enabled -> (булево)

Указывает, следует ли включить (true) или отключить (false) TTL для таблицы.

AttributeName -> (строка)

Имя атрибута TTL, используемого для хранения времени истечения срока действия элементов в таблице.

Сокращенный синтаксис:

Enabled=boolean,AttributeName=string

Синтаксис JSON:

{
  "Enabled": true|false,
  "AttributeName": "string"
}

--cli-input-json | --cli-input-yaml (строка) Чтение аргументов из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределяют значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Использовать определенный регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для заданной настройки cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить вывод страницы CLI.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительная информация приведена в руководстве по началу работы с AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры потребуют адаптации к правилам цитирования вашей консоли. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Для обновления настроек времени до истечения срока действия таблицы

В следующем примере update-time-to-live включено Время до истечения срока действия для указанной таблицы.

aws dynamodb update-time-to-live \
    --table-name MusicCollection \
    --time-to-live-specification Enabled=true,AttributeName=ttl

Вывод:

{
    "TimeToLiveSpecification": {
        "Enabled": true,
        "AttributeName": "ttl"
    }
}

Дополнительную информацию см. в разделе «Время до истечения срока действия» в руководстве разработчика Amazon DynamoDB.

Вывод

TimeToLiveSpecification -> (структура)

Представляет вывод операции UpdateTimeToLive.

Enabled -> (булево)

Указывает, следует ли включить (true) или отключить (false) TTL для таблицы.

AttributeName -> (строка)

Имя атрибута TTL, используемого для хранения времени истечения срока действия элементов в таблице.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API