Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

list-buckets

Описание

Примечание

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

Возвращает список всех ведер, принадлежащих аутентифицированному отправителю запроса. Для предоставления разрешения IAM на использование этой операции необходимо добавить действие политики s3:ListAllMyBuckets.

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

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

Сильно рекомендуется использовать только запросы с постраничной ListBuckets. Непостраничные ListBuckets запросы поддерживаются только для учетных записей Amazon Web Services, настроенных на стандартный квоту ведер в 10 000. Если у вас одобрена стандартная квота ведер более 10 000, необходимо отправлять постраничные ListBuckets запросы для перечисления ведер вашей учетной записи. Все непостраничные ListBuckets запросы будут отклонены для учетных записей Amazon Web Services со стандартной квотой ведер более 10 000.

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

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

Синтаксис

  list-buckets
[--prefix <value>]
[--bucket-region <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]

Параметры

--prefix (строка)

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

--bucket-region (строка)

Ограничивает ответ ведрами, расположенными в указанном регионе Amazon Web Services. Регион Amazon Web Services должен быть выражен в соответствии с кодом региона Amazon Web Services, например, us-west-2 для региона США-Запад (Орегон). Список допустимых значений для всех регионов Amazon Web Services см. в разделе Регионы и конечные точки.

Примечание

Запросы, отправленные на региональный конечный пункт, отличный от параметра bucket-region, не поддерживаются. Например, если вы хотите ограничить ответ своими ведрами в регионе us-west-2, запрос должен быть отправлен на конечный пункт в регионе us-west-2.

--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 (целое число)

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

Следующая команда использует команду list-buckets для отображения имен всех ваших ведер Amazon S3 (во всех регионах):

aws s3api list-buckets --query "Buckets[].Name"

Параметр запроса фильтрует вывод команды list-buckets, отображая только имена ведер.

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

Вывод

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

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

(структура)

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

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

Имя ведра.

ДатаСоздание -> (метка времени)

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

РегионВедра -> (строка)

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

Владелец -> (структура)

Владелец перечисленных ведер.

ИмяДляОтображения -> (строка)

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

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

Примечание

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

ИД -> (строка)

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

МаркерПродолжения -> (строка)

ContinuationToken включается в ответ, когда есть больше ведер, которые можно перечислить с помощью постраничного вывода. Следующий запрос ListBuckets к Amazon S3 может быть продолжен с этим ContinuationToken . ContinuationToken замаскирован и не является реальным ведром.

Префикс -> (строка)

Если Prefix был отправлен вместе с запросом, он включается в ответ.

Все имена ведер в ответе начинаются с указанного префикса имени ведра.

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

Spec-Zone.ru

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