Amazon Web Services, Inc.

AWS Health Imaging

This is the AWS HealthImaging API Reference . For an introduction to the service, see What is AWS HealthImaging? in the AWS HealthImaging Developer Guide .

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the AWS HealthImaging API Reference . For an introduction to the service, see What is AWS HealthImaging? in the AWS HealthImaging Developer Guide .

Endpoints 18

Datastore

  • GETList datastores/datastore?datastoreStatus=string&nextToken=string&maxResults=0List data stores.
  • POSTCreate datastore/datastoreCreate a data store.
  • GETGet datastore/datastore/:datastoreIdGet data store properties.
  • DELETEDelete datastore/datastore/:datastoreIdDelete a data store. Before a data store can be deleted, you must first delete all image sets within it.
  • POSTCopy image set/datastore/:datastoreId/imageSet/:sourceImageSetId/copyImageSetCopy an image set.
  • POSTDelete image set/datastore/:datastoreId/imageSet/:imageSetId/deleteImageSetDelete an image set.
  • GETGet dICOM import job/getDICOMImportJob/datastore/:datastoreId/job/:jobIdGet the import job properties to learn more about the job or job progress. The jobStatus refers to the execution of the import job. Therefore, an import job…
  • POSTGet image frame/datastore/:datastoreId/imageSet/:imageSetId/getImageFrameGet an image frame (pixel data) for an image set.
  • POSTGet image set/datastore/:datastoreId/imageSet/:imageSetId/getImageSet?version=stringGet image set properties.
  • POSTGet image set metadata/datastore/:datastoreId/imageSet/:imageSetId/getImageSetMetadata?version=stringGet metadata attributes for an image set.
  • GETList dICOM import jobs/listDICOMImportJobs/datastore/:datastoreId?jobStatus=string&nextToken=string&maxResults=0List import jobs created for a specific data store.
  • POSTList image set versions/datastore/:datastoreId/imageSet/:imageSetId/listImageSetVersions?nextToken=string&maxResults=0List image set versions.
  • GETList tags for resource/tags/:resourceArnLists all tags associated with a medical imaging resource.
  • POSTTag resource/tags/:resourceArnAdds a user-specifed key and value tag to a medical imaging resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes tags from a medical imaging resource.
  • POSTSearch image sets/datastore/:datastoreId/searchImageSetsSearch image sets based on defined input attributes. SearchImageSets accepts a single search query parameter and returns a paginated response of all image…
  • POSTStart dICOM import job/startDICOMImportJob/datastore/:datastoreIdStart importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files or enhances existing DICOM files with JSON metadata. The…
  • POSTUpdate image set metadata/datastore/:datastoreId/imageSet/:imageSetId/updateImageSetMetadata?latestVersion=string&force=true&includeStudyImageSets=trueUpdate image set metadata attributes.

API details

Base URL
https://medical-imaging.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
18 operations on 14 pathsPOST 11GET 5DELETE 2
Main resources
Datastore 4
Description format
AWS Smithy model, API version 2023-07-19

How to test the AWS Health Imaging in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Health Imaging collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List datastores” (GET /datastore?datastoreStatus=string&nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Health Imaging?

This is the AWS HealthImaging API Reference . For an introduction to the service, see What is AWS HealthImaging? in the AWS HealthImaging Developer Guide . It is listed under Developer tools and has 18 endpoints.

Who publishes the AWS Health Imaging?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Health Imaging?

Requests go to https://medical-imaging.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Health Imaging?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Health Imaging have?

18 operations on 14 paths (11 POST, 5 GET, 2 DELETE). The largest groups are Datastore.

Is forking the AWS Health Imaging free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.