Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

list-directory-buckets

Описание

Возвращает список всех каталожных ведер Amazon S3, принадлежащих аутентифицированному отправителю запроса. Дополнительную информацию о каталожных ведрах см. в разделе «Каталожные ведра» в Руководстве пользователя Amazon S3.

Примечание

Каталожные ведра - Для каталожных ведер необходимо отправлять запросы для данной операции API на региональный конечный пункт. Эти конечные пункты поддерживают запросы со стилем пути в формате ``https://s3express-control.*region-code* .amazonaws.com/bucket-name ``. Запросы со стилем виртуального хостинга не поддерживаются. Дополнительную информацию о конечных пунктах в зонах доступности см. в разделе «Региональные и зональные конечные пункты для каталожных ведер в зонах доступности» в Руководстве пользователя Amazon S3. Дополнительную информацию о конечных пунктах в локальных зонах см. в разделе «Концепции для каталожных ведер в локальных зонах» в Руководстве пользователя Amazon S3.

Разрешения

Вам необходимо иметь разрешение s3express:ListAllMyDirectoryBuckets в политике управления IAM вместо политики ведра. Доступ к этой операции API из других учетных записей не поддерживается. Данная операция может быть выполнена только учетной записью Amazon Web Services, владеющей ресурсом. Дополнительную информацию о политиках и разрешениях каталожных ведер см. в разделе «Управление идентификацией и доступом Amazon Web Services (IAM) для S3 Express One Zone» в Руководстве пользователя Amazon S3.

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

Каталожные ведра - Синтаксис заголовка HTTP Host - s3express-control.*region* .amazonaws.com.

Примечание

Элемент ответа BucketRegion не входит в синтаксис ответа ListDirectoryBuckets.

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

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

Синопсис

  list-directory-buckets
[--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]

Параметры

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

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла параметров.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • включено
  • выключено
  • авто

--no-sign-request (булево)

Не подписывать запросы. Кредиты не будут загружаться, если этот аргумент указан.

--ca-bundle (строка)

Файл с набором сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

Ведра -> (список)

Список ведер, принадлежащих запросившему.

(структура)

С точки зрения реализации, ведро является ресурсом.

Имя -> (строка)

Имя ведра.

CreationDate -> (метка времени)

Дата создания ведра. Эта дата может измениться при внесении изменений в ведро, например, при редактировании его политики.

BucketRegion -> (строка)

BucketRegion указывает регион Amazon Web Services, в котором расположено ведро. Если запрос содержит хотя бы один допустимый параметр, он включен в ответ.

ContinuationToken -> (строка)

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

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

Spec-Zone.ru

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