Spec-Zone.ru › AWS CLI v2

[ aws . omics ]

list-read-sets

Описание

Получает список наборов чтений.

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

list-read-sets является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлечь данные из результатов следующих выражений запроса: readSets

Синтаксис

  list-read-sets
--sequence-store-id <value>
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--sequence-store-id (строка)

Идентификатор хранилища последовательностей заданий.

--filter (структура)

Фильтр для применения к списку.

name -> (строка)

Имя для фильтрации.

status -> (строка)

Статус для фильтрации.

referenceArn -> (строка)

ARN геномной референции для фильтрации.

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

Начальная дата фильтра.

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

Конечная дата фильтра.

sampleId -> (строка)

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

subjectId -> (строка)

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

generatedFrom -> (строка)

Место происхождения источника.

creationType -> (строка)

Тип создания набора чтений.

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

name=string,status=string,referenceArn=string,createdAfter=timestamp,createdBefore=timestamp,sampleId=string,subjectId=string,generatedFrom=string,creationType=string

Синтаксис JSON:

{
  "name": "string",
  "status": "ARCHIVED"|"ACTIVATING"|"ACTIVE"|"DELETING"|"DELETED"|"PROCESSING_UPLOAD"|"UPLOAD_FAILED",
  "referenceArn": "string",
  "createdAfter": timestamp,
  "createdBefore": timestamp,
  "sampleId": "string",
  "subjectId": "string",
  "generatedFrom": "string",
  "creationType": "IMPORT"|"UPLOAD"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания, где начать постраничную навигацию. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной навигации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

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

Для получения списка наборов чтений

Следующий пример list-read-sets получает список наборов чтений для хранилища последовательностей с идентификатором 1234567890.

aws omics list-read-sets \
    --sequence-store-id 1234567890

Вывод:

{
    "readSets": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/1234567890",
            "creationTime": "2022-11-23T21:55:00.515Z",
            "fileType": "FASTQ",
            "id": "1234567890",
            "name": "HG00146",
            "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
            "sampleId": "fastq-sample",
            "sequenceStoreId": "1234567890",
            "status": "ACTIVE",
            "subjectId": "fastq-subject"
        }
    ]
}

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

Вывод

nextToken -> (строка)

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

readSets -> (список)

Список наборов чтений.

(структура)

Набор чтений.

id -> (строка)

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

arn -> (строка)

ARN набора чтений.

sequenceStoreId -> (строка)

Идентификатор хранилища последовательностей набора чтений.

subjectId -> (строка)

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

sampleId -> (строка)

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

status -> (строка)

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

name -> (строка)

Имя набора чтений.

description -> (строка)

Описание набора чтений.

referenceArn -> (строка)

ARN геномной референции набора чтений.

fileType -> (строка)

Тип файла набора чтений.

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

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

totalReadCount -> (длинное целое)

Общее количество чтений последовательности.

totalBaseCount -> (длинное целое)

Общее количество оснований последовательности.

generatedFrom -> (строка)

Источник происхождения последовательности.

alignment -> (строка)

Параметр выравнивания последовательности.

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

Время создания набора чтений.

statusMessage -> (строка)

Статус набора чтений. Предоставляет более подробную информацию о причинах статуса набора чтений.

creationType -> (строка)

Тип создания набора чтений.

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

Тег сущности (ETag) — это хэш объекта, представляющий его семантическое содержимое.

algorithm -> (строка)

Алгоритм, используемый для расчета ETag(ов) набора чтений.

source1 -> (строка)

Хэш ETag, рассчитанный для Source1 набора чтений.

source2 -> (строка)

Хэш ETag, рассчитанный для Source2 набора чтений.

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

Spec-Zone.ru

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