Spec-Zone.ru › AWS CLI v2

[ aws . budgets ]

describe-budget

Описание

Описывает бюджет.

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

Раздел "Синтаксис запроса" показывает синтаксис BudgetLimit. Для PlannedBudgetLimits, см. раздел Примеры.

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

Синтаксис

  describe-budget
--account-id <value>
--budget-name <value>
[--show-filter-expression | --no-show-filter-expression]
[--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, связанный с бюджетом, описание которого требуется.

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

Имя бюджета, описание которого требуется.

--show-filter-expression | --no-show-filter-expression (логическое значение)

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

--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 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-budget --account-id 111122223333 --budget-name "Example Budget"

Вывод:

{
   "Budget": {
       "CalculatedSpend": {
           "ForecastedSpend": {
               "Amount": "2641.54800000000022919266484677791595458984375",
               "Unit": "USD"
           },
           "ActualSpend": {
               "Amount": "604.4560000000000172803993336856365203857421875",
               "Unit": "USD"
           }
       },
       "BudgetType": "COST",
       "BudgetLimit": {
           "Amount": "100",
           "Unit": "USD"
       },
       "BudgetName": "Example Budget",
       "CostTypes": {
           "IncludeOtherSubscription": true,
           "IncludeUpfront": true,
           "IncludeRefund": true,
           "UseBlended": false,
           "IncludeDiscount": true,
           "UseAmortized": false,
           "IncludeTax": true,
           "IncludeCredit": true,
           "IncludeSupport": true,
           "IncludeRecurring": true,
           "IncludeSubscription": true
       },
       "TimeUnit": "MONTHLY",
       "TimePeriod": {
           "Start": 1477958399.0,
           "End": 3706473600.0
       },
       "CostFilters": {
           "AZ": [
               "us-east-1"
           ]
       }
   }
}

Вывод

Бюджет -> (структура)

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

ИмяБюджета -> (строка)

Название бюджета. Название должно быть уникальным в рамках учетной записи. Символы : и \, а также подстрока «/action/» не допускаются в BudgetName.

ПределБюджета -> (структура)

Общая сумма затрат, использования, использования RI, покрытия RI, использования Планов экономии или покрытия Планов экономии, которые вы хотите отслеживать с помощью своего бюджета.

BudgetLimit требуется для бюджетов затрат или использования, но является необязательным для бюджетов использования или покрытия RI или Планов экономии. Бюджеты использования или покрытия RI или Планов экономии по умолчанию устанавливаются в 100. Это единственное допустимое значение для бюджетов использования или покрытия RI или Планов экономии. Вы не можете использовать BudgetLimit с PlannedBudgetLimits для действий CreateBudget и UpdateBudget.

Сумма -> (строка)

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

Единица -> (строка)

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

ПланируемыеПределыБюджета -> (карта)

Карта, содержащая несколько BudgetLimit, включая текущие или будущие лимиты.

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

Для ежемесячных бюджетов предоставьте значения на 12 месяцев PlannedBudgetLimits. Это должно начинаться с текущего месяца и включать следующие 11 месяцев. key — начало месяца, UTC — в секундах эпохи.

Для квартальных бюджетов предоставьте записи значений PlannedBudgetLimits за четыре квартала с шагом стандартного календарного квартала. Это должно начинаться с текущего квартала и включать следующие три квартала. key — начало квартала, UTC — в секундах эпохи.

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

Если бюджет начинается в будущем, предоставьте значения PlannedBudgetLimits с даты начала бюджета.

После использования всех значений BudgetLimit в PlannedBudgetLimits бюджет продолжает использовать последний лимит в качестве BudgetLimit. В этот момент планируемый бюджет обеспечивает тот же опыт, что и фиксированный бюджет.

DescribeBudget и DescribeBudgets ответ вместе с PlannedBudgetLimits также содержат BudgetLimit, представляющие текущий месячный или квартальный лимит, присутствующий в PlannedBudgetLimits. Это относится только к бюджетам, созданным с помощью PlannedBudgetLimits. Бюджеты, созданные без PlannedBudgetLimits, содержат только BudgetLimit. Они не содержат PlannedBudgetLimits.

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

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

значение -> (структура)

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

Пример затрат: Spend для 3 USD затрат имеет следующие параметры:
  • Amount 3
  • Unit USD
Пример использования: Spend для 3 GB использования S3 имеет следующие параметры:
  • Amount 3
  • Unit GB

Сумма -> (строка)

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

Единица -> (строка)

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

ФильтрыЗатрат -> (карта)

Фильтры затрат, такие как Region, Service, LinkedAccount, Tag или CostCategory, применяемые к бюджету.

Amazon Web Services Budgets поддерживает следующие сервисы в качестве фильтра Service для бюджетов RI:

  • Amazon EC2
  • Amazon Redshift
  • Amazon Relational Database Service
  • Amazon ElastiCache
  • Amazon OpenSearch Service

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

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

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

(строка)

ТипыЗатрат -> (структура)

Типы затрат, включенные в этот бюджет COST.

USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION и SAVINGS_PLANS_COVERAGE бюджеты не содержат CostTypes.

ВключатьНалог -> (булево)

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

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

ВключатьПодписку -> (булево)

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

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

ИспользоватьСмешанный -> (булево)

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

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

ВключатьВозврат -> (булево)

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

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

ВключатьКредит -> (булево)

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

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

ВключатьАванс -> (булево)

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

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

ВключатьПовторные -> (булево)

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

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

ВключатьДругуюПодписку -> (булево)

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

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

ВключатьПоддержку -> (булево)

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

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

ВключатьСкидку -> (булево)

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

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

ИспользоватьАмортизированную -> (булево)

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

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

ЕдиницаВремени -> (строка)

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

ПериодВремени -> (структура)

Период времени, охватываемый бюджетом. Вы устанавливаете начальную и конечную дату. Начальная дата должна предшествовать конечной. Конечная дата должна предшествовать 06/15/87 00:00 UTC.

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

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

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

Начало -> (метка времени)

Начальная дата бюджета. Если вы создали бюджет и не указали начальную дату, 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.

Конец -> (метка времени)

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

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

ВычисленныеЗатраты -> (структура)

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

ФактическиеЗатраты -> (структура)

Сумма затрат, использования, единиц RI или единиц Планов экономии, которые вы использовали.

Сумма -> (строка)

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

Единица -> (строка)

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

ПрогнозируемыеЗатраты -> (структура)

Сумма затрат, использования, единиц RI или единиц Планов экономии, которые, по прогнозам, будут использованы.

Сумма -> (строка)

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

Единица -> (строка)

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

ТипБюджета -> (строка)

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

ВремяПоследнегоОбновления -> (метка времени)

Последний момент обновления этого бюджета.

ДанныеАвтоматическойНастройки -> (структура)

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

AutoAdjustType -> (строка)

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

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

Параметры, определяющие или описывающие исторические данные, на которых основывается ваш автоматический бюджет.

BudgetAdjustmentPeriod -> (целое число)

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

  • Для гранулярности DAILY максимальное значение равно 60.
  • Для гранулярности MONTHLY максимальное значение равно 12.
  • Для гранулярности QUARTERLY максимальное значение равно 4.
  • Для гранулярности ANNUALLY максимальное значение равно 1.

LookBackAvailablePeriods -> (целое число)

Целое число, описывающее количество периодов бюджета в вашем BudgetAdjustmentPeriod, включенных в вычисление вашего текущего BudgetLimit. Если у первого периода бюджета в вашем BudgetAdjustmentPeriod нет данных о затратах, то этот период не включается в среднее значение, определяющее ваш лимит бюджета.

Например, если вы установили BudgetAdjustmentPeriod как 4 кварталов, но в вашем аккаунте не было данных о затратах в первом квартале, то в расчёт включаются только последние три квартала. В этом случае, LookBackAvailablePeriods возвращает 3.

Вы не можете задавать своё собственное значение LookBackAvailablePeriods. Значение автоматически вычисляется из BudgetAdjustmentPeriod и ваших исторических данных о затратах.

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

Последнее время, когда ваш бюджет был автоматически отрегулирован.

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

Фильтровальные измерения для бюджета и соответствующие значения.

Or -> (список)

Возвращает результаты, соответствующие любому из объектов измерения.

(структура)

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

Or -> (список)

Возвращает результаты, соответствующие любому из объектов измерения.

(… рекурсивно …)

And -> (список)

Возвращает результаты, соответствующие обоим объектам измерения.

(… рекурсивно …)

(… рекурсивно …)Dimensions -> (структура)

Конкретное измерение для использования в Expression.

Key -> (строка)

Имя измерения, по которому вы хотите отфильтровать.

Values -> (список)

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

(строка)

MatchOptions -> (список)

Параметры сопоставления, которые вы можете использовать для фильтрации результатов. Вы можете указать только одно из этих значений в массиве.

(строка)

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

Конкретная метка для использования в Expression.

Key -> (строка)

Ключ для метки.

Values -> (список)

Конкретное значение метки.

(строка)

MatchOptions -> (список)

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

(строка)

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

Фильтр, основанный на CostCategoryValues.

Key -> (строка)

Уникальное имя категории затрат.

Values -> (список)

Конкретное значение категории затрат.

(строка)

MatchOptions -> (список)

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

(строка)

And -> (список)

Возвращает результаты, соответствующие обоим объектам измерения.

(структура)

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

Or -> (список)

Возвращает результаты, соответствующие любому из объектов измерения.

(… рекурсивно …)

And -> (список)

Возвращает результаты, соответствующие обоим объектам измерения.

(… рекурсивно …)

(… рекурсивно …)Dimensions -> (структура)

Конкретное измерение для использования в Expression.

Key -> (строка)

Имя измерения, по которому вы хотите отфильтровать.

Values -> (список)

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

(строка)

MatchOptions -> (список)

Параметры сопоставления, которые вы можете использовать для фильтрации результатов. Вы можете указать только одно из этих значений в массиве.

(строка)

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

Конкретная метка для использования в Expression.

Key -> (строка)

Ключ для метки.

Values -> (список)

Конкретное значение метки.

(строка)

MatchOptions -> (список)

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

(строка)

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

Фильтр, основанный на CostCategoryValues.

Key -> (строка)

Уникальное имя категории затрат.

Values -> (список)

Конкретное значение категории затрат.

(строка)

MatchOptions -> (список)

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

(строка)

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

Возвращает результаты, не соответствующие объекту измерения.

Or -> (список)

Возвращает результаты, соответствующие любому из объектов измерения.

(… рекурсивно …)

And -> (список)

Возвращает результаты, соответствующие обоим объектам измерения.

(… рекурсивно …)

(… рекурсивно …)Dimensions -> (структура)

Конкретное измерение для использования в Expression.

Key -> (строка)

Имя измерения, по которому вы хотите отфильтровать.

Values -> (список)

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

(строка)

MatchOptions -> (список)

Параметры сопоставления, которые вы можете использовать для фильтрации результатов. Вы можете указать только одно из этих значений в массиве.

(строка)

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

Конкретная метка для использования в Expression.

Key -> (строка)

Ключ для метки.

Values -> (список)

Конкретное значение метки.

(строка)

MatchOptions -> (список)

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

(строка)

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

Фильтр, основанный на CostCategoryValues.

Key -> (строка)

Уникальное имя категории затрат.

Values -> (список)

Конкретное значение категории затрат.

(строка)

MatchOptions -> (список)

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

(строка)

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

Конкретное измерение для использования в Expression.

Key -> (строка)

Имя измерения, по которому вы хотите отфильтровать.

Values -> (список)

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

(строка)

MatchOptions -> (список)

Параметры сопоставления, которые вы можете использовать для фильтрации результатов. Вы можете указать только одно из этих значений в массиве.

(строка)

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

Конкретная метка для использования в Expression.

Key -> (строка)

Ключ для метки.

Values -> (список)

Конкретное значение метки.

(строка)

MatchOptions -> (список)

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

(строка)

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

Фильтр, основанный на CostCategoryValues.

Key -> (строка)

Уникальное имя категории затрат.

Values -> (список)

Конкретное значение категории затрат.

(строка)

MatchOptions -> (список)

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

(строка)

Metrics -> (список)

Определение того, как агрегируются данные бюджета.

(строка)

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

Spec-Zone.ru

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