Spec-Zone.ru › AWS CLI v2

[ aws . support ]

describe-trusted-advisor-check-result

Описание

Возвращает результаты проверки Trusted Advisor с указанным идентификатором проверки. Идентификаторы проверок можно получить, вызвав операцию DescribeTrustedAdvisorChecks.

Ответ содержит объект TrustedAdvisorCheckResult, который содержит эти три объекта:

  • TrustedAdvisorCategorySpecificSummary
  • TrustedAdvisorResourceDetail
  • TrustedAdvisorResourcesSummary

Кроме того, ответ содержит следующие поля:

  • статус - Статус предупреждения проверки может быть ok (зелёный), warning (жёлтый), error (красный) или not_available .
  • отметка времени - Время последнего обновления проверки.
  • checkId - Уникальный идентификатор проверки.

Примечание

  • Для использования API поддержки Amazon Web Services необходимо иметь план Business, Enterprise On-Ramp или Enterprise Support.
  • Если вы вызываете API поддержки Amazon Web Services из учетной записи, у которой нет плана Business, Enterprise On-Ramp или Enterprise Support, отображается сообщение об ошибке SubscriptionRequiredException. Сведения об изменении плана поддержки см. в разделе Поддержка Amazon Web Services.

Для вызова операций Trusted Advisor в API поддержки Amazon Web Services необходимо использовать конечную точку US East (N. Virginia). В настоящее время конечные точки US West (Oregon) и Europe (Ireland) не поддерживают операции Trusted Advisor. Дополнительные сведения см. в разделе Об API поддержки Amazon Web Services в руководстве пользователя Amazon Web Services Support.

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

Синтаксис

  describe-trusted-advisor-check-result
--check-id <value>
[--language <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]

Параметры

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

Уникальный идентификатор проверки Trusted Advisor.

--language (строка)

Код ISO 639-1 языка, на котором вы хотите видеть результаты проверки.

API поддержки Amazon Web Services в настоящее время поддерживает следующие языки для Trusted Advisor:

  • Упрощённый китайский - zh
  • Традиционный китайский - zh_TW
  • Английский - en
  • Французский - fr
  • Немецкий - de
  • Индонезийский - id
  • Итальянский - it
  • Японский - ja
  • Корейский - ko
  • Бразильский португальский - pt_BR
  • Испанский - es

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросов параметров входных данных CLI.

Примеры

Примечание

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

За исключением случаев, когда указано иное, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительные сведения см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.

Для отображения результатов проверки AWS Trusted Advisor

В следующем describe-trusted-advisor-check-result примере выводятся результаты проверки IAM Use.

aws support describe-trusted-advisor-check-result \
    --check-id "zXCkfM1nI3"

Вывод:

{
    "result": {
        "checkId": "zXCkfM1nI3",
        "timestamp": "2020-05-13T21:38:05Z",
        "status": "ok",
        "resourcesSummary": {
            "resourcesProcessed": 1,
            "resourcesFlagged": 0,
            "resourcesIgnored": 0,
            "resourcesSuppressed": 0
        },
        "categorySpecificSummary": {
            "costOptimizing": {
                "estimatedMonthlySavings": 0.0,
                "estimatedPercentMonthlySavings": 0.0
            }
        },
        "flaggedResources": [
            {
                "status": "ok",
                "resourceId": "47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZEXAMPLE",
                "isSuppressed": false
            }
        ]
    }
}

Дополнительные сведения см. в разделе AWS Trusted Advisor в руководстве пользователя AWS Support.

Вывод

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

Подробные результаты проверки Trusted Advisor.

checkId -> (строка)

Уникальный идентификатор проверки Trusted Advisor.

timestamp -> (строка)

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

status -> (строка)

Статус предупреждения проверки: “ok” (зелёный), “warning” (жёлтый), “error” (красный) или “not_available”.

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

Сведения о ресурсах Amazon Web Services, которые анализировались при вызове Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

resourcesProcessed -> (длинное целое число)

Количество ресурсов Amazon Web Services, которые анализировались проверкой Trusted Advisor.

resourcesFlagged -> (длинное целое число)

Количество ресурсов Amazon Web Services, которые были помечены (указаны) проверкой Trusted Advisor.

resourcesIgnored -> (длинное целое число)

Количество ресурсов Amazon Web Services, пропущенных Trusted Advisor, так как информация была недоступна.

resourcesSuppressed -> (длинное целое число)

Количество ресурсов Amazon Web Services, пропущенных Trusted Advisor, так как они были помечены пользователем как подавленные.

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

Сводная информация, относящаяся к категории проверки. В настоящее время поддерживается только категория «Оптимизация расходов».

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

Сводная информация о снижении расходов для проверки Trusted Advisor, которая находится в категории «Оптимизация расходов».

estimatedMonthlySavings -> (двойное число)

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

estimatedPercentMonthlySavings -> (двойное число)

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

flaggedResources -> (список)

Подробности о каждом ресурсе, указанном в результате проверки.

(структура)

Содержит информацию о ресурсе, который был определён проверкой Trusted Advisor.

status -> (строка)

Код состояния ресурса, определенного в проверке Trusted Advisor.

region -> (строка)

Регион Amazon Web Services, в котором находится определённый ресурс.

resourceId -> (строка)

Уникальный идентификатор определённого ресурса.

isSuppressed -> (логическое значение)

Указывает, был ли ресурс Amazon Web Services пропущен Trusted Advisor, так как он был помечен пользователем как подавленный.

metadata -> (список)

Дополнительная информация об определённом ресурсе. Точный метаданные и их порядок можно получить, проверив объект TrustedAdvisorCheckDescription, возвращённый результатом вызова DescribeTrustedAdvisorChecks . Metadata содержит все данные, которые отображаются в файле Excel, даже в тех случаях, когда интерфейс пользователя отображает только сводные данные.

(строка)

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

Spec-Zone.ru

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