Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

установка-конфигурации-блокировки-объектов

Описание

Примечание

Данная операция не поддерживается для ведер каталогов.

Устанавливает конфигурацию блокировки объектов для указанного ведра. Правило, указанное в конфигурации блокировки объектов, будет по умолчанию применяться к каждому новому объекту, помещенному в указанное ведро. Дополнительную информацию см. в разделе Блокировка объектов.

Примечание

  • Для настроек DefaultRetention необходимо указать как режим, так и период.
  • Период DefaultRetention может быть либо Days, либо Years, но вы должны выбрать один. Вы не можете указать Days и Years одновременно.
  • Вы можете включить блокировку объектов для новых или существующих ведер. Дополнительную информацию см. в разделе Настройка блокировки объектов.

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

Синтаксис

  put-object-lock-configuration
--bucket <value>
[--object-lock-configuration <value>]
[--request-payer <value>]
[--token <value>]
[--content-md5 <value>]
[--checksum-algorithm <value>]
[--expected-bucket-owner <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]

Параметры

--bucket (строка)

Ведро, для которого вы хотите создать или заменить конфигурацию блокировки объектов.

--object-lock-configuration (структура)

Конфигурация блокировки объектов, которую вы хотите применить к указанному ведру.

ObjectLockEnabled -> (строка)

Указывает, включена ли конфигурация блокировки объектов для этого ведра. Включите ObjectLockEnabled при применении ObjectLockConfiguration к ведру.

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

Определяет правило блокировки объектов для указанного объекта. Включите это правило при применении ObjectLockConfiguration к ведру. Для настроек ведра необходимы и режим, и период. Период может быть либо Days, либо Years, но вы должны выбрать один. Вы не можете указать Days и Years одновременно.

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

Режим и период удержания по умолчанию для блокировки объектов, которые вы хотите применить к новым объектам, размещенным в указанном ведре. Для настроек ведра необходимы и режим, и период. Период может быть либо Days, либо Years, но вы должны выбрать один. Вы не можете указать Days и Years одновременно.

Mode -> (строка)

Режим удержания по умолчанию для блокировки объектов, который вы хотите применить к новым объектам, размещенным в указанном ведре. Должен использоваться с Days или Years.

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

Количество дней, которые вы хотите указать для периода удержания по умолчанию. Должен использоваться с Mode.

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

Количество лет, которые вы хотите указать для периода удержания по умолчанию. Должен использоваться с Mode.

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

ObjectLockEnabled=string,Rule={DefaultRetention={Mode=string,Days=integer,Years=integer}}

Синтаксис JSON:

{
  "ObjectLockEnabled": "Enabled",
  "Rule": {
    "DefaultRetention": {
      "Mode": "GOVERNANCE"|"COMPLIANCE",
      "Days": integer,
      "Years": integer
    }
  }
}

--request-payer (строка)

Подтверждает, что запрашивающий знает, что будет оплачивать за запрос. Владельцам ведер не нужно указывать этот параметр в своих запросах. Если у исходного или целевого ведра S3 включен Requester Pays, запрашивающий оплатит соответствующие расходы за копирование объекта. Информацию о загрузке объектов из ведер Requester Pays см. в разделе Загрузка объектов из ведер Requester Pays в руководстве пользователя Amazon S3.

Примечание

Данная функция не поддерживается для ведер каталогов.

Возможные значения:

  • requester

--token (строка)

Токен, позволяющий включить блокировку объектов для существующего ведра.

--content-md5 (строка)

MD5-хеш для тела запроса.

Для запросов, выполненных с помощью командной строки Amazon Web Services (CLI) или SDK Amazon Web Services, этот параметр вычисляется автоматически.

--checksum-algorithm (строка)

Указывает алгоритм, используемый для создания контрольной суммы объекта при использовании SDK. Этот заголовок не предоставляет дополнительных функций, если вы не используете SDK. При отправке этого заголовка необходимо отправить соответствующий заголовок x-amz-checksum или x-amz-trailer. В противном случае Amazon S3 отклоняет запрос с кодом HTTP-статуса 400 Bad Request. Дополнительную информацию см. в разделе Проверка целостности объекта в руководстве пользователя Amazon S3.

Если вы предоставляете отдельную контрольную сумму, Amazon S3 игнорирует предоставленный параметр ChecksumAlgorithm.

Возможные значения:

  • CRC32
  • CRC32C
  • SHA1
  • SHA256
  • CRC64NVME

--expected-bucket-owner (строка)

Идентификатор учетной записи владельца ожидаемого ведра. Если предоставленный вами идентификатор учетной записи не совпадает с фактическим владельцем ведра, запрос завершится с кодом HTTP-статуса 403 Forbidden (доступ запрещен).

--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
  • таблица
  • yaml
  • yaml-потоковый

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Установка конфигурации блокировки объектов на ведро

В следующем примере put-object-lock-configuration устанавливается блокировка объекта на 50 дней для указанного ведра.

aws s3api put-object-lock-configuration \
    --bucket amzn-s3-demo-bucket-with-object-lock \
    --object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 50 }}}'

Эта команда не выводит никаких результатов.

Вывод

RequestCharged -> (строка)

При наличии указывает, что запрашивающий успешно оплатил за запрос.

Примечание

Данная функция не поддерживается для ведер каталогов.

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

Spec-Zone.ru

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