Spec-Zone.ru › AWS CLI v2

[ aws . bcm-pricing-calculator ]

list-workload-estimate-usage

Описание

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

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

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

Синтаксис

  list-workload-estimate-usage
--workload-estimate-id <value>
[--filters <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]

Параметры

--workload-estimate-id (строка)

Уникальный идентификатор оценки рабочей нагрузки, для которой требуется вывести использование.

--filters (список)

Фильтры для применения к списку элементов использования.

(структура)

Представляет фильтр для вывода данных об использовании.

name -> (строка)

Имя атрибута фильтра.

values -> (список)

Значения для фильтрации.

(строка)

matchOption -> (строка)

Вариант сопоставления для фильтра (например, равно, содержит).

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

name=string,values=string,string,matchOption=string ...

Синтаксис JSON:

[
  {
    "name": "USAGE_ACCOUNT_ID"|"SERVICE_CODE"|"USAGE_TYPE"|"OPERATION"|"LOCATION"|"USAGE_GROUP"|"HISTORICAL_USAGE_ACCOUNT_ID"|"HISTORICAL_SERVICE_CODE"|"HISTORICAL_USAGE_TYPE"|"HISTORICAL_OPERATION"|"HISTORICAL_LOCATION",
    "values": ["string", ...],
    "matchOption": "EQUALS"|"STARTS_WITH"|"CONTAINS"
  }
  ...
]

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

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

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

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

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

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

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

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

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит JSON-пример входных данных, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример YAML входных данных, который можно использовать с --cli-input-yaml. Если указано значение output, он проверяет входные данные команды и возвращает пример JSON-выхода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое)

Включает отладочную запись журнала.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое)

Отключает автоматическую постраничную загрузку. Если автоматическая постраничная загрузка отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображает версию этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--no-sign-request (логическое)

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

--ca-bundle (строка)

Файл с корневым сертификатом для проверки 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.

Вывод

items -> (список)

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

(структура)

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

serviceCode -> (строка)

Код службы Amazon Web Services, связанный с этим элементом использования.

usageType -> (строка)

Тип использования для этого элемента.

operation -> (строка)

Конкретная операция, связанная с этим элементом использования.

location -> (строка)

Расположение, связанное с этим элементом использования.

id -> (строка)

Уникальный идентификатор этого элемента использования.

usageAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, связанный с этим элементом использования.

group -> (строка)

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

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

Оцененное количество использования для этого элемента.

unit -> (строка)

Единица измерения для количества использования.

amount -> (число с плавающей точкой)

Числовое значение количества использования.

cost -> (число с плавающей точкой)

Оценённая стоимость для этого элемента использования.

currency -> (строка)

Валюта оценочной стоимости.

status -> (строка)

Текущий статус этого элемента использования.

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

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

serviceCode -> (строка)

Код службы Amazon Web Services, связанный с использованием.

usageType -> (строка)

Тип использования.

operation -> (строка)

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

location -> (строка)

Расположение, связанное с использованием.

usageAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, связанный с использованием.

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

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

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

Дата и время начала интервала.

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

Дата и время окончания интервала.

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

Необязательное выражение фильтра для применения к данным о историческом использовании.

and -> (список)

Список выражений, которые объединяются с логикой И.

(структура)

Представляет сложное выражение фильтра для данных о затратах и использовании.

and -> (список)

Список выражений, которые объединяются с логикой И.

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

or -> (список)

Список выражений, которые объединяются с логикой ИЛИ.

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

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

Фильтрация по категориям затрат.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по измерениям (например, служба, операция).

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по тегам ресурсов.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

or -> (список)

Список выражений, которые объединяются с логикой ИЛИ.

(структура)

Представляет сложное выражение фильтра для данных о затратах и использовании.

and -> (список)

Список выражений, которые объединяются с логикой И.

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

or -> (список)

Список выражений, которые объединяются с логикой ИЛИ.

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

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

Фильтрация по категориям затрат.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по измерениям (например, служба, операция).

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по тегам ресурсов.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Выражение, которое необходимо инвертировать.

and -> (список)

Список выражений, которые объединяются с логикой И.

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

or -> (список)

Список выражений, которые объединяются с логикой ИЛИ.

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

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

Фильтрация по категориям затрат.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по измерениям (например, служба, операция).

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по тегам ресурсов.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по категориям затрат.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по измерениям (например, служба, операция).

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

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

Фильтрация по тегам ресурсов.

key -> (строка)

Ключ или атрибут для фильтрации.

matchOptions -> (список)

Параметры сопоставления для фильтра (например, равно, содержит).

(строка)

values -> (список)

Значения для сопоставления.

(строка)

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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