Spec-Zone.ru › AWS CLI v2

[ aws . migrationhubstrategy ]

list-application-components

Описание

Получает список всех компонентов приложения (процессов).

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

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

Синтаксис

  list-application-components
[--application-component-criteria <value>]
[--filter-value <value>]
[--group-id-filter <value>]
[--sort <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]

Параметры

--application-component-criteria (строка)

Критерии для фильтрации списка компонентов приложения.

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

  • NOT_DEFINED
  • APP_NAME
  • SERVER_ID
  • APP_TYPE
  • STRATEGY
  • DESTINATION
  • ANALYSIS_STATUS
  • ERROR_CATEGORY

--filter-value (строка)

Укажите значение, основываясь на типе критериев компонента приложения. Например, если applicationComponentCriteria установлено в значение SERVER_ID, и filterValue установлено в значение server1, тогда ListApplicationComponents возвращает все компоненты приложения, работающие на сервере server1.

--group-id-filter (список)

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

(структура)

Объект, содержащий информацию о различных импортах или группах для рекомендаций стратегии.

name -> (строка)

Ключ конкретной группы импорта.

value -> (строка)

Значение конкретной группы импорта.

Сокращённый синтаксис:

name=string,value=string ...

Синтаксис JSON:

[
  {
    "name": "ExternalId"|"ExternalSourceType",
    "value": "string"
  }
  ...
]

--sort (строка)

Указывает, сортировать ли по возрастанию (ASC) или убыванию (DESC) порядка.

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

  • ASC
  • DESC

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

Выходные данные

applicationComponentInfos -> (список)

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

(структура)

Содержит подробную информацию о компоненте приложения.

analysisStatus -> (строка)

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

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

Имя ведра S3 и имя ключа Amazon S3 для отчета об антипаттернах.

s3Bucket -> (строка)

Имя ведра S3.

s3key -> (строка)

Имя ключа Amazon S3.

antipatternReportStatus -> (строка)

Состояние генерации отчета об антипаттернах.

antipatternReportStatusMessage -> (строка)

Сообщение о состоянии антипаттерна.

appType -> (строка)

Тип компонента приложения.

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

Ошибка в анализе исходного кода или базы данных.

appUnitErrorCategory -> (строка)

Категория ошибки.

associatedServerId -> (строка)

Идентификатор сервера, на котором работает компонент приложения.

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

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

secretName -> (строка)

Ключ AWS Secrets Manager, содержащий учетные данные для подключения к базе данных.

id -> (строка)

Идентификатор компонента приложения.

inclusionStatus -> (строка)

Указывает, включен ли компонент приложения для рекомендации сервера.

lastAnalyzedTimestamp -> (временная метка)

Временная метка последнего анализа компонента приложения.

listAntipatternSeveritySummary -> (список)

Список сводных данных о серьезности антипаттернов.

(структура)

Содержит сводку по антипаттернам и их серьезности.

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

Количество антипаттернов.

severity -> (строка)

Серьезность антипаттернов.

moreServerAssociationExists -> (булево)

Устанавливается в значение true, если компонент приложения работает на нескольких серверах.

name -> (строка)

Имя компонента приложения.

osDriver -> (строка)

Драйвер ОС.

osVersion -> (строка)

Версия ОС.

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

Набор лучших рекомендаций для компонента приложения.

strategy -> (строка)

Рекомендуемая стратегия.

targetDestination -> (строка)

Рекомендуемое целевое направление.

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

Целевое направление для набора рекомендаций.

description -> (строка)

Описание инструмента.

name -> (строка)

Имя инструмента.

tranformationToolInstallationLink -> (строка)

Ссылка для установки инструмента.

resourceSubType -> (строка)

Подтип компонента приложения.

resultList -> (список)

Список результатов анализа.

(структура)

Ошибка анализа сервера.

analysisStatus -> (структура помеченных объединений)

Ошибка анализа сервера.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: runtimeAnalysisStatus, srcCodeOrDbAnalysisStatus.

runtimeAnalysisStatus -> (строка)

Состояние анализа.

srcCodeOrDbAnalysisStatus -> (строка)

Состояние анализа исходного кода или базы данных.

analysisType -> (строка)

Ошибка анализа сервера.

antipatternReportResultList -> (список)

Ошибка анализа сервера.

(структура)

Результат отчета об антипаттернах.

analyzerName -> (структура помеченных объединений)

Имя анализатора.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: binaryAnalyzerName, runTimeAnalyzerName, sourceCodeAnalyzerName.

binaryAnalyzerName -> (строка)

Имена бинарных анализаторов.

runTimeAnalyzerName -> (строка)

Имена анализаторов оценки.

sourceCodeAnalyzerName -> (строка)

Имена анализаторов исходного кода.

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

Содержит имя ведра S3 и имя ключа Amazon S3.

s3Bucket -> (строка)

Имя ведра S3.

s3key -> (строка)

Имя ключа Amazon S3.

antipatternReportStatus -> (строка)

Состояние генерации отчета об антипаттернах.

antipatternReportStatusMessage -> (строка)

Сообщение о состоянии антипаттерна.

statusMessage -> (строка)

Ошибка анализа сервера.

runtimeStatus -> (строка)

Состояние единицы приложения.

runtimeStatusMessage -> (строка)

Сообщение о состоянии единицы приложения.

sourceCodeRepositories -> (список)

Подробная информация о хранилище исходного кода, связанном с компонентом приложения.

(структура)

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

branch -> (строка)

Ветка исходного кода.

projectName -> (строка)

Имя проекта.

repository -> (строка)

Имя хранилища исходного кода.

versionControlType -> (строка)

Тип хранилища для исходного кода.

statusMessage -> (строка)

Подробное описание состояния анализа и любого сообщения об ошибке.

nextToken -> (строка)

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

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

Spec-Zone.ru

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