get-reservation-utilization

Описание

Получает использование резервирования для вашей учетной записи. Учетная запись управления в организации имеет доступ к учетным записям членов. Вы можете фильтровать данные по измерениям в течение определенного периода времени. Вы можете использовать GetDimensionValues для определения возможных значений измерений. В настоящее время вы можете группировать только по SUBSCRIPTION_ID .

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

Синтаксис

  get-reservation-utilization
--time-period <value>
[--group-by <value>]
[--granularity <value>]
[--filter <value>]
[--sort-by <value>]
[--next-page-token <value>]
[--max-results <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]

Параметры

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

Устанавливает начальную и конечную даты для получения использования резервируемых экземпляров (RI). Начальная дата включена, а конечная — исключена. Например, если start — 2017-01-01, а end — 2017-05-01, то данные о затратах и использовании извлекаются с 2017-01-01 по и включая 2017-04-30, но не включая 2017-05-01 .

Start -> (строка)

Начало периода времени. Начальная дата включена. Например, если start — 2017-01-01, Amazon Web Services извлекает данные о затратах и использовании, начиная с 2017-01-01 до конечной даты. Начальная дата должна быть равна или предшествовать текущей дате, чтобы избежать ошибки валидации.

End -> (строка)

Конец периода времени. Конечная дата исключена. Например, если end — 2017-05-01, Amazon Web Services извлекает данные о затратах и использовании с начальной даты до, но не включая, 2017-05-01 .

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

Start=string,End=string

Синтаксис JSON:

{
  "Start": "string",
  "End": "string"
}

--group-by (список)

Группирует только по SUBSCRIPTION_ID. Метаданные включены.

(структура)

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

Type -> (строка)

Строка, представляющая тип группы.

Key -> (строка)

Строка, представляющая ключ для заданной группы.

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

Type=string,Key=string ...

Синтаксис JSON:

[
  {
    "Type": "DIMENSION"|"TAG"|"COST_CATEGORY",
    "Key": "string"
  }
  ...
]

--granularity (строка)

Если GroupBy установлено, то Granularity установить нельзя. Если Granularity не установлено, объект ответа не включает Granularity, ни MONTHLY, ни DAILY. Если оба GroupBy и Granularity не установлены, то GetReservationUtilization по умолчанию устанавливается в DAILY.

Операция GetReservationUtilization поддерживает только DAILY и MONTHLY зернистости.

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

DAILY
MONTHLY
HOURLY

--filter (структура)

Фильтры данных использования по измерениям. Вы можете фильтровать по следующим измерениям:

AZ
CACHE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE

Примечание

Если не указано, фильтр SERVICE по умолчанию равен Amazon Elastic Compute Cloud - Compute. Поддерживаемые значения для SERVICE — Amazon Elastic Compute Cloud - Compute, Amazon Relational Database Service, Amazon ElastiCache, Amazon Redshift и Amazon Elasticsearch Service. Значение фильтра SERVICE не должно превышать «1».

SCOPE
TENANCY

GetReservationUtilization использует тот же объект Expression, что и другие операции, но среди каждого измерения поддерживается только AND, и вложенность поддерживается только до одного уровня вглубь. Если для измерения есть несколько значений, они объединяются операцией ИЛИ.

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 сочетание ИЛИ и НЕ не поддерживается. ИЛИ не поддерживается между различными измерениями или измерениями и тегами. Операторы НЕ не поддерживаются. Измерения также ограничены LINKED_ACCOUNT, REGION или RIGHTSIZING_TYPE.

Для действия GetReservationPurchaseRecommendation поддерживается только НЕ. ИЛИ и И НЕ поддерживаются. Измерения ограничены 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.

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

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

Возвращает результаты, соответствующие либо объекту 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.

(строка)

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

Фильтр, основанный на значениях 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.

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

Ключ тега.

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

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

(строка)

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

(строка)

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

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

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

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

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

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

(строка)

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

(строка)

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

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

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

Ключ тега.

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

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

(строка)

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

(строка)

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

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

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

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

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

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

(строка)

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

(строка)

Синтаксис JSON:

{
  "Or": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
      },
      "CostCategories": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
      }
    }
    ...
  ],
  "And": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
      },
      "CostCategories": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
      }
    }
    ...
  ],
  "Not": {
    "Or": [
      { ... recursive ... }
      ...
    ],
    "And": [
      { ... recursive ... }
      ...
    ],
    "Not": { ... recursive ... },
    "Dimensions": {
      "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
      "Values": ["string", ...],
      "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
    },
    "Tags": {
      "Key": "string",
      "Values": ["string", ...],
      "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
    },
    "CostCategories": {
      "Key": "string",
      "Values": ["string", ...],
      "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
    }
  },
  "Dimensions": {
    "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
    "Values": ["string", ...],
    "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
  },
  "Tags": {
    "Key": "string",
    "Values": ["string", ...],
    "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
  },
  "CostCategories": {
    "Key": "string",
    "Values": ["string", ...],
    "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL", ...]
  }
}

--sort-by (структура)

Значение, по которому требуется отсортировать данные.

Для Key поддерживаются следующие значения:

UtilizationPercentage
UtilizationPercentageInUnits
PurchasedHours
PurchasedUnits
TotalActualHours
TotalActualUnits
UnusedHours
UnusedUnits
OnDemandCostOfRIHoursUsed
NetRISavings
TotalPotentialRISavings
AmortizedUpfrontFee
AmortizedRecurringFee
TotalAmortizedFee
RICostForUnusedHours
RealizedSavings
UnrealizedSavings

Поддерживаемые значения для SortOrder — ASCENDING и DESCENDING.

Key -> (строка)

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

SortOrder -> (строка)

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

Сокращенная синтаксическая запись:

Key=string,SortOrder=string

Синтаксис JSON:

{
  "Key": "string",
  "SortOrder": "ASCENDING"|"DESCENDING"
}

--next-page-token (строка)

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

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

Максимальное количество объектов, возвращенных для этого запроса. Если доступно больше объектов, в ответе Amazon Web Services предоставляется значение NextPageToken, которое можно использовать в последующем вызове для получения следующей порции объектов.

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

Чтобы получить использование резервирования для вашей учетной записи

Следующий пример получает использование RI для всех типов экземпляров t2.nano с 2018-03-01 по 2018-08-01 для учетной записи.

aws ce get-reservation-utilization \
    --time-period Start=2018-03-01,End=2018-08-01 \
    --filter file://filters.json

Содержимое filters.json:

{
    "Dimensions": {
        "Key": "INSTANCE_TYPE",
        "Values": [
            "t2.nano"
        ]
    }
}

Вывод:

{
    "Total": {
        "TotalAmortizedFee": "0",
        "UtilizationPercentage": "0",
        "PurchasedHours": "0",
        "NetRISavings": "0",
        "TotalActualHours": "0",
        "AmortizedRecurringFee": "0",
        "UnusedHours": "0",
        "TotalPotentialRISavings": "0",
        "OnDemandCostOfRIHoursUsed": "0",
        "AmortizedUpfrontFee": "0"
    },
    "UtilizationsByTime": []
}

Вывод

UtilizationsByTime -> (список)

Количество времени, которое вы использовали свои Зарезервированные экземпляры (RI).

(структура)

Количество использования в часах.

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

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

Start -> (строка)

Начало периода времени. Дата начала включительно. Например, если start является 2017-01-01, Amazon Web Services извлекает данные о затратах и использовании, начиная с 2017-01-01 и до даты окончания. Дата начала должна быть равна или не позднее текущей даты, чтобы избежать ошибки валидации.

End -> (строка)

Конец периода времени. Дата окончания не включительно. Например, если end является 2017-05-01, Amazon Web Services извлекает данные о затратах и использовании с даты начала до, но не включая, 2017-05-01.

Groups -> (список)

Группы, которые использует этот результат использования.

(структура)

Группа резерваций, которые разделяют набор атрибутов.

Key -> (строка)

Ключ для определенного атрибута резервации.

Value -> (строка)

Значение определенного атрибута резервации.

Attributes -> (карта)

Атрибуты для этой группы резерваций.

key -> (строка)

value -> (строка)

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

Сколько вы использовали эту группу резерваций.

UtilizationPercentage -> (строка)

Процент времени резервации, который вы использовали.

UtilizationPercentageInUnits -> (строка)

Процент времени резервации Amazon EC2, который вы использовали. Он преобразован в нормализованные единицы. Нормализованные единицы доступны только для использования Amazon EC2 после 11 ноября 2017 года.

PurchasedHours -> (строка)

Сколько часов резервации вы приобрели.

PurchasedUnits -> (строка)

Количество часов резервации Amazon EC2, которые вы приобрели. Он преобразован в нормализованные единицы. Нормализованные единицы доступны только для использования Amazon EC2 после 11 ноября 2017 года.

TotalActualHours -> (строка)

Общее количество часов резервации, которые вы использовали.

TotalActualUnits -> (строка)

Общее количество часов резервации Amazon EC2, которые вы использовали. Он преобразован в нормализованные единицы. Нормализованные единицы доступны только для использования Amazon EC2 после 11 ноября 2017 года.

UnusedHours -> (строка)

Количество часов резервации, которые вы не использовали.

UnusedUnits -> (строка)

Количество часов резервации Amazon EC2, которые вы не использовали. Он преобразован в нормализованные единицы. Нормализованные единицы доступны только для использования Amazon EC2 после 11 ноября 2017 года.

OnDemandCostOfRIHoursUsed -> (строка)

Сколько стоит ваша резервация, если взимаются тарифы On-Demand.

NetRISavings -> (строка)

Сколько вы сэкономили благодаря приобретению и использованию резервации. Amazon Web Services рассчитывает это, вычитая TotalAmortizedFee из OnDemandCostOfRIHoursUsed.

TotalPotentialRISavings -> (строка)

Сколько вы можете сэкономить, если воспользуетесь всей своей резервацией.

AmortizedUpfrontFee -> (строка)

Первоначальная стоимость вашей резервации. Она амортизируется в течение периода резервации.

AmortizedRecurringFee -> (строка)

Ежемесячная стоимость вашей резервации. Она амортизируется в течение периода резервации.

TotalAmortizedFee -> (строка)

Общая стоимость вашей резервации. Она амортизируется в течение периода резервации.

RICostForUnusedHours -> (строка)

Стоимость неиспользованных часов для вашей резервации.

RealizedSavings -> (строка)

Реализованная экономия благодаря приобретению и использованию резервации.

UnrealizedSavings -> (строка)

Нереализованная экономия благодаря приобретению и использованию резервации.

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

Общее количество часов резервации, которые были использованы.

UtilizationPercentage -> (строка)

Процент времени резервации, который вы использовали.

UtilizationPercentageInUnits -> (строка)

PurchasedHours -> (строка)

Сколько часов резервации вы приобрели.

PurchasedUnits -> (строка)

TotalActualHours -> (строка)

Общее количество часов резервации, которые вы использовали.

TotalActualUnits -> (строка)

UnusedHours -> (строка)

Количество часов резервации, которые вы не использовали.

UnusedUnits -> (строка)

OnDemandCostOfRIHoursUsed -> (строка)

Сколько стоит ваша резервация, если взимаются тарифы On-Demand.

NetRISavings -> (строка)

TotalPotentialRISavings -> (строка)

Сколько вы можете сэкономить, если воспользуетесь всей своей резервацией.

AmortizedUpfrontFee -> (строка)

Первоначальная стоимость вашей резервации. Она амортизируется в течение периода резервации.

AmortizedRecurringFee -> (строка)

Ежемесячная стоимость вашей резервации. Она амортизируется в течение периода резервации.

TotalAmortizedFee -> (строка)

Общая стоимость вашей резервации. Она амортизируется в течение периода резервации.

RICostForUnusedHours -> (строка)

Стоимость неиспользованных часов для вашей резервации.

RealizedSavings -> (строка)

Реализованная экономия благодаря приобретению и использованию резервации.

UnrealizedSavings -> (строка)

Нереализованная экономия благодаря приобретению и использованию резервации.

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

Общее количество времени, которое вы использовали свои Зарезервированные экземпляры (RI).

UtilizationPercentage -> (строка)

Процент времени резервации, который вы использовали.

UtilizationPercentageInUnits -> (строка)

PurchasedHours -> (строка)

Сколько часов резервации вы приобрели.

PurchasedUnits -> (строка)

TotalActualHours -> (строка)

Общее количество часов резервации, которые вы использовали.

TotalActualUnits -> (строка)

UnusedHours -> (строка)

Количество часов резервации, которые вы не использовали.

UnusedUnits -> (строка)

OnDemandCostOfRIHoursUsed -> (строка)

Сколько стоит ваша резервация, если взимаются тарифы On-Demand.

NetRISavings -> (строка)

TotalPotentialRISavings -> (строка)

Сколько вы можете сэкономить, если воспользуетесь всей своей резервацией.

AmortizedUpfrontFee -> (строка)

Первоначальная стоимость вашей резервации. Она амортизируется в течение периода резервации.

AmortizedRecurringFee -> (строка)

Ежемесячная стоимость вашей резервации. Она амортизируется в течение периода резервации.

TotalAmortizedFee -> (строка)

Общая стоимость вашей резервации. Она амортизируется в течение периода резервации.

RICostForUnusedHours -> (строка)

Стоимость неиспользованных часов для вашей резервации.

RealizedSavings -> (строка)

Реализованная экономия благодаря приобретению и использованию резервации.

UnrealizedSavings -> (строка)

Нереализованная экономия благодаря приобретению и использованию резервации.

NextPageToken -> (строка)

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

END_OF_DOCUMENT_MARKER