Spec-Zone.ru › AWS CLI v2

[ aws . omics ]

create-workflow

Описание

Создает частный поток обработки данных. Частные потоки обработки данных зависят от различных ресурсов, которые необходимо создать и настроить перед созданием потока:

  • Входные данные : Входные данные для потока, хранящиеся в ведре S3 или хранилище последовательностей Amazon Web Services HealthOmics.
  • Файлы определения потока : Определяет поток в одном или нескольких файлах определения потока, написанных на WDL, Nextflow или CWL. Определение потока указывает входные и выходные данные для запусков, использующих этот поток. Оно также включает в себя параметры для запусков и задач потока, включая требования к вычислительным ресурсам и памяти.
  • Шаблоны параметров : Определяет параметры запуска, используя файл шаблона параметров (написанный в формате JSON).
  • Изображения контейнеров ECR : Создаёт один или несколько контейнерных изображений для потока обработки данных. Хранит изображения в приватном репозитории ECR.
  • (Необязательно) Лицензии Sentieon : Запрашивает лицензию Sentieon, если планируется использование программного обеспечения Sentieon в частном потоке обработки данных.

Дополнительную информацию см. в разделе «Создание или обновление частного потока обработки данных в Amazon Web Services HealthOmics» в руководстве пользователя Amazon Web Services HealthOmics.

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

Синтаксис

  create-workflow
[--name <value>]
[--description <value>]
[--engine <value>]
[--definition-zip <value>]
[--definition-uri <value>]
[--main <value>]
[--parameter-template <value>]
[--storage-capacity <value>]
[--tags <value>]
[--request-id <value>]
[--accelerators <value>]
[--storage-type <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]

Параметры

--name (строка)

Имя потока.

--description (строка)

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

--engine (строка)

Двигатель потока для данного потока.

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

  • WDL
  • NEXTFLOW
  • CWL

--definition-zip (бинарный файл)

Архив ZIP для потока.

--definition-uri (строка)

URI определения для потока.

--main (строка)

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

--parameter-template (словарь)

Шаблон параметров для потока.

ключ -> (строка)

значение -> (структура)

Параметр потока.

описание -> (строка)

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

необязательный -> (булево)

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

Сокращенная форма:

KeyName1=description=string,optional=boolean,KeyName2=description=string,optional=boolean

Синтаксис JSON:

{"string": {
      "description": "string",
      "optional": true|false
    }
  ...}

--storage-capacity (целое число)

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

--tags (словарь)

Теги для потока.

ключ -> (строка)

значение -> (строка)

Сокращенная форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--request-id (строка)

Для предотвращения многократного выполнения запросов укажите уникальный идентификатор для каждого запроса.

--accelerators (строка)

Вычислительный ускоритель, указанный для выполнения потока.

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

  • GPU

--storage-type (строка)

Тип хранилища по умолчанию для запусков, использующих этот поток. Хранилище STATIC выделяет фиксированный объем хранилища. Хранилище DYNAMIC динамически масштабирует объем хранилища вверх или вниз в зависимости от использования файловой системы. Дополнительную информацию о статическом и динамическом хранилище см. в руководстве Amazon Web Services HealthOmics User Guide .

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

  • STATIC
  • DYNAMIC

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Пакет сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию — 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 (boolean)

Отключить постраничный вывод CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для создания рабочей области

Следующий create-workflow пример создаёт рабочую область WDL.

aws omics create-workflow \
    --name cram-converter \
    --engine WDL \
    --definition-zip fileb://workflow-crambam.zip \
    --parameter-template file://workflow-params.json

workflow-crambam.zip — это ZIP-архив, содержащий определение рабочей области. workflow-params.json определяет параметры выполнения для рабочей области.

{
    "ref_fasta" : {
        "description": "Reference genome fasta file",
        "optional": false
    },
    "ref_fasta_index" : {
        "description": "Index of the reference genome fasta file",
        "optional": false
    },
    "ref_dict" : {
        "description": "dictionary file for 'ref_fasta'",
        "optional": false
    },
    "input_cram" : {
        "description": "The Cram file to convert to BAM",
        "optional": false
    },
    "sample_name" : {
        "description": "The name of the input sample, used to name the output BAM",
        "optional": false
    }
}

Вывод:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567",
    "id": "1234567",
    "status": "CREATING",
    "tags": {}
}

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

Вывод

arn -> (строка)

ARN рабочей области.

id -> (строка)

Идентификатор рабочей области.

status -> (строка)

Статус рабочей области.

tags -> (карта)

Теги рабочей области.

ключ -> (строка)

значение -> (строка)

uuid -> (строка)

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

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

Spec-Zone.ru

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