Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

получение-этапа-создания-изображения

Описание

Получает этап создания изображения.

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

Синтаксис

  get-image-pipeline
--image-pipeline-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]

Параметры

--image-pipeline-arn (строка)

Amazon Resource Name (ARN) этапа создания изображения, который требуется получить.

--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-image-pipeline примере выводятся подробности о этапе создания изображения, указав его ARN.

aws imagebuilder get-image-pipeline \
    --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imagePipeline": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
        "name": "MyWindows2016Pipeline",
        "description": "Builds Windows 2016 Images",
        "platform": "Windows",
        "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
        "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
        "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
        "imageTestsConfiguration": {
            "imageTestsEnabled": true,
            "timeoutMinutes": 60
        },
        "schedule": {
            "scheduleExpression": "cron(0 0 * * SUN)",
            "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
        },
        "status": "ENABLED",
        "dateCreated": "2020-02-19T19:04:01.253Z",
        "dateUpdated": "2020-02-19T19:04:01.253Z",
        "tags": {}
    }
}

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

Вывод

requestId -> (строка)

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

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

Объект конвейера изображений.

arn -> (строка)

Amazon Resource Name (ARN) конвейера изображений.

name -> (строка)

Имя конвейера изображений.

description -> (строка)

Описание конвейера изображений.

platform -> (строка)

Платформа конвейера изображений.

enhancedImageMetadataEnabled -> (булево)

Сбор дополнительной информации об изображении, включая версию операционной системы (ОС) и список пакетов. Эта информация используется для повышения удобства использования EC2 Image Builder. Включено по умолчанию.

imageRecipeArn -> (строка)

Amazon Resource Name (ARN) рецепта изображений, связанного с этим конвейером изображений.

containerRecipeArn -> (строка)

Amazon Resource Name (ARN) рецепта контейнера, используемого для этого конвейера.

infrastructureConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации инфраструктуры, связанной с этим конвейером изображений.

distributionConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации распределения, связанной с этим конвейером изображений.

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

Конфигурация тестов изображений конвейера изображений.

imageTestsEnabled -> (булево)

Определяет, должны ли выполняться тесты после создания изображения. Image Builder по умолчанию включает выполнение тестов после создания изображения, перед распространением изображения.

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

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

Примечание

Свойство таймаута в настоящее время неактивно. Это значение игнорируется.

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

График конвейера изображений.

scheduleExpression -> (строка)

Выражение cron определяет, как часто EC2 Image Builder оценивает ваш pipelineExecutionStartCondition.

Дополнительную информацию о формате выражения cron в Image Builder см. в разделе Использование выражений cron в EC2 Image Builder.

timezone -> (строка)

Часовой пояс, применяемый к выражению планирования. Например, «Etc/UTC», «America/Los_Angeles» в формате часовых поясов IANA. Если не указано, по умолчанию используется UTC.

pipelineExecutionStartCondition -> (строка)

Настройка условия запуска настраивает момент, когда конвейер должен инициировать новую сборку изображения следующим образом. Если значение не задано, Image Builder использует EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE по умолчанию.

  • EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (по умолчанию) – При использовании семантических фильтров версий на базовом изображении или компонентах в вашем рецепте изображений EC2 Image Builder создает новое изображение только тогда, когда существуют новые версии базового изображения или компонентов в вашем рецепте, соответствующие фильтру.

Примечание

Семантический синтаксис версии см. в разделе СоздатьКомпонент.
  • EXPRESSION_MATCH_ONLY – Это условие создает новое изображение каждый раз, когда выражение CRON соответствует текущему времени.

status -> (строка)

Статус конвейера изображений.

dateCreated -> (строка)

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

dateUpdated -> (строка)

Дата последнего обновления этого конвейера изображений.

dateLastRun -> (строка)

Эта функция больше не поддерживается и не возвращает значение.

dateNextRun -> (строка)

Следующая дата запуска конвейера.

tags -> (карта)

Теги этого конвейера изображений.

key -> (строка)

value -> (строка)

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

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

imageScanningEnabled -> (булево)

Настройка, указывающая, сохраняет ли Image Builder моментальный снимок результатов сканирования уязвимостей, которые Amazon Inspector выполняет на экземпляре сборки при создании нового изображения.

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

Содержит настройки Amazon ECR для сканирования уязвимостей.

repositoryName -> (строка)

Имя репозитория контейнеров, который Amazon Inspector сканирует для выявления проблем с вашими контейнерными изображениями. Имя включает путь к расположению репозитория. Если вы не предоставите эту информацию, Image Builder создаст репозиторий в вашей учетной записи под названием image-builder-image-scanning-repository для сканирования уязвимостей выходных контейнерных изображений.

containerTags -> (список)

Теги, которые Image Builder применяет к выходному контейнерному изображению, которое сканирует Amazon Inspector. Теги могут помочь вам идентифицировать и управлять сканированными изображениями.

(строка)

executionRole -> (строка)

Имя или Amazon Resource Name (ARN) для созданной роли IAM, которая предоставляет Image Builder доступ для выполнения действий по рабочему процессу.

workflows -> (список)

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

(структура)

Содержит параметры управления и настраиваемые входные данные для ресурса рабочего процесса.

workflowArn -> (строка)

Amazon Resource Name (ARN) ресурса рабочего процесса.

parameters -> (список)

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

(структура)

Содержит пару ключ/значение, которая устанавливает указанный параметр рабочего процесса.

name -> (строка)

Имя параметра рабочего процесса, который нужно установить.

value -> (список)

Устанавливает значение указанного параметра рабочего процесса.

(строка)

parallelGroup -> (строка)

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

onFailure -> (строка)

Действие, которое нужно выполнить, если рабочий процесс завершится с ошибкой.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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