Spec-Zone.ru › AWS CLI v2

[ aws . healthlake ]

create-fhir-datastore

Описание

Создает хранилище данных, которое может импортировать и экспортировать данные в формате FHIR.

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

Синтаксис

  create-fhir-datastore
[--datastore-name <value>]
--datastore-type-version <value>
[--sse-configuration <value>]
[--preload-data-config <value>]
[--client-token <value>]
[--tags <value>]
[--identity-provider-configuration <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-name (строка)

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

--datastore-type-version (строка)

Версия FHIR хранилища данных. Поддерживается только версия R4.

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

  • R4

--sse-configuration (структура)

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

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

Настройка шифрования KMS, используемая для предоставления данных о шифровании данных.

CmkType -> (строка)

Тип управляемого клиентом ключа шифрования (CMK), используемого для шифрования. Два поддерживаемых типа CMK — это CMK, принадлежащие клиенту, и CMK, принадлежащие AWS.

KmsKeyId -> (строка)

Идентификатор/псевдоним ключа шифрования KMS, используемый для шифрования содержимого хранилища данных в состоянии покоя.

Сокращённый синтаксис:

KmsEncryptionConfig={CmkType=string,KmsKeyId=string}

Синтаксис JSON:

{
  "KmsEncryptionConfig": {
    "CmkType": "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
    "KmsKeyId": "string"
  }
}

--preload-data-config (структура)

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

PreloadDataType -> (строка)

Тип предварительно загруженных данных. Поддерживается только предварительная загрузка данных Synthea.

Сокращённый синтаксис:

PreloadDataType=string

Синтаксис JSON:

{
  "PreloadDataType": "SYNTHEA"
}

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

Необязательный предоставленный пользователем токен, используемый для обеспечения идемпотентности.

--tags (список)

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

(структура)

Тег — это метка, состоящая из определённого пользователем ключа и значения. Формат тегов — {“Ключ”, “Значение”}

Ключ -> (строка)

Часть ключа тега. Ключи тегов чувствительны к регистру.

Значение -> (строка)

Часть значения тега. Значения тегов чувствительны к регистру.

Сокращённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--identity-provider-configuration (структура)

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

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

Amazon Resource Name (ARN) функции Lambda, которую вы хотите использовать для декодирования маркера доступа, созданного сервером авторизации.

Сокращённый синтаксис:

AuthorizationStrategy=string,FineGrainedAuthorizationEnabled=boolean,Metadata=string,IdpLambdaArn=string

Синтаксис JSON:

{
  "AuthorizationStrategy": "SMART_ON_FHIR_V1"|"SMART_ON_FHIR"|"AWS_AUTH",
  "FineGrainedAuthorizationEnabled": true|false,
  "Metadata": "string",
  "IdpLambdaArn": "string"
}

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

Пример 1: Создание хранилища данных HealthLake с поддержкой SigV4

Следующий create-fhir-datastore пример демонстрирует, как создать новое хранилище данных в AWS HealthLake.

aws healthlake create-fhir-datastore \
    --datastore-type-version R4 \
    --datastore-name "FhirTestDatastore"

Вывод:

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
    "DatastoreStatus": "CREATING",
    "DatastoreId": "(Data store ID)"
}

Пример 2: Создание хранилища данных HealthLake с поддержкой SMART on FHIR

Следующий create-fhir-datastore пример демонстрирует, как создать новое хранилище данных с поддержкой SMART on FHIR в AWS HealthLake.

aws healthlake create-fhir-datastore \
    --datastore-name "your-data-store-name" \
    --datastore-type-version R4 \
    --preload-data-config PreloadDataType="SYNTHEA" \
    --sse-configuration '{ "KmsEncryptionConfig": {  "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:your-account-id:key/your-key-id" } }' \
    --identity-provider-configuration  file://identity_provider_configuration.json

Содержание identity_provider_configuration.json:

{
    "AuthorizationStrategy": "SMART_ON_FHIR_V1",
    "FineGrainedAuthorizationEnabled": true,
    "IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name",
    "Metadata": "{\"issuer\":\"https://ehr.example.com\", \"jwks_uri\":\"https://ehr.example.com/.well-known/jwks.json\",\"authorization_endpoint\":\"https://ehr.example.com/auth/authorize\",\"token_endpoint\":\"https://ehr.token.com/auth/token\",\"token_endpoint_auth_methods_supported\":[\"client_secret_basic\",\"foo\"],\"grant_types_supported\":[\"client_credential\",\"foo\"],\"registration_endpoint\":\"https://ehr.example.com/auth/register\",\"scopes_supported\":[\"openId\",\"profile\",\"launch\"],\"response_types_supported\":[\"code\"],\"management_endpoint\":\"https://ehr.example.com/user/manage\",\"introspection_endpoint\":\"https://ehr.example.com/user/introspect\",\"revocation_endpoint\":\"https://ehr.example.com/user/revoke\",\"code_challenge_methods_supported\":[\"S256\"],\"capabilities\":[\"launch-ehr\",\"sso-openid-connect\",\"client-public\"]}"
}

Вывод:

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
    "DatastoreStatus": "CREATING",
    "DatastoreId": "(Data store ID)"
}

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

Вывод

DatastoreId -> (строка)

Идентификатор хранилища данных, сгенерированный AWS. Этот идентификатор содержится в выводе начального вызова создания хранилища данных.

DatastoreArn -> (строка)

ARN хранилища данных генерируется во время создания хранилища данных и может быть найден в выводе начального вызова создания хранилища данных.

DatastoreStatus -> (строка)

Состояние хранилища данных FHIR.

DatastoreEndpoint -> (строка)

AWS-конечная точка созданного хранилища данных.

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

Spec-Zone.ru

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