[ aws . healthlake ]

delete-fhir-datastore

Description

Deletes a Data Store.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--datastore-id (string)

The AWS-generated ID for the Data Store to be deleted.

--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 delete a FHIR Data Store

The following delete-fhir-datastore example demonstrates how to delete a Data Store and all of its contents in Amazon HealthLake.

aws healthlake delete-fhir-datastore \
    --datastore-id (Data Store ID) \
    --region us-east-1

Output:

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

For more information, see Creating and monitoring a FHIR Data Store <https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html> in the Amazon HealthLake Developer Guide.

Output

DatastoreId -> (string)

The AWS-generated ID for the Data Store to be deleted.

DatastoreArn -> (string)

The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.

DatastoreStatus -> (string)

The status of the Data Store that the user has requested to be deleted.

DatastoreEndpoint -> (string)

The AWS endpoint for the Data Store the user has requested to be deleted.