AWS Health Imaging

2024/05/15 - AWS Health Imaging - 1 updated api methods

Changes  Added support for importing medical imaging data from Amazon S3 buckets across accounts and regions.

StartDICOMImportJob (updated) Link ΒΆ
Changes (request)
{'inputOwnerAccountId': 'string'}

Start importing bulk data into an 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.

See also: AWS API Documentation

Request Syntax

client.start_dicom_import_job(
    jobName='string',
    dataAccessRoleArn='string',
    clientToken='string',
    datastoreId='string',
    inputS3Uri='string',
    outputS3Uri='string',
    inputOwnerAccountId='string'
)
type jobName

string

param jobName

The import job name.

type dataAccessRoleArn

string

param dataAccessRoleArn

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.

type clientToken

string

param clientToken

[REQUIRED]

A unique identifier for API idempotency.

This field is autopopulated if not provided.

type datastoreId

string

param datastoreId

[REQUIRED]

The data store identifier.

type inputS3Uri

string

param inputS3Uri

[REQUIRED]

The input prefix path for the S3 bucket that contains the DICOM files to be imported.

type outputS3Uri

string

param outputS3Uri

[REQUIRED]

The output prefix of the S3 bucket to upload the results of the DICOM import job.

type inputOwnerAccountId

string

param inputOwnerAccountId

The account ID of the source S3 bucket owner.

rtype

dict

returns

Response Syntax

{
    'datastoreId': 'string',
    'jobId': 'string',
    'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'submittedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • datastoreId (string) --

      The data store identifier.

    • jobId (string) --

      The import job identifier.

    • jobStatus (string) --

      The import job status.

    • submittedAt (datetime) --

      The timestamp when the import job was submitted.