Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

list-components

Описание

Возвращает список компонентов, которые можно фильтровать по имени или используя указанные filters для оптимизации результатов. Новые созданные компоненты могут отобразиться в результатах API ListComponents в течение двух минут.

Примечание

Семантическая версия имеет четыре узла: <major>.<minor>.<patch>/<build>. Вы можете назначить значения для первых трёх и фильтровать по всем им.

Фильтрование: С семантической версией у вас есть гибкость использования подстановочных знаков (x) для указания последних версий или узлов при выборе базового образа или компонентов для вашего рецепта. Когда вы используете подстановочный знак в любом узле, все узлы справа от первого подстановочного знака также должны быть подстановочными знаками.

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

Синтаксис

  list-components
[--owner <value>]
[--filters <value>]
[--by-name | --no-by-name]
[--max-results <value>]
[--next-token <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]

Параметры

--owner (строка)

Фильтрует результаты на основе типа владельца компонента. По умолчанию этот запрос возвращает список компонентов, принадлежащих вашему аккаунту. Чтобы увидеть результаты для других типов владельцев, вы можете указать компоненты, управляемые Amazon, компоненты сторонних производителей или компоненты, которые другие аккаунты поделились с вами.

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

  • Self
  • Shared
  • Amazon
  • ThirdParty
  • AWSMarketplace

--filters (список)

Используйте следующие фильтры для оптимизации результатов:

  • description
  • name
  • platform
  • supportedOsVersion
  • type
  • version

(структура)

Пара имя-значение фильтра, используемая для возврата более специфичного списка результатов из операции списка. Фильтры могут быть использованы для сопоставления набора ресурсов по определённым критериям, таким как метки, атрибуты или идентификаторы.

name -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

values -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

name=string,values=string,string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

--by-name | --no-by-name (булево)

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

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

Максимальное количество элементов для возврата в запросе.

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

Токен для указания, где начать постраничную навигацию. Это nextToken из ранее усечённого ответа.

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для получения списка всех семантических версий компонентов

Следующий list-components пример выводит список всех семантических версий компонентов, к которым у вас есть доступ. Вы можете необязательно отфильтровать, чтобы получить список компонентов, принадлежащих вам, управляемых Amazon, или которые были предоставлены вам другими аккаунтами.

aws imagebuilder list-components

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "componentVersionList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0",
            "name": "component-name",
            "version": "1.0.0",
            "platform": "Linux",
            "type": "TEST",
            "owner": "123456789012",
            "dateCreated": "2020-01-27T20:43:30.306Z"
        }
    ]
}

Для получения дополнительной информации, см. Настройка и управление конвейером образов EC2 Image Builder с помощью AWS CLI в руководстве пользователя EC2 Image Builder.

Вывод

requestId -> (строка)

Идентификатор запроса, уникально определяющий этот запрос.

componentVersionList -> (список)

Список семантических версий компонентов.

Примечание

Семантическая версия имеет четыре узла: <major>.<minor>.<patch>/<build>. Вы можете назначать значения для первых трех узлов и фильтровать по всем им.

(структура)

Определяющие характеристики конкретной версии компонента Amazon Web Services TOE.

arn -> (строка)

Amazon Resource Name (ARN) компонента.

Примечание

Семантическая версия включена в Amazon Resource Name (ARN) каждого объекта на уровне, применимом к данному объекту следующим образом:

  • ARN без версии и ARN по имени не включают конкретные значения ни в одном из узлов. Узлы либо полностью отсутствуют, либо указаны как универсальные символы, например: x.x.x.
  • ARN версии содержат только первые три узла: <major>.<minor>.<patch>
  • ARN версии сборки содержат все четыре узла и указывают на конкретную сборку для конкретной версии объекта.

name -> (строка)

Имя компонента.

version -> (строка)

Семантическая версия компонента.

Примечание

Семантическая версия имеет четыре узла: <major>.<minor>.<patch>/<build>. Вы можете назначать значения для первых трех узлов и фильтровать по всем им.

Назначение: для первых трех узлов вы можете назначить любое положительное целое число, включая ноль, с верхним пределом 2^30-1, или 1073741823 для каждого узла. Image Builder автоматически назначает номер сборки четвертому узлу.

Шаблоны: вы можете использовать любой числовой шаблон, который соответствует требованиям назначения для узлов, которые вы можете назначить. Например, вы можете выбрать шаблон версии программного обеспечения, такой как 1.0.0, или дату, такую как 2021.01.01.

Фильтрация: с семантической версией у вас есть возможность использовать универсальные символы (x) для указания самых последних версий или узлов при выборе базового образа или компонентов для вашего рецепта. При использовании универсального символа в любом узле все узлы справа от первого универсального символа также должны быть универсальными символами.

description -> (строка)

Описание компонента.

platform -> (строка)

Платформа компонента.

supportedOsVersions -> (список)

Версия операционной системы (ОС), поддерживаемая компонентом. Если информация об ОС доступна, выполняется совпадение по префиксу с версией ОС базового образа во время создания рецепта образа.

(строка)

type -> (строка)

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

owner -> (строка)

Владелец компонента.

dateCreated -> (строка)

Дата создания компонента.

status -> (строка)

Описание текущего состояния версии компонента.

productCodes -> (список)

Содержит коды продуктов, используемые в целях выставления счетов для компонентов Amazon Web Services Marketplace.

(структура)

Информация об одном коде продукта.

productCodeId -> (строка)

Для компонентов Amazon Web Services Marketplace это содержит идентификатор кода продукта, который можно нанести на EC2 AMI для обеспечения правильного выставления счетов за компоненты. Если это свойство пустое, это может означать, что компонент не опубликован.

productCodeType -> (строка)

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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