Spec-Zone.ru › AWS CLI v2

[ aws . bcm-pricing-calculator ]

list-workload-estimates

Описание

Отображает все оценки затрат на рабочую нагрузку для учетной записи.

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

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

Синтаксис

  list-workload-estimates
[--created-at-filter <value>]
[--expires-at-filter <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]

Параметры

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

Фильтрует оценки затрат на рабочую нагрузку на основе даты создания.

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

Включает результаты после этой метки времени.

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

Включает результаты перед этой меткой времени.

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

afterTimestamp=timestamp,beforeTimestamp=timestamp

Синтаксис JSON:

{
  "afterTimestamp": timestamp,
  "beforeTimestamp": timestamp
}

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

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

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

Включает результаты после этой метки времени.

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

Включает результаты перед этой меткой времени.

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

afterTimestamp=timestamp,beforeTimestamp=timestamp

Синтаксис JSON:

{
  "afterTimestamp": timestamp,
  "beforeTimestamp": timestamp
}

--filters (список)

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

(структура)

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

name -> (строка)

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

values -> (список)

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

(строка)

matchOption -> (строка)

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

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

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

Синтаксис JSON:

[
  {
    "name": "STATUS"|"NAME",
    "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
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

Использует определенный профиль из файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

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

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

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

items -> (список)

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

(структура)

Предоставляет сводку оценки затрат на рабочую нагрузку.

id -> (строка)

Уникальный идентификатор оценки затрат на рабочую нагрузку.

name -> (строка)

Имя оценки затрат на рабочую нагрузку.

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

Метка времени создания оценки затрат на рабочую нагрузку.

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

Метка времени истечения срока действия оценки затрат на рабочую нагрузку.

rateType -> (строка)

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

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

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

status -> (строка)

Текущий статус оценки затрат на рабочую нагрузку.

totalCost -> (двойное число)

Общий прогнозируемый расход на рабочую нагрузку.

costCurrency -> (строка)

Валюта прогнозируемого расхода.

failureMessage -> (строка)

Сообщение об ошибке, если создание или обработка оценки затрат на рабочую нагрузку завершились неудачей.

nextToken -> (строка)

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

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

Spec-Zone.ru

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