Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

list-object-versions

Описание

Примечание

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

Возвращает метаданные обо всех версиях объектов в ведре. Вы также можете использовать параметры запроса в качестве критериев выбора для возвращения метаданных о подмножестве всех версий объектов.

Предупреждение

Для использования этой операции необходимо иметь разрешение на выполнение действия s3:ListBucketVersions. Обратите внимание на разницу в именах.

Примечание

Ответ 200 OK может содержать допустимый или недопустимый XML. Убедитесь, что ваше приложение разработано для парсинга содержимого ответа и соответствующей обработки.

Для использования данной операции необходимо иметь доступ READ к ведру.

Следующие операции связаны с ListObjectVersions:

  • ListObjectsV2
  • GetObject
  • PutObject
  • DeleteObject

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

list-object-versions является постраничной операцией. Для получения всего набора результатов может потребоваться несколько API-вызовов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query с постраничным ответом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Versions, DeleteMarkers, CommonPrefixes

Синтаксис

  list-object-versions
--bucket <value>
[--delimiter <value>]
[--encoding-type <value>]
[--prefix <value>]
[--expected-bucket-owner <value>]
[--request-payer <value>]
[--optional-object-attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

Имя ведра, содержащего объекты.

--delimiter (строка)

Разделитель — это символ, который вы указываете для группировки ключей. Все ключи, содержащие одну и ту же строку между prefix и первым вхождением разделителя, группируются под одним элементом результата в CommonPrefixes. Эти группы учитываются как один результат по ограничению max-keys. Эти ключи не возвращаются нигде в другом месте ответа.

--encoding-type (строка)

Тип кодирования, используемый Amazon S3 для кодирования ключей объектов в ответе. Ответы кодируются только в UTF-8. Ключ объекта может содержать любые символы Юникода. Однако, парсер XML 1.0 не может обработать определенные символы, такие как символы со значением ASCII от 0 до 10. Для символов, которые не поддерживаются в XML 1.0, вы можете добавить этот параметр, чтобы запросить кодирование Amazon S3 ключей в ответе. Дополнительную информацию о символах, которых следует избегать в именах ключей объектов, см. в руководстве по именованию ключей объектов .

Примечание

При использовании кодирования URL не-ASCII символы, используемые в имени ключа объекта, будут кодироваться по процентам в соответствии с кодовыми значениями UTF-8. Например, объект test_file(3).png будет отображаться как test_file%283%29.png .

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

  • url

--prefix (строка)

Используйте этот параметр, чтобы выбрать только те ключи, которые начинаются с указанного префикса. Вы можете использовать префиксы для разделения ведра на различные группы ключей. (Вы можете представить использование prefix для создания групп так же, как вы бы использовали папку в файловой системе.) Вы можете использовать prefix с delimiter, чтобы объединить множество объектов в один результат под CommonPrefixes.

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

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

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

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

Примечание

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

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

  • requester

--optional-object-attributes (список)

Указывает необязательные поля, которые вы хотите получить в ответе. Поля, которые вы не укажете, не будут возвращены.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  RestoreStatus

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON строки. JSON строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределяют значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничного просмотра. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе Постраничный просмотр в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS сервиса.

Примеры использования см. в разделе Постраничный просмотр в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного просмотра укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный просмотр в Руководстве пользователя AWS Command Line Interface.

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

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

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

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

Примеры

Примечание

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

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

Следующая команда извлекает информацию о версии объекта в ведре с именем amzn-s3-demo-bucket:

aws s3api list-object-versions --bucket amzn-s3-demo-bucket --prefix index.html

Вывод:

{
    "DeleteMarkers": [
        {
            "Owner": {
                "DisplayName": "my-username",
                "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
            },
            "IsLatest": true,
            "VersionId": "B2VsEK5saUNNHKcOAJj7hIE86RozToyq",
            "Key": "index.html",
            "LastModified": "2015-11-10T00:57:03.000Z"
        },
        {
            "Owner": {
                "DisplayName": "my-username",
                "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
            },
            "IsLatest": false,
            "VersionId": ".FLQEZscLIcfxSq.jsFJ.szUkmng2Yw6",
            "Key": "index.html",
            "LastModified": "2015-11-09T23:32:20.000Z"
        }
    ],
    "Versions": [
        {
            "LastModified": "2015-11-10T00:20:11.000Z",
            "VersionId": "Rb_l2T8UHDkFEwCgJjhlgPOZC0qJ.vpD",
            "ETag": "\"0622528de826c0df5db1258a23b80be5\"",
            "StorageClass": "STANDARD",
            "Key": "index.html",
            "Owner": {
                "DisplayName": "my-username",
                "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
            },
            "IsLatest": false,
            "Size": 38
        },
        {
            "LastModified": "2015-11-09T23:26:41.000Z",
            "VersionId": "rasWWGpgk9E4s0LyTJgusGeRQKLVIAFf",
            "ETag": "\"06225825b8028de826c0df5db1a23be5\"",
            "StorageClass": "STANDARD",
            "Key": "index.html",
            "Owner": {
                "DisplayName": "my-username",
                "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
            },
            "IsLatest": false,
            "Size": 38
        },
        {
            "LastModified": "2015-11-09T22:50:50.000Z",
            "VersionId": "null",
            "ETag": "\"d1f45267a863c8392e07d24dd592f1b9\"",
            "StorageClass": "STANDARD",
            "Key": "index.html",
            "Owner": {
                "DisplayName": "my-username",
                "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
            },
            "IsLatest": false,
            "Size": 533823
        }
    ]
}

Вывод

IsTruncated -> (boolean)

Флаг, указывающий, вернула ли Amazon S3 все результаты, соответствующие поисковым критериям. Если результаты были усечены, вы можете выполнить последующий запрошенный запрос, используя параметры ответа NextKeyMarker и NextVersionIdMarker в качестве отправной точки в другом запросе, чтобы вернуть остальную часть результатов.

KeyMarker -> (string)

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

VersionIdMarker -> (string)

Отмечает последнюю версию ключа, возвращенную в усеченном ответе.

NextKeyMarker -> (string)

Когда количество ответов превышает значение MaxKeys, NextKeyMarker указывает первый ключ, не возвращенный, который удовлетворяет поисковым критериям. Используйте это значение для параметра запроса key-marker в последующем запросе.

NextVersionIdMarker -> (string)

Когда количество ответов превышает значение MaxKeys, NextVersionIdMarker указывает первую версию объекта, не возвращенную, которая удовлетворяет поисковым критериям. Используйте это значение для параметра запроса version-id-marker в последующем запросе.

Versions -> (list)

Контейнер для информации о версии.

(структура)

Версия объекта.

ETag -> (string)

Тег сущности — это хэш MD5 этой версии объекта.

ChecksumAlgorithm -> (list)

Алгоритм, используемый для создания контрольной суммы объекта.

(string)

ChecksumType -> (string)

Тип контрольной суммы, используемый для вычисления значения контрольной суммы объекта. Дополнительную информацию см. в разделе Проверка целостности объекта в руководстве пользователя Amazon S3.

Size -> (long)

Размер объекта в байтах.

StorageClass -> (string)

Класс хранилища, используемого для хранения объекта.

Key -> (string)

Ключ объекта.

VersionId -> (string)

Идентификатор версии объекта.

IsLatest -> (boolean)

Указывает, является ли объект (true) или не является (false) последней версией объекта.

LastModified -> (timestamp)

Дата и время последнего изменения объекта.

Owner -> (structure)

Указывает владельца объекта.

DisplayName -> (string)

Контейнер для отображаемого имени владельца. Это значение поддерживается только в следующих регионах Amazon Web Services:

  • США (Восточное побережье, Северная Вирджиния)
  • США (Западное побережье, Северная Калифорния)
  • США (Западное побережье, Орегон)
  • Азиатско-Тихоокеанский регион (Сингапур)
  • Азиатско-Тихоокеанский регион (Сидней)
  • Азиатско-Тихоокеанский регион (Токио)
  • Европа (Ирландия)
  • Южная Америка (Сан-Паулу)

Примечание

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

ID -> (string)

Контейнер для ID владельца.

RestoreStatus -> (structure)

Указывает состояние восстановления объекта. Объекты в определенных классах хранилища должны быть восстановлены, прежде чем они смогут быть получены. Дополнительную информацию об этих классах хранилища и о работе с архивированными объектами см. в разделе Работа с архивированными объектами в руководстве пользователя Amazon S3.

IsRestoreInProgress -> (boolean)

Указывает, выполняется ли в настоящее время восстановление объекта. Если восстановление объекта выполняется, заголовок возвращает значение TRUE. Например:

x-amz-optional-object-attributes: IsRestoreInProgress="true"

Если восстановление объекта завершено, заголовок возвращает значение FALSE. Например:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

Если объект не был восстановлен, ответ заголовка отсутствует.

RestoreExpiryDate -> (timestamp)

Указывает, когда восстановленная копия истечет. Это значение заполняется только в том случае, если объект уже был восстановлен. Например:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

DeleteMarkers -> (list)

Контейнер для объекта, являющегося маркером удаления. Чтобы узнать больше о маркерах удаления, см. Раздел Работа с маркерами удаления.

(структура)

Информация о маркере удаления.

Owner -> (structure)

Аккаунт, создавший маркер удаления.

DisplayName -> (string)

Контейнер для отображаемого имени владельца. Это значение поддерживается только в следующих регионах Amazon Web Services:

  • США (Восточное побережье, Северная Вирджиния)
  • США (Западное побережье, Северная Калифорния)
  • США (Западное побережье, Орегон)
  • Азиатско-Тихоокеанский регион (Сингапур)
  • Азиатско-Тихоокеанский регион (Сидней)
  • Азиатско-Тихоокеанский регион (Токио)
  • Европа (Ирландия)
  • Южная Америка (Сан-Паулу)

Примечание

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

ID -> (string)

Контейнер для ID владельца.

Key -> (string)

Ключ объекта.

VersionId -> (string)

Идентификатор версии объекта.

IsLatest -> (boolean)

Указывает, является ли объект (true) или не является (false) последней версией объекта.

LastModified -> (timestamp)

Дата и время последнего изменения объекта.

Name -> (string)

Имя ведра.

Prefix -> (string)

Выбирает объекты, начинающиеся со значения, указанного в этом параметре.

Delimiter -> (string)

Разделитель для группировки включенных ключей. Разделитель — это символ, который вы указываете для группировки ключей. Все ключи, содержащие одну и ту же строку между префиксом и первым вхождением разделителя, группируются в одном элементе результата в CommonPrefixes. Эти группы учитываются как один результат в пределах ограничения max-keys. Эти ключи не возвращаются в других частях ответа.

MaxKeys -> (integer)

Указывает максимальное количество возвращаемых объектов.

CommonPrefixes -> (list)

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

(структура)

Контейнер для всех (если таковые имеются) ключей между префиксом и следующим вхождением строки, указанной с помощью разделителя. CommonPrefixes перечисляет ключи, которые действуют как подкаталоги в каталоге, указанном префиксом. Например, если префикс — notes/, а разделитель — слэш (/), как в notes/summer/july, то общий префикс — notes/summer/.

Prefix -> (string)

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

EncodingType -> (string)

Тип кодирования, используемый Amazon S3 для кодирования имен ключей объекта в XML-ответе.

Если вы укажете параметр запроса encoding-type, Amazon S3 включит этот элемент в ответ и вернет закодированные значения имен ключей в следующих элементах ответа:

KeyMarker, NextKeyMarker, Prefix, Key и Delimiter.

RequestCharged -> (string)

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

Примечание

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

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

Spec-Zone.ru

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