[ aws . healthlake ]

describe-fhir-datastore

Description

Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-fhir-datastore
[--datastore-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--datastore-id (string)

The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’ output.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

DatastoreProperties -> (structure)

All properties associated with a Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

DatastoreId -> (string)

The AWS-generated ID number for the Data Store.

DatastoreArn -> (string)

The Amazon Resource Name used in the creation of the Data Store.

DatastoreName -> (string)

The user-generated name for the Data Store.

DatastoreStatus -> (string)

The status of the Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, or ‘DELETED’.

CreatedAt -> (timestamp)

The time that a Data Store was created.

DatastoreTypeVersion -> (string)

The FHIR version. Only R4 version data is supported.

DatastoreEndpoint -> (string)

The AWS endpoint for the Data Store. Each Data Store will have it’s own endpoint with Data Store ID in the endpoint URL.

PreloadDataConfig -> (structure)

The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.

PreloadDataType -> (string)

The type of preloaded data. Only Synthea preloaded data is supported.