How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon HealthImaging Datastore API

The Datastore API from Amazon HealthImaging — 10 operation(s) for datastore.

Amazon HealthImaging Datastore API is one of 5 APIs that Amazon HealthImaging publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Datastore. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an API reference, and authentication docs.

This API exposes 12 operations across 10 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://medical-imaging.{region}.amazonaws.com, https://medical-imaging.{region}.amazonaws.com, http://medical-imaging.{region}.amazonaws.com.cn, https://medical-imaging.{region}.amazonaws.com.cn.

12 operations 10 paths 68 schemas 1 DELETE2 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://medical-imaging.us-east-1.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon HealthImaging Datastore API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Datastore 12
POST
/datastore/{datastoreId}/imageSet/{sourceImageSetId}/copyImageSet
Amazon HealthImaging Copy Image Set
CopyImageSet 9 params body → 200480481482483484485486
POST
/datastore
Amazon HealthImaging Create Datastore
CreateDatastore 7 params body → 200480481482483484485
GET
/datastore
Amazon HealthImaging List Datastores
ListDatastores 10 params → 200480481482483
DELETE
/datastore/{datastoreId}
Amazon HealthImaging Delete Datastore
DeleteDatastore 8 params → 200480481482483484485
GET
/datastore/{datastoreId}
Amazon HealthImaging Get Datastore
GetDatastore 8 params → 200480481482483484
POST
/datastore/{datastoreId}/imageSet/{imageSetId}/deleteImageSet
Amazon HealthImaging Delete Image Set
DeleteImageSet 9 params → 200480481482483484485
POST
/datastore/{datastoreId}/imageSet/{imageSetId}/getImageFrame
Amazon HealthImaging Get Image Frame
GetImageFrame 9 params body → 200480481482483484485
POST
/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSet
Amazon HealthImaging Get Image Set
GetImageSet 10 params → 200480481482483484485
POST
/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSetMetadata
Amazon HealthImaging Get Image Set Metadata
GetImageSetMetadata 10 params → 200480481482483484485
POST
/datastore/{datastoreId}/imageSet/{imageSetId}/listImageSetVersions
Amazon HealthImaging List Image Set Versions
ListImageSetVersions 11 params → 200480481482483484485
POST
/datastore/{datastoreId}/searchImageSets
Amazon HealthImaging Search Image Sets
SearchImageSets 10 params body → 200480481482483484485
POST
/datastore/{datastoreId}/imageSet/{imageSetId}/updateImageSetMetadata#latestVersion
Amazon HealthImaging Update Image Set Metadata
UpdateImageSetMetadata 10 params body → 200480481482483484485486

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are DICOMTags (12 properties), GetImageSetResponse (10 properties), ImageSetProperties (8 properties), UpdateImageSetMetadataResponse (8 properties). Each schema is shown below with its type and property counts.

Arn
string
ListImageSetVersionsResponse
object
2 properties 1 required
DICOMAccessionNumber
string
ConflictException
SearchByAttributeValue
object
The search input attribute value.
6 properties
DICOMNumberOfStudyRelatedSeries
integer
DICOMStudyDate
string
ThrottlingException
SearchImageSetsResponse
object
2 properties 1 required
ImageSetsMetadataSummaries
array
ImageSetsMetadataSummary
object
Summary of the image set metadata.
5 properties 1 required
Operator
string
DICOMPatientBirthDate
string
CopyDestinationImageSetProperties
object
Copy the image set properties of the destination image set.
7 properties 2 required
CreateDatastoreResponse
object
2 properties 2 required
CopyDestinationImageSet
object
Copy the destination image set.
2 properties 2 required
ServiceQuotaExceededException
DatastoreSummary
object
List of summaries of data stores.
6 properties 3 required
DICOMStudyInstanceUID
string
CopySourceImageSetInformation
object
Copy source image set information.
1 property 1 required
PayloadBlob
string
DeleteDatastoreResponse
object
2 properties 2 required
Message
string
ListDatastoresResponse
object
2 properties
KmsKeyArn
string
ARN referencing a KMS key or KMS key alias.
ResourceNotFoundException
NextToken
string
SearchCriteriaFiltersList
array
ImageSetProperties
object
The image set properties.
8 properties 3 required
DeleteImageSetResponse
object
4 properties 4 required
DICOMTags
object
The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.
12 properties
Date
string
DICOMStudyTime
string
DICOMStudyId
string
DICOMPatientName
string
CopyImageSetResponse
object
3 properties 3 required
Integer
integer
ImageSetExternalVersionId
string
DatastoreSummaries
array
DatastoreStatus
string
GetImageFrameResponse
object
1 property 1 required
CopySourceImageSetProperties
object
Copy source image set properties.
7 properties 2 required
DICOMPatientId
string
DatastoreProperties
object
The properties associated with the data store.
7 properties 3 required
GetImageSetResponse
object
10 properties 4 required
UpdateImageSetMetadataResponse
object
8 properties 4 required
ImageSetId
string
DatastoreId
string
ImageSetMetadataBlob
string
AccessDeniedException
DICOMStudyDescription
string
ValidationException
DICOMStudyDateAndTime
object
The aggregated structure to store DICOM study date and study time for search capabilities.
2 properties 1 required
DatastoreName
string
DICOMUpdates
object
The object containing removableAttributes and updatableAttributes .
2 properties
GetImageSetMetadataResponse
object
1 property 1 required
ImageFrameId
string
ImageSetState
string
DICOMNumberOfStudyRelatedInstances
integer
DICOMAttribute
string
GetDatastoreResponse
object
1 property 1 required
SearchFilter
object
The search filter.
2 properties 2 required
ImageSetWorkflowStatus
string
SearchFilterValuesList
array
DICOMPatientSex
string
TagValue
string
InternalServerException
ImageSetPropertiesList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-healthimaging-datastore-api-openapi.yml Raw ↑

Other APIs Amazon HealthImaging publishes across the network.

Amazon HealthImaging GetDICOMImportJob API
Amazon HealthImaging ListDICOMImportJobs API
Amazon HealthImaging StartDICOMImportJob API
Amazon HealthImaging Tags API
Where this information came from

This is an independent, third-party profile of Amazon HealthImaging Datastore API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.