list-objects-v2

Описание

Возвращает некоторые или все (до 1000) объекты в ведре с каждым запросом. Вы можете использовать параметры запроса в качестве критериев выбора для возвращения подмножества объектов в ведре. Ответ 200 OK может содержать допустимый или недопустимый XML. Убедитесь, что ваше приложение спроектировано для разбора содержимого ответа и обработки его соответствующим образом. Дополнительную информацию о перечислении объектов см. в разделе Программное перечисление ключей объектов в Руководстве пользователя Amazon S3. Чтобы получить список ваших ведер, см. ListBuckets.

• Разрешения ведер общего назначения - Для использования этой операции необходимо иметь доступ для чтения к ведру. Вам необходимо иметь разрешение на выполнение операции s3:ListBucket. Владелец ведра имеет это разрешение по умолчанию и может предоставить это разрешение другим. Дополнительную информацию о разрешениях см. в разделах Разрешения, связанные с операциями над подресурсами ведра, и Управление разрешениями доступа к вашим ресурсам Amazon S3 в Руководстве пользователя Amazon S3.

• Разрешения ведер каталогов - Для предоставления доступа к этой операции API для ведра каталога рекомендуется использовать операцию API ` CreateSession https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html`__ для авторизации на основе сеанса. В частности, вы предоставляете разрешение s3express:CreateSession ведру каталога в политике ведра или политике на основе идентификатора IAM. Затем вы выполняете вызов API CreateSession по ведру для получения маркера сеанса. С маркером сеанса в вашем заголовке запроса вы можете отправлять запросы API в эту операцию. После истечения срока действия маркера сеанса выполните еще один вызов API CreateSession для генерации нового маркера сеанса для использования. Amazon Web Services CLI или SDK автоматически создают сеанс и обновляют маркер сеанса, чтобы избежать перерывов в работе службы при истечении срока действия сеанса. Дополнительную информацию об авторизации см. в ` CreateSession https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html`__.

  Порядок сортировки возвращаемых объектов

• Ведра общего назначения - Для ведер общего назначения, ListObjectsV2 возвращает объекты в лексикографическом порядке на основе их имен ключей.

• Ведра каталогов - Для ведер каталогов, ListObjectsV2 не возвращает объекты в лексикографическом порядке.

  Синтаксис заголовка HTTP Host

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

• GetObject
• PutObject
• CreateBucket

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

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

Синтаксис

  list-objects-v2
--bucket <value>
[--delimiter <value>]
[--encoding-type <value>]
[--prefix <value>]
[--fetch-owner | --no-fetch-owner]
[--start-after <value>]
[--request-payer <value>]
[--expected-bucket-owner <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 (строка)

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

--prefix (строка)

--fetch-owner | --no-fetch-owner (булево)

--start-after (строка)

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

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

--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 (строка)

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение null или 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 s3api list-objects-v2 \
    --bucket amzn-s3-demo-bucket

Вывод:

{
    "Contents": [
        {
            "LastModified": "2019-11-05T23:11:50.000Z",
            "ETag": "\"621503c373607d548b37cff8778d992c\"",
            "StorageClass": "STANDARD",
            "Key": "doc1.rtf",
            "Size": 391
        },
        {
            "LastModified": "2019-11-05T23:11:50.000Z",
            "ETag": "\"a2cecc36ab7c7fe3a71a273b9d45b1b5\"",
            "StorageClass": "STANDARD",
            "Key": "doc2.rtf",
            "Size": 373
        },
        {
            "LastModified": "2019-11-05T23:11:50.000Z",
            "ETag": "\"08210852f65a2e9cb999972539a64d68\"",
            "StorageClass": "STANDARD",
            "Key": "doc3.rtf",
            "Size": 399
        },
        {
            "LastModified": "2019-11-05T23:11:50.000Z",
            "ETag": "\"d1852dd683f404306569471af106988e\"",
            "StorageClass": "STANDARD",
            "Key": "doc4.rtf",
            "Size": 6225
        }
    ]
}

Вывод

IsTruncated -> (boolean)

Contents -> (список)

Name -> (строка)

Prefix -> (строка)

Delimiter -> (строка)

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

CommonPrefixes -> (список)

EncodingType -> (строка)

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

ContinuationToken -> (строка)

NextContinuationToken -> (строка)

StartAfter -> (строка)

RequestCharged -> (строка)