[ aws . imagebuilder ]
получить-компонент
Описание
Получает объект компонента.
См. также: Документацию API AWS
Синтаксис
get-component
--component-build-version-arn <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]
Параметры
--component-build-version-arn (строка)
/\d+$ .--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.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее об этом см. руководство по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной оболочки. Подробнее см. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для получения подробностей о компоненте
В следующем get-component примере выводятся детали компонента, указав его ARN.
aws imagebuilder get-component \
--component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1
Вывод:
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"component": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1",
"name": "component-name",
"version": "1.0.0",
"type": "TEST",
"platform": "Linux",
"owner": "123456789012",
"data": "name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n",
"encrypted": true,
"dateCreated": "2020-01-27T20:43:30.306Z",
"tags": {}
}
}
Дополнительную информацию см. в разделе «Настройка и управление конвейером изображений EC2 Image Builder с помощью AWS CLI» в Руководстве пользователя EC2 Image Builder.
Вывод
requestId -> (строка)
component -> (структура)
Объект компонента, указанный в запросе.
arn -> (строка)
name -> (строка)
version -> (строка)
description -> (строка)
changeDescription -> (строка)
type -> (строка)
platform -> (строка)
supportedOsVersions -> (список)
Версия операционной системы (ОС), поддерживаемая компонентом. Если информация об ОС доступна, Image Builder выполняет совпадение префикса с базовой версией ОС образа во время создания рецепта образа.
(строка)
state -> (структура)
Описывает текущее состояние компонента.
status -> (строка)
reason -> (строка)
parameters -> (список)
Содержит подробности параметров для каждого из параметров, которые документ компонента определил для компонента.
(структура)
Определяет параметр, используемый для предоставления конфигурационных данных для компонента.
name -> (строка)
type -> (строка)
defaultValue -> (список)
Значение по умолчанию этого параметра, если вход не предоставлен.
(строка)
description -> (строка)
owner -> (строка)
data -> (строка)
kmsKeyId -> (строка)
encrypted -> (логическое значение)
dateCreated -> (строка)
tags -> (карта)
Теги, применимые к компоненту.
key -> (строка)
value -> (строка)
publisher -> (строка)
obfuscate -> (логическое значение)
productCodes -> (список)
Содержит коды продуктов, используемые для целей выставления счетов за компоненты Amazon Web Services Marketplace.
(структура)
Информация об одном коде продукта.
productCodeId -> (строка)
productCodeType -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|