Spec-Zone.ru › AWS CLI v2

[ aws . budgets ]

describe-budget-performance-history

Описание

Описывает историю DAILY , MONTHLY и QUARTERLY бюджетов. История бюджетов недоступна для ANNUAL бюджетов.

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

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

Синтаксис

  describe-budget-performance-history
--account-id <value>
--budget-name <value>
[--time-period <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 (строка)

Идентификатор учетной записи пользователя. Представляет собой 12-значное число.

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

Строка, представляющая имя бюджета. Символы «:» и «"», а также подстрока «/action/» запрещены.

--time-period (структура)

Получает частоту перехода бюджета в состояние ALARM за указанный период.

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

Начальная дата для бюджета. Если вы создали бюджет и не указали начальную дату, Amazon Web Services по умолчанию устанавливает её к началу выбранного периода (DAILY, MONTHLY, QUARTERLY или ANNUALLY). Например, если вы создали бюджет 24 января 2018 года, выбрали DAILY и не задали начальную дату, Amazon Web Services установила начальную дату на 01/24/18 00:00 UTC . Если вы выбрали MONTHLY , Amazon Web Services установила начальную дату на 01/01/18 00:00 UTC . Значения по умолчанию одинаковы для консоли Billing and Cost Management и API.

Вы можете изменить начальную дату с помощью операции UpdateBudget.

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

Конечная дата для бюджета. Если вы не указали конечную дату, Amazon Web Services по умолчанию устанавливает её на 06/15/87 00:00 UTC . Значения по умолчанию одинаковы для консоли Billing and Cost Management и API.

После конечной даты Amazon Web Services удаляет бюджет и все связанные уведомления и подписчиков. Вы можете изменить конечную дату с помощью операции UpdateBudget.

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

Start=timestamp,End=timestamp

Синтаксис JSON:

{
  "Start": timestamp,
  "End": timestamp
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставляемому --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передать произвольные двоичные значения с помощью значения JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-службы из-за превышения времени ожидания.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.

--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.

Вывод

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

История частоты достижения бюджетом состояния ALARM.

Для бюджетов с DAILY периодом, история сохраняет состояние бюджета за последние 60 дней. Для бюджетов с MONTHLY периодом, история сохраняет состояние бюджета за текущий месяц и последние 12 месяцев. Для бюджетов с QUARTERLY периодом, история сохраняет состояние бюджета за последние четыре квартала.

BudgetName -> (строка)

Строка, представляющая имя бюджета. Символы «:», «"» и подстрока «/action/» запрещены.

BudgetType -> (строка)

Тип бюджета. Он должен быть одним из следующих типов:

COST , USAGE , RI_UTILIZATION , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION или SAVINGS_PLANS_COVERAGE .

CostFilters -> (карта)

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

ключ -> (строка)

Общая строка.

значение -> (список)

(строка)

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

История типов затрат для бюджета за указанный период.

IncludeTax -> (булево)

Указывает, включает ли бюджет налоги.

Значение по умолчанию — true .

IncludeSubscription -> (булево)

Указывает, включает ли бюджет подписки.

Значение по умолчанию — true .

UseBlended -> (булево)

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

Значение по умолчанию — false .

IncludeRefund -> (булево)

Указывает, включает ли бюджет возвраты.

Значение по умолчанию — true .

IncludeCredit -> (булево)

Указывает, включает ли бюджет кредиты.

Значение по умолчанию — true .

IncludeUpfront -> (булево)

Указывает, включает ли бюджет первоначальные расходы RI.

Значение по умолчанию — true .

IncludeRecurring -> (булево)

Указывает, включает ли бюджет повторяющиеся платежи, такие как ежемесячные платежи RI.

Значение по умолчанию — true .

IncludeOtherSubscription -> (булево)

Указывает, включает ли бюджет расходы на подписки, не связанные с RI.

Значение по умолчанию — true .

IncludeSupport -> (булево)

Указывает, включает ли бюджет расходы на подписку на поддержку.

Значение по умолчанию — true .

IncludeDiscount -> (булево)

Указывает, включает ли бюджет скидки.

Значение по умолчанию — true .

UseAmortized -> (булево)

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

Значение по умолчанию — false .

TimeUnit -> (строка)

Единица измерения времени бюджета, например, MONTHLY или QUARTERLY.

BudgetedAndActualAmountsList -> (список)

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

(структура)

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

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

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

Amount -> (строка)

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

Unit -> (строка)

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

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

Ваши фактические затраты или использование за период бюджета.

Amount -> (строка)

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

Unit -> (строка)

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

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

Период, охватываемый этим сравнением бюджета.

Start -> (временная метка)

Дата начала бюджета. Если вы создали бюджет и не указали дату начала, Amazon Web Services использует начало выбранного вами периода (DAILY, MONTHLY, QUARTERLY или ANNUALLY). Например, если вы создали бюджет 24 января 2018 года, выбрали DAILY и не задали дату начала, Amazon Web Services установили дату начала 01/24/18 00:00 UTC . Если вы выбрали MONTHLY , Amazon Web Services установили дату начала 01/01/18 00:00 UTC . Значения по умолчанию одинаковы для консоли Billing and Cost Management и API.

Вы можете изменить дату начала с помощью операции UpdateBudget.

End -> (временная метка)

Дата окончания бюджета. Если вы не указали дату окончания, Amazon Web Services установит дату окончания 06/15/87 00:00 UTC. Значения по умолчанию одинаковы для консоли Billing and Cost Management и API.

После даты окончания Amazon Web Services удалит бюджет и все связанные уведомления и подписчиков. Вы можете изменить дату окончания с помощью операции UpdateBudget.

NextToken -> (строка)

Общая строка.

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

Spec-Zone.ru

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