Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

list-budgets

Описание

Список бюджетов в ферме.

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

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

Синтаксис

  list-budgets
--farm-id <value>
[--status <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]

Параметры

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

Идентификатор фермы, связанной с бюджетами.

--status (строка)

Статус бюджетов для отображения.

Возможные значения:

  • ACTIVE
  • INACTIVE

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

nextToken -> (строка)

Если Deadline Cloud возвращает nextToken, значит, доступны дополнительные результаты. Значение nextToken — уникальный токен постраничной обработки для каждой страницы. Для получения следующей страницы вызовите операцию снова, используя возвращенный токен. Все остальные аргументы остаются неизменными. Если больше результатов нет, то nextToken установлено в значение null. Каждый токен постраничной обработки действует 24 часа. Если вы предоставите недействительный токен, вы получите ошибку HTTP 400 ValidationException.

budgets -> (список)

Бюджеты для включения в список.

(структура)

Резюме бюджета.

budgetId -> (строка)

Идентификатор бюджета.

usageTrackingResource -> (структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхних ключей: queueId.

queueId -> (строка)

Идентификатор очереди.

status -> (строка)

Статус бюджета.

  • ACTIVE — Бюджет оценивается.
  • INACTIVE — Бюджет неактивен. Это может включать статусы «Просрочен», «Отменен» или «Удален».

displayName -> (строка)

Имя для отображения резюме бюджета, подлежащего обновлению.

Предупреждение

Это поле может хранить любое содержимое. Прежде чем отображать это содержимое на веб-странице или в любой другой системе, которая может интерпретировать содержимое этого поля, необходимо его обработать или закодировать.

description -> (строка)

Описание резюме бюджета.

Предупреждение

Это поле может хранить любое содержимое. Прежде чем отображать это содержимое на веб-странице или в любой другой системе, которая может интерпретировать содержимое этого поля, необходимо его обработать или закодировать.

approximateDollarLimit -> (число с плавающей запятой)

Приблизительный предел бюджета в долларах.

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

Потребленное использование для бюджета.

approximateDollarUsage -> (число с плавающей запятой)

Потребленная сумма бюджета.

createdBy -> (строка)

Пользователь или система, создавшая этот ресурс.

createdAt -> (метка времени)

Дата и время создания ресурса.

updatedBy -> (строка)

Пользователь или система, обновившая этот ресурс.

updatedAt -> (метка времени)

Дата и время обновления ресурса.

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

Spec-Zone.ru

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