Spec-Zone.ru › AWS CLI v2

[ aws . cost-optimization-hub ]

list-recommendation-summaries

Описание

Возвращает краткое представление оценок экономии ресурсов. Также возвращает объединённую экономию по различным типам рекомендаций.

Примечание

Следующие фильтры не поддерживаются для этого API: recommendationIds , resourceArns , и resourceIds .

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

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

Синтаксис

  list-recommendation-summaries
[--filter <value>]
--group-by <value>
[--metrics <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]

Параметры

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

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

restartNeeded -> (булево)

Требуется ли перезагрузка для реализации рекомендации.

rollbackPossible -> (булево)

Можно ли отменить реализацию рекомендации.

implementationEfforts -> (список)

Усилия, необходимые для реализации рекомендации.

(строка)

accountIds -> (список)

Учётная запись, к которой относится рекомендация.

(строка)

regions -> (список)

Регион Amazon Web Services ресурса.

(строка)

resourceTypes -> (список)

Тип ресурса рекомендации.

(строка)

actionTypes -> (список)

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

(строка)

tags -> (список)

Список тегов, назначенных рекомендации.

(структура)

Структура тега, содержащая ключ и значение тега.

key -> (строка)

Ключ, связанный с тегом.

value -> (строка)

Значение, связанное с тегом.

resourceIds -> (список)

Идентификатор ресурса рекомендации.

(строка)

resourceArns -> (список)

Amazon Resource Name (ARN) рекомендации.

(строка)

recommendationIds -> (список)

Идентификаторы рекомендаций.

(строка)

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

restartNeeded=boolean,rollbackPossible=boolean,implementationEfforts=string,string,accountIds=string,string,regions=string,string,resourceTypes=string,string,actionTypes=string,string,tags=[{key=string,value=string},{key=string,value=string}],resourceIds=string,string,resourceArns=string,string,recommendationIds=string,string

Синтаксис JSON:

{
  "restartNeeded": true|false,
  "rollbackPossible": true|false,
  "implementationEfforts": ["VeryLow"|"Low"|"Medium"|"High"|"VeryHigh", ...],
  "accountIds": ["string", ...],
  "regions": ["string", ...],
  "resourceTypes": ["Ec2Instance"|"LambdaFunction"|"EbsVolume"|"EcsService"|"Ec2AutoScalingGroup"|"Ec2InstanceSavingsPlans"|"ComputeSavingsPlans"|"SageMakerSavingsPlans"|"Ec2ReservedInstances"|"RdsReservedInstances"|"OpenSearchReservedInstances"|"RedshiftReservedInstances"|"ElastiCacheReservedInstances"|"RdsDbInstanceStorage"|"RdsDbInstance"|"DynamoDbReservedCapacity"|"MemoryDbReservedInstances", ...],
  "actionTypes": ["Rightsize"|"Stop"|"Upgrade"|"PurchaseSavingsPlans"|"PurchaseReservedInstances"|"MigrateToGraviton"|"Delete"|"ScaleIn", ...],
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "resourceIds": ["string", ...],
  "resourceArns": ["string", ...],
  "recommendationIds": ["string", ...]
}

--group-by (строка)

Группа рекомендаций по измерению.

--metrics (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  SavingsPercentage

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

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

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

Вывод

estimatedTotalDedupedSavings -> (двойное)

Общая экономия для агрегированного представления.

items -> (список)

Список всех рекомендаций по экономии.

(структура)

Сводка рекомендаций по оптимизации размера, включая объединённую экономию от всех типов рекомендаций.

group -> (строка)

Группа рекомендаций.

estimatedMonthlySavings -> (двойное)

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

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

Общее количество рекомендаций по экземплярам.

groupBy -> (строка)

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

currencyCode -> (строка)

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

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

Результаты или описания дополнительных метрик, в зависимости от того, были ли метрики запрошены или нет.

savingsPercentage -> (строка)

Процент экономии на основе расходов в Amazon Web Services за последние 30 дней.

Примечание

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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