Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

получение тегов объекта

Описание

Примечание

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

Возвращает набор тегов объекта. Вы отправляете запрос GET к подресурсу тегов, связанному с объектом.

Для использования этой операции вам необходимо иметь разрешение на выполнение действия s3:GetObjectTagging. По умолчанию действие GET возвращает информацию о текущей версии объекта. Для ведер с поддержкой версий в вашем ведре может быть несколько версий объекта. Чтобы получить теги любой другой версии, используйте параметр запроса versionId. Вам также потребуется разрешение на выполнение действия s3:GetObjectVersionTagging.

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

Дополнительную информацию об объектной метке Amazon S3 см. в разделе Метки объектов.

Следующие действия относятся к GetObjectTagging:

  • DeleteObjectTagging
  • GetObjectAttributes
  • PutObjectTagging

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

Синтаксис

  get-object-tagging
--bucket <value>
--key <value>
[--version-id <value>]
[--expected-bucket-owner <value>]
[--request-payer <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.

S3 на Outposts - При использовании этого действия с S3 на Outposts необходимо направить запросы на хост-имя S3 на Outposts. Хост-имя S3 на Outposts имеет вид `` ИмяТочкиДоступа -ИдентификаторАккаунта .*ИдентификаторOutpost* .s3-outposts.*Регион* .amazonaws.com`` . При использовании этого действия с S3 на Outposts целевое ведро должно быть ARN точки доступа Outposts или псевдонимом точки доступа. Дополнительную информацию о S3 на Outposts см. в разделе Что такое S3 на Outposts? в Руководстве пользователя Amazon S3.

--key (строка)

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

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

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

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

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

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

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

Примечание

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

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

  • requester

--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 в Руководстве пользователя AWS CLI.

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

Чтобы получить теги, присоединенные к объекту

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

aws s3api get-object-tagging \
    --bucket amzn-s3-demo-bucket \
    --key doc1.rtf

Вывод:

{
    "TagSet": [
        {
            "Value": "confidential",
            "Key": "designation"
        }
    ]
}

Следующий get-object-tagging пример пытается получить набор тегов объекта doc2.rtf, который не имеет тегов.

aws s3api get-object-tagging \
    --bucket amzn-s3-demo-bucket \
    --key doc2.rtf

Вывод:

{
    "TagSet": []
}

Следующий get-object-tagging пример получает набор тегов объекта doc3.rtf, который имеет несколько тегов.

aws s3api get-object-tagging \
    --bucket amzn-s3-demo-bucket \
    --key doc3.rtf

Вывод:

{
    "TagSet": [
        {
            "Value": "confidential",
            "Key": "designation"
        },
        {
            "Value": "finance",
            "Key": "department"
        },
        {
            "Value": "payroll",
            "Key": "team"
        }
    ]
}

Вывод

VersionId -> (строка)

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

TagSet -> (список)

Содержит набор тегов.

(структура)

Контейнер пары имени-значения ключа.

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

Значение тега.

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

Spec-Zone.ru

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