Spec-Zone.ru › AWS CLI v2

[ aws . compute-optimizer ]

получение-предпочтений-рекомендаций

Описание

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

Используйте параметр scope, чтобы указать, какие предпочтения возвратить. Вы можете указать, нужно ли возвращать предпочтения для организации, определенного идентификатора учетной записи или конкретного экземпляра EC2 или группы Auto Scaling Amazon Resource Name (ARN).

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

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

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

Синтаксис

  get-recommendation-preferences
--resource-type <value>
[--scope <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]

Параметры

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

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

Параметр Ec2Instance охватывает автономные экземпляры и экземпляры, входящие в группы Auto Scaling. Параметр AutoScalingGroup охватывает только экземпляры, входящие в группу Auto Scaling.

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

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

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

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

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

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"
}

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

Образ сертификата 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.

Вывод

nextToken -> (строка)

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

Это значение равно null, если больше нет страниц настроек рекомендаций для возврата.

recommendationPreferencesDetails -> (список)

Массив объектов, описывающих настройки рекомендаций.

(структура)

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

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

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

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

name -> (строка)

Название области.

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

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

value -> (строка)

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

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

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

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

resourceType -> (строка)

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

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

enhancedInfrastructureMetrics -> (строка)

Состояние настройки рекомендации расширенных метрик инфраструктуры.

При обновлении страницы рекомендаций статус Active подтверждает, что настройка применена к рекомендациям, а статус Inactive подтверждает, что настройка ещё не применена к рекомендациям.

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

inferredWorkloadTypes -> (строка)

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

При обновлении страницы рекомендаций статус Active подтверждает, что настройка применена к рекомендациям, а статус Inactive подтверждает, что настройка ещё не применена к рекомендациям.

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

Объект, описывающий настройку рекомендации внешних метрик.

Если настройка применена в последнем обновлении рекомендаций, в ответе отображается объект со значением source. Если настройка ещё не применена к рекомендациям, этот объект в ответе не отображается.

source -> (строка)

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

lookBackPeriod -> (строка)

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

utilizationPreferences -> (список)

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

Примечание

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

(структура)

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

Примечание

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

metricName -> (строка)

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

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

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

threshold -> (строка)

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

Примечание

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

headroom -> (строка)

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

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

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

preferredResources -> (список)

Настройка для управления типами ресурсов, которые учитываются при формировании рекомендаций по оптимизации размера. Этот объект разрешает любые символьные выражения и возвращает эффективный список значений типа кандидата ресурса. Если настройка не задана, этот объект равен null.

(структура)

Описание эффективных предпочтительных ресурсов, которые Compute Optimizer рассматривает как кандидатов для рекомендаций по оптимизации размера.

Примечание

Compute Optimizer поддерживает только типы экземпляров Amazon EC2.

name -> (строка)

Название списка предпочтительных ресурсов.

includeList -> (список)

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

(строка)

effectiveIncludeList -> (список)

Расширенный вариант вашего списка предпочтительных ресурсов.

(строка)

excludeList -> (список)

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

(строка)

savingsEstimationMode -> (строка)

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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