This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, and analyzing medical images. For an introduction to the service, see the AWS HealthImaging Developer Guide .
We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.
For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the See Also link at the end of each section that describes an API action or data type.
The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.
Data store actions
Import job actions
Image set access actions
Image set modification actions
CopyImageSet – See Copying an image set.
Tagging actions
TagResource – See Tagging a data store and Tagging an image set.
ListTagsForResource – See Tagging a data store and Tagging an image set.
UntagResource – See Tagging a data store and Tagging an image set.
ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDICOMImportJobResponse'
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
parameters:
- name: datastoreId
in: path
required: true
description: The data store identifier.
schema:
type: string
pattern: '[0-9a-z]{32}'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- dataAccessRoleArn
- clientToken
- inputS3Uri
- outputS3Uri
properties:
jobName:
description: The import job name.
type: string
pattern: '[A-Za-z0-9._/#-]+'
minLength: 1
maxLength: 64
dataAccessRoleArn:
description: The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.
type: string
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
minLength: 20
maxLength: 2048
clientToken:
description: A unique identifier for API idempotency.
type: string
pattern: '[A-Za-z0-9._-]+'
minLength: 1
maxLength: 64
inputS3Uri:
description: The input prefix path for the S3 bucket that contains the DICOM files to be imported.
type: string
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
minLength: 1
maxLength: 1024
outputS3Uri:
description: The output prefix of the S3 bucket to upload the results of the DICOM import job.
type: string
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
minLength: 1
maxLength: 1024
summary: Amazon HealthImaging Start DICOM Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- StartDICOMImportJob
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
schemas:
ResourceNotFoundException: {}
ConflictException: {}
DatastoreId:
type: string
pattern: '[0-9a-z]{32}'
StartDICOMImportJobResponse:
type: object
required:
- datastoreId
- jobId
- jobStatus
- submittedAt
properties:
datastoreId:
allOf:
- $ref: '#/components/schemas/DatastoreId'
- description: The data store identifier.
jobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The import job identifier.
jobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The import job status.
submittedAt:
allOf:
- $ref: '#/components/schemas/Date'
- description: The timestamp when the import job was submitted.
JobId:
type: string
pattern: '[0-9a-z]+'
minLength: 1
maxLength: 32
Date:
type: string
format: date-time
ThrottlingException: {}
ValidationException: {}
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED
- FAILED
ServiceQuotaExceededException: {}
AccessDeniedException: {}
InternalServerException: {}
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/medical-imaging/
x-hasEquivalentPaths: true