Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

Получение параметров хранения объекта

Описание

Примечание

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

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

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

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

  • GetObjectAttributes

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

Синтаксис

  get-object-retention
--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. При использовании этого действия с точкой доступа через SDK Amazon Web Services необходимо указать ARN точки доступа вместо имени ведра. Дополнительную информацию об ARN точек доступа см. в разделе Использование точек доступа в Руководстве пользователя Amazon S3.

--key (строка)

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

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

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

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

Подтверждает, что запрашивающий знает о том, что будет взиматься плата за запрос. Владельцам ведер не нужно указывать этот параметр в своих запросах. Если у исходного или целевого ведра S3 включена функция Requester Pays, запрашивающий заплатит за соответствующие расходы на копирование объекта. Подробную информацию о загрузке объектов из ведер с функцией Requester Pays см. в разделе Загрузка объектов из ведер Requester Pays в Руководстве пользователя 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Получение конфигурации хранения объекта

Следующий get-object-retention пример получает конфигурацию хранения объекта для указанного объекта.

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

Вывод:

{
    "Retention": {
        "Mode": "GOVERNANCE",
        "RetainUntilDate": "2025-01-01T00:00:00.000Z"
    }
}

Вывод

Хранение -> (структура)

Элемент-контейнер для параметров хранения объекта.

Режим -> (строка)

Указывает режим хранения для указанного объекта.

Дата истечения срока действия -> (метка времени)

Дата истечения срока действия защиты Object Lock Retention.

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

Spec-Zone.ru

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