Spec-Zone.ru › AWS CLI v2

[ aws . wellarchitected ]

получить-объединенный-отчет

Описание

Получить объединенный отчет о ваших рабочих нагрузках.

Вы можете дополнительно выбрать включение рабочих нагрузок, которые были с вами разделены.

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

Синтаксис

  get-consolidated-report
--format <value>
[--include-shared-resources | --no-include-shared-resources]
[--next-token <value>]
[--max-results <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]

Параметры

--format (строка)

Формат объединенного отчета.

Для PDF возвращается Base64String. Для JSON возвращается Metrics.

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

  • PDF
  • JSON

--include-shared-resources | --no-include-shared-resources (булево)

Установите в значение true, чтобы включить общие ресурсы в отчет.

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

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

--max-results (целое число)

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

--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
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

Метрики -> (список)

Метрики, составляющие объединенный отчет.

Возвращается только при запросе формата JSON.

(структура)

Метрика, которая вносит вклад в объединенный отчет.

ТипМетрики -> (строка)

Тип метрики метрики в объединенном отчете. В настоящее время поддерживаются только типы метрик WORKLOAD.

RiskCounts -> (карта)

Карта из имен рисков к количеству вопросов, имеющих данный рейтинг.

ключ -> (строка)

Риск для данной рабочей нагрузки, обзора объектива, столпа или вопроса.

значение -> (целое число)

Целое неотрицательное число, которое обозначает количество.

WorkloadId -> (строка)

Идентификатор, назначенный рабочей нагрузке. Этот идентификатор уникален в Amazon Web Services Region.

WorkloadName -> (строка)

Имя рабочей нагрузки.

Имя должно быть уникальным в рамках учетной записи в Amazon Web Services Region. Пробелы и регистр при проверке уникальности игнорируются.

WorkloadArn -> (строка)

ARN рабочей нагрузки.

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

Зафиксированная дата и время.

Lenses -> (список)

Метрики для объективов в рабочей нагрузке.

(структура)

Метрика для определенного объектива в рабочей нагрузке.

LensArn -> (строка)

ARN объектива.

Pillars -> (список)

Метрики для столпов в объективе.

(структура)

Метрика для определенного столпа в объективе.

PillarId -> (строка)

Идентификатор, используемый для идентификации столпа, например, security .

Столб определяется его PillarReviewSummary$PillarId .

RiskCounts -> (карта)

Карта из имен рисков к количеству вопросов, имеющих данный рейтинг.

ключ -> (строка)

Риск для данной рабочей нагрузки, обзора объектива, столпа или вопроса.

значение -> (целое число)

Целое неотрицательное число, которое обозначает количество.

Questions -> (список)

Вопросы, которые были определены как риски в столпе.

(структура)

Метрика для определенного вопроса в столпе.

QuestionId -> (строка)

Идентификатор вопроса.

Risk -> (строка)

Риск для данной рабочей нагрузки, обзора объектива, столпа или вопроса.

BestPractices -> (список)

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

(структура)

Рекомендация по наилучшей практике или вариант ответа, который был определен как риск в этом вопросе.

ChoiceId -> (строка)

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

ChoiceTitle -> (строка)

Заголовок варианта.

RiskCounts -> (карта)

Карта из имен рисков к количеству вопросов, имеющих данный рейтинг.

ключ -> (строка)

Риск для данной рабочей нагрузки, обзора объектива, столпа или вопроса.

значение -> (целое число)

Целое неотрицательное число, которое обозначает количество.

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

Общее количество примененных объективов к рабочей нагрузке.

NextToken -> (строка)

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

Base64String -> (строка)

Представление строки, закодированной в Base64, отчета об обзоре объектива.

Эти данные можно использовать для создания файла PDF.

Возвращается только GetConsolidatedReport при запросе формата PDF.

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

Spec-Zone.ru

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