SearchImageSets - AWS HealthImaging


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 date range queries must be input as (lowerBound, upperBound).

By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.

Request Syntax

POST /datastore/datastoreId/searchImageSets?maxResults=maxResults&nextToken=nextToken HTTP/1.1 Content-type: application/json { "filters": [ { "operator": "string", "values": [ { ... } ] } ], "sort": { "sortField": "string", "sortOrder": "string" } }

URI Request Parameters

The request uses the following URI parameters.


The identifier of the data store where the image sets reside.

Pattern: [0-9a-z]{32}

Required: Yes


The maximum number of results that can be returned in a search.

Valid Range: Minimum value of 1. Maximum value of 50.


The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Request Body

The request accepts the following data in JSON format.


The filters for the search criteria.

Type: Array of SearchFilter objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: No


The sort input for search criteria.

Type: Sort object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "imageSetsMetadataSummaries": [ { "createdAt": number, "DICOMTags": { "DICOMAccessionNumber": "string", "DICOMNumberOfStudyRelatedInstances": number, "DICOMNumberOfStudyRelatedSeries": number, "DICOMPatientBirthDate": "string", "DICOMPatientId": "string", "DICOMPatientName": "string", "DICOMPatientSex": "string", "DICOMSeriesBodyPart": "string", "DICOMSeriesInstanceUID": "string", "DICOMSeriesModality": "string", "DICOMSeriesNumber": number, "DICOMStudyDate": "string", "DICOMStudyDescription": "string", "DICOMStudyId": "string", "DICOMStudyInstanceUID": "string", "DICOMStudyTime": "string" }, "imageSetId": "string", "updatedAt": number, "version": number } ], "nextToken": "string", "sort": { "sortField": "string", "sortOrder": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The model containing the image set results.

Type: Array of ImageSetsMetadataSummary objects


The token for pagination results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}


The sort order for image set search results.

Type: Sort object


For information about the errors that are common to all actions, see Common Errors.


The user does not have sufficient access to perform this action.

HTTP Status Code: 403


Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409


An unexpected error occurred during processing of the request.

HTTP Status Code: 500


The request references a resource which does not exist.

HTTP Status Code: 404


The request was denied due to throttling.

HTTP Status Code: 429


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: