Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

обновление уведомления подписчика

Описание

Обновляет существующий метод уведомления для подписки (конечная точка SQS или HTTPs) или переключает конечную точку подписки на уведомления для подписчика.

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

Синтаксис

  update-subscriber-notification
--configuration <value>
--subscriber-id <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]

Параметры

--configuration (структура помеченного союза)

Настройка уведомления подписчика.

Примечание

Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен: httpsNotificationConfiguration, sqsNotificationConfiguration.

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

Настройки, используемые для уведомления подписчика по HTTPS.

authorizationApiKeyName -> (строка)

Имя ключа для подписки на уведомления.

authorizationApiKeyValue -> (строка)

Значение ключа для подписки на уведомления.

endpoint -> (строка)

Конечная точка подписки в Security Lake. Если вы предпочитаете уведомления по HTTPs, заполните это поле.

httpMethod -> (строка)

Метод HTTPS, используемый для подписки на уведомления.

targetRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM для API-назначений EventBridge, которую вы создали. Дополнительную информацию об ARN и их использовании в политиках см. в руководстве пользователя Amazon Security Lake, раздел «Управление доступом к данным и управляемые политики Amazon Web Services».

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

Настройки для уведомления подписчика через SQS.

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

httpsNotificationConfiguration={authorizationApiKeyName=string,authorizationApiKeyValue=string,endpoint=string,httpMethod=string,targetRoleArn=string},sqsNotificationConfiguration={}

Синтаксис JSON:

{
  "httpsNotificationConfiguration": {
    "authorizationApiKeyName": "string",
    "authorizationApiKeyValue": "string",
    "endpoint": "string",
    "httpMethod": "POST"|"PUT",
    "targetRoleArn": "string"
  },
  "sqsNotificationConfiguration": {

  }
}

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

Идентификатор подписки, для которой указано уведомление о подписке.

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Для обновления уведомления подписчика

Следующий update-subscriber-notification пример демонстрирует, как обновить метод уведомления для подписчика.

aws securitylake update-subscriber-notification \
    --subscriber-id "12345ab8-1a34-1c34-1bd4-12345ab9012" \
    --configuration '{"httpsNotificationConfiguration": {"targetRoleArn":"arn:aws:iam::XXX:role/service-role/RoleName", "endpoint":"https://account-management.$3.$2.securitylake.aws.dev/v1/datalake"}}'

Вывод:

{
    "subscriberEndpoint": [
        "https://account-management.$3.$2.securitylake.aws.dev/v1/datalake"
    ]
}

Дополнительную информацию см. в разделе «Управление подписчиками» в руководстве пользователя Amazon Security Lake.

Вывод

subscriberEndpoint -> (строка)

Конечная точка подписчика, в которую публикуются сообщения об ошибках.

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

Spec-Zone.ru

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