describe-cost-category-definition

Описание

Возвращает имя, Amazon Resource Name (ARN), правила, определение и даты действия категории затрат, определенной в аккаунте.

У вас есть возможность использовать EffectiveOn, чтобы вернуть категорию затрат, активную в определенную дату. Если EffectiveOn не указано, вы увидите категорию затрат, эффективную на текущую дату. Если категория затрат все еще эффективна, EffectiveEnd в ответе будет опущено.

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

Синтаксис

  describe-cost-category-definition
--cost-category-arn <value>
[--effective-on <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]

Параметры

--cost-category-arn (строка)

Уникальный идентификатор вашей категории затрат.

--effective-on (строка)

Дата, когда категория затрат была эффективна.

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

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

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

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

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

Вывод

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

Структура категорий затрат. Включает подробные метаданные и набор правил для объекта CostCategory.

CostCategoryArn -> (строка)

Уникальный идентификатор вашей категории затрат.

EffectiveStart -> (строка)

Дата начала действия вашей категории затрат.

EffectiveEnd -> (строка)

Дата окончания действия вашей категории затрат.

Name -> (строка)

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

RuleVersion -> (строка)

Версия схемы правил в этой конкретной категории затрат.

Rules -> (список)

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

(структура)

Value -> (строка)

Значение по умолчанию для категории затрат.

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

Объект Expression, используемый для категоризации затрат. Поддерживает измерения, теги и вложенные выражения. В настоящее время поддерживаются только следующие измерения: LINKED_ACCOUNT , SERVICE_CODE , RECORD_TYPE , LINKED_ACCOUNT_NAME , REGION и USAGE_TYPE .

RECORD_TYPE — это измерение, используемое для API Cost Explorer, и также поддерживается для выражений категорий затрат. Это измерение использует разные термины в зависимости от того, используете ли вы консоль или API/редактор JSON. Подробное сравнение см. в разделе Сравнение терминов в руководстве пользователя «Управление выставлением счетов и затратами».

Or -> (список)

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

(структура)

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

Не все типы Expression поддерживаются в каждом API. Обратитесь к документации каждого конкретного API, чтобы узнать, что поддерживается.

Существует два шаблона:

Простые значения измерений.
- Существует три типа простых значений измерений: CostCategories , Tags и Dimensions .
  - Укажите поле CostCategories для определения фильтра, который действует на категории затрат.
  - Укажите поле Tags для определения фильтра, который действует на теги распределения затрат.
  - Укажите поле Dimensions для определения фильтра, который действует на ` DimensionValues https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html`__.
- Для каждого типа фильтра вы можете указать имя измерения и значения для фильтров, которые вы планируете использовать.
  - Например, вы можете отфильтровать по REGION==us-east-1 OR REGION==us-west-1. Для GetRightsizingRecommendation регион — это полное имя (например, REGION==US East (N. Virginia)).
  - Соответствующее значение Expression для этого примера следующее: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
  - Как показано в предыдущем примере, списки значений измерений объединяются с OR при применении фильтра.
- Вы также можете установить различные параметры сопоставления для дальнейшего управления поведением фильтра. Не все API поддерживают параметры сопоставления. Обратитесь к документации каждого конкретного API, чтобы узнать, что поддерживается.
  - Например, вы можете отфильтровать по именам связанных учетных записей, начинающимся с «a».
  - Соответствующее значение Expression для этого примера следующее: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
Составные типы Expression с логическими операциями.
- Вы можете использовать несколько типов Expression и логические операторы AND/OR/NOT для создания списка одного или нескольких объектов Expression. Это позволяет фильтровать по более сложным параметрам.
- Например, вы можете отфильтровать по ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
- Соответствующее значение Expression для этого примера следующее: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

Примечание

Поскольку каждый Expression может иметь только один оператор, служба возвращает ошибку, если указано более одного. Следующий пример показывает объект Expression, который создает ошибку: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

Следующее — пример соответствующего сообщения об ошибке: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

Примечание

Для действия GetRightsizingRecommendation сочетание OR и NOT не поддерживается. OR не поддерживается между разными измерениями или измерениями и тегами. Операторы NOT не поддерживаются. Измерения также ограничены LINKED_ACCOUNT , REGION или RIGHTSIZING_TYPE .

Для действия GetReservationPurchaseRecommendation поддерживается только NOT. AND и OR не поддерживаются. Измерения ограничены LINKED_ACCOUNT .

Or -> (список)

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

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

And -> (список)

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

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

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

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

Key -> (строка)

Имена типов метаданных, которые вы можете использовать для фильтрации и группировки результатов. Например, AZ возвращает список доступных зон.

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

LINKED_ACCOUNT_NAME и SERVICE_CODE могут использоваться только в CostCategoryRule.

ANOMALY_TOTAL_IMPACT_ABSOLUTE и ANOMALY_TOTAL_IMPACT_PERCENTAGE могут использоваться только в AnomalySubscriptions.

Values -> (список)

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

(строка)

MatchOptions -> (список)

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

MatchOptions применимо только к действиям, связанным с категориями затрат и подписками на аномалии. Обратитесь к документации каждого конкретного API, чтобы узнать, что поддерживается.

Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

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

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

Key -> (строка)

Ключ тега.

Values -> (список)

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

(строка)

MatchOptions -> (список)

Параметры сопоставления, которые вы можете использовать для фильтрации результатов. MatchOptions применимо только к действиям, связанным с категориями затрат. Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE .

(строка)

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

Фильтр, основанный на значениях CostCategory.

Key -> (строка)

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

Values -> (список)

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

(строка)

MatchOptions -> (список)

Параметры сопоставления, которые вы можете использовать для фильтрации результатов. MatchOptions применимо только к действиям, связанным с категориями затрат. Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

And -> (список)

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

(структура)

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

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

Существует два шаблона:

Простые значения измерений.
- Существует три типа простых значений измерений: CostCategories , Tags и Dimensions .
  - Укажите поле CostCategories для определения фильтра, который действует на категории затрат.
  - Укажите поле Tags для определения фильтра, который действует на теги распределения затрат.
  - Укажите поле Dimensions для определения фильтра, который действует на ` DimensionValues https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html`__ .
- Для каждого типа фильтра вы можете указать имя измерения и значения для фильтров, которые вы планируете использовать.
  - Например, вы можете отфильтровать по REGION==us-east-1 OR REGION==us-west-1 . Для GetRightsizingRecommendation регион — это полное имя (например, REGION==US East (N. Virginia)).
  - Соответствующий Expression для этого примера выглядит следующим образом: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
  - Как показано в предыдущем примере, списки значений измерений объединяются с OR при применении фильтра.
- Вы также можете установить различные параметры соответствия для дальнейшего управления поведением фильтра. Не все API поддерживают параметры соответствия. Обратитесь к документации для каждого конкретного API, чтобы узнать, что поддерживается.
  - Например, вы можете отфильтровать по именам связанных учетных записей, начинающимся с "a".
  - Соответствующий Expression для этого примера выглядит следующим образом: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
Составные типы Expression с логическими операциями.
- Вы можете использовать несколько типов Expression и логические операторы AND/OR/NOT, чтобы создать список одного или нескольких объектов Expression. Сделав это, вы можете отфильтровать по более сложным параметрам.
- Например, вы можете отфильтровать по ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) .
- Соответствующий Expression для этого примера выглядит следующим образом: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

Примечание

Поскольку каждая Expression может иметь только один оператор, служба возвращает ошибку, если указано более одного. Следующий пример показывает объект Expression, который создаёт ошибку: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

Вот пример соответствующего сообщения об ошибке: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

Примечание

Для действия GetRightsizingRecommendation комбинация OR и NOT не поддерживается. OR не поддерживается между различными измерениями или измерениями и тегами. Операторы NOT не поддерживаются. Измерения также ограничены LINKED_ACCOUNT , REGION или RIGHTSIZING_TYPE .

Или -> (список)

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

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

И -> (список)

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

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

(… рекурсивно…)Измерения -> (структура)

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

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

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

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

LINKED_ACCOUNT_NAME и SERVICE_CODE могут использоваться только в CostCategoryRule.

ANOMALY_TOTAL_IMPACT_ABSOLUTE и ANOMALY_TOTAL_IMPACT_PERCENTAGE могут использоваться только в AnomalySubscriptions.

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

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

(строка)

Параметры соответствия -> (список)

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

MatchOptions применим только для действий, связанных с категориями затрат и подписками на аномалии. Обратитесь к документации для каждого конкретного API, чтобы узнать, что поддерживается.

Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

Теги -> (структура)

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

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

Ключ тега.

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

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

(строка)

Параметры соответствия -> (список)

Параметры соответствия, которые можно использовать для фильтрации результатов. MatchOptions применим только для действий, связанных с категориями затрат. Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

Categories затрат -> (структура)

Фильтр, основанный на значениях CostCategory.

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

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

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

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

(строка)

Параметры соответствия -> (список)

Параметры соответствия, которые можно использовать для фильтрации результатов. MatchOptions применим только для действий, связанных с категориями затрат. Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

Не -> (структура)

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

Или -> (список)

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

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

И -> (список)

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

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

(… рекурсивно…)Измерения -> (структура)

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

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

LINKED_ACCOUNT_NAME и SERVICE_CODE могут использоваться только в CostCategoryRule.

ANOMALY_TOTAL_IMPACT_ABSOLUTE и ANOMALY_TOTAL_IMPACT_PERCENTAGE могут использоваться только в AnomalySubscriptions.

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

(строка)

Параметры соответствия -> (список)

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

Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

Теги -> (структура)

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

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

Ключ тега.

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

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

(строка)

Параметры соответствия -> (список)

(строка)

Categories затрат -> (структура)

Фильтр, основанный на значениях CostCategory.

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

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

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

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

(строка)

Параметры соответствия -> (список)

(строка)

Измерения -> (структура)

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

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

LINKED_ACCOUNT_NAME и SERVICE_CODE могут использоваться только в CostCategoryRule.

ANOMALY_TOTAL_IMPACT_ABSOLUTE и ANOMALY_TOTAL_IMPACT_PERCENTAGE могут использоваться только в AnomalySubscriptions.

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

(строка)

Параметры соответствия -> (список)

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

Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

Теги -> (структура)

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

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

Ключ тега.

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

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

(строка)

Параметры соответствия -> (список)

(строка)

Categories затрат -> (структура)

Фильтр, основанный на значениях CostCategory.

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

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

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

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

(строка)

Параметры сопоставления -> (список)

Параметры сопоставления, которые можно использовать для фильтрации результатов. Параметры сопоставления применимы только для действий, связанных с категорией затрат. Значения по умолчанию для MatchOptions — EQUALS и CASE_SENSITIVE.

(строка)

Унаследованное значение -> (структура)

Значение, к которому относится строка элемента, если строка элемента содержит соответствующее измерение.

Имя измерения -> (строка)

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

Если вы укажете LINKED_ACCOUNT_NAME, значение категории затрат будет основано на имени счета. Если вы укажете TAG, значение категории затрат будет основано на значении указанного ключа тега.

Ключ измерения -> (строка)

Ключ для извлечения значений категории затрат.

Тип -> (строка)

Вы можете определить тип правила CostCategoryRule как REGULAR или INHERITED_VALUE. Тип правила INHERITED_VALUE добавляет гибкость для определения правила, которое динамически наследует значение категории затрат. Это значение из значения измерения, определенного CostCategoryInheritedValueDimension. Например, предположим, что вы хотите динамически сгруппировать затраты на основе значения определенного ключа тега. Сначала выберите тип правила «унаследованное значение», а затем выберите измерение тега и укажите используемый ключ тега.

Правила разделения затрат -> (список)

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

(структура)

Используйте правило разделения затрат для разделения затрат одного значения категории затрат на несколько других целевых значений.

Источник -> (строка)

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

Цели -> (список)

Значения категории затрат, на которые вы хотите разделить затраты. Эти значения не могут использоваться в качестве источника в других правилах разделения затрат.

(строка)

Метод -> (строка)

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

Proportional — Распределяет затраты между целевыми значениями в зависимости от пропорциональной взвешенной стоимости каждого целевого значения.

Fixed — Распределяет затраты между целевыми значениями на основе заданного вами процентного распределения.

>``Равномерно`` — Распределяет затраты равномерно по всем целевым значениям.

Параметры -> (список)

Параметры метода разделения затрат. Требуется только для метода FIXED.

(структура)

Параметры метода разделения затрат.

Тип -> (строка)

Тип параметра.

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

Значения параметра.

(строка)

Статус обработки -> (список)

Список статусов обработки продуктов Cost Management для конкретной категории затрат.

(структура)

Список статусов обработки продуктов Cost Management для конкретной категории затрат.

Компонент -> (строка)

Имя продукта Cost Management, к которому относится примененный статус.

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

Статус процесса для определенной категории затрат.

Значение по умолчанию -> (строка)

Значение по умолчанию для категории затрат.