Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . healthlake ]



Adds a user specifed key and value tag to a Data Store.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--resource-arn <value>
--tags <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--resource-arn (string)

The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to.

--tags (list)

The user specified key and value pair tags being added to a Data Store.


A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}

Key -> (string)

The key portion of a tag. Tag keys are case sensitive.

Value -> (string)

The value portion of tag. Tag values are case sensitive.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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


To add a tag to Data Store

The following tag-resource example shows how to add a tag to a Data Store.

aws healthlake tag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:691207106566:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --tags '[{"Key": "key1", "Value": "value1"}]' \
    --region us-east-1

This command produces no output.

For more information, see 'Adding a tag to a Data Store <>'__ in the Amazon HealthLake Developer Guide..