Spec-Zone.ru › AWS CLI v2

[ aws . trustedadvisor ]

list-recommendations

Описание

Список отфильтрованных рекомендаций

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

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

Синтаксис

  list-recommendations
[--after-last-updated-at <value>]
[--aws-service <value>]
[--before-last-updated-at <value>]
[--check-identifier <value>]
[--pillar <value>]
[--source <value>]
[--status <value>]
[--type <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]

Параметры

--after-last-updated-at (метка времени)

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

--aws-service (строка)

AWS-сервис, связанный с рекомендацией

--before-last-updated-at (метка времени)

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

--check-identifier (строка)

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

--pillar (строка)

Столбец рекомендации

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

  • cost_optimizing
  • performance
  • security
  • service_limits
  • fault_tolerance
  • operational_excellence

--source (строка)

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

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

  • aws_config
  • compute_optimizer
  • cost_explorer
  • lse
  • manual
  • pse
  • rds
  • resilience
  • resilience_hub
  • security_hub
  • stir
  • ta_check
  • well_architected

--status (строка)

Статус рекомендации

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

  • ok
  • warning
  • error

--type (строка)

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

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

  • standard
  • priority

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

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробная информация представлена в руководстве «Начало работы» в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования по аналогии с unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Пример 1: Просмотр рекомендаций

Следующий list-recommendations пример отображает все рекомендации без фильтрации.

aws trustedadvisor list-recommendations

Вывод:

{
    "recommendationSummaries": [
        {
            "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578",
            "name": "MFA Recommendation",
            "awsServices": [
                "iam"
            ],
            "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos",
            "id": "55fa4d2e-bbb7-491a-833b-5773e9589578",
            "lastUpdatedAt": "2023-11-01T15:57:58.673Z",
            "pillarSpecificAggregates": {
                "costOptimizing": {
                    "estimatedMonthlySavings": 0.0,
                    "estimatedPercentMonthlySavings": 0.0
                }
            },
            "pillars": [
                "security"
            ],
            "resourcesAggregates": {
                "errorCount": 1,
                "okCount": 0,
                "warningCount": 0
            },
            "source": "ta_check",
            "status": "error",
            "type": "standard"
        },
        {
            "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e-c7650955d9cd",
            "name": "RDS clusters quota warning",
            "awsServices": [
                "rds"
            ],
            "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz",
            "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd",
            "lastUpdatedAt": "2023-11-01T15:58:17.397Z",
            "pillarSpecificAggregates": {
                "costOptimizing": {
                    "estimatedMonthlySavings": 0.0,
                    "estimatedPercentMonthlySavings": 0.0
                }
            },
            "pillars": [
                "service_limits"
            ],
            "resourcesAggregates": {
                "errorCount": 0,
                "okCount": 3,
                "warningCount": 6
            },
            "source": "ta_check",
            "status": "warning",
            "type": "standard"
        }
    ],
    "nextToken": "REDACTED"
}

Дополнительная информация представлена в разделе «Начало работы с API Trusted Advisor» в руководстве пользователя AWS Trusted Advisor.

Пример 2: Просмотр рекомендаций с фильтром

Следующий list-recommendations пример отображает рекомендации с применением фильтра.

aws trustedadvisor list-recommendations \
    --aws-service iam \
    --max-items 100

Вывод:

{
    "recommendationSummaries": [{
        "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578",
        "name": "MFA Recommendation",
        "awsServices": [
            "iam"
        ],
        "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos",
        "id": "55fa4d2e-bbb7-491a-833b-5773e9589578",
        "lastUpdatedAt": "2023-11-01T15:57:58.673Z",
        "pillarSpecificAggregates": {
            "costOptimizing": {
                "estimatedMonthlySavings": 0.0,
                "estimatedPercentMonthlySavings": 0.0
            }
        },
        "pillars": [
            "security"
        ],
        "resourcesAggregates": {
            "errorCount": 1,
            "okCount": 0,
            "warningCount": 0
        },
        "source": "ta_check",
        "status": "error",
        "type": "standard"
    }],
    "nextToken": "REDACTED"
}

Дополнительная информация представлена в разделе «Начало работы с API Trusted Advisor» в руководстве пользователя AWS Trusted Advisor.

Пример 3: Просмотр рекомендаций с маркером постраничного вывода

Следующий list-recommendations пример использует маркер «nextToken», полученный из предыдущего запроса, для получения следующей страницы отфильтрованных рекомендаций.

aws trustedadvisor list-recommendations \
    --aws-service rds \
    --max-items 100 \
    --starting-token <next-token>

Вывод:

{
    "recommendationSummaries": [{
        "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e-c7650955d9cd",
        "name": "RDS clusters quota warning",
        "awsServices": [
            "rds"
        ],
        "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz",
        "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd",
        "lastUpdatedAt": "2023-11-01T15:58:17.397Z",
        "pillarSpecificAggregates": {
            "costOptimizing": {
                "estimatedMonthlySavings": 0.0,
                "estimatedPercentMonthlySavings": 0.0
            }
        },
        "pillars": [
            "service_limits"
        ],
        "resourcesAggregates": {
            "errorCount": 0,
            "okCount": 3,
            "warningCount": 6
        },
        "source": "ta_check",
        "status": "warning",
        "type": "standard"
    }]
}

Дополнительная информация представлена в разделе «Начало работы с API Trusted Advisor» в руководстве пользователя AWS Trusted Advisor.

Вывод

nextToken -> (строка)

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

recommendationSummaries -> (список)

Список рекомендаций

(структура)

Резюме рекомендации для учетной записи

arn -> (строка)

ARN рекомендации

awsServices -> (список)

AWS-сервисы, к которым относится рекомендация

(строка)

checkArn -> (строка)

ARN проверки AWS Trusted Advisor, относящейся к рекомендации

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

Время создания рекомендации, если она создана приоритетом AWS Trusted Advisor

id -> (строка)

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

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

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

lifecycleStage -> (строка)

Этап жизненного цикла из приоритета AWS Trusted Advisor

name -> (строка)

Название рекомендации AWS Trusted Advisor

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

Агрегации столпов для экономии затрат

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

Агрегаты оптимизации затрат

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

Ожидаемая экономия ежемесячно

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

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

pillars -> (список)

Столбы, по которым оптимизируется рекомендация

(строка)

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

Агрегация всех ресурсов

errorCount -> (длинное)

Количество AWS-ресурсов, которые были помечены как содержащие ошибки в соответствии с проверкой Trusted Advisor

okCount -> (длинное)

Количество AWS-ресурсов, которые были помечены как OK в соответствии с проверкой Trusted Advisor

warningCount -> (длинное)

Количество AWS-ресурсов, которые были помечены как имеющие предупреждение в соответствии с проверкой Trusted Advisor

source -> (строка)

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

status -> (строка)

Статус рекомендации

type -> (строка)

Автоматизирована ли рекомендация или сгенерирована приоритетом AWS Trusted Advisor

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

Spec-Zone.ru

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