[ aws . healthlake ]
описание-хранилища-fhir
Описание
Получает свойства хранилища данных FHIR, включая идентификатор хранилища, ARN хранилища, имя хранилища, статус хранилища, время создания хранилища, версию типа хранилища и конечную точку хранилища.
См. также: Документацию API AWS
Синтаксис
describe-fhir-datastore
--datastore-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 (строка)
--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 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-datastore пример демонстрирует, как найти свойства хранилища в AWS HealthLake.
aws healthlake describe-fhir-datastore \
--datastore-id "1f2f459836ac6c513ce899f9e4f66a59"
Вывод:
{
"DatastoreProperties": {
"PreloadDataConfig": {
"PreloadDataType": "SYNTHEA"
},
"SseConfiguration": {
"KmsEncryptionConfig": {
"CmkType": "CUSTOMER_MANAGED_KMS_KEY",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
},
"DatastoreName": "Demo",
"DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Data store ID>",
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Data store ID>/r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "<Data store ID>",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
}
}
}
Дополнительную информацию см. в разделе Создание и мониторинг хранилищ FHIR в руководстве разработчика AWS HealthLake.
Вывод
DatastoreProperties -> (структура)
Все свойства хранилища, включая идентификатор хранилища, ARN хранилища, имя хранилища, статус хранилища, время создания хранилища, версию типа хранилища и конечную точку хранилища.
DatastoreId -> (строка)
DatastoreArn -> (строка)
DatastoreName -> (строка)
DatastoreStatus -> (строка)
CreatedAt -> (метка времени)
DatastoreTypeVersion -> (строка)
DatastoreEndpoint -> (строка)
SseConfiguration -> (структура)
Настройка ключа шифрования на стороне сервера для ключа шифрования, предоставленного клиентом (CMK).
KmsEncryptionConfig -> (структура)
Настройка шифрования KMS, используемая для предоставления информации о шифровании данных.
CmkType -> (строка)
KmsKeyId -> (строка)
PreloadDataConfig -> (структура)
Настройка предварительно загруженных данных для хранилища. Поддерживаются только предварительно загруженные данные из Synthea.
PreloadDataType -> (строка)
IdentityProviderConfiguration -> (структура)
Провайдер удостоверений, выбранный при создании хранилища.
AuthorizationStrategy -> (строка)
FineGrainedAuthorizationEnabled -> (логическое значение)
Metadata -> (строка)
Элементы метаданных JSON, которые вы хотите использовать в конфигурации провайдера удостоверений. Требуемые элементы указаны на основе спецификации запуска приложения SMART. Дополнительную информацию обо всех возможных элементах см. в разделе Метаданные в спецификации запуска приложения SMART.
authorization_endpoint : URL OAuth2-конечной точки авторизации.
grant_types_supported : Массив типов грантов, поддерживаемых на токен-конечной точке. Вы должны предоставить как минимум один вариант типа гранта. Допустимые варианты — authorization_code и client_credentials.
token_endpoint : URL OAuth2-конечной точки токена.
capabilities : Массив строк SMART-возможностей, поддерживаемых сервером авторизации.
code_challenge_methods_supported : Массив строк поддерживаемых методов вызова кода PKCE. Вы должны включить метод S256 в массив методов вызова кода PKCE.
IdpLambdaArn -> (строка)
ErrorCause -> (структура)
Причина ошибки для текущей операции с хранилищем данных.
ErrorMessage -> (строка)
ErrorCategory -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.