Spec-Zone.ru › AWS CLI v2

[ aws . cost-optimization-hub ]

list-recommendations

Описание

Возвращает список рекомендаций.

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

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

Синтаксис

  list-recommendations
[--filter <value>]
[--order-by <value>]
[--include-all-recommendations | --no-include-all-recommendations]
[--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", ...]
}

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

Порядок рекомендаций по измерению.

dimension -> (строка)

Сортирует по значениям измерения.

order -> (строка)

Порядок сортировки данных.

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

dimension=string,order=string

Синтаксис JSON:

{
  "dimension": "string",
  "order": "Asc"|"Desc"
}

--include-all-recommendations | --no-include-all-recommendations (логическое)

Список всех рекомендаций для ресурса или одной рекомендации, если дубликаты удалены с помощью resourceId.

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

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

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

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

--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 (строка)

Набор сертификатов 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.

Вывод

items -> (список)

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

(структура)

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

recommendationId -> (строка)

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

accountId -> (строка)

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

region -> (строка)

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

resourceId -> (строка)

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

resourceArn -> (строка)

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

currentResourceType -> (строка)

Текущий тип ресурса.

recommendedResourceType -> (строка)

Рекомендуемый тип ресурса.

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

Ожидаемая сумма ежемесячной экономии по рекомендации.

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

Ожидаемый процент экономии по отношению к общей стоимости за период анализа стоимости.

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

Ожидаемая ежемесячная стоимость текущего ресурса. Для резервированных экземпляров и планов экономии это стоимость для допустимого использования.

currencyCode -> (строка)

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

implementationEffort -> (строка)

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

restartNeeded -> (логическое)

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

actionType -> (строка)

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

rollbackPossible -> (логическое)

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

currentResourceSummary -> (строка)

Описание текущего ресурса.

recommendedResourceSummary -> (строка)

Описание рекомендуемого ресурса.

lastRefreshTimestamp -> (временная метка)

Время последнего обновления рекомендации.

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

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

source -> (строка)

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

tags -> (список)

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

(структура)

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

key -> (строка)

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

value -> (строка)

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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