Spec-Zone.ru › AWS CLI v2

[ aws . compute-optimizer ]

put-recommendation-preferences

Описание

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

Для получения дополнительной информации см. Активация расширенных метрик инфраструктуры в Руководстве пользователя Compute Optimizer.

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

Синтаксис

  put-recommendation-preferences
--resource-type <value>
[--scope <value>]
[--enhanced-infrastructure-metrics <value>]
[--inferred-workload-types <value>]
[--external-metrics-preference <value>]
[--look-back-period <value>]
[--utilization-preferences <value>]
[--preferred-resources <value>]
[--savings-estimation-mode <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]

Параметры

--resource-type (строка)

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

Вариант Ec2Instance охватывает автономные экземпляры и экземпляры, которые являются частью групп Auto Scaling. Вариант AutoScalingGroup охватывает только экземпляры, которые являются частью группы Auto Scaling.

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

  • Ec2Instance
  • AutoScalingGroup
  • EbsVolume
  • LambdaFunction
  • NotApplicable
  • EcsService
  • License
  • RdsDBInstance
  • Idle

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

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

Вы можете создавать предпочтения рекомендаций на уровне организации (только для учетных записей управления организацией), на уровне учетной записи и на уровне ресурса. Дополнительную информацию см. в разделе Активация расширенных метрик инфраструктуры в руководстве пользователя Compute Optimizer.

Примечание

Вы не можете создавать предпочтения рекомендаций для групп Auto Scaling на уровнях организации и учетной записи. Вы можете создавать предпочтения рекомендаций для групп Auto Scaling только на уровне ресурса, указав имя области ResourceArn и значение области — Amazon Resource Name (ARN) группы Auto Scaling. Это настроит предпочтение для всех экземпляров, которые являются частью указанной группы Auto Scaling. Также нельзя создавать предпочтения рекомендаций на уровне ресурса для экземпляров, которые являются частью группы Auto Scaling. Вы можете создавать предпочтения рекомендаций на уровне ресурса только для автономных экземпляров.

name -> (строка)

Имя области.

Возможные области:

  • Organization — Указывает, что предпочтение рекомендации применяется на уровне организации для всех учетных записей-членов организации.
  • AccountId — Указывает, что предпочтение рекомендации применяется на уровне учетной записи для всех ресурсов заданного типа ресурса в учетной записи.
  • ResourceArn — Указывает, что предпочтение рекомендации применяется на уровне отдельных ресурсов.

value -> (строка)

Значение области.

Если вы указали name области как:

  • Organization — value должно быть ALL_ACCOUNTS.
  • AccountId — value должен быть 12-значным идентификатором Amazon Web Services учетной записи.
  • ResourceArn — value должен быть Amazon Resource Name (ARN) экземпляра EC2 или группы Auto Scaling.

В настоящее время поддерживаются только ARN экземпляров EC2 и групп Auto Scaling.

Сокращенная синтаксическая конструкция:

name=string,value=string

Синтаксис JSON:

{
  "name": "Organization"|"AccountId"|"ResourceArn",
  "value": "string"
}

--enhanced-infrastructure-metrics (строка)

Состояние предпочтения рекомендации метрик расширенной инфраструктуры для создания или обновления.

Укажите значение Active состояния, чтобы активировать предпочтение, или укажите значение Inactive, чтобы деактивировать предпочтение.

Дополнительную информацию см. в разделе Расширенные метрики инфраструктуры в руководстве пользователя Compute Optimizer.

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

  • Active
  • Inactive

--inferred-workload-types (строка)

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

Примечание

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

Укажите значение Inactive состояния, чтобы деактивировать функцию, или укажите значение Active, чтобы активировать ее.

Дополнительную информацию см. в разделе Инферированные типы рабочих нагрузок в руководстве пользователя Compute Optimizer.

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

  • Active
  • Inactive

--external-metrics-preference (структура)

Поставщик предпочтения рекомендации внешних метрик для создания или обновления.

Укажите допустимого поставщика в поле source, чтобы активировать предпочтение. Чтобы удалить это предпочтение, см. действие DeleteRecommendationPreferences.

Это предпочтение может быть установлено только для типа ресурса Ec2Instance.

Дополнительную информацию см. в разделе Ввод внешних метрик в руководстве пользователя Compute Optimizer.

source -> (строка)

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

Сокращенная синтаксическая конструкция:

source=string

Синтаксис JSON:

{
  "source": "Datadog"|"Dynatrace"|"NewRelic"|"Instana"
}

--look-back-period (строка)

Предпочтение для управления количеством дней, в течение которых анализируются метрики использования ресурсов Amazon Web Services. Если это предпочтение не указано, используется значение по умолчанию DAYS_14.

Вы можете установить это предпочтение только для типов ресурсов Amazon EC2 instance и Auto Scaling group.

Примечание

  • Предпочтения для прослеживаемости экземпляров Amazon EC2 могут быть настроены на уровнях организации, учетной записи и ресурса.
  • Предпочтения прослеживаемости для групп Auto Scaling могут быть настроены только на уровне ресурса.

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

  • DAYS_14
  • DAYS_32
  • DAYS_93

--utilization-preferences (список)

Предпочтение для управления пороговым значением использования ЦП ресурса, резервом использования ЦП и резервом использования памяти. Если это предпочтение не указано, используются следующие значения по умолчанию.

Использование ЦП:

  • P99_5 для порога
  • PERCENT_20 для резерва

Использование памяти:

  • PERCENT_20 для резерва

Примечание

  • Вы можете настроить предпочтения использования ЦП и памяти только для типа ресурса Amazon EC2 instance.
  • Настройка порога недоступна для использования памяти.

(структура)

Предпочтение для управления пороговым значением использования ЦП ресурса, резервом использования ЦП и резервом использования памяти.

Примечание

Это предпочтение доступно только для типа ресурса Amazon EC2 instance.

metricName -> (строка)

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

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

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

threshold -> (строка)

Значение порога, используемое для указанного параметра метрики.

Примечание

Вы можете указать только значение порога для использования ЦП.

headroom -> (строка)

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

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

  • Использование ЦП: PERCENT_30 | PERCENT_20 | PERCENT_0
  • Использование памяти: PERCENT_30 | PERCENT_20 | PERCENT_10

Сокращенная синтаксическая конструкция:

metricName=string,metricParameters={threshold=string,headroom=string} ...

Синтаксис JSON:

[
  {
    "metricName": "CpuUtilization"|"MemoryUtilization",
    "metricParameters": {
      "threshold": "P90"|"P95"|"P99_5",
      "headroom": "PERCENT_30"|"PERCENT_20"|"PERCENT_10"|"PERCENT_0"
    }
  }
  ...
]

--preferred-resources (список)

Предпочтение для управления типами значений ресурсов, которые учитываются при генерации рекомендаций по оптимальному размеру. Вы можете указать это предпочтение в виде сочетания списков включения и исключения. Вы должны указать либо includeList, либо excludeList. Если предпочтение — пустой набор значений типа ресурса, возникает ошибка.

Примечание

Вы можете настроить это предпочтение только для типов ресурсов Amazon EC2 instance и Auto Scaling group.

(структура)

Предпочтение для управления типами значений ресурсов, которые учитываются при генерации рекомендаций по оптимальному размеру. Вы можете указать это предпочтение в виде сочетания списков включения и исключения. Вы должны указать либо includeList, либо excludeList. Если предпочтение — пустой набор значений типа ресурса, возникает ошибка. Дополнительную информацию см. в разделе Предпочтения рекомендаций по оптимальному размеру в руководстве пользователя Compute Optimizer.

Примечание

  • Это предпочтение доступно только для типов ресурсов Amazon EC2 instance и Auto Scaling group.
  • Compute Optimizer поддерживает только настройку Ec2InstanceTypes.

name -> (строка)

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

Примечание

Compute Optimizer поддерживает только настройку Ec2InstanceTypes.

includeList -> (список)

Предпочтительные значения типа ресурса для включения в кандидаты рекомендаций. Вы можете указать точное значение типа ресурса, например m5.large, или использовать выражения с подстановкой символа, например m5. Если это не указано, по умолчанию включаются все поддерживаемые ресурсы. В этом списке можно указать до 1000 значений.

(строка)

excludeList -> (список)

Предпочтительные значения типа ресурса для исключения из кандидатов рекомендаций. Если это не указано, по умолчанию включаются все поддерживаемые ресурсы. В этом списке можно указать до 1000 значений.

(строка)

Сокращенная синтаксическая конструкция:

name=string,includeList=string,string,excludeList=string,string ...

Синтаксис JSON:

[
  {
    "name": "Ec2InstanceTypes",
    "includeList": ["string", ...],
    "excludeList": ["string", ...]
  }
  ...
]

--savings-estimation-mode (строка)

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

Укажите значение AfterDiscounts состояния, чтобы активировать предпочтение, или укажите значение BeforeDiscounts, чтобы деактивировать предпочтение.

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

Дополнительную информацию см. в разделе Режим оценки экономии в руководстве пользователя Compute Optimizer.

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

  • AfterDiscounts
  • BeforeDiscounts

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

Вывод

Нет

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

Spec-Zone.ru

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