Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

get-bucket-notification-configuration

Описание

Примечание

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

Возвращает конфигурацию уведомлений ведра.

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

По умолчанию, для чтения конфигурации уведомлений ведра необходимо быть владельцем ведра. Однако, владелец ведра может использовать политику ведра для предоставления другим пользователям разрешения на чтение этой конфигурации с помощью разрешения s3:GetBucketNotification.

При использовании данной API-операции с точкой доступа, укажите псевдоним точки доступа вместо имени ведра.

При использовании данной API-операции с точкой доступа Object Lambda, укажите псевдоним точки доступа Object Lambda вместо имени ведра. Если псевдоним точки доступа Object Lambda в запросе недействителен, возвращается код ошибки InvalidAccessPointAliasError. Для получения дополнительной информации о InvalidAccessPointAliasError, см. Список кодов ошибок .

Для получения дополнительной информации о настройке и чтении конфигурации уведомлений ведра, см. Настройка уведомлений о событиях ведра. Для получения дополнительной информации о политиках ведер, см. Использование политик ведер.

Следующее действие связано с GetBucketNotification :

  • PutBucketNotification

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

Синтаксис

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

Имя ведра, для которого нужно получить конфигурацию уведомлений.

При использовании данной API-операции с точкой доступа, укажите псевдоним точки доступа вместо имени ведра.

При использовании данной API-операции с точкой доступа Object Lambda, укажите псевдоним точки доступа Object Lambda вместо имени ведра. Если псевдоним точки доступа Object Lambda в запросе недействителен, возвращается код ошибки InvalidAccessPointAliasError. Для получения дополнительной информации о InvalidAccessPointAliasError, см. Список кодов ошибок .

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

Идентификатор учетной записи ожидаемого владельца ведра. Если предоставленный идентификатор учетной записи не соответствует фактическому владельцу ведра, запрос завершается с кодом HTTP-статуса 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 (строка)

Переопределить адрес по умолчанию команды указанным адресом.

--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 get-bucket-notification-configuration --bucket amzn-s3-demo-bucket

Вывод:

{
    "TopicConfigurations": [
        {
            "Id": "YmQzMmEwM2EjZWVlI0NGItNzVtZjI1MC00ZjgyLWZDBiZWNl",
            "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-notification-topic",
            "Events": [
                "s3:ObjectCreated:*"
            ]
        }
    ]
}

Вывод

TopicConfigurations -> (список)

Тема, в которую отправляются уведомления, и события, для которых генерируются уведомления.

(структура)

Контейнер для указания конфигурации публикации сообщений в тему Amazon Simple Notification Service (Amazon SNS) при обнаружении Amazon S3 указанных событий.

Id -> (строка)

Необязательный уникальный идентификатор конфигураций в конфигурации уведомлений. Если вы его не предоставите, Amazon S3 назначит идентификатор.

TopicArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы Amazon SNS, в которую Amazon S3 публикует сообщение при обнаружении событий указанного типа.

Events -> (список)

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

(строка)

Событие ведра, для которого нужно отправлять уведомления.

Filter -> (структура)

Указывает правила фильтрации имени ключа объекта. Сведения о фильтрации имени ключа см. в разделе Настройка уведомлений об событиях с помощью фильтрации имени ключа объекта в руководстве пользователя Amazon S3.

Key -> (структура)

Контейнер для правил фильтрации префикса и суффикса имени ключа объекта.

FilterRules -> (список)

Список контейнеров для пары ключ-значение, определяющей критерии правила фильтрации.

(структура)

Указывает имя ключа объекта Amazon S3 для фильтрации. Имя ключа объекта — это имя, назначенное объекту в вашем ведре Amazon S3. Вы указываете, нужно ли фильтровать по суффиксу или префиксу имени ключа объекта. Префикс — это определенная строка символов в начале имени ключа объекта, которую можно использовать для организации объектов. Например, вы можете начать имена связанных объектов с префикса, например, 2023- или engineering/ . Затем вы можете использовать FilterRule, чтобы найти объекты в ведре с именами ключей, имеющими тот же префикс. Суффикс аналогичен префиксу, но он находится в конце имени ключа объекта, а не в начале.

Name -> (строка)

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

Value -> (строка)

Значение, которое фильтр ищет в именах ключей объектов.

QueueConfigurations -> (список)

Amazon Simple Queue Service очереди для публикации сообщений и события, для которых следует публиковать сообщения.

(структура)

Определяет конфигурацию для публикации сообщений в очередь Amazon Simple Queue Service (Amazon SQS) при обнаружении Amazon S3 указанных событий.

Id -> (строка)

Необязательный уникальный идентификатор конфигураций в конфигурации уведомлений. Если вы его не предоставите, Amazon S3 назначит идентификатор.

QueueArn -> (строка)

Идентификатор ресурса Amazon (ARN) очереди Amazon SQS, в которую Amazon S3 публикует сообщение при обнаружении событий указанного типа.

Events -> (список)

Коллекция событий ведра, для которых нужно отправлять уведомления

(строка)

Событие ведра, для которого нужно отправлять уведомления.

Filter -> (структура)

Указывает правила фильтрации имени ключа объекта. Сведения о фильтрации имени ключа см. в разделе Настройка уведомлений об событиях с помощью фильтрации имени ключа объекта в руководстве пользователя Amazon S3.

Key -> (структура)

Контейнер для правил фильтрации префикса и суффикса имени ключа объекта.

FilterRules -> (список)

Список контейнеров для пары ключ-значение, определяющей критерии правила фильтрации.

(структура)

Указывает имя ключа объекта Amazon S3 для фильтрации. Имя ключа объекта — это имя, назначенное объекту в вашем ведре Amazon S3. Вы указываете, нужно ли фильтровать по суффиксу или префиксу имени ключа объекта. Префикс — это определенная строка символов в начале имени ключа объекта, которую можно использовать для организации объектов. Например, вы можете начать имена связанных объектов с префикса, например, 2023- или engineering/ . Затем вы можете использовать FilterRule, чтобы найти объекты в ведре с именами ключей, имеющими тот же префикс. Суффикс аналогичен префиксу, но он находится в конце имени ключа объекта, а не в начале.

Name -> (строка)

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

Value -> (строка)

Значение, которое фильтр ищет в именах ключей объектов.

LambdaFunctionConfigurations -> (список)

Описание функций Lambda для вызова и событий, для которых нужно вызывать их.

(структура)

Контейнер для указания конфигурации для уведомлений Lambda.

Id -> (строка)

Необязательный уникальный идентификатор конфигураций в конфигурации уведомлений. Если вы его не предоставите, Amazon S3 назначит идентификатор.

LambdaFunctionArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda, которую Amazon S3 вызывает при возникновении указанного типа события.

Events -> (список)

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

(строка)

Событие ведра, для которого нужно отправлять уведомления.

Filter -> (структура)

Указывает правила фильтрации имени ключа объекта. Сведения о фильтрации имени ключа см. в разделе Настройка уведомлений об событиях с помощью фильтрации имени ключа объекта в руководстве пользователя Amazon S3.

Key -> (структура)

Контейнер для правил фильтрации префикса и суффикса имени ключа объекта.

FilterRules -> (список)

Список контейнеров для пары ключ-значение, определяющей критерии правила фильтрации.

(структура)

Указывает имя ключа объекта Amazon S3 для фильтрации. Имя ключа объекта — это имя, назначенное объекту в вашем ведре Amazon S3. Вы указываете, нужно ли фильтровать по суффиксу или префиксу имени ключа объекта. Префикс — это определенная строка символов в начале имени ключа объекта, которую можно использовать для организации объектов. Например, вы можете начать имена связанных объектов с префикса, например, 2023- или engineering/ . Затем вы можете использовать FilterRule, чтобы найти объекты в ведре с именами ключей, имеющими тот же префикс. Суффикс аналогичен префиксу, но он находится в конце имени ключа объекта, а не в начале.

Name -> (строка)

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

Value -> (строка)

Значение, которое фильтр ищет в именах ключей объектов.

EventBridgeConfiguration -> (структура)

Включает доставку событий в Amazon EventBridge.

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

Spec-Zone.ru

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