JavaScript: Add rest of actions for HealthImaging (#5475)

awsdocs · Dec 15, 2023 · 9dd9e84 · 9dd9e84
1 parent d35cc66
commit 9dd9e84
Show file tree

Hide file tree

Showing 39 changed files with 2,254 additions and 65 deletions.
diff --git a/.doc_gen/metadata/medical-imaging_metadata.yaml b/.doc_gen/metadata/medical-imaging_metadata.yaml
@@ -1,4 +1,20 @@
 # zexi 0.4.0
+medical-imaging_Hello:
+  title: Hello &AHI;
+  title_abbrev: Hello &AHI;
+  synopsis: get started using &AHI;.
+  category: Hello
+  languages:
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.datastore.createDatastoreV3
+  services:
+    medical-imaging: {ListDatastores}
 medical-imaging_CreateDatastore:
   title: Create a &AHI; data store using an &AWS; SDK
   title_abbrev: Create a data store
@@ -173,6 +189,14 @@ medical-imaging_StartDICOMImportJob:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.StartDICOMImportJob
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.dicom.startDicomImportJobV3
   services:
     medical-imaging: {StartDICOMImportJob}
 medical-imaging_GetDICOMImportJob:
@@ -189,6 +213,14 @@ medical-imaging_GetDICOMImportJob:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.GetDICOMImportJob
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.dicom.getDICOMImportJobV3
   services:
     medical-imaging: {GetDICOMImportJob}
 medical-imaging_ListDICOMImportJobs:
@@ -205,6 +237,14 @@ medical-imaging_ListDICOMImportJobs:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.ListDICOMImportJobs
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.dicom.listDICOMImportJobsV3
   services:
     medical-imaging: {ListDICOMImportJobs}
 medical-imaging_SearchImageSets:
@@ -221,6 +261,26 @@ medical-imaging_SearchImageSets:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.SearchImageSets
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description: The utility function for searching image sets.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.searchImageSetV3
+            - description: "Use case #1: EQUAL operator."
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.searchImageSetV3.datastoreID
+                - medical-imaging.JavaScript.resource.searchImageSetV3.equalFilter
+            - description: "Use case #2: BETWEEN operator using DICOMStudyDate and DICOMStudyTime."
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.searchImageSetV3.datastoreID
+                - medical-imaging.JavaScript.resource.searchImageSetV3.betweenFilter1
+            - description: "Use case #3: BETWEEN operator using createdAt. Time studies were previously persisted."
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.searchImageSetV3.datastoreID
+                - medical-imaging.JavaScript.resource.searchImageSetV3.betweenFilter2
   services:
     medical-imaging: {SearchImageSets}
 medical-imaging_GetImageSet:
@@ -237,6 +297,14 @@ medical-imaging_GetImageSet:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.GetImageSet
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.getImageSetV3
   services:
     medical-imaging: {GetImageSet}
 medical-imaging_GetImageSetMetadata:
@@ -253,6 +321,20 @@ medical-imaging_GetImageSetMetadata:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.GetImageSetMetadata
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description: Utility function to get image set metadata.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.getImageSetMetadataV3
+            - description: Get image set metadata without version.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.getImageSetMetadataV3.withoutversion
+            - description: Get image set metadata with version.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.getImageSetMetadataV3.withversion
   services:
     medical-imaging: {GetImageSetMetadata}
 medical-imaging_GetImageFrame:
@@ -269,6 +351,14 @@ medical-imaging_GetImageFrame:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.GetImageFrame
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.getImageFrameV3
   services:
     medical-imaging: {GetImageFrame}
 medical-imaging_ListImageSetVersions:
@@ -285,6 +375,14 @@ medical-imaging_ListImageSetVersions:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.ListImageSetVersions
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.listImageSetVersionsV3
   services:
     medical-imaging: {ListImageSetVersions}
 medical-imaging_UpdateImageSetMetadata:
@@ -301,6 +399,17 @@ medical-imaging_UpdateImageSetMetadata:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.UpdateImageSetMetadata
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.datastore.updateImageSetMetadataV3
+            - description: Encode the metadata.
+              snippet_tags:
+                - medical-imaging.JavaScript.datastore.updateImageSetMetadataV3.main
   services:
     medical-imaging: {UpdateImageSetMetadata}
 medical-imaging_CopyImageSet:
@@ -317,6 +426,20 @@ medical-imaging_CopyImageSet:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.CopyImageSet
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description: Utility function to copy an image set.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.copyImageSetV3
+            - description: Copy an image set without a destination.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.copyImageSetV3.without_destination
+            - description: Copy an image set with a destination.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.copyImageSetV3.with_destination
   services:
     medical-imaging: {CopyImageSet}
 medical-imaging_DeleteImageSet:
@@ -333,6 +456,14 @@ medical-imaging_DeleteImageSet:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.DeleteImageSet
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.deleteImageSetV3
   services:
     medical-imaging: {DeleteImageSet}
 medical-imaging_TagResource:
@@ -349,6 +480,14 @@ medical-imaging_TagResource:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.TagResource
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.tagResourceV3
   services:
     medical-imaging: {TagResource}
 medical-imaging_UntagResource:
@@ -365,6 +504,14 @@ medical-imaging_UntagResource:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.UntagResource
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.unTagResourceV3
   services:
     medical-imaging: {UntagResource}
 medical-imaging_ListTagsForResource:
@@ -381,5 +528,75 @@ medical-imaging_ListTagsForResource:
             - description:
               snippet_tags:
                 - python.example_code.medical-imaging.ListTagsForResource
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.listTagsForResourceV3
   services:
     medical-imaging: {ListTagsForResource}
+medical-imaging_tagging_datastores:
+  title: Tagging a &AHI; data store using an &AWS; SDK
+  title_abbrev: Tagging a data store
+  synopsis: tag a &AHI; data store.
+  category: Scenarios
+  languages:
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description: To tag a data store.
+              snippet_tags:
+                - medical-imaging.JavaScript.datastore.tagging.V3
+            - description: The utility function for tagging a resource.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.tagResourceV3
+            - description: To list tags for a data store.
+              snippet_tags:
+                - medical-imaging.JavaScript.datastore.list_tags.V3
+            - description: The utility function for listing a resource's tags.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.listTagsForResourceV3
+            - description: To untag a data store.
+              snippet_tags:
+                - medical-imaging.JavaScript.datastore.untag.V3
+            - description: The utility function for untagging a resource.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.unTagResourceV3
+  services:
+    medical-imaging: {TagResource, UntagResource, ListTagsForResource}
+medical-imaging_tagging_imagesets:
+  title: Tagging a &AHI; image set using an &AWS; SDK
+  title_abbrev: Tagging an image set
+  synopsis: tag a &AHI; image set.
+  category: Scenarios
+  languages:
+    JavaScript:
+      versions:
+        - sdk_version: 3
+          github: javascriptv3/example_code/medical-imaging
+          excerpts:
+            - description: To tag an image set.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.tagging.V3
+            - description: The utility function for tagging a resource.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.tagResourceV3
+            - description: To list tags for an image set.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.list_tags.V3
+            - description: The utility function for listing a resource's tags.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.listTagsForResourceV3
+            - description: To untag an image set.
+              snippet_tags:
+                - medical-imaging.JavaScript.imageset.untag.V3
+            - description: The utility function for untagging a resource.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.unTagResourceV3
+  services:
+    medical-imaging: {TagResource, UntagResource, ListTagsForResource}