Spec-Zone.ru › AWS CLI v2

[ aws . healthlake ]

list-fhir-export-jobs

Описание

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

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

Синтаксис

  list-fhir-export-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 (строка)

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

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

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

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

Переопределить стандартный 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок 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.

Для отображения всех заданий экспорта FHIR

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

aws healthlake list-fhir-export-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-EXPORT" \
    --job-status SUBMITTED  \
    --max-results (Integer between 1 and 500)

Вывод:

{
    "ExportJobPropertiesList": [
        {
            "ExportJobProperties": {
                "OutputDataConfig": {
                    "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                    "S3Configuration": {
                        "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                        "KmsKeyId": "(KmsKey Id)"
                    }
                },
                "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
                "JobStatus": "COMPLETED",
                "JobId": "c145fbb27b192af392f8ce6e7838e34f",
                "JobName": "FHIR-EXPORT",
                "SubmitTime": "2024-11-20T11:31:46.672000-05:00",
                "EndTime": "2024-11-20T11:34:01.636000-05:00",
                "DatastoreId": "(Data store ID)"
            }
        }
    ]
}

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

Вывод

ExportJobPropertiesList -> (список)

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

(структура)

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

JobId -> (строка)

ID, сгенерированный AWS, для задания экспорта.

JobName -> (строка)

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

JobStatus -> (строка)

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

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

Время инициирования задания экспорта.

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

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

DatastoreId -> (строка)

ID, сгенерированный AWS, для хранилища данных, из которого файлы экспортируются для задания экспорта.

OutputDataConfig -> (структура сопоставления типов)

Настройка вывода данных, предоставленная при создании задания экспорта.

Примечание

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

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

Настройка вывода данных, предоставленная при создании задания экспорта.

S3Uri -> (строка)

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

KmsKeyId -> (строка)

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

DataAccessRoleArn -> (строка)

Идентификатор Amazon Resource Name, используемый при инициировании задания.

Message -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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