Spec-Zone.ru › AWS CLI v2

[ aws . healthlake ]

describe-fhir-import-job

Описание

Отображает свойства задания импорта FHIR, включая ID, ARN, имя и статус задания.

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

Синтаксис

  describe-fhir-import-job
--datastore-id <value>
--job-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]

Параметры

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

Сгенерированный AWS ID хранилища данных.

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

Сгенерированный AWS 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 (строка)

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

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

Для описания задания импорта FHIR

Следующий describe-fhir-import-job пример демонстрирует, как узнать свойства задания импорта FHIR с использованием AWS HealthLake.

aws healthlake describe-fhir-import-job \
    --datastore-id (Data store ID) \
    --job-id c145fbb27b192af392f8ce6e7838e34f

Вывод:

{
    "ImportJobProperties": {
    "InputDataConfig": {
        "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
        { "arrayitem2": 2 }
    },
    "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
    "JobStatus": "COMPLETED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f",
    "SubmitTime": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Data store ID)"
    }
}

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

Вывод

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

Свойства запроса задания импорта, включая ID, ARN, имя, статус задания и отчет о прогрессе задания.

JobId -> (строка)

Сгенерированный AWS идентификатор для задания импорта.

JobName -> (строка)

Имя задания импорта, заданное пользователем.

JobStatus -> (строка)

Статус задания импорта. Возможные статусы: SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.

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

Время отправки задания импорта на обработку.

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

Время завершения задания импорта.

DatastoreId -> (строка)

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

InputDataConfig -> (структура помеченного союза)

Конфигурация входных данных, предоставленная при создании задания импорта.

Примечание

Это структура помеченного союза. Может быть задано только одно из следующих верхнеуровневых ключей: S3Uri.

S3Uri -> (строка)

S3Uri — это указанное пользователем расположение S3 с данными FHIR, которые необходимо импортировать в AWS HealthLake.

JobOutputDataConfig -> (структура помеченного союза)

Конфигурация выходных данных, предоставленная при создании задания экспорта.

Примечание

Это структура помеченного союза. Может быть задано только одно из следующих верхнеуровневых ключей: S3Configuration.

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

Конфигурация выходных данных, предоставленная при создании задания экспорта.

S3Uri -> (строка)

S3Uri — это указанное пользователем расположение S3 с данными FHIR, которые необходимо импортировать в AWS HealthLake.

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемый для доступа к ведру S3.

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

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

TotalNumberOfScannedFiles -> (длинное целое число)

Количество файлов, просканированных из входного ведра S3.

TotalSizeOfScannedFilesInMB -> (вещественное число)

Размер (в МБ) файлов, просканированных из входного ведра S3.

TotalNumberOfImportedFiles -> (длинное целое число)

Количество файлов, импортированных до настоящего времени.

TotalNumberOfResourcesScanned -> (длинное целое число)

Количество ресурсов, просканированных из входного ведра S3.

TotalNumberOfResourcesImported -> (длинное целое число)

Количество ресурсов, импортированных до настоящего времени.

TotalNumberOfResourcesWithCustomerError -> (длинное целое число)

Количество ресурсов, которые не удалось импортировать из-за ошибки клиента.

TotalNumberOfFilesReadWithCustomerError -> (длинное целое число)

Количество файлов, чтение которых не удалось из-за ошибки клиента.

Throughput -> (вещественное число)

Пропускная способность (в МБ/с) задания импорта.

DataAccessRoleArn -> (строка)

Amazon Resource Name (ARN), предоставляющий AWS HealthLake доступ к вашим входным данным.

Message -> (строка)

Объяснение любых ошибок, которые могут возникнуть во время задания импорта FHIR.

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

Spec-Zone.ru

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