docs(client-healthlake): Updating the HealthLake service documentation.

aws · Jul 26, 2023 · 91c3467 · 91c3467
1 parent 2928f54
commit 91c3467
Show file tree

Hide file tree

Showing 19 changed files with 162 additions and 169 deletions.
diff --git a/clients/client-healthlake/README.md b/clients/client-healthlake/README.md
@@ -6,7 +6,7 @@
 
 AWS SDK for JavaScript HealthLake Client for Node.js, Browser and React Native.
 
-<p>Amazon HealthLake is a HIPAA eligibile service that allows customers to store,
+<p>AWS HealthLake is a HIPAA eligibile service that allows customers to store,
 transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.</p>
 
 ## Installing

diff --git a/clients/client-healthlake/src/HealthLake.ts b/clients/client-healthlake/src/HealthLake.ts
@@ -294,7 +294,7 @@ export interface HealthLake {
 
 /**
  * @public
- * <p>Amazon HealthLake is a HIPAA eligibile service that allows customers to store,
+ * <p>AWS HealthLake is a HIPAA eligibile service that allows customers to store,
  * transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.</p>
  */
 export class HealthLake extends HealthLakeClient implements HealthLake {}

diff --git a/clients/client-healthlake/src/HealthLakeClient.ts b/clients/client-healthlake/src/HealthLakeClient.ts
@@ -290,7 +290,7 @@ export interface HealthLakeClientResolvedConfig extends HealthLakeClientResolved
 
 /**
  * @public
- * <p>Amazon HealthLake is a HIPAA eligibile service that allows customers to store,
+ * <p>AWS HealthLake is a HIPAA eligibile service that allows customers to store,
  * transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.</p>
  */
 export class HealthLakeClient extends __Client<

diff --git a/clients/client-healthlake/src/commands/CreateFHIRDatastoreCommand.ts b/clients/client-healthlake/src/commands/CreateFHIRDatastoreCommand.ts
@@ -36,7 +36,7 @@ export interface CreateFHIRDatastoreCommandOutput extends CreateFHIRDatastoreRes
 
 /**
  * @public
- * <p>Creates a Data Store that can ingest and export FHIR formatted data.</p>
+ * <p>Creates a data store that can ingest and export FHIR formatted data.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-healthlake/src/commands/DeleteFHIRDatastoreCommand.ts b/clients/client-healthlake/src/commands/DeleteFHIRDatastoreCommand.ts
@@ -36,7 +36,7 @@ export interface DeleteFHIRDatastoreCommandOutput extends DeleteFHIRDatastoreRes
 
 /**
  * @public
- * <p>Deletes a Data Store. </p>
+ * <p>Deletes a data store. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,13 +67,13 @@ export interface DeleteFHIRDatastoreCommandOutput extends DeleteFHIRDatastoreRes
  * <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 can not be performed.</p>
+ * <p>The data store is in a transition state and the user requested action can not be performed.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/DescribeFHIRDatastoreCommand.ts b/clients/client-healthlake/src/commands/DescribeFHIRDatastoreCommand.ts
@@ -36,9 +36,8 @@ export interface DescribeFHIRDatastoreCommandOutput extends DescribeFHIRDatastor
 
 /**
  * @public
- * <p>Gets the properties associated with the FHIR Data Store, including the Data Store ID,
- * Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and
- * Data Store endpoint.</p>
+ * <p>Gets the properties associated with the FHIR data store, including the data store ID,
+ * data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -89,7 +88,7 @@ export interface DescribeFHIRDatastoreCommandOutput extends DescribeFHIRDatastor
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/DescribeFHIRExportJobCommand.ts b/clients/client-healthlake/src/commands/DescribeFHIRExportJobCommand.ts
@@ -80,7 +80,7 @@ export interface DescribeFHIRExportJobCommandOutput extends DescribeFHIRExportJo
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/DescribeFHIRImportJobCommand.ts b/clients/client-healthlake/src/commands/DescribeFHIRImportJobCommand.ts
@@ -83,7 +83,7 @@ export interface DescribeFHIRImportJobCommandOutput extends DescribeFHIRImportJo
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/ListFHIRDatastoresCommand.ts b/clients/client-healthlake/src/commands/ListFHIRDatastoresCommand.ts
@@ -36,8 +36,7 @@ export interface ListFHIRDatastoresCommandOutput extends ListFHIRDatastoresRespo
 
 /**
  * @public
- * <p>Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store
- * status.</p>
+ * <p>Lists all FHIR data stores that are in the user’s account, regardless of data store status.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-healthlake/src/commands/ListFHIRExportJobsCommand.ts b/clients/client-healthlake/src/commands/ListFHIRExportJobsCommand.ts
@@ -93,7 +93,7 @@ export interface ListFHIRExportJobsCommandOutput extends ListFHIRExportJobsRespo
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/ListFHIRImportJobsCommand.ts b/clients/client-healthlake/src/commands/ListFHIRImportJobsCommand.ts
@@ -96,7 +96,7 @@ export interface ListFHIRImportJobsCommandOutput extends ListFHIRImportJobsRespo
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/ListTagsForResourceCommand.ts b/clients/client-healthlake/src/commands/ListTagsForResourceCommand.ts
@@ -37,7 +37,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 /**
  * @public
  * <p>
- * Returns a list of all existing tags associated with a Data Store.
+ * Returns a list of all existing tags associated with a data store.
  * </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -68,7 +68,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <p> The requested data store was not found.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>The user input parameter was invalid.</p>

diff --git a/clients/client-healthlake/src/commands/StartFHIRExportJobCommand.ts b/clients/client-healthlake/src/commands/StartFHIRExportJobCommand.ts
@@ -78,7 +78,7 @@ export interface StartFHIRExportJobCommandOutput extends StartFHIRExportJobRespo
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/StartFHIRImportJobCommand.ts b/clients/client-healthlake/src/commands/StartFHIRImportJobCommand.ts
@@ -81,7 +81,7 @@ export interface StartFHIRImportJobCommandOutput extends StartFHIRImportJobRespo
  * <p>Unknown error occurs in the service.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <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>

diff --git a/clients/client-healthlake/src/commands/TagResourceCommand.ts b/clients/client-healthlake/src/commands/TagResourceCommand.ts
@@ -37,7 +37,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 /**
  * @public
  * <p>
- * Adds a user specified key and value tag to a Data Store.
+ * Adds a user specified key and value tag to a data store.
  * </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -67,7 +67,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <p> The requested data store was not found.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>The user input parameter was invalid.</p>

diff --git a/clients/client-healthlake/src/commands/UntagResourceCommand.ts b/clients/client-healthlake/src/commands/UntagResourceCommand.ts
@@ -37,7 +37,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 /**
  * @public
  * <p>
- * Removes tags from a Data Store.
+ * Removes tags from a data store.
  * </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -64,7 +64,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- * <p> The requested Data Store was not found.</p>
+ * <p> The requested data store was not found.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>The user input parameter was invalid.</p>

diff --git a/clients/client-healthlake/src/index.ts b/clients/client-healthlake/src/index.ts
@@ -1,7 +1,7 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>Amazon HealthLake is a HIPAA eligibile service that allows customers to store,
+ * <p>AWS HealthLake is a HIPAA eligibile service that allows customers to store,
  * transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.</p>
  *
  * @packageDocumentation