Spec-Zone.ru › AWS CLI v2

[ aws . glacier ]

set-vault-notifications

Описание

Данная операция настраивает уведомления, которые будут отправляться при возникновении определённых событий в хранилище. По умолчанию уведомления не отправляются.

Для настройки уведомлений хранилища отправьте запрос PUT к подресурсу notification-configuration хранилища. Запрос должен содержать JSON-документ, который предоставляет тему Amazon SNS и конкретные события, для которых Amazon S3 Glacier должен отправлять уведомления в эту тему.

Теме Amazon SNS необходимо предоставить разрешение на публикацию уведомлений хранилищем. Вы можете настроить хранилище для публикации уведомлений о следующих событиях хранилища:

  • ArchiveRetrievalCompleted Это событие происходит, когда завершается задача извлечения архива, инициированная ( InitiateJob ). Статус завершённой задачи может быть «Успешно» или «Ошибка». Уведомление, отправленное в тему SNS, является тем же выводом, что и возвращаемое значение из DescribeJob .
  • InventoryRetrievalCompleted Это событие происходит, когда завершается задача извлечения инвентаризации, инициированная ( InitiateJob ). Статус завершённой задачи может быть «Успешно» или «Ошибка». Уведомление, отправленное в тему SNS, является тем же выводом, что и возвращаемое значение из DescribeJob .

Учётная запись AWS имеет полные разрешения на выполнение всех операций (действий). Однако пользователи AWS Identity and Access Management (IAM) по умолчанию не имеют разрешений. Вам необходимо предоставить им явное разрешение на выполнение определённых действий. Дополнительную информацию см. в разделе Контроль доступа с использованием AWS Identity and Access Management (IAM) .

Концептуальная информация и базовый REST API см. в разделах Настройка уведомлений хранилища в Amazon S3 Glacier и Настройка конфигурации уведомлений хранилища в руководстве разработчика Amazon Glacier.

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

Синтаксис

  set-vault-notifications
--account-id <value>
--vault-name <value>
[--vault-notification-config <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]

Параметры

--account-id (строка)

Значение AccountId — это идентификатор учётной записи AWS, владеющей хранилищем. Вы можете указать идентификатор учётной записи AWS или необязательно один символ ‘-’ (тире), в этом случае Amazon S3 Glacier использует идентификатор учётной записи AWS, связанный с учетными данными, используемыми для подписания запроса. Если вы используете идентификатор учётной записи, не включайте в него тире (‘-’).

--vault-name (строка)

Имя хранилища.

--vault-notification-config (структура)

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

SNSTopic -> (строка)

Amazon Resource Name (ARN) темы Amazon Simple Notification Service (Amazon SNS).

Events -> (список)

Список одного или нескольких событий, для которых Amazon S3 Glacier отправит уведомление в указанную тему Amazon SNS.

(строка)

Сокращённый синтаксис:

SNSTopic=string,Events=string,string

JSON-синтаксис:

{
  "SNSTopic": "string",
  "Events": ["string", ...]
}

--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
  • текст
  • таблица
  • 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 CLI. Подробную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Следующая команда настраивает уведомления SNS для хранилища с именем my-vault:

aws glacier set-vault-notifications --account-id - --vault-name my-vault --vault-notification-config file://notificationconfig.json

notificationconfig.json — это JSON-файл в текущей папке, который определяет тему SNS и события для публикации:

{
  "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault",
  "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"]
}

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

Вывод

Нет

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

Spec-Zone.ru

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