Merge branch 'main' into tm_logging

awsdocs · Apr 24, 2024 · d5811c3 · d5811c3
2 parents bced69e + c3f0adf
commit d5811c3
Show file tree

Hide file tree

Showing 21 changed files with 1,869 additions and 389 deletions.
diff --git a/.doc_gen/metadata/medical-imaging_metadata.yaml b/.doc_gen/metadata/medical-imaging_metadata.yaml
@@ -26,6 +26,15 @@ medical-imaging_Hello:
             - description: Code for the hello_health_imaging.cpp source file.
               snippet_tags:
                 - cpp.example_code.medical-imaging.hello_medical-imaging
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/medical-imaging/imaging_set_and_frames_workflow
+          github_note_at_bottom: true
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.medical-imaging.Hello
   services:
     medical-imaging: {ListDatastores}
 medical-imaging_CreateDatastore:
@@ -394,6 +403,12 @@ medical-imaging_SearchImageSets:
                previously persisted.
               snippet_tags:
                 - python.example_code.medical-imaging.SearchImageSets.use_case3
+            - description: >
+                Use case #4: EQUAL operator on DICOMSeriesInstanceUID and
+                BETWEEN on updatedAt and sort response in ASC order on
+                updatedAt field.
+              snippet_tags:
+                - python.example_code.medical-imaging.SearchImageSets.use_case4
             - description: >
                The following code instantiates the MedicalImagingWrapper object.
               snippet_tags:
@@ -423,6 +438,13 @@ medical-imaging_SearchImageSets:
               snippet_tags:
                 - medical-imaging.JavaScript.resource.searchImageSetV3.datastoreID
                 - medical-imaging.JavaScript.resource.searchImageSetV3.betweenFilter2
+            - description: >
+                Use case #4: EQUAL operator on DICOMSeriesInstanceUID and
+                BETWEEN on updatedAt and sort response in ASC order on
+                updatedAt field.
+              snippet_tags:
+                - medical-imaging.JavaScript.resource.searchImageSetV3.datastoreID
+                - medical-imaging.JavaScript.resource.searchImageSetV3.sortAndFilter
     Java:
       versions:
         - sdk_version: 2
@@ -445,6 +467,12 @@ medical-imaging_SearchImageSets:
                previously persisted.
               snippet_tags:
                 - medicalimaging.java2.search_imagesets.use_case3
+            - description: >
+                Use case #4: EQUAL operator on DICOMSeriesInstanceUID and
+                BETWEEN on updatedAt and sort response in ASC order on
+                updatedAt field.
+              snippet_tags:
+                - medicalimaging.java2.search_imagesets.use_case4
     C++:
       versions:
         - sdk_version: 1
@@ -467,6 +495,12 @@ medical-imaging_SearchImageSets:
                previously persisted.
               snippet_tags:
                 - cpp.example_code.medical_imaging.SearchImageSets.use_case3
+            - description: >
+                Use case #4: EQUAL operator on DICOMSeriesInstanceUID and
+                BETWEEN on updatedAt and sort response in ASC order on
+                updatedAt field.
+              snippet_tags:
+                - cpp.example_code.medical_imaging.SearchImageSets.use_case4
   services:
     medical-imaging: {SearchImageSets}
 medical-imaging_GetImageSet:
@@ -1193,21 +1227,72 @@ medical-imaging_Scenario_ImageSetsAndFrames:
               snippet_tags:
                 - cpp.example_code.medical-imaging.image-sets-workflow.clean_up
                 - cpp.example_code.medical-imaging.image-sets-workflow.empty_data_store
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/medical-imaging/imaging_set_and_frames_workflow
+          github_note_at_bottom: true
+          excerpts:
+            - description: Create an &CFN; stack with the necessary resources.
+              snippet_tags:
+                - python.example_code.medical-imaging.workflow.deploy
+            - description: Copy DICOM files to the &S3; import bucket.
+              snippet_tags:
+                - python.example_code.medical-imaging.workflow.copy
+            - description: Import the DICOM files to the &S3; data store.
+              snippet_tags:
+                - python.example_code.medical-imaging.MedicalImagingWorkflowWrapper.decl
+                - python.example_code.medical-imaging.workflow.StartDICOMImportJob
+            - description: Get image sets created by the DICOM import job.
+              snippet_tags:
+                - python.example_code.medical-imaging.MedicalImagingWorkflowWrapper.decl
+                - python.example_code.medical-imaging.workflow.GetImageSetsForImportJob
+                - python.example_code.medical-imaging.workflow.GetImageSet
+            - description: Get image frame information for image sets.
+              snippet_tags:
+                - python.example_code.medical-imaging.MedicalImagingWorkflowWrapper.decl
+                - python.example_code.medical-imaging.workflow.GetImageFrames
+                - python.example_code.medical-imaging.workflow.GetImageSetMetadata
+            - description: Download, decode and verify image frames.
+              snippet_tags:
+                - python.example_code.medical-imaging.MedicalImagingWorkflowWrapper.decl
+                - python.example_code.medical-imaging.workflow.GetPixelData
+                - python.example_code.medical-imaging.workflow.downloadAndCheck
+            - description: Clean up resources.
+              snippet_tags:
+                - python.example_code.medical-imaging.workflow.destroy
+                - python.example_code.medical-imaging.MedicalImagingWorkflowWrapper.decl
+                - python.example_code.medical-imaging.workflow.SearchImageSets
+                - python.example_code.medical-imaging.workflow.DeleteImageSet
     JavaScript:
       versions:
         - sdk_version: 3
           github: javascriptv3/example_code/medical-imaging
           github_note_at_bottom: true
           excerpts:
-            - description:
+            - description: <noloc>index.js</noloc> - Orchestrate steps.
               snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/index.js
+            - description: <noloc>step-1.js</noloc> - Deploy resources.
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-1.js
+            - description: <noloc>step-2.js</noloc> - Copy DICOM files. 
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-2.js
+            - description: <noloc>step-3.js</noloc> - Start import into datastore.
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-3.js
+            - description: <noloc>step-4.js</noloc> - Get image set IDs.
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-4.js
+            - description: <noloc>step-5.js</noloc> - Get image frame IDs.
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-5.js
+            - description: <noloc>step-6.js</noloc> - Verify image frames. The <ulink url="https://github.com/aws-samples/aws-healthimaging-samples/tree/main/pixel-data-verification">&AWS; HealthImaging Pixel Data Verification</ulink> library was used for verification.
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-6.js
+            - description: <noloc>step-7.js</noloc> - Destroy resources.
+              snippet_files:
                 - javascriptv3/example_code/medical-imaging/scenarios/health-image-sets/step-7.js
   services:
     medical-imaging:

diff --git a/.github/workflows/docker-push.yml b/.github/workflows/docker-push.yml
@@ -17,8 +17,7 @@ jobs:
     name: Push Docker image to ECR Public
     if: github.event.pull_request.merged == true
     env:
-      REGISTRY: public.ecr.aws
-      REGISTRY_ALIAS: b4v4v1s0
+      REGISTRY: 808326389482.dkr.ecr.us-east-1.amazonaws.com
       IMAGE_TAG: latest
       REGION: us-east-1
     runs-on: ubuntu-latest
@@ -51,10 +50,10 @@ jobs:
         env:
           REPOSITORY: ruby
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -66,10 +65,10 @@ jobs:
         env:
           REPOSITORY: python
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -81,10 +80,10 @@ jobs:
         env:
           REPOSITORY: javascriptv3
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile .
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -96,10 +95,10 @@ jobs:
         env:
           REPOSITORY: rustv1
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -111,10 +110,10 @@ jobs:
         env:
           REPOSITORY: gov2
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -126,10 +125,10 @@ jobs:
         env:
           REPOSITORY: cpp
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -141,10 +140,10 @@ jobs:
         env:
           REPOSITORY: dotnetv3
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -156,10 +155,10 @@ jobs:
         env:
           REPOSITORY: javav2
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -171,10 +170,10 @@ jobs:
         env:
           REPOSITORY: kotlin
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -186,10 +185,10 @@ jobs:
         env:
           REPOSITORY: php
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
 
       #################################
@@ -201,8 +200,8 @@ jobs:
         env:
           REPOSITORY: swift
         run: |
-          aws ecr-public get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY/$REGISTRY_ALIAS
+          aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $REGISTRY
           docker build -t $REPOSITORY -f ./$REPOSITORY/Dockerfile ./$REPOSITORY
-          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
-          docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG
+          docker tag $REPOSITORY:$IMAGE_TAG $REGISTRY/$REPOSITORY:$IMAGE_TAG
+          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG
         continue-on-error: true
diff --git a/.github/workflows/validate-doc-metadata.yml b/.github/workflows/validate-doc-metadata.yml
@@ -18,4 +18,4 @@ jobs:
       - name: checkout repo content
         uses: actions/checkout@v4
       - name: validate metadata
-        uses: awsdocs/aws-doc-sdk-examples-tools@2024-04-10-A
+        uses: awsdocs/aws-doc-sdk-examples-tools@2024-04-19-A
diff --git a/cpp/example_code/medical-imaging/medical-imaging_samples.h b/cpp/example_code/medical-imaging/medical-imaging_samples.h
@@ -91,11 +91,10 @@ namespace AwsDoc {
           \param clientConfig: Aws client configuration.
           \return bool: Function succeeded.
           */
-        bool searchImageSets(
-                const Aws::String &dataStoreID,
-                const Aws::MedicalImaging::Model::SearchCriteria &searchCriteria,
-                Aws::Vector<Aws::String> &imageSetResults,
-                const Aws::Client::ClientConfiguration &clientConfig);
+        bool searchImageSets(const Aws::String &dataStoreID,
+                             const Aws::MedicalImaging::Model::SearchCriteria &searchCriteria,
+                             Aws::Vector<Aws::String> &imageSetResults,
+                             const Aws::Client::ClientConfiguration &clientConfig);
 
 
     } // namespace Medical_Imaging