Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

list-images

Описание

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

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

Синтаксис

  list-images
[--owner <value>]
[--filters <value>]
[--by-name | --no-by-name]
[--max-results <value>]
[--next-token <value>]
[--include-deprecated | --no-include-deprecated]
[--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 (список)

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

  • name
  • osVersion
  • platform
  • type
  • version

(структура)

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

name -> (строка)

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

values -> (список)

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

(строка)

Упрощенный синтаксис:

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

Синтаксис JSON:

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

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

Запрашивает список образов со значением имени рецепта.

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

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

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

Маркер, указывающий, где начать пагинацию. Это следующий маркер (nextToken) из ранее усеченного ответа.

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

Включает устаревшие образы в список ответов.

--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 (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки config/env.

--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-images перечисляет все доступные семантические версии.

aws imagebuilder list-images

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageVersionList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03",
            "name": "MyBasicRecipe",
            "version": "2019.12.03",
            "platform": "Windows",
            "owner": "123456789012",
            "dateCreated": "2020-02-14T21:29:18.810Z"
        }
    ]
}

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

Вывод

requestId -> (строка)

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

imageVersionList -> (список)

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

Примечание

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

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

(структура)

Определяющие характеристики конкретной версии изображения Image Builder.

arn -> (строка)

Amazon Resource Name (ARN) конкретной версии изображения Image Builder.

Примечание

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

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

name -> (строка)

Имя этой конкретной версии изображения Image Builder.

type -> (строка)

Указывает, создаёт ли это изображение AMI или контейнерное изображение.

version -> (строка)

Подробности для конкретной версии изображения Image Builder. Эта версия следует синтаксису семантической версии.

Примечание

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

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

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

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

platform -> (строка)

Платформа операционной системы версии изображения, например «Windows» или «Linux».

osVersion -> (строка)

Версия операционной системы экземпляра сборки Amazon EC2. Например, Amazon Linux 2, Ubuntu 18 или Microsoft Windows Server 2019.

owner -> (строка)

Владелец версии изображения.

dateCreated -> (строка)

Дата создания этой конкретной версии изображения Image Builder.

buildType -> (строка)

Указывает тип сборки, создавшей это изображение. Сборка может быть инициирована следующими способами:

  • USER_INITIATED – Запрос на сборку конвейера вручную.
  • SCHEDULED – Запрос на сборку конвейера, инициированный выражением cron в конвейере Image Builder или из EventBridge.
  • IMPORT – Импорт ВМ создал изображение для использования в качестве базового изображения для рецепта.
  • IMPORT_ISO – Импорт диска ISO создал изображение.

imageSource -> (строка)

Источник базового изображения, которое Image Builder использовал для построения этого изображения.

nextToken -> (строка)

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

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

Spec-Zone.ru

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