Spec-Zone.ru › AWS CLI v2

[ aws . budgets ]

describe-notifications-for-budget

Описание

Отображает уведомления, связанные с бюджетом.

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

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

Синтаксис

  describe-notifications-for-budget
--account-id <value>
--budget-name <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]

Параметры

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

Идентификатор accountId, связанный с бюджетом, уведомления о котором требуется получить.

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

Название бюджета, уведомления о котором требуется получить.

--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
  • 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-auto-prompt (логическое значение)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

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

Получение уведомлений о бюджете

В этом примере извлекаются уведомления о бюджете затрат и использования.

Команда:

aws budgets describe-notifications-for-budget --account-id 111122223333 --budget-name "Example Budget" --max-results 5

Вывод:

{
   "Notifications": [
       {
           "Threshold": 80.0,
           "ComparisonOperator": "GREATER_THAN",
           "NotificationType": "ACTUAL"
       }
   ]
}

Вывод

Уведомления -> (список)

Список уведомлений, связанных с бюджетом.

(структура)

Уведомление, связанное с бюджетом. Бюджет может иметь до десяти уведомлений.

Каждое уведомление должно иметь хотя бы одного подписчика. Уведомление может иметь одного подписчика SNS и до 10 подписчиков электронной почты, в общей сложности 11 подписчиков.

Например, если у вас есть бюджет в 200 долларов и вы хотите получать уведомления, когда превысите 160 долларов, создайте уведомление со следующими параметрами:

  • Тип уведомления ACTUAL
  • thresholdType значении PERCENTAGE
  • comparisonOperator значении GREATER_THAN
  • threshold уведомления значении 80

NotificationType -> (строка)

Указывает, относится ли уведомление к затратам (ACTUAL) или прогнозируемым затратам (FORECASTED).

ComparisonOperator -> (строка)

Операция сравнения для данного уведомления.

Threshold -> (двойное)

Порог, связанный с уведомлением. Пороги всегда выражаются в процентах, и многие клиенты находят полезным получать оповещения в диапазоне 50% - 200% от выделенного бюджета. Максимальное значение порога составляет 1 000 000% выше выделенного бюджета.

ThresholdType -> (строка)

Тип порога для уведомления. Для порогов ABSOLUTE_VALUE Amazon Web Services уведомляет вас, когда вы превышаете или прогнозируется превышение порога общих затрат. Для порогов PERCENTAGE Amazon Web Services уведомляет вас, когда вы превышаете или прогнозируется превышение определенного процента от прогнозируемых затрат. Например, если у вас бюджет в 200 долларов и у вас есть порог PERCENTAGE 80%, Amazon Web Services уведомляет вас, когда вы превышаете 160 долларов.

NotificationState -> (строка)

Указывает, находится ли это уведомление в состоянии тревоги. Если уведомление о бюджете находится в состоянии ALARM, вы превысили установленный порог для бюджета.

NextToken -> (строка)

Маркер постраничного вывода в ответ от сервиса, который указывает следующий набор результатов, которые можно получить.

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

Spec-Zone.ru

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