Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

get-workflow

Описание

Получение объекта ресурса рабочего процесса.

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

Синтаксис

  get-workflow
--workflow-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]

Параметры

--workflow-build-version-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-auto-prompt (булево)

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

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

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

Вывод

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

Ресурс рабочего процесса, указанный в запросе.

arn -> (строка)

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

name -> (строка)

Имя ресурса рабочего процесса.

version -> (строка)

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

description -> (строка)

Описание рабочего процесса.

changeDescription -> (строка)

Описание изменений, внесенных в этой версии рабочего процесса, или что отличает эту версию от других версий рабочего процесса.

type -> (строка)

Указывает этап создания образа, к которому применяется рабочий процесс. Image Builder в настоящее время поддерживает рабочие процессы сборки и тестирования.

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

Описывает текущий статус рабочего процесса и причину этого статуса.

status -> (строка)

Текущее состояние рабочего процесса.

reason -> (строка)

Описание того, как или почему рабочий процесс изменил состояние.

owner -> (строка)

Владелец ресурса рабочего процесса.

data -> (строка)

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

kmsKeyId -> (строка)

Идентификатор ключа KMS, используемый для шифрования ресурса рабочего процесса.

dateCreated -> (строка)

Отметка времени, когда Image Builder создал ресурс рабочего процесса.

tags -> (карта)

Теги, относящиеся к ресурсу рабочего процесса

key -> (строка)

value -> (строка)

parameters -> (список)

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

(структура)

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

name -> (строка)

Имя этого входного параметра.

type -> (строка)

Тип входных данных, предоставляемых этим параметром. В настоящее время поддерживается значение «строка».

defaultValue -> (список)

Значение по умолчанию для этого параметра, если входные данные не предоставлены.

(строка)

description -> (строка)

Описание этого параметра.

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

Spec-Zone.ru

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