@aws-sdk/client-healthlake 3.1120.0 → 3.1122.0

package/dist-types/commands/RestoreFHIRDatastoreCommand.d.ts

@@ -0,0 +1,152 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { RestoreFHIRDatastoreRequest, RestoreFHIRDatastoreResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link RestoreFHIRDatastoreCommand}.
+ */
+export interface RestoreFHIRDatastoreCommandInput extends RestoreFHIRDatastoreRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RestoreFHIRDatastoreCommand}.
+ */
+export interface RestoreFHIRDatastoreCommandOutput extends RestoreFHIRDatastoreResponse, __MetadataBearer {
+}
+declare const RestoreFHIRDatastoreCommand_base: {
+    new (input: RestoreFHIRDatastoreCommandInput): import("@smithy/core/client").CommandImpl<RestoreFHIRDatastoreCommandInput, RestoreFHIRDatastoreCommandOutput, import("..").HealthLakeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: RestoreFHIRDatastoreCommandInput): import("@smithy/core/client").CommandImpl<RestoreFHIRDatastoreCommandInput, RestoreFHIRDatastoreCommandOutput, import("..").HealthLakeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Restore a backup-enabled data store to a point in time. Creates a new data store from the backup.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { HealthLakeClient, RestoreFHIRDatastoreCommand } from "@aws-sdk/client-healthlake"; // ES Modules import
+ * // const { HealthLakeClient, RestoreFHIRDatastoreCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import
+ * // import type { HealthLakeClientConfig } from "@aws-sdk/client-healthlake";
+ * const config = {}; // type is HealthLakeClientConfig
+ * const client = new HealthLakeClient(config);
+ * const input = { // RestoreFHIRDatastoreRequest
+ *   SourceDatastoreId: "STRING_VALUE", // required
+ *   RestoreConfiguration: { // RestoreConfiguration Union: only one key present
+ *     ContinuousBackupRestoreConfiguration: { // ContinuousBackupRestoreConfiguration
+ *       RestorePointTime: new Date("TIMESTAMP"),
+ *     },
+ *   },
+ *   DatastoreName: "STRING_VALUE",
+ *   SseConfiguration: { // SseConfiguration
+ *     KmsEncryptionConfig: { // KmsEncryptionConfig
+ *       CmkType: "CUSTOMER_MANAGED_KMS_KEY" || "AWS_OWNED_KMS_KEY", // required
+ *       KmsKeyId: "STRING_VALUE",
+ *     },
+ *   },
+ *   ClientToken: "STRING_VALUE",
+ *   Tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   IdentityProviderConfiguration: { // IdentityProviderConfiguration
+ *     AuthorizationStrategy: "SMART_ON_FHIR_V1" || "SMART_ON_FHIR" || "AWS_AUTH", // required
+ *     FineGrainedAuthorizationEnabled: true || false,
+ *     Metadata: "STRING_VALUE",
+ *     IdpLambdaArn: "STRING_VALUE",
+ *   },
+ *   AnalyticsConfiguration: { // AnalyticsConfiguration
+ *     Status: "ENABLED" || "ENABLING" || "DISABLED" || "DISABLING" || "PAUSING" || "PAUSED",
+ *   },
+ *   NlpConfiguration: { // NlpConfiguration
+ *     Status: "ENABLED" || "ENABLING" || "DISABLED" || "DISABLING",
+ *   },
+ *   ProfileConfiguration: { // ProfileConfiguration
+ *     DefaultProfiles: [ // DefaultProfiles
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ * };
+ * const command = new RestoreFHIRDatastoreCommand(input);
+ * const response = await client.send(command);
+ * // { // RestoreFHIRDatastoreResponse
+ * //   DatastoreId: "STRING_VALUE", // required
+ * //   DatastoreArn: "STRING_VALUE", // required
+ * //   DatastoreStatus: "CREATING" || "ACTIVE" || "DELETING" || "DELETED" || "CREATE_FAILED" || "UPDATING" || "UPDATE_FAILED", // required
+ * //   DatastoreEndpoint: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param RestoreFHIRDatastoreCommandInput - {@link RestoreFHIRDatastoreCommandInput}
+ * @returns {@link RestoreFHIRDatastoreCommandOutput}
+ * @see {@link RestoreFHIRDatastoreCommandInput} for command's `input` shape.
+ * @see {@link RestoreFHIRDatastoreCommandOutput} for command's `response` shape.
+ * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied. Your account is not authorized to perform this operation.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The data store is in a transition state and the user requested action cannot be performed.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unknown internal error occurred in the service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested data store was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The user input parameter was invalid.</p>
+ *
+ * @throws {@link HealthLakeServiceException}
+ * <p>Base exception class for all service exceptions from HealthLake service.</p>
+ *
+ *
+ * @example Restore a data store to a point in time
+ * ```javascript
+ * //
+ * const input = {
+ *   DatastoreName: "RestoredFhirDatastore",
+ *   RestoreConfiguration: {
+ *     ContinuousBackupRestoreConfiguration: {
+ *       RestorePointTime: "2026-08-01T00:00:00Z"
+ *     }
+ *   },
+ *   SourceDatastoreId: "source-datastore-id"
+ * };
+ * const command = new RestoreFHIRDatastoreCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DatastoreArn: "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/restored-datastore-id",
+ *   DatastoreEndpoint: "https://healthlake.us-east-1.amazonaws.com/datastore/restored-datastore-id/r4/",
+ *   DatastoreId: "restored-datastore-id",
+ *   DatastoreStatus: "CREATING"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class RestoreFHIRDatastoreCommand extends RestoreFHIRDatastoreCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RestoreFHIRDatastoreRequest;
+            output: RestoreFHIRDatastoreResponse;
+        };
+        sdk: {
+            input: RestoreFHIRDatastoreCommandInput;
+            output: RestoreFHIRDatastoreCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StartDataTransformationJobCommand.d.ts

@@ -24,7 +24,7 @@ declare const StartDataTransformationJobCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.</p>
+ * <p>Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or HealthLake.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartFHIRExportJobCommand.d.ts

@@ -65,7 +65,7 @@ declare const StartFHIRExportJobCommand_base: {
  *  <p>Access is denied. Your account is not authorized to perform this operation.</p>
  *
  * @throws {@link FailedDependencyException} (client fault)
- *  A dependent service failed to fulfill the request.
+ *  <p>A dependent service failed to fulfill the request.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An unknown internal error occurred in the service.</p>

package/dist-types/commands/StartFHIRImportJobCommand.d.ts

@@ -73,7 +73,7 @@ declare const StartFHIRImportJobCommand_base: {
  *  <p>Access is denied. Your account is not authorized to perform this operation.</p>
  *
  * @throws {@link FailedDependencyException} (client fault)
- *  A dependent service failed to fulfill the request.
+ *  <p>A dependent service failed to fulfill the request.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An unknown internal error occurred in the service.</p>

package/dist-types/commands/UpdateFHIRDatastoreCommand.d.ts

@@ -53,6 +53,12 @@ declare const UpdateFHIRDatastoreCommand_base: {
  *     Metadata: "STRING_VALUE",
  *     IdpLambdaArn: "STRING_VALUE",
  *   },
+ *   BackupConfiguration: { // BackupConfiguration
+ *     Status: "ENABLED" || "DISABLED",
+ *     BackupType: "CONTINUOUS",
+ *     RetentionPeriodInDays: Number("int"),
+ *     BackupTagsEnabled: true || false,
+ *   },
  * };
  * const command = new UpdateFHIRDatastoreCommand(input);
  * const response = await client.send(command);
@@ -95,6 +101,18 @@ declare const UpdateFHIRDatastoreCommand_base: {
  * //         "STRING_VALUE",
  * //       ],
  * //     },
+ * //     BackupStatusInfo: { // DatastoreBackupStatus
+ * //       Configuration: { // BackupConfiguration
+ * //         Status: "ENABLED" || "DISABLED",
+ * //         BackupType: "CONTINUOUS",
+ * //         RetentionPeriodInDays: Number("int"),
+ * //         BackupTagsEnabled: true || false,
+ * //       },
+ * //       BackupEnabledAt: new Date("TIMESTAMP"),
+ * //       EarliestRestorePoint: new Date("TIMESTAMP"),
+ * //       LatestRestorePoint: new Date("TIMESTAMP"),
+ * //       ScheduledPermanentDeletionTime: new Date("TIMESTAMP"),
+ * //     },
  * //   },
  * // };
  *
@@ -128,6 +146,61 @@ declare const UpdateFHIRDatastoreCommand_base: {
  * <p>Base exception class for all service exceptions from HealthLake service.</p>
  *
  *
+ * @example Update a data store's name and configuration
+ * ```javascript
+ * //
+ * const input = {
+ *   AnalyticsConfiguration: {
+ *     Status: "DISABLED"
+ *   },
+ *   DatastoreId: "datastore-id",
+ *   DatastoreName: "RenamedFhirDatastore",
+ *   IdentityProviderConfiguration: {
+ *     AuthorizationStrategy: "SMART_ON_FHIR_V1",
+ *     FineGrainedAuthorizationEnabled: true
+ *   },
+ *   NlpConfiguration: {
+ *     Status: "ENABLED"
+ *   },
+ *   ProfileConfiguration: {
+ *     DefaultProfiles: [
+ *       "us-core-3.1.1",
+ *       "carin-bb-2.0.0"
+ *     ]
+ *   }
+ * };
+ * const command = new UpdateFHIRDatastoreCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DatastoreProperties: {
+ *     AnalyticsConfiguration: {
+ *       Status: "PAUSING"
+ *     },
+ *     DatastoreArn: "arn:aws:healthlake:us-east-1:123456789012:datastore/datastore-id",
+ *     DatastoreEndpoint: "https://healthlake.us-east-1.amazonaws.com/datastore/datastore-id/r4/",
+ *     DatastoreId: "datastore-id",
+ *     DatastoreName: "RenamedFhirDatastore",
+ *     DatastoreStatus: "UPDATING",
+ *     DatastoreTypeVersion: "R4",
+ *     IdentityProviderConfiguration: {
+ *       AuthorizationStrategy: "SMART_ON_FHIR_V1",
+ *       FineGrainedAuthorizationEnabled: true
+ *     },
+ *     NlpConfiguration: {
+ *       Status: "ENABLING"
+ *     },
+ *     ProfileConfiguration: {
+ *       DefaultProfiles: [
+ *         "us-core-3.1.1",
+ *         "carin-bb-2.0.0"
+ *       ]
+ *     }
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateFHIRDatastoreCommand extends UpdateFHIRDatastoreCommand_base {

package/dist-types/commands/UpdateProfileWithAgentCommand.d.ts

@@ -85,7 +85,7 @@ declare const UpdateProfileWithAgentCommand_base: {
  *  <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p>You are not authorized to make this request. Verify that your AWS credentials are valid and that you have the required permissions.</p>
+ *  <p>You are not authorized to make this request. Verify that your Amazon Web Services credentials are valid and that you have the required permissions.</p>
  *
  * @throws {@link UnsupportedMIMETypeException} (client fault)
  *  <p>The content type in your request is not supported. Use a supported content type for this operation.</p>

package/dist-types/commands/index.d.ts

@@ -15,6 +15,7 @@ export * from "./ListFHIRExportJobsCommand";
 export * from "./ListFHIRImportJobsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PublishDataTransformationProfileCommand";
+export * from "./RestoreFHIRDatastoreCommand";
 export * from "./StartDataTransformationJobCommand";
 export * from "./StartFHIRExportJobCommand";
 export * from "./StartFHIRImportJobCommand";

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <p>This is the <i>AWS HealthLake API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/healthlake/latest/devguide/what-is.html">What is AWS HealthLake?</a> in the <i>AWS HealthLake Developer Guide</i>.</p>
+ * <p>This is the <i>HealthLake API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/healthlake/latest/devguide/what-is.html">What is HealthLake?</a> in the <i>HealthLake Developer Guide</i>.</p>
  *
  * @packageDocumentation
  */

package/dist-types/models/enums.d.ts

@@ -95,6 +95,29 @@ export declare const AuthorizationStrategy: {
  * @public
  */
 export type AuthorizationStrategy = (typeof AuthorizationStrategy)[keyof typeof AuthorizationStrategy];
+/**
+ * @public
+ * @enum
+ */
+export declare const BackupType: {
+    readonly CONTINUOUS: "CONTINUOUS";
+};
+/**
+ * @public
+ */
+export type BackupType = (typeof BackupType)[keyof typeof BackupType];
+/**
+ * @public
+ * @enum
+ */
+export declare const BackupStatus: {
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+};
+/**
+ * @public
+ */
+export type BackupStatus = (typeof BackupStatus)[keyof typeof BackupStatus];
 /**
  * @public
  * @enum

package/dist-types/models/errors.d.ts

@@ -103,7 +103,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
- * The request exceeds the service quota.
+ * <p>The request exceeds the service quota.</p>
  * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -159,7 +159,7 @@ export declare class NotImplementedOperationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotImplementedOperationException, __BaseException>);
 }
 /**
- * <p>You are not authorized to make this request. Verify that your AWS credentials are valid and that you have the required permissions.</p>
+ * <p>You are not authorized to make this request. Verify that your Amazon Web Services credentials are valid and that you have the required permissions.</p>
  * @public
  */
 export declare class UnauthorizedException extends __BaseException {
@@ -185,7 +185,7 @@ export declare class UnsupportedMIMETypeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedMIMETypeException, __BaseException>);
 }
 /**
- * A dependent service failed to fulfill the request.
+ * <p>A dependent service failed to fulfill the request.</p>
  * @public
  */
 export declare class FailedDependencyException extends __BaseException {