Spec-Zone.ru › AWS CLI v2

[ aws . omics ]

get-read-set-metadata

Описание

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

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

Синтаксис

  get-read-set-metadata
--id <value>
--sequence-store-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 (строка)

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

--sequence-store-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 (строка)

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

  • вкл
  • выкл
  • авто

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

Для просмотра набора считываний

Следующий get-read-set-metadata пример получает сведения о файлах набора считываний.

aws omics get-read-set-metadata \
    --sequence-store-id 1234567890 \
    --id 1234567890

Вывод:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/1234567890",
    "creationTime": "2022-11-23T21:55:00.515Z",
    "fileType": "FASTQ",
    "files": {
        "source1": {
            "contentLength": 310054739,
            "partSize": 104857600,
            "totalParts": 3
        },
        "source2": {
            "contentLength": 307846621,
            "partSize": 104857600,
            "totalParts": 3
        }
    },
    "id": "1234567890",
    "name": "HG00146",
    "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
    "sampleId": "fastq-sample",
    "sequenceInformation": {
        "alignment": "UNALIGNED",
        "totalBaseCount": 677717384,
        "totalReadCount": 8917334
    },
    "sequenceStoreId": "1234567890",
    "status": "ACTIVE",
    "subjectId": "fastq-subject"
}

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

Вывод

id -> (строка)

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

arn -> (строка)

ARN набора считываний.

sequenceStoreId -> (строка)

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

subjectId -> (строка)

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

sampleId -> (строка)

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

status -> (строка)

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

name -> (строка)

Имя набора считываний.

description -> (строка)

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

fileType -> (строка)

Тип файла набора считываний.

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

Дата создания набора считываний.

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

Информация о последовательностях набора считываний.

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

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

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

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

generatedFrom -> (строка)

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

alignment -> (строка)

Настройка выравнивания последовательности.

referenceArn -> (строка)

ARN эталонной генома набора считываний.

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

Файлы набора считываний.

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

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

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

Общее количество частей файла.

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

Размер части файла.

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

Длина содержимого файла.

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

Метаданные URI S3 хранилища последовательностей.

s3Uri -> (строка)

URI S3 для каждого файла набора считываний.

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

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

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

Общее количество частей файла.

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

Размер части файла.

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

Длина содержимого файла.

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

Метаданные URI S3 хранилища последовательностей.

s3Uri -> (строка)

URI S3 для каждого файла набора считываний.

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

Индекс файлов.

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

Общее количество частей файла.

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

Размер части файла.

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

Длина содержимого файла.

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

Метаданные URI S3 хранилища последовательностей.

s3Uri -> (строка)

URI S3 для каждого файла набора считываний.

statusMessage -> (строка)

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

creationType -> (строка)

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

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

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

algorithm -> (строка)

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

source1 -> (строка)

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

source2 -> (строка)

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

creationJobId -> (строка)

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

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

Spec-Zone.ru

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