Spec-Zone.ru › AWS CLI v2

[ aws . omics ]

start-annotation-import-job

Описание

Запускает задачу импорта аннотаций.

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

Синтаксис

  start-annotation-import-job
--destination-name <value>
--role-arn <value>
--items <value>
[--version-name <value>]
[--format-options <value>]
[--run-left-normalization | --no-run-left-normalization]
[--annotation-fields <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]

Параметры

--destination-name (строка)

Назначение хранилища аннотаций для задачи.

--role-arn (строка)

Роль службы для задачи.

--items (список)

Элементы для импорта.

(структура)

Источник для задачи импорта аннотаций.

source -> (строка)

Расположение исходного файла в Amazon S3.

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

source=string ...

Синтаксис JSON:

[
  {
    "source": "string"
  }
  ...
]

--version-name (строка)

Имя версии хранилища аннотаций.

--format-options (структура помеченного объединения)

Параметры форматирования файла аннотаций.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: tsvOptions, vcfOptions.

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

Параметры для файла TSV.

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

Параметры чтения файла.

sep -> (строка)

Разделитель полей файла.

encoding -> (строка)

Кодировка файла.

quote -> (строка)

Символ кавычек файла.

quoteAll -> (булево)

Необходимо ли цитировать все значения или только те, которые содержат кавычки.

escape -> (строка)

Символ для экранирования кавычек в файле.

escapeQuotes -> (булево)

Нужно ли экранировать кавычки в файле.

comment -> (строка)

Символ комментария файла.

header -> (булево)

Есть ли в файле строка заголовка.

lineSep -> (строка)

Разделитель строк файла.

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

Параметры для файла VCF.

ignoreQualField -> (булево)

Настройка игнорирования поля qual файла.

ignoreFilterField -> (булево)

Настройка игнорирования поля filter файла.

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

tsvOptions={readOptions={sep=string,encoding=string,quote=string,quoteAll=boolean,escape=string,escapeQuotes=boolean,comment=string,header=boolean,lineSep=string}},vcfOptions={ignoreQualField=boolean,ignoreFilterField=boolean}

Синтаксис JSON:

{
  "tsvOptions": {
    "readOptions": {
      "sep": "string",
      "encoding": "string",
      "quote": "string",
      "quoteAll": true|false,
      "escape": "string",
      "escapeQuotes": true|false,
      "comment": "string",
      "header": true|false,
      "lineSep": "string"
    }
  },
  "vcfOptions": {
    "ignoreQualField": true|false,
    "ignoreFilterField": true|false
  }
}

--run-left-normalization | --no-run-left-normalization (булево)

Настройка левой нормализации задачи.

--annotation-fields (отображение)

Схема аннотаций, сгенерированная из обработанных данных аннотаций.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--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.

Для импорта аннотаций

Следующий start-annotation-import-job пример импортирует аннотации из Amazon S3.

aws omics start-annotation-import-job \
    --destination-name tsv_ann_store \
    --no-run-left-normalization \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --items source=s3://omics-artifacts-01d6xmpl4e72dd32/targetedregions.bed.gz

Вывод:

{
    "jobId": "984162c7-xmpl-4d23-ab47-286f7950bfbf"
}

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

Вывод

jobId -> (строка)

Идентификатор задачи.

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

Spec-Zone.ru

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