AWS CLI Command Reference

[ aws . healthlake ]

create-data-transformation-profile

Description

Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.

See also: AWS API Documentation

Synopsis

  create-data-transformation-profile
--source-format <value>
--source <value>
[--kms-key-id <value>]
[--profile-description <value>]
--profile-name <value>
[--tags <value>]
[--client-token <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]
[--cli-error-format <value>]

Options

--source-format (string) [required]

The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).

Possible values:

  • CCDA
  • CSV

--source (tagged union structure) [required]

The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: StarterProfile, ExistingVersionedProfileId, ProfileMapping, SampleData.

StarterProfile -> (structure)

Creates the profile from a built-in starter profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).

StarterProfileName -> (string) [required]

The name of the built-in starter profile.

ExistingVersionedProfileId -> (structure)

Creates the profile by cloning an existing profile at a specific version.

ProfileId -> (string) [required]

The unique identifier of the existing profile to clone from.

Version -> (integer) [required]

The version number of the existing profile to clone from.

ProfileMapping -> (structure)

Creates the profile from raw profile content that you provide directly. Use this variant for continuous integration and continuous delivery (CI/CD) workflows.

ProfileMapping -> (map) [required]

The content as a map of file paths to profile strings.

key -> (string)

value -> (string)

SampleData -> (structure)

Creates the profile from a sample data file stored in Amazon S3. Valid only when the source format is Comma-separated values (CSV).

S3Uri -> (string) [required]

The Amazon S3 URI of the sample data file.

Constraints:

  • min: 1
  • max: 1024
  • pattern: s3://[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9](/.*)?

Shorthand Syntax:

StarterProfile={StarterProfileName=string},ExistingVersionedProfileId={ProfileId=string,Version=integer},ProfileMapping={ProfileMapping={KeyName1=string,KeyName2=string}},SampleData={S3Uri=string}

JSON Syntax:

{
  "StarterProfile": {
    "StarterProfileName": "string"
  },
  "ExistingVersionedProfileId": {
    "ProfileId": "string",
    "Version": integer
  },
  "ProfileMapping": {
    "ProfileMapping": {"string": "string"
      ...}
  },
  "SampleData": {
    "S3Uri": "string"
  }
}

--kms-key-id (string)

The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.

Constraints:

  • min: 1
  • max: 2048

--profile-description (string)

A human-readable description of the profile’s purpose.

Constraints:

  • min: 0
  • max: 1000

--profile-name (string) [required]

A name for the data transformation profile.

Constraints:

  • min: 1
  • max: 256

--tags (map)

The tags to associate with the profile at creation time.

Constraints:

  • min: 0
  • max: 50

key -> (string)

The key of the tag. Tag keys are case-sensitive and must be unique per resource.

Constraints:

  • min: 1
  • max: 128

value -> (string)

The value of the tag. Tag values are case-sensitive and can be empty strings.

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9-]+

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

ProfileId -> (string)

The unique identifier of the created profile.

Constraints:

  • min: 32
  • max: 32
  • pattern: [a-f0-9]{32}

Version -> (integer)

The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state.

Constraints:

  • min: 0
  • max: 99

SourceFormat -> (string)

The source data format of the profile.

Possible values:

  • CCDA
  • CSV

TargetFormat -> (string)

The target output format. Always FHIR_R4 .

Possible values:

  • FHIR_R4

ProfileName -> (string)

The name of the created profile.

Constraints:

  • min: 1
  • max: 256

LastUpdatedAt -> (timestamp)

The timestamp when the profile was last updated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.