AWS CLI Command Reference

[ aws . healthlake ]

restore-fhir-datastore

Description

Restore a backup-enabled data store to a point in time. Creates a new data store from the backup.

See also: AWS API Documentation

Synopsis

  restore-fhir-datastore
--source-datastore-id <value>
--restore-configuration <value>
[--datastore-name <value>]
[--sse-configuration <value>]
[--client-token <value>]
[--tags <value>]
[--identity-provider-configuration <value>]
[--analytics-configuration <value>]
[--nlp-configuration <value>]
[--profile-configuration <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-datastore-id (string) [required]

The identifier of the source data store to restore from.

Constraints:

  • min: 1
  • max: 32
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)

--restore-configuration (tagged union structure) [required]

The restore configuration specifying the type and parameters for the restore.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ContinuousBackupRestoreConfiguration.

ContinuousBackupRestoreConfiguration -> (structure)

Configuration for restoring from continuous backup to a specific point in time.

RestorePointTime -> (timestamp)

The point in time to restore the data store to, specified as a UTC timestamp.

Shorthand Syntax:

ContinuousBackupRestoreConfiguration={RestorePointTime=timestamp}

JSON Syntax:

{
  "ContinuousBackupRestoreConfiguration": {
    "RestorePointTime": timestamp
  }
}

--datastore-name (string)

The name for the restored data store.

Constraints:

  • min: 1
  • max: 256
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)

--sse-configuration (structure)

The server-side encryption key configuration for the restored data store.

KmsEncryptionConfig -> (structure) [required]

The Key Management Service (KMS) encryption configuration used to provide details for data encryption.

CmkType -> (string) [required]

The type of customer-managed-key (CMK) used for encryption.

Possible values:

  • CUSTOMER_MANAGED_KMS_KEY
  • AWS_OWNED_KMS_KEY

KmsKeyId -> (string)

The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.

Constraints:

  • min: 1
  • max: 400
  • pattern: (arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))

Shorthand Syntax:

KmsEncryptionConfig={CmkType=string,KmsKeyId=string}

JSON Syntax:

{
  "KmsEncryptionConfig": {
    "CmkType": "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
    "KmsKeyId": "string"
  }
}

--client-token (string)

An optional user-provided token to ensure API idempotency of the restore.

Constraints:

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

--tags (list)

The resource tags applied to the restored data store.

Constraints:

  • min: 0
  • max: 200

(structure)

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

Key -> (string) [required]

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

Constraints:

  • min: 1
  • max: 128
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value -> (string) [required]

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

Constraints:

  • min: 0
  • max: 256
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--identity-provider-configuration (structure)

The identity provider configuration for the restored data store.

AuthorizationStrategy -> (string) [required]

The authorization strategy selected when the HealthLake data store is created.

Note

HealthLake provides support for both SMART on FHIR V1 and V2 as described below.

  • SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which includes read (read/search) and write (create/update/delete) permissions.
  • SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2, which includes create , read , update , delete , and search permissions.
  • Amazon Web Services_AUTH – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.

Possible values:

  • SMART_ON_FHIR_V1
  • SMART_ON_FHIR
  • AWS_AUTH

FineGrainedAuthorizationEnabled -> (boolean)

The parameter to enable SMART on FHIR fine-grained authorization for the data store.

Metadata -> (string)

The JSON metadata elements to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART’s App Launch specification.

authorization_endpoint : The URL to the OAuth2 authorization endpoint.

grant_types_supported : An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials .

token_endpoint : The URL to the OAuth2 token endpoint.

capabilities : An array of strings of the SMART capabilities that the authorization server supports.

code_challenge_methods_supported : An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

IdpLambdaArn -> (string)

The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.

Constraints:

  • min: 49
  • max: 256
  • pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9\-_\.]+(:(\$LATEST|[a-zA-Z0-9\-_]+))?

Shorthand Syntax:

AuthorizationStrategy=string,FineGrainedAuthorizationEnabled=boolean,Metadata=string,IdpLambdaArn=string

JSON Syntax:

{
  "AuthorizationStrategy": "SMART_ON_FHIR_V1"|"SMART_ON_FHIR"|"AWS_AUTH",
  "FineGrainedAuthorizationEnabled": true|false,
  "Metadata": "string",
  "IdpLambdaArn": "string"
}

--analytics-configuration (structure)

The analytics configuration for the restored data store.

Status -> (string)

The status of the analytics configuration.

Possible values:

  • ENABLED
  • ENABLING
  • DISABLED
  • DISABLING
  • PAUSING
  • PAUSED

Shorthand Syntax:

Status=string

JSON Syntax:

{
  "Status": "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"|"PAUSING"|"PAUSED"
}

--nlp-configuration (structure)

The NLP configuration for the restored data store.

Status -> (string)

The status of the NLP configuration.

Possible values:

  • ENABLED
  • ENABLING
  • DISABLED
  • DISABLING

Shorthand Syntax:

Status=string

JSON Syntax:

{
  "Status": "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"
}

--profile-configuration (structure)

The profile configuration for the restored data store.

DefaultProfiles -> (list)

The list of default profiles for the data store.

(string)

A general-purpose string value.

Constraints:

  • min: 0
  • max: 10000
  • pattern: [\P{M}\p{M}]{0,10000}

Shorthand Syntax:

DefaultProfiles=string,string

JSON Syntax:

{
  "DefaultProfiles": ["string", ...]
}

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

DatastoreId -> (string)

The restored data store identifier.

Constraints:

  • min: 1
  • max: 32
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)

DatastoreArn -> (string)

The Amazon Resource Name (ARN) for the restored data store.

Constraints:

  • pattern: arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?

DatastoreStatus -> (string)

The restored data store status.

Possible values:

  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • CREATE_FAILED
  • UPDATING
  • UPDATE_FAILED

DatastoreEndpoint -> (string)

The AWS endpoint for the restored data store.

Constraints:

  • min: 1
  • max: 5000
  • pattern: [\P{M}\p{M}]{1,5000}
© Copyright 2026, Amazon Web Services. Created using Sphinx.