Spec-Zone.ru › AWS CLI v2

[ aws . chime ]

put-retention-settings

Описание

Устанавливает параметры хранения для указанной учётной записи Amazon Chime Enterprise. Рекомендуется использовать AWS CloudTrail для мониторинга использования этого API в вашей учётной записи. Дополнительную информацию можно найти в руководстве по администрированию Amazon Chime, раздел Ведение журналов вызовов API Amazon Chime с помощью AWS CloudTrail.

Чтобы отключить существующие параметры хранения, удалите число дней из соответствующего поля RetentionDays в объекте RetentionSettings. Дополнительную информацию о параметрах хранения см. в руководстве по администрированию Amazon Chime, раздел Управление политиками хранения чата.

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

Синтаксис

  put-retention-settings
--account-id <value>
--retention-settings <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]

Параметры

--account-id (строка)

Идентификатор учётной записи Amazon Chime.

--retention-settings (структура)

Параметры хранения.

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

Параметры хранения чат-комнат.

RetentionDays -> (целое число)

Число дней, в течение которых сохраняются сообщения чат-комнат.

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

Параметры хранения чат-бесед.

RetentionDays -> (целое число)

Число дней, в течение которых сохраняются сообщения чат-бесед.

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

RoomRetentionSettings={RetentionDays=integer},ConversationRetentionSettings={RetentionDays=integer}

Синтаксис JSON:

{
  "RoomRetentionSettings": {
    "RetentionDays": integer
  },
  "ConversationRetentionSettings": {
    "RetentionDays": integer
  }
}

--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 (строка)

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

  • on
  • off
  • auto

--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.

Вывод

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

Параметры хранения.

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

Параметры хранения чат-комнат.

RetentionDays -> (целое число)

Число дней, в течение которых сохраняются сообщения чат-комнат.

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

Параметры хранения чат-бесед.

RetentionDays -> (целое число)

Число дней, в течение которых сохраняются сообщения чат-бесед.

InitiateDeletionTimestamp -> (метка времени)

Метка времени, представляющая время, в которое указанные элементы будут постоянно удалены, в формате ISO 8601.

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

Spec-Zone.ru

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