Spec-Zone.ru › AWS CLI v2

[ aws . healthlake ]

list-fhir-import-jobs

Описание

Отображает все задачи импорта FHIR, связанные с учетной записью, и их статусы.

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

Синтаксис

  list-fhir-import-jobs
--datastore-id <value>
[--next-token <value>]
[--max-results <value>]
[--job-name <value>]
[--job-status <value>]
[--submitted-before <value>]
[--submitted-after <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 (строка)

Этот параметр ограничивает ответ задачей импорта с указанным идентификатором хранилища данных.

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

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

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

Этот параметр ограничивает количество возвращаемых результатов запроса ListFHIRImportJobs максимальным значением, указанным пользователем.

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

Этот параметр ограничивает ответ задачей импорта с указанным именем задачи.

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

Этот параметр ограничивает ответ задачей импорта с указанным статусом задачи.

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

  • SUBMITTED
  • QUEUED
  • IN_PROGRESS
  • COMPLETED_WITH_ERRORS
  • COMPLETED
  • FAILED
  • CANCEL_SUBMITTED
  • CANCEL_IN_PROGRESS
  • CANCEL_COMPLETED
  • CANCEL_FAILED

--submitted-before (метка времени)

Этот параметр ограничивает ответ задачами импорта FHIR, отправленными до указанной даты.

--submitted-after (метка времени)

Этот параметр ограничивает ответ задачами импорта FHIR, отправленными после указанной даты.

--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
  • 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Чтобы отобразить все задачи импорта FHIR

Следующий list-fhir-import-jobs пример показывает, как использовать команду для просмотра списка всех задач импорта, связанных с учетной записью.

aws healthlake list-fhir-import-jobs \
    --datastore-id (Data store ID) \
    --submitted-before (DATE like 2024-10-13T19:00:00Z) \
    --submitted-after (DATE like 2020-10-13T19:00:00Z ) \
    --job-name "FHIR-IMPORT" \
    --job-status SUBMITTED  \
    -max-results (Integer between 1 and 500)

Вывод:

{
    "ImportJobPropertiesList": [
        {
            "JobId": "c0fddbf76f238297632d4aebdbfc9ddf",
            "JobStatus": "COMPLETED",
            "SubmitTime": "2024-11-20T10:08:46.813000-05:00",
            "EndTime": "2024-11-20T10:10:09.093000-05:00",
            "DatastoreId": "(Data store ID)",
            "InputDataConfig": {
                "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
            },
            "JobOutputDataConfig": {
                "S3Configuration": {
                    "S3Uri": "s3://(Bucket Name)/import/6407b9ae4c2def3cb6f1a46a0c599ec0-FHIR_IMPORT-c0fddbf76f238297632d4aebdbfc9ddf/",
                    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/b7f645cb-e564-4981-8672-9e012d1ff1a0"
                }
            },
            "JobProgressReport": {
                "TotalNumberOfScannedFiles": 1,
                "TotalSizeOfScannedFilesInMB": 0.001798,
                "TotalNumberOfImportedFiles": 1,
                "TotalNumberOfResourcesScanned": 1,
                "TotalNumberOfResourcesImported": 1,
                "TotalNumberOfResourcesWithCustomerError": 0,
                "TotalNumberOfFilesReadWithCustomerError": 0,
                "Throughput": 0.0
            },
            "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)"
        }
    ]
}

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

Вывод

ImportJobPropertiesList -> (список)

Свойства перечисленных задач импорта FHIR, включая идентификатор, ARN, имя, состояние задачи и отчет о ходе выполнения задачи.

(структура)

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

JobId -> (строка)

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

JobName -> (строка)

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

JobStatus -> (строка)

Состояние задачи импорта. Возможные состояния: ПОДАНО, В_ПРОЦЕССЕ, ЗАВЕРШЕНО_С_ОШИБКАМИ, ЗАВЕРШЕНО, НЕУДАЧА.

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 -> (длинное целое)

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

Throughput -> (двойное)

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

DataAccessRoleArn -> (строка)

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

Message -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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