list-fhir-datastores¶

Description¶

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

Synopsis¶

  list-fhir-datastores
[--filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--filter (structure)

Lists all filters associated with a FHIR Data Store request.

DatastoreName -> (string)

Allows the user to filter Data Store results by name.

DatastoreStatus -> (string)

Allows the user to filter Data Store results by status.

CreatedBefore -> (timestamp)

A filter that allows the user to set cutoff dates for records. All Data Stores created before the specified date will be included in the results.

CreatedAfter -> (timestamp)

A filter that allows the user to set cutoff dates for records. All Data Stores created after the specified date will be included in the results.

Shorthand Syntax:

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

JSON Syntax:

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

--next-token (string)

Fetches the next page of Data Stores when results are paginated.

--max-results (integer)

The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call.

--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.

Examples¶

To list FHIR Data Stores

The following list-fhir-datastores example shows to how to use the command and how users can filter results based on Data Store status in Amazon HealthLake.

aws healthlake list-fhir-datastores \
    --region us-east-1 \
    --filter DatastoreStatus=ACTIVE

Output:

{
    "DatastorePropertiesList": [
    {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "DatastoreName": "FhirTestDatastore",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Datastore ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Datastore ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1605574003.209,
        "DatastoreId": "<Datastore ID>"
    },
    {
        "DatastoreName": "Demo",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Datastore ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Datastore ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1603761064.881,
        "DatastoreId": "<Datastore ID>"
    }
    ]
}

For more information, see Creating and monitoring a FHIR Data Store in the Amazon HealthLake Developer Guide.

Output¶

DatastorePropertiesList -> (list)

All properties associated with the listed Data Stores.

(structure)

Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.

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.

SseConfiguration -> (structure)

The server-side encryption key configuration for a customer provided encryption key (CMK).

KmsEncryptionConfig -> (structure)

The KMS encryption configuration used to provide details for data encryption.

CmkType -> (string)

The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

KmsKeyId -> (string)

The KMS encryption key id/alias used to encrypt the Data Store contents at rest.

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.

NextToken -> (string)

Pagination token that can be used to retrieve the next page of results.

Table of Contents

Feedback

User Guide