Amazon HealthLake

2026/08/28 - Amazon HealthLake - 1 new4 updated api methods

Changes  New HealthLake API, RestoreFHIRDatastore, providing the capability to restore active datastores to a point in time within the last 30 days or recover a deleted datastore from the delete snapshot.

RestoreFHIRDatastore (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.restore_fhir_datastore(
    SourceDatastoreId='string',
    RestoreConfiguration={
        'ContinuousBackupRestoreConfiguration': {
            'RestorePointTime': datetime(2015, 1, 1)
        }
    },
    DatastoreName='string',
    SseConfiguration={
        'KmsEncryptionConfig': {
            'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
            'KmsKeyId': 'string'
        }
    },
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IdentityProviderConfiguration={
        'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
        'FineGrainedAuthorizationEnabled': True|False,
        'Metadata': 'string',
        'IdpLambdaArn': 'string'
    },
    AnalyticsConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
    },
    NlpConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
    },
    ProfileConfiguration={
        'DefaultProfiles': [
            'string',
        ]
    }
)
type SourceDatastoreId:

string

param SourceDatastoreId:

[REQUIRED]

The identifier of the source data store to restore from.

type RestoreConfiguration:

dict

param RestoreConfiguration:

[REQUIRED]

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

  • ContinuousBackupRestoreConfiguration (dict) --

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

    • RestorePointTime (datetime) --

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

type DatastoreName:

string

param DatastoreName:

The name for the restored data store.

type SseConfiguration:

dict

param SseConfiguration:

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

  • KmsEncryptionConfig (dict) -- [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.

    • KmsKeyId (string) --

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

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type Tags:

list

param Tags:

The resource tags applied to the restored data store.

  • (dict) --

    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.

    • Value (string) -- [REQUIRED]

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

type IdentityProviderConfiguration:

dict

param IdentityProviderConfiguration:

The identity provider configuration for the restored data store.

  • AuthorizationStrategy (string) -- [REQUIRED]

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

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

type AnalyticsConfiguration:

dict

param AnalyticsConfiguration:

The analytics configuration for the restored data store.

  • Status (string) --

    The status of the analytics configuration.

type NlpConfiguration:

dict

param NlpConfiguration:

The NLP configuration for the restored data store.

  • Status (string) --

    The status of the NLP configuration.

type ProfileConfiguration:

dict

param ProfileConfiguration:

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.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
    'DatastoreEndpoint': 'string'
}

Response Structure

  • (dict) --

    • DatastoreId (string) --

      The restored data store identifier.

    • DatastoreArn (string) --

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

    • DatastoreStatus (string) --

      The restored data store status.

    • DatastoreEndpoint (string) --

      The AWS endpoint for the restored data store.

CreateFHIRDatastore (updated) Link ¶
Changes (request) 
{'BackupConfiguration': {'BackupTagsEnabled': 'boolean',
                         'BackupType': 'CONTINUOUS',
                         'RetentionPeriodInDays': 'integer',
                         'Status': 'ENABLED | DISABLED'}}

Create a FHIR-enabled data store.

See also: AWS API Documentation

Request Syntax

client.create_fhir_datastore(
    DatastoreName='string',
    DatastoreTypeVersion='R4',
    SseConfiguration={
        'KmsEncryptionConfig': {
            'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
            'KmsKeyId': 'string'
        }
    },
    PreloadDataConfig={
        'PreloadDataType': 'SYNTHEA'
    },
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IdentityProviderConfiguration={
        'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
        'FineGrainedAuthorizationEnabled': True|False,
        'Metadata': 'string',
        'IdpLambdaArn': 'string'
    },
    AnalyticsConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
    },
    NlpConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
    },
    ProfileConfiguration={
        'DefaultProfiles': [
            'string',
        ]
    },
    BackupConfiguration={
        'Status': 'ENABLED'|'DISABLED',
        'BackupType': 'CONTINUOUS',
        'RetentionPeriodInDays': 123,
        'BackupTagsEnabled': True|False
    }
)
type DatastoreName:

string

param DatastoreName:

The data store name (user-generated).

type DatastoreTypeVersion:

string

param DatastoreTypeVersion:

[REQUIRED]

The FHIR release version supported by the data store. Current support is for version R4.

type SseConfiguration:

dict

param SseConfiguration:

The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.

  • KmsEncryptionConfig (dict) -- [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.

    • KmsKeyId (string) --

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

type PreloadDataConfig:

dict

param PreloadDataConfig:

An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.

  • PreloadDataType (string) -- [REQUIRED]

    The type of preloaded data. Only Synthea preloaded data is supported.

type ClientToken:

string

param ClientToken:

An optional user-provided token to ensure API idempotency.

This field is autopopulated if not provided.

type Tags:

list

param Tags:

The resource tags applied to a data store when it is created.

  • (dict) --

    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.

    • Value (string) -- [REQUIRED]

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

type IdentityProviderConfiguration:

dict

param IdentityProviderConfiguration:

The identity provider configuration to use for the data store.

  • AuthorizationStrategy (string) -- [REQUIRED]

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

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

type AnalyticsConfiguration:

dict

param AnalyticsConfiguration:

The analytics configuration for the data store.

  • Status (string) --

    The status of the analytics configuration.

type NlpConfiguration:

dict

param NlpConfiguration:

The natural language processing (NLP) configuration for the data store.

  • Status (string) --

    The status of the NLP configuration.

type ProfileConfiguration:

dict

param ProfileConfiguration:

The profile configuration for the data store.

  • DefaultProfiles (list) --

    The list of default profiles for the data store.

    • (string) --

      A general-purpose string value.

type BackupConfiguration:

dict

param BackupConfiguration:

The backup configuration for the data store.

  • Status (string) --

    The backup status of the data store.

  • BackupType (string) --

    The type of backup.

  • RetentionPeriodInDays (integer) --

    The number of days backup data is retained.

  • BackupTagsEnabled (boolean) --

    Specifies whether tags are included in backups.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
    'DatastoreEndpoint': 'string'
}

Response Structure

  • (dict) --

    • DatastoreId (string) --

      The data store identifier.

    • DatastoreArn (string) --

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

    • DatastoreStatus (string) --

      The data store status.

    • DatastoreEndpoint (string) --

      The Amazon Web Services endpoint created for the data store.

DescribeFHIRDatastore (updated) Link ¶
Changes (response) 
{'DatastoreProperties': {'BackupStatusInfo': {'BackupEnabledAt': 'timestamp',
                                              'Configuration': {'BackupTagsEnabled': 'boolean',
                                                                'BackupType': 'CONTINUOUS',
                                                                'RetentionPeriodInDays': 'integer',
                                                                'Status': 'ENABLED '
                                                                          '| '
                                                                          'DISABLED'},
                                              'EarliestRestorePoint': 'timestamp',
                                              'LatestRestorePoint': 'timestamp',
                                              'ScheduledPermanentDeletionTime': 'timestamp'}}}

Get properties for a FHIR-enabled data store.

See also: AWS API Documentation

Request Syntax

client.describe_fhir_datastore(
    DatastoreId='string'
)
type DatastoreId:

string

param DatastoreId:

[REQUIRED]

The data store identifier.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreProperties': {
        'DatastoreId': 'string',
        'DatastoreArn': 'string',
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'DatastoreTypeVersion': 'R4',
        'DatastoreEndpoint': 'string',
        'SseConfiguration': {
            'KmsEncryptionConfig': {
                'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
                'KmsKeyId': 'string'
            }
        },
        'PreloadDataConfig': {
            'PreloadDataType': 'SYNTHEA'
        },
        'IdentityProviderConfiguration': {
            'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
            'FineGrainedAuthorizationEnabled': True|False,
            'Metadata': 'string',
            'IdpLambdaArn': 'string'
        },
        'ErrorCause': {
            'ErrorMessage': 'string',
            'ErrorCategory': 'RETRYABLE_ERROR'|'NON_RETRYABLE_ERROR'
        },
        'NlpConfiguration': {
            'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
        },
        'AnalyticsConfiguration': {
            'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
        },
        'ProfileConfiguration': {
            'DefaultProfiles': [
                'string',
            ]
        },
        'BackupStatusInfo': {
            'Configuration': {
                'Status': 'ENABLED'|'DISABLED',
                'BackupType': 'CONTINUOUS',
                'RetentionPeriodInDays': 123,
                'BackupTagsEnabled': True|False
            },
            'BackupEnabledAt': datetime(2015, 1, 1),
            'EarliestRestorePoint': datetime(2015, 1, 1),
            'LatestRestorePoint': datetime(2015, 1, 1),
            'ScheduledPermanentDeletionTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    • DatastoreProperties (dict) --

      The data store properties.

      • DatastoreId (string) --

        The data store identifier.

      • DatastoreArn (string) --

        The Amazon Resource Name (ARN) used in the creation of the data store.

      • DatastoreName (string) --

        The data store name.

      • DatastoreStatus (string) --

        The data store status.

      • CreatedAt (datetime) --

        The time the data store was created.

      • DatastoreTypeVersion (string) --

        The FHIR release version supported by the data store. Current support is for version R4.

      • DatastoreEndpoint (string) --

        The Amazon Web Services endpoint for the data store.

      • SseConfiguration (dict) --

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

        • KmsEncryptionConfig (dict) --

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

          • CmkType (string) --

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

          • KmsKeyId (string) --

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

      • PreloadDataConfig (dict) --

        The preloaded Synthea data configuration for the data store.

        • PreloadDataType (string) --

          The type of preloaded data. Only Synthea preloaded data is supported.

      • IdentityProviderConfiguration (dict) --

        The identity provider selected during data store creation.

        • AuthorizationStrategy (string) --

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

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

      • ErrorCause (dict) --

        The error cause for the current data store operation.

        • ErrorMessage (string) --

          The error message text for ErrorCause.

        • ErrorCategory (string) --

          The error category for ErrorCause.

      • NlpConfiguration (dict) --

        The natural language processing (NLP) configuration for the data store.

        • Status (string) --

          The status of the NLP configuration.

      • AnalyticsConfiguration (dict) --

        The analytics configuration for the data store.

        • Status (string) --

          The status of the analytics configuration.

      • ProfileConfiguration (dict) --

        The profile configuration for the data store.

        • DefaultProfiles (list) --

          The list of default profiles for the data store.

          • (string) --

            A general-purpose string value.

      • BackupStatusInfo (dict) --

        The backup status information for the data store.

        • Configuration (dict) --

          The backup configuration for the data store.

          • Status (string) --

            The backup status of the data store.

          • BackupType (string) --

            The type of backup.

          • RetentionPeriodInDays (integer) --

            The number of days backup data is retained.

          • BackupTagsEnabled (boolean) --

            Specifies whether tags are included in backups.

        • BackupEnabledAt (datetime) --

          The time backup was enabled on the data store.

        • EarliestRestorePoint (datetime) --

          The earliest point in time the data store can be restored to.

        • LatestRestorePoint (datetime) --

          The latest point in time the data store can be restored to.

        • ScheduledPermanentDeletionTime (datetime) --

          The time the retained backup data is scheduled for permanent deletion.

ListFHIRDatastores (updated) Link ¶
Changes (response) 
{'DatastorePropertiesList': {'BackupStatusInfo': {'BackupEnabledAt': 'timestamp',
                                                  'Configuration': {'BackupTagsEnabled': 'boolean',
                                                                    'BackupType': 'CONTINUOUS',
                                                                    'RetentionPeriodInDays': 'integer',
                                                                    'Status': 'ENABLED '
                                                                              '| '
                                                                              'DISABLED'},
                                                  'EarliestRestorePoint': 'timestamp',
                                                  'LatestRestorePoint': 'timestamp',
                                                  'ScheduledPermanentDeletionTime': 'timestamp'}}}

List all FHIR-enabled data stores in a user’s account, regardless of data store status.

See also: AWS API Documentation

Request Syntax

client.list_fhir_datastores(
    Filter={
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
        'CreatedBefore': datetime(2015, 1, 1),
        'CreatedAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)
type Filter:

dict

param Filter:

List all filters associated with a FHIR data store request.

  • DatastoreName (string) --

    Filter data store results by name.

  • DatastoreStatus (string) --

    Filter data store results by status.

  • CreatedBefore (datetime) --

    Filter to set cutoff dates for records. All data stores created before the specified date are included in the results.

  • CreatedAfter (datetime) --

    Filter to set cutoff dates for records. All data stores created after the specified date are included in the results.

type NextToken:

string

param NextToken:

The token used to retrieve the next page of data stores when results are paginated.

type MaxResults:

integer

param MaxResults:

The maximum number of data stores returned on a page.

rtype:

dict

returns:

Response Syntax

{
    'DatastorePropertiesList': [
        {
            'DatastoreId': 'string',
            'DatastoreArn': 'string',
            'DatastoreName': 'string',
            'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
            'CreatedAt': datetime(2015, 1, 1),
            'DatastoreTypeVersion': 'R4',
            'DatastoreEndpoint': 'string',
            'SseConfiguration': {
                'KmsEncryptionConfig': {
                    'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
                    'KmsKeyId': 'string'
                }
            },
            'PreloadDataConfig': {
                'PreloadDataType': 'SYNTHEA'
            },
            'IdentityProviderConfiguration': {
                'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
                'FineGrainedAuthorizationEnabled': True|False,
                'Metadata': 'string',
                'IdpLambdaArn': 'string'
            },
            'ErrorCause': {
                'ErrorMessage': 'string',
                'ErrorCategory': 'RETRYABLE_ERROR'|'NON_RETRYABLE_ERROR'
            },
            'NlpConfiguration': {
                'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
            },
            'AnalyticsConfiguration': {
                'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
            },
            'ProfileConfiguration': {
                'DefaultProfiles': [
                    'string',
                ]
            },
            'BackupStatusInfo': {
                'Configuration': {
                    'Status': 'ENABLED'|'DISABLED',
                    'BackupType': 'CONTINUOUS',
                    'RetentionPeriodInDays': 123,
                    'BackupTagsEnabled': True|False
                },
                'BackupEnabledAt': datetime(2015, 1, 1),
                'EarliestRestorePoint': datetime(2015, 1, 1),
                'LatestRestorePoint': datetime(2015, 1, 1),
                'ScheduledPermanentDeletionTime': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DatastorePropertiesList (list) --

      The properties associated with all listed data stores.

      • (dict) --

        The data store properties.

        • DatastoreId (string) --

          The data store identifier.

        • DatastoreArn (string) --

          The Amazon Resource Name (ARN) used in the creation of the data store.

        • DatastoreName (string) --

          The data store name.

        • DatastoreStatus (string) --

          The data store status.

        • CreatedAt (datetime) --

          The time the data store was created.

        • DatastoreTypeVersion (string) --

          The FHIR release version supported by the data store. Current support is for version R4.

        • DatastoreEndpoint (string) --

          The Amazon Web Services endpoint for the data store.

        • SseConfiguration (dict) --

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

          • KmsEncryptionConfig (dict) --

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

            • CmkType (string) --

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

            • KmsKeyId (string) --

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

        • PreloadDataConfig (dict) --

          The preloaded Synthea data configuration for the data store.

          • PreloadDataType (string) --

            The type of preloaded data. Only Synthea preloaded data is supported.

        • IdentityProviderConfiguration (dict) --

          The identity provider selected during data store creation.

          • AuthorizationStrategy (string) --

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

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

        • ErrorCause (dict) --

          The error cause for the current data store operation.

          • ErrorMessage (string) --

            The error message text for ErrorCause.

          • ErrorCategory (string) --

            The error category for ErrorCause.

        • NlpConfiguration (dict) --

          The natural language processing (NLP) configuration for the data store.

          • Status (string) --

            The status of the NLP configuration.

        • AnalyticsConfiguration (dict) --

          The analytics configuration for the data store.

          • Status (string) --

            The status of the analytics configuration.

        • ProfileConfiguration (dict) --

          The profile configuration for the data store.

          • DefaultProfiles (list) --

            The list of default profiles for the data store.

            • (string) --

              A general-purpose string value.

        • BackupStatusInfo (dict) --

          The backup status information for the data store.

          • Configuration (dict) --

            The backup configuration for the data store.

            • Status (string) --

              The backup status of the data store.

            • BackupType (string) --

              The type of backup.

            • RetentionPeriodInDays (integer) --

              The number of days backup data is retained.

            • BackupTagsEnabled (boolean) --

              Specifies whether tags are included in backups.

          • BackupEnabledAt (datetime) --

            The time backup was enabled on the data store.

          • EarliestRestorePoint (datetime) --

            The earliest point in time the data store can be restored to.

          • LatestRestorePoint (datetime) --

            The latest point in time the data store can be restored to.

          • ScheduledPermanentDeletionTime (datetime) --

            The time the retained backup data is scheduled for permanent deletion.

    • NextToken (string) --

      The pagination token used to retrieve the next page of results.

UpdateFHIRDatastore (updated) Link ¶
Changes (request, response)
Request 
{'BackupConfiguration': {'BackupTagsEnabled': 'boolean',
                         'BackupType': 'CONTINUOUS',
                         'RetentionPeriodInDays': 'integer',
                         'Status': 'ENABLED | DISABLED'}}
Response 
{'DatastoreProperties': {'BackupStatusInfo': {'BackupEnabledAt': 'timestamp',
                                              'Configuration': {'BackupTagsEnabled': 'boolean',
                                                                'BackupType': 'CONTINUOUS',
                                                                'RetentionPeriodInDays': 'integer',
                                                                'Status': 'ENABLED '
                                                                          '| '
                                                                          'DISABLED'},
                                              'EarliestRestorePoint': 'timestamp',
                                              'LatestRestorePoint': 'timestamp',
                                              'ScheduledPermanentDeletionTime': 'timestamp'}}}

Update the properties of a FHIR-enabled data store.

See also: AWS API Documentation

Request Syntax

client.update_fhir_datastore(
    DatastoreId='string',
    DatastoreName='string',
    AnalyticsConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
    },
    NlpConfiguration={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
    },
    ProfileConfiguration={
        'DefaultProfiles': [
            'string',
        ]
    },
    IdentityProviderConfiguration={
        'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
        'FineGrainedAuthorizationEnabled': True|False,
        'Metadata': 'string',
        'IdpLambdaArn': 'string'
    },
    BackupConfiguration={
        'Status': 'ENABLED'|'DISABLED',
        'BackupType': 'CONTINUOUS',
        'RetentionPeriodInDays': 123,
        'BackupTagsEnabled': True|False
    }
)
type DatastoreId:

string

param DatastoreId:

[REQUIRED]

The data store identifier.

type DatastoreName:

string

param DatastoreName:

The data store name.

type AnalyticsConfiguration:

dict

param AnalyticsConfiguration:

The analytics configuration for the data store.

  • Status (string) --

    The status of the analytics configuration.

type NlpConfiguration:

dict

param NlpConfiguration:

The natural language processing (NLP) configuration for the data store.

  • Status (string) --

    The status of the NLP configuration.

type ProfileConfiguration:

dict

param ProfileConfiguration:

The profile configuration for the data store.

  • DefaultProfiles (list) --

    The list of default profiles for the data store.

    • (string) --

      A general-purpose string value.

type IdentityProviderConfiguration:

dict

param IdentityProviderConfiguration:

The identity provider configuration for the data store.

  • AuthorizationStrategy (string) -- [REQUIRED]

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

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

type BackupConfiguration:

dict

param BackupConfiguration:

The backup configuration for the data store.

  • Status (string) --

    The backup status of the data store.

  • BackupType (string) --

    The type of backup.

  • RetentionPeriodInDays (integer) --

    The number of days backup data is retained.

  • BackupTagsEnabled (boolean) --

    Specifies whether tags are included in backups.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreProperties': {
        'DatastoreId': 'string',
        'DatastoreArn': 'string',
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED',
        'CreatedAt': datetime(2015, 1, 1),
        'DatastoreTypeVersion': 'R4',
        'DatastoreEndpoint': 'string',
        'SseConfiguration': {
            'KmsEncryptionConfig': {
                'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
                'KmsKeyId': 'string'
            }
        },
        'PreloadDataConfig': {
            'PreloadDataType': 'SYNTHEA'
        },
        'IdentityProviderConfiguration': {
            'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
            'FineGrainedAuthorizationEnabled': True|False,
            'Metadata': 'string',
            'IdpLambdaArn': 'string'
        },
        'ErrorCause': {
            'ErrorMessage': 'string',
            'ErrorCategory': 'RETRYABLE_ERROR'|'NON_RETRYABLE_ERROR'
        },
        'NlpConfiguration': {
            'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
        },
        'AnalyticsConfiguration': {
            'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'|'PAUSING'|'PAUSED'
        },
        'ProfileConfiguration': {
            'DefaultProfiles': [
                'string',
            ]
        },
        'BackupStatusInfo': {
            'Configuration': {
                'Status': 'ENABLED'|'DISABLED',
                'BackupType': 'CONTINUOUS',
                'RetentionPeriodInDays': 123,
                'BackupTagsEnabled': True|False
            },
            'BackupEnabledAt': datetime(2015, 1, 1),
            'EarliestRestorePoint': datetime(2015, 1, 1),
            'LatestRestorePoint': datetime(2015, 1, 1),
            'ScheduledPermanentDeletionTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    • DatastoreProperties (dict) --

      The data store properties.

      • DatastoreId (string) --

        The data store identifier.

      • DatastoreArn (string) --

        The Amazon Resource Name (ARN) used in the creation of the data store.

      • DatastoreName (string) --

        The data store name.

      • DatastoreStatus (string) --

        The data store status.

      • CreatedAt (datetime) --

        The time the data store was created.

      • DatastoreTypeVersion (string) --

        The FHIR release version supported by the data store. Current support is for version R4.

      • DatastoreEndpoint (string) --

        The Amazon Web Services endpoint for the data store.

      • SseConfiguration (dict) --

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

        • KmsEncryptionConfig (dict) --

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

          • CmkType (string) --

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

          • KmsKeyId (string) --

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

      • PreloadDataConfig (dict) --

        The preloaded Synthea data configuration for the data store.

        • PreloadDataType (string) --

          The type of preloaded data. Only Synthea preloaded data is supported.

      • IdentityProviderConfiguration (dict) --

        The identity provider selected during data store creation.

        • AuthorizationStrategy (string) --

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

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

      • ErrorCause (dict) --

        The error cause for the current data store operation.

        • ErrorMessage (string) --

          The error message text for ErrorCause.

        • ErrorCategory (string) --

          The error category for ErrorCause.

      • NlpConfiguration (dict) --

        The natural language processing (NLP) configuration for the data store.

        • Status (string) --

          The status of the NLP configuration.

      • AnalyticsConfiguration (dict) --

        The analytics configuration for the data store.

        • Status (string) --

          The status of the analytics configuration.

      • ProfileConfiguration (dict) --

        The profile configuration for the data store.

        • DefaultProfiles (list) --

          The list of default profiles for the data store.

          • (string) --

            A general-purpose string value.

      • BackupStatusInfo (dict) --

        The backup status information for the data store.

        • Configuration (dict) --

          The backup configuration for the data store.

          • Status (string) --

            The backup status of the data store.

          • BackupType (string) --

            The type of backup.

          • RetentionPeriodInDays (integer) --

            The number of days backup data is retained.

          • BackupTagsEnabled (boolean) --

            Specifies whether tags are included in backups.

        • BackupEnabledAt (datetime) --

          The time backup was enabled on the data store.

        • EarliestRestorePoint (datetime) --

          The earliest point in time the data store can be restored to.

        • LatestRestorePoint (datetime) --

          The latest point in time the data store can be restored to.

        • ScheduledPermanentDeletionTime (datetime) --

          The time the retained backup data is scheduled for permanent deletion.