Spec-Zone.ru › AWS CLI v2

[ aws . healthlake ]

list-fhir-datastores

Описание

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

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

Синтаксис

  list-fhir-datastores
[--filter <value>]
[--next-token <value>]
[--max-results <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]

Параметры

--filter (структура)

Отображает все фильтры, связанные с запросом хранилища FHIR.

DatastoreName -> (строка)

Позволяет пользователю фильтровать результаты хранилищ по имени.

DatastoreStatus -> (строка)

Позволяет пользователю фильтровать результаты хранилищ по статусу.

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

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

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

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

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

DatastoreName=string,DatastoreStatus=string,CreatedBefore=timestamp,CreatedAfter=timestamp

Синтаксис JSON:

{
  "DatastoreName": "string",
  "DatastoreStatus": "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"CREATE_FAILED",
  "CreatedBefore": timestamp,
  "CreatedAfter": timestamp
}

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

Выводит следующую страницу данных хранилищ, когда результаты страницированы.

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

Максимальное количество хранилищ, возвращаемых на одной странице вызова ListFHIRDatastoresRequest.

--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
  • text
  • таблица
  • 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 данных

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

aws healthlake list-fhir-datastores \
    --filter DatastoreStatus=ACTIVE

Вывод:

{
    "DatastorePropertiesList": [
    {
        "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.

Вывод

DatastorePropertiesList -> (список)

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

(структура)

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

DatastoreId -> (строка)

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

DatastoreArn -> (строка)

Используемый в создании хранилища Amazon Resource Name.

DatastoreName -> (строка)

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

DatastoreStatus -> (строка)

Статус хранилища.

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

Время создания хранилища.

DatastoreTypeVersion -> (строка)

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

DatastoreEndpoint -> (строка)

AWS конечная точка хранилища. У каждого хранилища будет своя конечная точка с идентификатором хранилища в URL конечной точки.

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

Настройки ключа шифрования на стороне сервера для предоставленного пользователем ключа шифрования (CMK).

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

Настройки шифрования KMS, предоставляющие подробности для шифрования данных.

CmkType -> (строка)

Тип используемого ключа CMK. Поддерживаются два типа CMK: пользовательские CMK и CMK AWS.

KmsKeyId -> (строка)

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

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

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

PreloadDataType -> (строка)

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

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

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

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

Причина ошибки текущей операции с хранилищем.

ErrorMessage -> (строка)

Текст сообщения об ошибке.

ErrorCategory -> (строка)

Категория ошибки операции создания/удаления хранилища. Возможные статусы — RETRYABLE_ERROR или NON_RETRYABLE_ERROR.

NextToken -> (строка)

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

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

Spec-Zone.ru

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