AWS CLI Command Reference

[ aws . medical-imaging ]

search-image-sets

Description

Search image sets based on defined input attributes.

Note

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.

See also: AWS API Documentation

search-image-sets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: imageSetsMetadataSummaries

Synopsis

  search-image-sets
--datastore-id <value>
[--search-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--datastore-id (string)

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

--search-criteria (structure)

The search criteria that filters by applying a maximum of 1 item to SearchByAttribute .

filters -> (list)

The filters for the search criteria.

(structure)

The search filter.

values -> (list)

The search filter values.

(tagged union structure)

The search input attribute value.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DICOMPatientId, DICOMAccessionNumber, DICOMStudyId, DICOMStudyInstanceUID, DICOMSeriesInstanceUID, createdAt, updatedAt, DICOMStudyDateAndTime.

DICOMPatientId -> (string)

The patient ID input for search.

DICOMAccessionNumber -> (string)

The DICOM accession number for search.

DICOMStudyId -> (string)

The DICOM study ID for search.

DICOMStudyInstanceUID -> (string)

The DICOM study instance UID for search.

DICOMSeriesInstanceUID -> (string)

The Series Instance UID input for search.

createdAt -> (timestamp)

The created at time of the image set provided for search.

updatedAt -> (timestamp)

The timestamp input for search.

DICOMStudyDateAndTime -> (structure)

The aggregated structure containing DICOM study date and study time for search.

DICOMStudyDate -> (string)

The DICOM study date provided in yyMMdd format.

DICOMStudyTime -> (string)

The DICOM study time provided in HHmmss.FFFFFF format.

operator -> (string)

The search filter operator for imageSetDateTime .

sort -> (structure)

The sort input for search criteria.

sortOrder -> (string)

The sort order for search criteria.

sortField -> (string)

The sort field for search criteria.

JSON Syntax:

{
  "filters": [
    {
      "values": [
        {
          "DICOMPatientId": "string",
          "DICOMAccessionNumber": "string",
          "DICOMStudyId": "string",
          "DICOMStudyInstanceUID": "string",
          "DICOMSeriesInstanceUID": "string",
          "createdAt": timestamp,
          "updatedAt": timestamp,
          "DICOMStudyDateAndTime": {
            "DICOMStudyDate": "string",
            "DICOMStudyTime": "string"
          }
        }
        ...
      ],
      "operator": "EQUAL"|"BETWEEN"
    }
    ...
  ],
  "sort": {
    "sortOrder": "ASC"|"DESC",
    "sortField": "updatedAt"|"createdAt"|"DICOMStudyDateAndTime"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To search image sets with an EQUAL operator

The following search-image-sets code example uses the EQUAL operator to search image sets based on a specific value.

aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria file://search-criteria.json

Contents of search-criteria.json

{
    "filters": [{
        "values": [{"DICOMPatientId" : "SUBJECT08701"}],
        "operator": "EQUAL"
    }]
}

Output:

{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
             "DICOMPatientSex": "F",
             "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
             "DICOMPatientBirthDate": "19201120",
             "DICOMStudyDescription": "UNKNOWN",
             "DICOMPatientId": "SUBJECT08701",
             "DICOMPatientName": "Melissa844 Huel628",
             "DICOMNumberOfStudyRelatedInstances": 1,
             "DICOMStudyTime": "140728",
             "DICOMNumberOfStudyRelatedSeries": 1
            },
        "updatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}

Example 2: To search image sets with a BETWEEN operator using DICOMStudyDate and DICOMStudyTime

The following search-image-sets code example searches for image sets with DICOM Studies generated between January 1, 1990 (12:00 AM) and January 1, 2023 (12:00 AM).

Note: DICOMStudyTime is optional. If it is not present, 12:00 AM (start of the day) is the time value for the dates provided for filtering.

aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria file://search-criteria.json

Contents of search-criteria.json

{
    "filters": [{
        "values": [{
            "DICOMStudyDateAndTime": {
                "DICOMStudyDate": "19900101",
                "DICOMStudyTime": "000000"
            }
        },
        {
            "DICOMStudyDateAndTime": {
                "DICOMStudyDate": "20230101",
                "DICOMStudyTime": "000000"
            }
        }],
        "operator": "BETWEEN"
    }]
}

Output:

{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
            "DICOMPatientSex": "F",
            "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
            "DICOMPatientBirthDate": "19201120",
            "DICOMStudyDescription": "UNKNOWN",
            "DICOMPatientId": "SUBJECT08701",
            "DICOMPatientName": "Melissa844 Huel628",
            "DICOMNumberOfStudyRelatedInstances": 1,
            "DICOMStudyTime": "140728",
            "DICOMNumberOfStudyRelatedSeries": 1
        },
        "updatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}

Example 3: To search image sets with a BETWEEN operator using createdAt (time studies were previously persisted)

The following search-image-sets code example searches for image sets with DICOM Studies persisted in HealthImaging between the time ranges in UTC time zone.

Note: Provide createdAt in example format (“1985-04-12T23:20:50.52Z”).

aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria  file://search-criteria.json

Contents of search-criteria.json

{
    "filters": [{
        "values": [{
            "createdAt": "1985-04-12T23:20:50.52Z"
        },
        {
            "createdAt": "2022-04-12T23:20:50.52Z"
        }],
        "operator": "BETWEEN"
    }]
}

Output:

{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
            "DICOMPatientSex": "F",
            "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
            "DICOMPatientBirthDate": "19201120",
            "DICOMStudyDescription": "UNKNOWN",
            "DICOMPatientId": "SUBJECT08701",
            "DICOMPatientName": "Melissa844 Huel628",
            "DICOMNumberOfStudyRelatedInstances": 1,
            "DICOMStudyTime": "140728",
            "DICOMNumberOfStudyRelatedSeries": 1
        },
        "lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}

Example 4: To search image sets with an EQUAL operator on DICOMSeriesInstanceUID and BETWEEN on updatedAt and sort response in ASC order on updatedAt field

The following search-image-sets code example searches for image sets with an EQUAL operator on DICOMSeriesInstanceUID and BETWEEN on updatedAt and sort response in ASC order on updatedAt field.

Note: Provide updatedAt in example format (“1985-04-12T23:20:50.52Z”).

aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria  file://search-criteria.json

Contents of search-criteria.json

{
    "filters": [{
        "values": [{
            "updatedAt": "2024-03-11T15:00:05.074000-07:00"
        }, {
            "updatedAt": "2024-03-11T16:00:05.074000-07:00"
        }],
        "operator": "BETWEEN"
    }, {
        "values": [{
            "DICOMSeriesInstanceUID": "1.2.840.99999999.84710745.943275268089"
        }],
        "operator": "EQUAL"
    }],
    "sort": {
        "sortField": "updatedAt",
        "sortOrder": "ASC"
    }
}

Output:

{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
            "DICOMPatientSex": "F",
            "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
            "DICOMPatientBirthDate": "19201120",
            "DICOMStudyDescription": "UNKNOWN",
            "DICOMPatientId": "SUBJECT08701",
            "DICOMPatientName": "Melissa844 Huel628",
            "DICOMNumberOfStudyRelatedInstances": 1,
            "DICOMStudyTime": "140728",
            "DICOMNumberOfStudyRelatedSeries": 1
        },
        "lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}

For more information, see Searching image sets in the AWS HealthImaging Developer Guide.

Output

imageSetsMetadataSummaries -> (list)

The model containing the image set results.

(structure)

Summary of the image set metadata.

imageSetId -> (string)

The image set identifier.

version -> (integer)

The image set version.

createdAt -> (timestamp)

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

updatedAt -> (timestamp)

The time an image set was last updated.

DICOMTags -> (structure)

The DICOM tags associated with the image set.

DICOMPatientId -> (string)

The unique identifier for a patient in a DICOM Study.

DICOMPatientName -> (string)

The patient name.

DICOMPatientBirthDate -> (string)

The patient birth date.

DICOMPatientSex -> (string)

The patient sex.

DICOMStudyInstanceUID -> (string)

The DICOM provided identifier for the Study Instance UID.

DICOMStudyId -> (string)

The DICOM provided identifier for the Study ID.

DICOMStudyDescription -> (string)

The DICOM provided Study Description.

DICOMNumberOfStudyRelatedSeries -> (integer)

The total number of series in the DICOM study.

DICOMNumberOfStudyRelatedInstances -> (integer)

The total number of instances in the DICOM study.

DICOMAccessionNumber -> (string)

The accession number for the DICOM study.

DICOMSeriesInstanceUID -> (string)

The DICOM provided identifier for the Series Instance UID.

DICOMSeriesModality -> (string)

The DICOM provided identifier for the series Modality.

DICOMSeriesBodyPart -> (string)

The DICOM provided identifier for the series Body Part Examined.

DICOMSeriesNumber -> (integer)

The DICOM provided identifier for the Series Number.

DICOMStudyDate -> (string)

The study date.

DICOMStudyTime -> (string)

The study time.

sort -> (structure)

The sort order for image set search results.

sortOrder -> (string)

The sort order for search criteria.

sortField -> (string)

The sort field for search criteria.

nextToken -> (string)

The token for pagination results.
© Copyright 2018, Amazon Web Services. Created using Sphinx.