From c7bb8391af460e5577d0add99885283f1b07ef89 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 20 Oct 2023 20:11:32 +0000 Subject: [PATCH] docs(client-medical-imaging): Updates on documentation links --- clients/client-medical-imaging/README.md | 87 +++++++------- .../src/MedicalImaging.ts | 87 +++++++------- .../src/MedicalImagingClient.ts | 87 +++++++------- .../src/commands/CopyImageSetCommand.ts | 2 +- .../src/commands/CreateDatastoreCommand.ts | 2 +- .../src/commands/DeleteDatastoreCommand.ts | 2 +- .../src/commands/DeleteImageSetCommand.ts | 2 +- .../src/commands/GetDICOMImportJobCommand.ts | 2 +- .../src/commands/GetDatastoreCommand.ts | 2 +- .../src/commands/GetImageFrameCommand.ts | 2 +- .../src/commands/GetImageSetCommand.ts | 2 +- .../commands/GetImageSetMetadataCommand.ts | 2 +- .../commands/ListDICOMImportJobsCommand.ts | 4 +- .../src/commands/ListDatastoresCommand.ts | 4 +- .../commands/ListImageSetVersionsCommand.ts | 2 +- .../commands/ListTagsForResourceCommand.ts | 2 +- .../src/commands/SearchImageSetsCommand.ts | 11 +- .../commands/StartDICOMImportJobCommand.ts | 2 +- .../src/commands/TagResourceCommand.ts | 2 +- .../src/commands/UntagResourceCommand.ts | 2 +- .../commands/UpdateImageSetMetadataCommand.ts | 2 +- .../src/endpoint/ruleset.ts | 44 ++++---- clients/client-medical-imaging/src/index.ts | 87 +++++++------- .../src/models/models_0.ts | 10 +- .../aws-models/medical-imaging.json | 106 ++++++++---------- 25 files changed, 280 insertions(+), 277 deletions(-) diff --git a/clients/client-medical-imaging/README.md b/clients/client-medical-imaging/README.md index 724e5f09b380..cf8918054c21 100644 --- a/clients/client-medical-imaging/README.md +++ b/clients/client-medical-imaging/README.md @@ -6,47 +6,48 @@ AWS SDK for JavaScript MedicalImaging Client for Node.js, Browser and React Native. -

This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, -and analyzing medical images. For an introduction to the service, see the +

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health +care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For +an introduction to the service, see the AWS HealthImaging Developer Guide .

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.

-

For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the +

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the See Also link at the end of each section that describes an API action or data type.

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the -AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.

+AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.

Data store actions

@@ -55,21 +56,21 @@ provided to actions within this Reference, along with links back to correspondin

@@ -78,27 +79,27 @@ provided to actions within this Reference, along with links back to correspondin

@@ -107,27 +108,27 @@ provided to actions within this Reference, along with links back to correspondin

@@ -136,24 +137,24 @@ provided to actions within this Reference, along with links back to correspondin

diff --git a/clients/client-medical-imaging/src/MedicalImaging.ts b/clients/client-medical-imaging/src/MedicalImaging.ts index 42ea81928677..21225301f38b 100644 --- a/clients/client-medical-imaging/src/MedicalImaging.ts +++ b/clients/client-medical-imaging/src/MedicalImaging.ts @@ -366,47 +366,48 @@ export interface MedicalImaging { /** * @public - *

This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, - * and analyzing medical images. For an introduction to the service, see the + *

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health + * care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For + * an introduction to the service, see the * AWS HealthImaging Developer Guide * .

* *

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as * they take care of request authentication, serialization, and connection management. For more information, * see Tools to build on AWS.

- *

For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the + *

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the * See Also link at the end of each section that describes an API action or data type.

* *

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are * provided to actions within this Reference, along with links back to corresponding sections in the - * AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.

+ * AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.

*

* Data store actions *

* *

@@ -415,21 +416,21 @@ export interface MedicalImaging { *

*

@@ -438,27 +439,27 @@ export interface MedicalImaging { *

*

@@ -467,27 +468,27 @@ export interface MedicalImaging { *

*

@@ -496,24 +497,24 @@ export interface MedicalImaging { *

*/ diff --git a/clients/client-medical-imaging/src/MedicalImagingClient.ts b/clients/client-medical-imaging/src/MedicalImagingClient.ts index 95bc98761d52..a9b5b71d3d3a 100644 --- a/clients/client-medical-imaging/src/MedicalImagingClient.ts +++ b/clients/client-medical-imaging/src/MedicalImagingClient.ts @@ -322,47 +322,48 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient /** * @public - *

This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, - * and analyzing medical images. For an introduction to the service, see the + *

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health + * care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For + * an introduction to the service, see the * AWS HealthImaging Developer Guide * .

* *

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as * they take care of request authentication, serialization, and connection management. For more information, * see Tools to build on AWS.

- *

For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the + *

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the * See Also link at the end of each section that describes an API action or data type.

* *

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are * provided to actions within this Reference, along with links back to corresponding sections in the - * AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.

+ * AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.

*

* Data store actions *

* *

@@ -371,21 +372,21 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient *

*

@@ -394,27 +395,27 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient *

*

@@ -423,27 +424,27 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient *

*

@@ -452,24 +453,24 @@ export interface MedicalImagingClientResolvedConfig extends MedicalImagingClient *

*/ diff --git a/clients/client-medical-imaging/src/commands/CopyImageSetCommand.ts b/clients/client-medical-imaging/src/commands/CopyImageSetCommand.ts index b329800637ff..770e91b967c2 100644 --- a/clients/client-medical-imaging/src/commands/CopyImageSetCommand.ts +++ b/clients/client-medical-imaging/src/commands/CopyImageSetCommand.ts @@ -108,7 +108,7 @@ export interface CopyImageSetCommandOutput extends CopyImageSetResponse, __Metad *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/CreateDatastoreCommand.ts b/clients/client-medical-imaging/src/commands/CreateDatastoreCommand.ts index 7ab29dd219f8..9831dd8204b3 100644 --- a/clients/client-medical-imaging/src/commands/CreateDatastoreCommand.ts +++ b/clients/client-medical-imaging/src/commands/CreateDatastoreCommand.ts @@ -83,7 +83,7 @@ export interface CreateDatastoreCommandOutput extends CreateDatastoreResponse, _ *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/DeleteDatastoreCommand.ts b/clients/client-medical-imaging/src/commands/DeleteDatastoreCommand.ts index e110faca383d..4e68a8377aaa 100644 --- a/clients/client-medical-imaging/src/commands/DeleteDatastoreCommand.ts +++ b/clients/client-medical-imaging/src/commands/DeleteDatastoreCommand.ts @@ -81,7 +81,7 @@ export interface DeleteDatastoreCommandOutput extends DeleteDatastoreResponse, _ *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/DeleteImageSetCommand.ts b/clients/client-medical-imaging/src/commands/DeleteImageSetCommand.ts index 5e9dfac29d4b..edf3189c4c97 100644 --- a/clients/client-medical-imaging/src/commands/DeleteImageSetCommand.ts +++ b/clients/client-medical-imaging/src/commands/DeleteImageSetCommand.ts @@ -81,7 +81,7 @@ export interface DeleteImageSetCommandOutput extends DeleteImageSetResponse, __M *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts b/clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts index d1002ebead0b..05331781fd96 100644 --- a/clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts +++ b/clients/client-medical-imaging/src/commands/GetDICOMImportJobCommand.ts @@ -89,7 +89,7 @@ export interface GetDICOMImportJobCommandOutput extends GetDICOMImportJobRespons *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/GetDatastoreCommand.ts b/clients/client-medical-imaging/src/commands/GetDatastoreCommand.ts index ac46240013be..773f9fbe6a6c 100644 --- a/clients/client-medical-imaging/src/commands/GetDatastoreCommand.ts +++ b/clients/client-medical-imaging/src/commands/GetDatastoreCommand.ts @@ -82,7 +82,7 @@ export interface GetDatastoreCommandOutput extends GetDatastoreResponse, __Metad *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/GetImageFrameCommand.ts b/clients/client-medical-imaging/src/commands/GetImageFrameCommand.ts index 96865358c7d0..6aced0871a30 100644 --- a/clients/client-medical-imaging/src/commands/GetImageFrameCommand.ts +++ b/clients/client-medical-imaging/src/commands/GetImageFrameCommand.ts @@ -90,7 +90,7 @@ export interface GetImageFrameCommandOutput extends OmitThe request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/GetImageSetCommand.ts b/clients/client-medical-imaging/src/commands/GetImageSetCommand.ts index 87d821363806..6c8b4de053d0 100644 --- a/clients/client-medical-imaging/src/commands/GetImageSetCommand.ts +++ b/clients/client-medical-imaging/src/commands/GetImageSetCommand.ts @@ -88,7 +88,7 @@ export interface GetImageSetCommandOutput extends GetImageSetResponse, __Metadat *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/GetImageSetMetadataCommand.ts b/clients/client-medical-imaging/src/commands/GetImageSetMetadataCommand.ts index 23639c5eff95..fa594d8f5606 100644 --- a/clients/client-medical-imaging/src/commands/GetImageSetMetadataCommand.ts +++ b/clients/client-medical-imaging/src/commands/GetImageSetMetadataCommand.ts @@ -91,7 +91,7 @@ export interface GetImageSetMetadataCommandOutput *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/ListDICOMImportJobsCommand.ts b/clients/client-medical-imaging/src/commands/ListDICOMImportJobsCommand.ts index eb28be4b424f..5f4052de2464 100644 --- a/clients/client-medical-imaging/src/commands/ListDICOMImportJobsCommand.ts +++ b/clients/client-medical-imaging/src/commands/ListDICOMImportJobsCommand.ts @@ -37,7 +37,7 @@ export interface ListDICOMImportJobsCommandOutput extends ListDICOMImportJobsRes /** * @public - *

List import jobs created by this AWS account for a specific data store.

+ *

List import jobs created for a specific data store.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -92,7 +92,7 @@ export interface ListDICOMImportJobsCommandOutput extends ListDICOMImportJobsRes *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/ListDatastoresCommand.ts b/clients/client-medical-imaging/src/commands/ListDatastoresCommand.ts index bc7e773806f8..e264e8455da3 100644 --- a/clients/client-medical-imaging/src/commands/ListDatastoresCommand.ts +++ b/clients/client-medical-imaging/src/commands/ListDatastoresCommand.ts @@ -37,7 +37,7 @@ export interface ListDatastoresCommandOutput extends ListDatastoresResponse, __M /** * @public - *

List data stores created by this AWS account.

+ *

List data stores.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -83,7 +83,7 @@ export interface ListDatastoresCommandOutput extends ListDatastoresResponse, __M *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/ListImageSetVersionsCommand.ts b/clients/client-medical-imaging/src/commands/ListImageSetVersionsCommand.ts index e5af3cbff0c0..81c9c24192e7 100644 --- a/clients/client-medical-imaging/src/commands/ListImageSetVersionsCommand.ts +++ b/clients/client-medical-imaging/src/commands/ListImageSetVersionsCommand.ts @@ -92,7 +92,7 @@ export interface ListImageSetVersionsCommandOutput extends ListImageSetVersionsR *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/ListTagsForResourceCommand.ts b/clients/client-medical-imaging/src/commands/ListTagsForResourceCommand.ts index cb16f96ff9b9..990d13ee9a24 100644 --- a/clients/client-medical-imaging/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-medical-imaging/src/commands/ListTagsForResourceCommand.ts @@ -76,7 +76,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts b/clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts index 9bb934d44fc6..aeb5df0bed26 100644 --- a/clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts +++ b/clients/client-medical-imaging/src/commands/SearchImageSetsCommand.ts @@ -43,6 +43,15 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _ /** * @public *

Search image sets based on defined input attributes.

+ * + *

+ * SearchImageSets accepts a single search + * query parameter and returns a paginated response of all image sets that have the + * matching criteria. All range queries must be input as (lowerBound, upperBound).

+ *

+ * SearchImageSets uses the updatedAt field for sorting + * in decreasing order from latest to oldest.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -126,7 +135,7 @@ export interface SearchImageSetsCommandOutput extends SearchImageSetsResponse, _ *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/StartDICOMImportJobCommand.ts b/clients/client-medical-imaging/src/commands/StartDICOMImportJobCommand.ts index 2ef954e2ecc0..4c6205376b82 100644 --- a/clients/client-medical-imaging/src/commands/StartDICOMImportJobCommand.ts +++ b/clients/client-medical-imaging/src/commands/StartDICOMImportJobCommand.ts @@ -90,7 +90,7 @@ export interface StartDICOMImportJobCommandOutput extends StartDICOMImportJobRes *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/TagResourceCommand.ts b/clients/client-medical-imaging/src/commands/TagResourceCommand.ts index 0c9850d9766b..053b16ab9434 100644 --- a/clients/client-medical-imaging/src/commands/TagResourceCommand.ts +++ b/clients/client-medical-imaging/src/commands/TagResourceCommand.ts @@ -75,7 +75,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/UntagResourceCommand.ts b/clients/client-medical-imaging/src/commands/UntagResourceCommand.ts index 57c9651c72a2..c78a6ce8938a 100644 --- a/clients/client-medical-imaging/src/commands/UntagResourceCommand.ts +++ b/clients/client-medical-imaging/src/commands/UntagResourceCommand.ts @@ -75,7 +75,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/commands/UpdateImageSetMetadataCommand.ts b/clients/client-medical-imaging/src/commands/UpdateImageSetMetadataCommand.ts index 0f15ec9cb522..5ffbe46dabdd 100644 --- a/clients/client-medical-imaging/src/commands/UpdateImageSetMetadataCommand.ts +++ b/clients/client-medical-imaging/src/commands/UpdateImageSetMetadataCommand.ts @@ -99,7 +99,7 @@ export interface UpdateImageSetMetadataCommandOutput extends UpdateImageSetMetad *

The request was denied due to throttling.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

* * @throws {@link MedicalImagingServiceException} *

Base exception class for all service exceptions from MedicalImaging service.

diff --git a/clients/client-medical-imaging/src/endpoint/ruleset.ts b/clients/client-medical-imaging/src/endpoint/ruleset.ts index ed46cfa0ffbe..9b7cf44cb2d5 100644 --- a/clients/client-medical-imaging/src/endpoint/ruleset.ts +++ b/clients/client-medical-imaging/src/endpoint/ruleset.ts @@ -6,25 +6,27 @@ import { RuleSetObject } from "@smithy/types"; or see "smithy.rules#endpointRuleSet" in codegen/sdk-codegen/aws-models/medical-imaging.json */ -const q="required", -r="fn", -s="argv", -t="ref"; -const a="isSet", -b="tree", -c="error", -d="endpoint", -e="PartitionResult", -f={[q]:false,"type":"String"}, -g={[q]:true,"default":false,"type":"Boolean"}, -h={[t]:"Endpoint"}, -i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]}, -j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]}, -k={}, -l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]}, -m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]}, -n=[i], -o=[j], -p=[{[t]:"Region"}]; -const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://medical-imaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://medical-imaging-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://medical-imaging.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://medical-imaging.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]}; +const s="required", +t="fn", +u="argv", +v="ref"; +const a=true, +b="isSet", +c="booleanEquals", +d="error", +e="endpoint", +f="tree", +g="PartitionResult", +h={[s]:false,"type":"String"}, +i={[s]:true,"default":false,"type":"Boolean"}, +j={[v]:"Endpoint"}, +k={[t]:c,[u]:[{[v]:"UseFIPS"},true]}, +l={[t]:c,[u]:[{[v]:"UseDualStack"},true]}, +m={}, +n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]}, +o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]}, +p=[k], +q=[l], +r=[{[v]:"Region"}]; +const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f}],type:f},{rules:[{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{rules:[{endpoint:{url:"https://medical-imaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{rules:[{endpoint:{url:"https://medical-imaging-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{rules:[{endpoint:{url:"https://medical-imaging.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{rules:[{endpoint:{url:"https://medical-imaging.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}],type:f}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-medical-imaging/src/index.ts b/clients/client-medical-imaging/src/index.ts index f29c1d8bf602..6ea5969a7d61 100644 --- a/clients/client-medical-imaging/src/index.ts +++ b/clients/client-medical-imaging/src/index.ts @@ -1,47 +1,48 @@ // smithy-typescript generated code /* eslint-disable */ /** - *

This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, - * and analyzing medical images. For an introduction to the service, see the + *

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health + * care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For + * an introduction to the service, see the * AWS HealthImaging Developer Guide * .

* *

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as * they take care of request authentication, serialization, and connection management. For more information, * see Tools to build on AWS.

- *

For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the + *

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the * See Also link at the end of each section that describes an API action or data type.

* *

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are * provided to actions within this Reference, along with links back to corresponding sections in the - * AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.

+ * AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.

*

* Data store actions *

* *

@@ -50,21 +51,21 @@ *

*

@@ -73,27 +74,27 @@ *

*

@@ -102,27 +103,27 @@ *

*

@@ -131,24 +132,24 @@ *

* diff --git a/clients/client-medical-imaging/src/models/models_0.ts b/clients/client-medical-imaging/src/models/models_0.ts index 53644384232d..55662526757c 100644 --- a/clients/client-medical-imaging/src/models/models_0.ts +++ b/clients/client-medical-imaging/src/models/models_0.ts @@ -353,7 +353,7 @@ export class ThrottlingException extends __BaseException { /** * @public - *

The input fails to satisfy the constraints specified by an AWS service.

+ *

The input fails to satisfy the constraints set by the service.

*/ export class ValidationException extends __BaseException { readonly name: "ValidationException" = "ValidationException"; @@ -395,7 +395,7 @@ export interface CreateDatastoreRequest { /** * @public - *

The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.

+ *

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

*/ kmsKeyArn?: string; } @@ -498,7 +498,7 @@ export interface DatastoreProperties { /** * @public - *

The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.

+ *

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

*/ kmsKeyArn?: string; @@ -1504,14 +1504,14 @@ export interface ImageSetsMetadataSummary { /** * @public - *

The time an image set is created in AWS HealthImaging. Sample creation + *

The time an image set is created. Sample creation * date is provided in 1985-04-12T23:20:50.52Z format.

*/ createdAt?: Date; /** * @public - *

The time when an image was last updated in AWS HealthImaging.

+ *

The time an image set was last updated.

*/ updatedAt?: Date; diff --git a/codegen/sdk-codegen/aws-models/medical-imaging.json b/codegen/sdk-codegen/aws-models/medical-imaging.json index db94e31d4f37..902832959e8c 100644 --- a/codegen/sdk-codegen/aws-models/medical-imaging.json +++ b/codegen/sdk-codegen/aws-models/medical-imaging.json @@ -80,7 +80,7 @@ } }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing,\n and analyzing medical images. For an introduction to the service, see the \n AWS HealthImaging Developer Guide\n .

\n \n

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as\n they take care of request authentication, serialization, and connection management. For more information,\n see Tools to build on AWS.

\n

For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the\n See Also link at the end of each section that describes an API action or data type.

\n \n

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are \n provided to actions within this Reference, along with links back to corresponding sections in the \n AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.

\n

\n Data store actions\n

\n \n

\n Import job actions\n

\n \n

\n Image set access actions\n

\n \n

\n Image set modification actions\n

\n \n

\n Tagging actions\n

\n ", + "smithy.api#documentation": "

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health\n care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For\n an introduction to the service, see the \n AWS HealthImaging Developer Guide\n .

\n \n

We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as\n they take care of request authentication, serialization, and connection management. For more information,\n see Tools to build on AWS.

\n

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the\n See Also link at the end of each section that describes an API action or data type.

\n \n

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are \n provided to actions within this Reference, along with links back to corresponding sections in the \n AWS HealthImaging Developer Guide where you can view console procedures and CLI/SDK code examples.

\n

\n Data store actions\n

\n \n

\n Import job actions\n

\n \n

\n Image set access actions\n

\n \n

\n Image set modification actions\n

\n \n

\n Tagging actions\n

\n ", "smithy.api#title": "AWS Health Imaging", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -124,7 +124,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -143,7 +142,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -171,13 +169,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -190,7 +189,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -204,7 +202,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -227,7 +224,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -262,11 +258,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -277,16 +271,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -300,14 +297,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -316,15 +311,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -335,16 +329,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -358,7 +355,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -378,11 +374,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -393,20 +387,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -417,18 +413,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -1090,10 +1090,7 @@ } ], "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], "smithy.api#documentation": "

Create a data store.

", "smithy.api#http": { "method": "POST", @@ -1128,7 +1125,7 @@ "kmsKeyArn": { "target": "com.amazonaws.medicalimaging#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

" } } }, @@ -1596,7 +1593,7 @@ "kmsKeyArn": { "target": "com.amazonaws.medicalimaging#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

" } }, "datastoreArn": { @@ -1645,9 +1642,7 @@ "aws.api#arn": { "template": "datastore/{datastoreId}" }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], "aws.iam#disableConditionKeyInference": {} } }, @@ -2515,9 +2510,7 @@ "aws.api#arn": { "template": "datastore/{datastoreId}/imageset/{imageSetId}" }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], "aws.iam#disableConditionKeyInference": {} } }, @@ -2634,13 +2627,13 @@ "createdAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { - "smithy.api#documentation": "

The time an image set is created in AWS HealthImaging. Sample creation \n date is provided in 1985-04-12T23:20:50.52Z format.

" + "smithy.api#documentation": "

The time an image set is created. Sample creation \n date is provided in 1985-04-12T23:20:50.52Z format.

" } }, "updatedAt": { "target": "com.amazonaws.medicalimaging#Date", "traits": { - "smithy.api#documentation": "

The time when an image was last updated in AWS HealthImaging.

" + "smithy.api#documentation": "

The time an image set was last updated.

" } }, "DICOMTags": { @@ -2760,7 +2753,7 @@ } ], "traits": { - "smithy.api#documentation": "

List import jobs created by this AWS account for a specific data store.

", + "smithy.api#documentation": "

List import jobs created for a specific data store.

", "smithy.api#http": { "method": "GET", "uri": "/listDICOMImportJobs/datastore/{datastoreId}" @@ -2859,7 +2852,7 @@ } ], "traits": { - "smithy.api#documentation": "

List data stores created by this AWS account.

", + "smithy.api#documentation": "

List data stores.

", "smithy.api#http": { "method": "GET", "uri": "/datastore" @@ -3326,7 +3319,7 @@ } ], "traits": { - "smithy.api#documentation": "

Search image sets based on defined input attributes.

", + "smithy.api#documentation": "

Search image sets based on defined input attributes.

\n \n

\n SearchImageSets accepts a single search \n query parameter and returns a paginated response of all image sets that have the \n matching criteria. All range queries must be input as (lowerBound, upperBound).

\n

\n SearchImageSets uses the updatedAt field for sorting \n in decreasing order from latest to oldest.

\n ", "smithy.api#endpoint": { "hostPrefix": "runtime-" }, @@ -3604,10 +3597,7 @@ } ], "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], "smithy.api#documentation": "

Adds a user-specifed key and value tag to a medical imaging resource.

", "smithy.api#http": { "method": "POST", @@ -3712,9 +3702,7 @@ } ], "traits": { - "aws.iam#conditionKeys": [ - "aws:TagKeys" - ], + "aws.iam#conditionKeys": ["aws:TagKeys"], "smithy.api#documentation": "

Removes tags from a medical imaging resource.

", "smithy.api#http": { "method": "DELETE", @@ -3922,10 +3910,10 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", + "smithy.api#documentation": "

The input fails to satisfy the constraints set by the service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } -} \ No newline at end of file +}