Spec-Zone.ru › AWS CLI v2

[ aws . omics ]

get-workflow

Описание

Получает информацию о рабочем процессе.

Если рабочий процесс с вами совместён, вы не можете экспортировать его.

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

Синтаксис

  get-workflow
--id <value>
[--type <value>]
[--export <value>]
[--workflow-owner-id <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]

Параметры

--id (строка)

Идентификатор рабочего процесса.

--type (строка)

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

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

  • PRIVATE
  • READY2RUN

--export (список)

Формат экспорта рабочего процесса.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  DEFINITION

--workflow-owner-id (строка)

Идентификатор владельца рабочего процесса.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. Подробную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

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

Для просмотра рабочего процесса

Следующий get-workflow пример получает подробную информацию о рабочем процессе с идентификатором 1234567.

aws omics get-workflow \
    --id 1234567

Вывод:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567",
    "creationTime": "2022-11-30T22:33:16.225368Z",
    "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf",
    "engine": "WDL",
    "id": "1234567",
    "main": "workflow-crambam.wdl",
    "name": "cram-converter",
    "parameterTemplate": {
        "ref_dict": {
            "description": "dictionary file for 'ref_fasta'"
        },
        "ref_fasta_index": {
            "description": "Index of the reference genome fasta file"
        },
        "ref_fasta": {
            "description": "Reference genome fasta file"
        },
        "input_cram": {
            "description": "The Cram file to convert to BAM"
        },
        "sample_name": {
            "description": "The name of the input sample, used to name the output BAM"
        }
    },
    "status": "ACTIVE",
    "statusMessage": "workflow-crambam.wdl\n    workflow CramToBamFlow\n        call CramToBamTask\n        call ValidateSamFile\n    task CramToBamTask\n    task ValidateSamFile\n",
    "tags": {},
    "type": "PRIVATE"
}

Дополнительную информацию см. в разделе «Рабочие процессы Omics» в руководстве разработчика Amazon Omics.

Вывод

arn -> (строка)

ARN рабочего процесса.

id -> (строка)

Идентификатор рабочего процесса.

status -> (строка)

Статус рабочего процесса.

type -> (строка)

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

name -> (строка)

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

description -> (строка)

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

engine -> (строка)

Двигатель рабочего процесса.

definition -> (строка)

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

main -> (строка)

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

digest -> (строка)

Хеш-код рабочего процесса.

parameterTemplate -> (массив)

Шаблон параметров рабочего процесса.

key -> (строка)

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

Параметр рабочего процесса.

description -> (строка)

Описание параметра.

optional -> (булево)

Является ли параметр необязательным.

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

Установленная по умолчанию емкость статического хранилища (в гигабайтах) для запусков, использующих этот рабочий процесс или версию рабочего процесса.

creationTime -> (метка времени)

Время создания рабочего процесса.

statusMessage -> (строка)

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

tags -> (массив)

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

key -> (строка)

value -> (строка)

metadata -> (массив)

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

key -> (строка)

value -> (строка)

accelerators -> (строка)

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

storageType -> (строка)

Тип хранилища по умолчанию для запусков, использующих этот рабочий процесс.

uuid -> (строка)

Универсальный уникальный идентификатор (UUID) для этого рабочего процесса.

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

Spec-Zone.ru

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