Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

get-object-legal-hold

Описание

Примечание

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

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

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

Следующее действие связано с GetObjectLegalHold :

  • GetObjectAttributes

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

Синтаксис

  get-object-legal-hold
--bucket <value>
--key <value>
[--version-id <value>]
[--request-payer <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 (строка)

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

Точки доступа - Когда вы используете это действие с точкой доступа для ведер общего назначения, вы должны указать псевдоним точки доступа вместо имени ведра или указать ARN точки доступа. Когда вы используете это действие с точкой доступа для ведер каталогов, вы должны указать имя точки доступа вместо имени ведра. При использовании ARN точки доступа вы должны направлять запросы на хост-имя точки доступа. Хост-имя точки доступа имеет вид ИмяТочкиДоступа -ИдентификаторАккаунта .s3-accesspoint.*Регион* .amazonaws.com. При использовании этого действия с точкой доступа через Amazon Web Services SDKs, вы предоставляете ARN точки доступа вместо имени ведра. Дополнительную информацию о ARN точек доступа см. в разделе Использование точек доступа в руководстве пользователя Amazon S3.

--key (строка)

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

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

Идентификатор версии объекта, для которого требуется получить статус правового резервирования.

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

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

Примечание

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

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

  • requester

--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
  • текст
  • таблица
  • 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.

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

Получение статуса правового резервирования объекта

Следующий get-object-legal-hold пример получает статус правового резервирования для указанного объекта.

aws s3api get-object-legal-hold \
    --bucket amzn-s3-demo-bucket-with-object-lock \
    --key doc1.rtf

Вывод:

{
    "LegalHold": {
        "Status": "ON"
    }
}

Вывод

Правовое резервирование -> (структура)

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

Статус -> (строка)

Указывает, имеет ли указанный объект правовое резервирование.

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

Spec-Zone.ru

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