HealthLake / Client / restore_fhir_datastore

restore_fhir_datastore

HealthLake.Client.restore_fhir_datastore(**kwargs)

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

response = 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',
        ]
    }
)

Parameters:

• SourceDatastoreId (string) –

  [REQUIRED]

  The identifier of the source data store to restore from.

• RestoreConfiguration (dict) –

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

• DatastoreName (string) – The name for the restored data store.

• SseConfiguration (dict) –

  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.

• ClientToken (string) –

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

  This field is autopopulated if not provided.

• Tags (list) –

  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.

• IdentityProviderConfiguration (dict) –

  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.

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

• AnalyticsConfiguration (dict) –

  The analytics configuration for the restored data store.

  • Status (string) –

    The status of the analytics configuration.

• NlpConfiguration (dict) –

  The NLP configuration for the restored data store.

  • Status (string) –

    The status of the NLP configuration.

• ProfileConfiguration (dict) –

  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.

Return type:

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.

Exceptions

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.AccessDeniedException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.ConflictException

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.InternalServerException