head-bucket
Описание
Вы можете использовать эту операцию, чтобы определить, существует ли ведро и разрешено ли вам к нему доступ. Действие возвращает 200 OK, если ведро существует и вам разрешен доступ к нему.
Примечание
Если ведро не существует или у вас нет разрешения на доступ к нему, запрос HEAD возвращает общий код 400 Bad Request, 403 Forbidden или 404 Not Found. Тело сообщения не включено, поэтому вы не можете определить исключение, кроме этих кодов HTTP-ответов.
Аутентификация и авторизация
Ведра общего назначения - Запросы к общедоступным ведрам, предоставляющим разрешение s3:ListBucket публично, не требуют подписи. Все остальные HeadBucket запросы должны быть аутентифицированы и подписаны с помощью учетных данных IAM (идентификатор ключа доступа и секретный ключ доступа для учетных записей IAM). Все заголовки с префиксом x-amz-, включая x-amz-copy-source, должны быть подписаны. Дополнительную информацию см. в разделе REST Authentication.
Ведра каталогов - Вы должны использовать учетные данные IAM для аутентификации и авторизации доступа к HeadBucket API-операции вместо использования временных учетных данных безопасности через CreateSession API-операцию.
Amazon Web Services CLI или SDK выполняют аутентификацию и авторизацию от вашего имени.
-
Разрешения для ведер общего назначения - Для использования этой операции вам необходимо иметь разрешения для выполнения действия
s3:ListBucket. Владелец ведра имеет это разрешение по умолчанию и может предоставить его другим. Дополнительную информацию о разрешениях см. в разделе Управление разрешениями доступа к вашим ресурсам Amazon S3 в руководстве пользователя Amazon S3. -
Разрешения для ведер каталогов - Вам необходимо иметь разрешение **
s3express:CreateSession** в элементеActionполитики. По умолчанию сессия находится в режимеReadWrite. Если вы хотите ограничить доступ, вы можете явно установить ключевое условиеs3express:SessionModeвReadOnlyдля ведра. Дополнительную информацию о примерах политик ведер см. в примере политик ведер для S3 Express One Zone и политиках Amazon Web Services Identity and Access Management (IAM) на основе идентификаторов для S3 Express One Zone в руководстве пользователя Amazon S3.Синтаксис заголовка HTTP Host
Примечание
Вы должны отправлять запросы для этой API-операции на зональный конечный пункт. Эти конечные пункты поддерживают запросы в стиле виртуального хостинга в форматеhttps://*bucket-name* .s3express-*zone-id* .*region-code* .amazonaws.com. Запросы в стиле пути не поддерживаются. Дополнительную информацию о конечных точках в зонах доступности см. в разделе Региональные и зональные конечные точки для ведер каталогов в зонах доступности в руководстве пользователя Amazon S3. Дополнительную информацию о конечных точках в локальных зонах см. в разделе Концепции для ведер каталогов в локальных зонах в руководстве пользователя Amazon S3.См. также: AWS API Documentation
Синопсис
head-bucket
--bucket <value>
[--expected-bucket-owner <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 (строка)
Имя ведра.
Ведра каталогов - При использовании этой операции с ведром каталога вы должны использовать запросы в стиле виртуального хостинга в формате `` Имя_ведра .s3express-id_зоны .*код_региона* .amazonaws.com`` . Запросы в стиле пути не поддерживаются. Имена ведер каталогов должны быть уникальными в выбранной зоне (зоне доступности или локальной зоне). Имена ведер должны соответствовать формату `` основное_имя_ведра –id_зоны –x-s3`` (например, `` amzn-s3-demo-bucket –usw2-az1 –x-s3`` ). Сведения о ограничениях именования ведер см. в правилах именования ведер каталогов в руководстве пользователя Amazon S3.
Точки доступа - При использовании этого действия с точкой доступа для ведер общего назначения вы должны указать псевдоним точки доступа вместо имени ведра или указать ARN точки доступа. При использовании этого действия с точкой доступа для ведер каталогов вы должны указать имя точки доступа вместо имени ведра. При использовании ARN точки доступа вы должны направить запросы на хост-имя точки доступа. Хост-имя точки доступа имеет вид Имя_точки_доступа -ID_аккаунта .s3-accesspoint.*Регион* .amazonaws.com. При использовании этого действия с точкой доступа через Amazon Web Services SDK вы предоставляете ARN точки доступа вместо имени ведра. Дополнительную информацию об ARN точек доступа см. в разделе Использование точек доступа в руководстве пользователя Amazon S3.
Точки доступа Object Lambda - При использовании этой API-операции с точкой доступа Object Lambda укажите псевдоним точки доступа Object Lambda вместо имени ведра. Если псевдоним точки доступа Object Lambda в запросе недействителен, возвращается код ошибки InvalidAccessPointAliasError. Дополнительную информацию о InvalidAccessPointAliasError см. в списке кодов ошибок.
Примечание
S3 в Outposts - При использовании этого действия с S3 в Outposts вы должны направить запросы на хост-имя S3 в Outposts. Хост-имя S3 в Outposts имеет вид `` Имя_точки_доступа -ID_аккаунта .*ID_outpost* .s3-outposts.*Регион* .amazonaws.com`` . При использовании этого действия с S3 в Outposts целевое ведро должно быть ARN точки доступа Outposts или псевдонимом точки доступа. Дополнительную информацию о S3 в Outposts см. в разделе Что такое S3 в Outposts? в руководстве пользователя Amazon S3.
--expected-bucket-owner (строка)
403 Forbidden (доступ запрещен).--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
- 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 для вывода.
--cli-auto-prompt (булево)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.
Следующая команда проверяет доступ к ведру с именем amzn-s3-demo-bucket:
aws s3api head-bucket --bucket amzn-s3-demo-bucket
Если ведро существует и у вас есть к нему доступ, вывод не возвращается. В противном случае будет отображено сообщение об ошибке. Например:
A client error (404) occurred when calling the HeadBucket operation: Not Found
Вывод
BucketLocationType -> (строка)
Тип расположения, где создается ведро.
Примечание
Данная функциональность поддерживается только ведрами каталогов.BucketLocationName -> (строка)
Имя расположения, где будет создано ведро.
Для ведер каталогов — идентификатор зоны доступности или локальной зоны, где создаётся ведро. Пример значения идентификатора зоны для зоны доступности — usw2-az1 .
Примечание
Данная функциональность поддерживается только ведрами каталогов.BucketRegion -> (строка)
AccessPointAlias -> (булево)
Указывает, является ли имя ведра, используемое в запросе, псевдонимом точки доступа.
Примечание
Для ведер каталогов значение этого поля равноfalse .
© Copyright 2025, Amazon Web Services. Created using Sphinx.