aws-sdk-medicalimaging 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61d9b9dfeeb43494686ae92b21073634c060e879b392ed7d40e5a1e6a11c1f6
-  data.tar.gz: 838d39ebbdf36c25e93db52ea183b57e1357d1c7f7674bcd35cf7e3ab933ac0c
+  metadata.gz: 91788be7ecb39ff67aab0c5fb3921432c7f7a206e7eaae430cb89b4b06aae11c
+  data.tar.gz: 97fe61baa8e677b4e26e9fe71eaec7854b24b965c4cc4358a0517e8aa6e5d7ac
 SHA512:
-  metadata.gz: 8f1a61a23a4a9737f806774025e4ab97cc0bb11f07768c3d00674f2b02d0b49da3d2475acfd402263b5775d3565fd16b4adc3a4100e52522fdc9e540935ac462
-  data.tar.gz: b46cafdcb9ff3132479a80805e6e2b34e50d117356d47cf7b390e8909e51bc917dcc15d119c1900e2d6b82dd013dfcc2e4bb41bfd6b4978b8f12d366c487df4e
+  metadata.gz: c9159c804aece14650f2a670a1bddc6e4864c7eea503de849ce9e5421fa791603fef1f5f26719ffdc0c40dcd5541130a37835995bdc1c1289a61ea62bbd73c09
+  data.tar.gz: b8cd25b72308d49618706393284a7227dd8f18d1c4c7f7a367cbb2b76a300b9a72fa1416b2ec44f56abb151245793dca6561f2c3754eb5b5c3415789c9779dd4

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.7.0 (2024-04-03)
+------------------
+
+* Feature - SearchImageSets API now supports following enhancements - Additional support for searching on UpdatedAt and SeriesInstanceUID - Support for searching existing filters between dates/times - Support for sorting the search result by Ascending/Descending - Additional parameters returned in the response
+
+1.6.0 (2024-01-26)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.5.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.7.0

data/lib/aws-sdk-medicalimaging/client.rb

@@ -572,6 +572,15 @@ module Aws::MedicalImaging
     # Get the import job properties to learn more about the job or job
     # progress.
     #
+    # <note markdown="1"> The `jobStatus` refers to the execution of the import job. Therefore,
+    # an import job can return a `jobStatus` as `COMPLETED` even if
+    # validation issues are discovered during the import process. If a
+    # `jobStatus` returns as `COMPLETED`, we still recommend you review the
+    # output manifests written to S3, as they provide details on the success
+    # or failure of individual P10 object imports.
+    #
+    #  </note>
+    #
     # @option params [required, String] :datastore_id
     #   The data store identifier.
     #
@@ -992,6 +1001,7 @@ module Aws::MedicalImaging
     # @return [Types::SearchImageSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::SearchImageSetsResponse#image_sets_metadata_summaries #image_sets_metadata_summaries} => Array&lt;Types::ImageSetsMetadataSummary&gt;
+    #   * {Types::SearchImageSetsResponse#sort #data.sort} => Types::Sort (This method conflicts with a method on Response, call it through the data member)
     #   * {Types::SearchImageSetsResponse#next_token #next_token} => String
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@@ -1009,7 +1019,9 @@ module Aws::MedicalImaging
     #               dicom_accession_number: "DICOMAccessionNumber",
     #               dicom_study_id: "DICOMStudyId",
     #               dicom_study_instance_uid: "DICOMStudyInstanceUID",
+    #               dicom_series_instance_uid: "DICOMSeriesInstanceUID",
     #               created_at: Time.now,
+    #               updated_at: Time.now,
     #               dicom_study_date_and_time: {
     #                 dicom_study_date: "DICOMStudyDate", # required
     #                 dicom_study_time: "DICOMStudyTime",
@@ -1019,6 +1031,10 @@ module Aws::MedicalImaging
     #           operator: "EQUAL", # required, accepts EQUAL, BETWEEN
     #         },
     #       ],
+    #       sort: {
+    #         sort_order: "ASC", # required, accepts ASC, DESC
+    #         sort_field: "updatedAt", # required, accepts updatedAt, createdAt, DICOMStudyDateAndTime
+    #       },
     #     },
     #     max_results: 1,
     #     next_token: "NextToken",
@@ -1041,8 +1057,14 @@ module Aws::MedicalImaging
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_number_of_study_related_series #=> Integer
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_number_of_study_related_instances #=> Integer
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_accession_number #=> String
+    #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_instance_uid #=> String
+    #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_modality #=> String
+    #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_body_part #=> String
+    #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_series_number #=> Integer
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_date #=> String
     #   resp.image_sets_metadata_summaries[0].dicom_tags.dicom_study_time #=> String
+    #   resp.data.sort.sort_order #=> String, one of "ASC", "DESC"
+    #   resp.data.sort.sort_field #=> String, one of "updatedAt", "createdAt", "DICOMStudyDateAndTime"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchImageSets AWS API Documentation
@@ -1246,7 +1268,7 @@ module Aws::MedicalImaging
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-medicalimaging'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.7.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-medicalimaging/client_api.rb

@@ -37,6 +37,10 @@ module Aws::MedicalImaging
     DICOMPatientId = Shapes::StringShape.new(name: 'DICOMPatientId')
     DICOMPatientName = Shapes::StringShape.new(name: 'DICOMPatientName')
     DICOMPatientSex = Shapes::StringShape.new(name: 'DICOMPatientSex')
+    DICOMSeriesBodyPart = Shapes::StringShape.new(name: 'DICOMSeriesBodyPart')
+    DICOMSeriesInstanceUID = Shapes::StringShape.new(name: 'DICOMSeriesInstanceUID')
+    DICOMSeriesModality = Shapes::StringShape.new(name: 'DICOMSeriesModality')
+    DICOMSeriesNumber = Shapes::IntegerShape.new(name: 'DICOMSeriesNumber')
     DICOMStudyDate = Shapes::StringShape.new(name: 'DICOMStudyDate')
     DICOMStudyDateAndTime = Shapes::StructureShape.new(name: 'DICOMStudyDateAndTime')
     DICOMStudyDescription = Shapes::StringShape.new(name: 'DICOMStudyDescription')
@@ -111,6 +115,9 @@ module Aws::MedicalImaging
     SearchImageSetsRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'SearchImageSetsRequestMaxResultsInteger')
     SearchImageSetsResponse = Shapes::StructureShape.new(name: 'SearchImageSetsResponse')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
+    Sort = Shapes::StructureShape.new(name: 'Sort')
+    SortField = Shapes::StringShape.new(name: 'SortField')
+    SortOrder = Shapes::StringShape.new(name: 'SortOrder')
     StartDICOMImportJobRequest = Shapes::StructureShape.new(name: 'StartDICOMImportJobRequest')
     StartDICOMImportJobResponse = Shapes::StructureShape.new(name: 'StartDICOMImportJobResponse')
     String = Shapes::StringShape.new(name: 'String')
@@ -222,6 +229,10 @@ module Aws::MedicalImaging
     DICOMTags.add_member(:dicom_number_of_study_related_series, Shapes::ShapeRef.new(shape: DICOMNumberOfStudyRelatedSeries, location_name: "DICOMNumberOfStudyRelatedSeries"))
     DICOMTags.add_member(:dicom_number_of_study_related_instances, Shapes::ShapeRef.new(shape: DICOMNumberOfStudyRelatedInstances, location_name: "DICOMNumberOfStudyRelatedInstances"))
     DICOMTags.add_member(:dicom_accession_number, Shapes::ShapeRef.new(shape: DICOMAccessionNumber, location_name: "DICOMAccessionNumber"))
+    DICOMTags.add_member(:dicom_series_instance_uid, Shapes::ShapeRef.new(shape: DICOMSeriesInstanceUID, location_name: "DICOMSeriesInstanceUID"))
+    DICOMTags.add_member(:dicom_series_modality, Shapes::ShapeRef.new(shape: DICOMSeriesModality, location_name: "DICOMSeriesModality"))
+    DICOMTags.add_member(:dicom_series_body_part, Shapes::ShapeRef.new(shape: DICOMSeriesBodyPart, location_name: "DICOMSeriesBodyPart"))
+    DICOMTags.add_member(:dicom_series_number, Shapes::ShapeRef.new(shape: DICOMSeriesNumber, location_name: "DICOMSeriesNumber"))
     DICOMTags.add_member(:dicom_study_date, Shapes::ShapeRef.new(shape: DICOMStudyDate, location_name: "DICOMStudyDate"))
     DICOMTags.add_member(:dicom_study_time, Shapes::ShapeRef.new(shape: DICOMStudyTime, location_name: "DICOMStudyTime"))
     DICOMTags.struct_class = Types::DICOMTags
@@ -396,19 +407,24 @@ module Aws::MedicalImaging
     SearchByAttributeValue.add_member(:dicom_accession_number, Shapes::ShapeRef.new(shape: DICOMAccessionNumber, location_name: "DICOMAccessionNumber"))
     SearchByAttributeValue.add_member(:dicom_study_id, Shapes::ShapeRef.new(shape: DICOMStudyId, location_name: "DICOMStudyId"))
     SearchByAttributeValue.add_member(:dicom_study_instance_uid, Shapes::ShapeRef.new(shape: DICOMStudyInstanceUID, location_name: "DICOMStudyInstanceUID"))
+    SearchByAttributeValue.add_member(:dicom_series_instance_uid, Shapes::ShapeRef.new(shape: DICOMSeriesInstanceUID, location_name: "DICOMSeriesInstanceUID"))
     SearchByAttributeValue.add_member(:created_at, Shapes::ShapeRef.new(shape: Date, location_name: "createdAt"))
+    SearchByAttributeValue.add_member(:updated_at, Shapes::ShapeRef.new(shape: Date, location_name: "updatedAt"))
     SearchByAttributeValue.add_member(:dicom_study_date_and_time, Shapes::ShapeRef.new(shape: DICOMStudyDateAndTime, location_name: "DICOMStudyDateAndTime"))
     SearchByAttributeValue.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
     SearchByAttributeValue.add_member_subclass(:dicom_patient_id, Types::SearchByAttributeValue::DicomPatientId)
     SearchByAttributeValue.add_member_subclass(:dicom_accession_number, Types::SearchByAttributeValue::DicomAccessionNumber)
     SearchByAttributeValue.add_member_subclass(:dicom_study_id, Types::SearchByAttributeValue::DicomStudyId)
     SearchByAttributeValue.add_member_subclass(:dicom_study_instance_uid, Types::SearchByAttributeValue::DicomStudyInstanceUid)
+    SearchByAttributeValue.add_member_subclass(:dicom_series_instance_uid, Types::SearchByAttributeValue::DicomSeriesInstanceUid)
     SearchByAttributeValue.add_member_subclass(:created_at, Types::SearchByAttributeValue::CreatedAt)
+    SearchByAttributeValue.add_member_subclass(:updated_at, Types::SearchByAttributeValue::UpdatedAt)
     SearchByAttributeValue.add_member_subclass(:dicom_study_date_and_time, Types::SearchByAttributeValue::DicomStudyDateAndTime)
     SearchByAttributeValue.add_member_subclass(:unknown, Types::SearchByAttributeValue::Unknown)
     SearchByAttributeValue.struct_class = Types::SearchByAttributeValue
 
     SearchCriteria.add_member(:filters, Shapes::ShapeRef.new(shape: SearchCriteriaFiltersList, location_name: "filters"))
+    SearchCriteria.add_member(:sort, Shapes::ShapeRef.new(shape: Sort, location_name: "sort"))
     SearchCriteria.struct_class = Types::SearchCriteria
 
     SearchCriteriaFiltersList.member = Shapes::ShapeRef.new(shape: SearchFilter)
@@ -428,12 +444,17 @@ module Aws::MedicalImaging
     SearchImageSetsRequest[:payload_member] = SearchImageSetsRequest.member(:search_criteria)
 
     SearchImageSetsResponse.add_member(:image_sets_metadata_summaries, Shapes::ShapeRef.new(shape: ImageSetsMetadataSummaries, required: true, location_name: "imageSetsMetadataSummaries"))
+    SearchImageSetsResponse.add_member(:sort, Shapes::ShapeRef.new(shape: Sort, location_name: "sort"))
     SearchImageSetsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     SearchImageSetsResponse.struct_class = Types::SearchImageSetsResponse
 
     ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
+    Sort.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "sortOrder"))
+    Sort.add_member(:sort_field, Shapes::ShapeRef.new(shape: SortField, required: true, location_name: "sortField"))
+    Sort.struct_class = Types::Sort
+
     StartDICOMImportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "jobName"))
     StartDICOMImportJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "dataAccessRoleArn"))
     StartDICOMImportJobRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, required: true, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))

data/lib/aws-sdk-medicalimaging/plugins/endpoints.rb

@@ -14,6 +14,7 @@ module Aws::MedicalImaging
       option(
         :endpoint_provider,
         doc_type: 'Aws::MedicalImaging::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\

data/lib/aws-sdk-medicalimaging/types.rb

@@ -425,15 +425,15 @@ module Aws::MedicalImaging
     #   @return [String]
     #
     # @!attribute [rw] dicom_study_instance_uid
-    #   The DICOM provided identifier for studyInstanceUid.>
+    #   The DICOM provided identifier for the Study Instance UID.
     #   @return [String]
     #
     # @!attribute [rw] dicom_study_id
-    #   The DICOM provided studyId.
+    #   The DICOM provided identifier for the Study ID.
     #   @return [String]
     #
     # @!attribute [rw] dicom_study_description
-    #   The description of the study.
+    #   The DICOM provided Study Description.
     #   @return [String]
     #
     # @!attribute [rw] dicom_number_of_study_related_series
@@ -448,6 +448,22 @@ module Aws::MedicalImaging
     #   The accession number for the DICOM study.
     #   @return [String]
     #
+    # @!attribute [rw] dicom_series_instance_uid
+    #   The DICOM provided identifier for the Series Instance UID.
+    #   @return [String]
+    #
+    # @!attribute [rw] dicom_series_modality
+    #   The DICOM provided identifier for the series Modality.
+    #   @return [String]
+    #
+    # @!attribute [rw] dicom_series_body_part
+    #   The DICOM provided identifier for the series Body Part Examined.
+    #   @return [String]
+    #
+    # @!attribute [rw] dicom_series_number
+    #   The DICOM provided identifier for the Series Number.
+    #   @return [Integer]
+    #
     # @!attribute [rw] dicom_study_date
     #   The study date.
     #   @return [String]
@@ -469,9 +485,13 @@ module Aws::MedicalImaging
       :dicom_number_of_study_related_series,
       :dicom_number_of_study_related_instances,
       :dicom_accession_number,
+      :dicom_series_instance_uid,
+      :dicom_series_modality,
+      :dicom_series_body_part,
+      :dicom_series_number,
       :dicom_study_date,
       :dicom_study_time)
-      SENSITIVE = [:dicom_patient_id, :dicom_patient_name, :dicom_patient_birth_date, :dicom_patient_sex, :dicom_study_instance_uid, :dicom_study_id, :dicom_study_description, :dicom_accession_number, :dicom_study_date, :dicom_study_time]
+      SENSITIVE = [:dicom_patient_id, :dicom_patient_name, :dicom_patient_birth_date, :dicom_patient_sex, :dicom_study_instance_uid, :dicom_study_id, :dicom_study_description, :dicom_accession_number, :dicom_series_instance_uid, :dicom_series_modality, :dicom_series_body_part, :dicom_series_number, :dicom_study_date, :dicom_study_time]
       include Aws::Structure
     end
 
@@ -1195,10 +1215,18 @@ module Aws::MedicalImaging
     #   The DICOM study instance UID for search.
     #   @return [String]
     #
+    # @!attribute [rw] dicom_series_instance_uid
+    #   The Series Instance UID input for search.
+    #   @return [String]
+    #
     # @!attribute [rw] created_at
     #   The created at time of the image set provided for search.
     #   @return [Time]
     #
+    # @!attribute [rw] updated_at
+    #   The timestamp input for search.
+    #   @return [Time]
+    #
     # @!attribute [rw] dicom_study_date_and_time
     #   The aggregated structure containing DICOM study date and study time
     #   for search.
@@ -1211,10 +1239,12 @@ module Aws::MedicalImaging
       :dicom_accession_number,
       :dicom_study_id,
       :dicom_study_instance_uid,
+      :dicom_series_instance_uid,
       :created_at,
+      :updated_at,
       :dicom_study_date_and_time,
       :unknown)
-      SENSITIVE = [:dicom_patient_id, :dicom_accession_number, :dicom_study_id, :dicom_study_instance_uid]
+      SENSITIVE = [:dicom_patient_id, :dicom_accession_number, :dicom_study_id, :dicom_study_instance_uid, :dicom_series_instance_uid]
       include Aws::Structure
       include Aws::Structure::Union
 
@@ -1222,7 +1252,9 @@ module Aws::MedicalImaging
       class DicomAccessionNumber < SearchByAttributeValue; end
       class DicomStudyId < SearchByAttributeValue; end
       class DicomStudyInstanceUid < SearchByAttributeValue; end
+      class DicomSeriesInstanceUid < SearchByAttributeValue; end
       class CreatedAt < SearchByAttributeValue; end
+      class UpdatedAt < SearchByAttributeValue; end
       class DicomStudyDateAndTime < SearchByAttributeValue; end
       class Unknown < SearchByAttributeValue; end
     end
@@ -1233,10 +1265,15 @@ module Aws::MedicalImaging
     #   The filters for the search criteria.
     #   @return [Array<Types::SearchFilter>]
     #
+    # @!attribute [rw] sort
+    #   The sort input for search criteria.
+    #   @return [Types::Sort]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/SearchCriteria AWS API Documentation
     #
     class SearchCriteria < Struct.new(
-      :filters)
+      :filters,
+      :sort)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1294,6 +1331,10 @@ module Aws::MedicalImaging
     #   The model containing the image set results.
     #   @return [Array<Types::ImageSetsMetadataSummary>]
     #
+    # @!attribute [rw] sort
+    #   The sort order for image set search results.
+    #   @return [Types::Sort]
+    #
     # @!attribute [rw] next_token
     #   The token for pagination results.
     #   @return [String]
@@ -1302,6 +1343,7 @@ module Aws::MedicalImaging
     #
     class SearchImageSetsResponse < Struct.new(
       :image_sets_metadata_summaries,
+      :sort,
       :next_token)
       SENSITIVE = []
       include Aws::Structure
@@ -1320,6 +1362,25 @@ module Aws::MedicalImaging
       include Aws::Structure
     end
 
+    # Sort search results.
+    #
+    # @!attribute [rw] sort_order
+    #   The sort order for search criteria.
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_field
+    #   The sort field for search criteria.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/Sort AWS API Documentation
+    #
+    class Sort < Struct.new(
+      :sort_order,
+      :sort_field)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] job_name
     #   The import job name.
     #   @return [String]

data/lib/aws-sdk-medicalimaging.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-medicalimaging/customizations'
 # @!group service
 module Aws::MedicalImaging
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.7.0'
 
 end