HealthImaging / Client / start_dicom_import_job

start_dicom_import_job#

HealthImaging.Client.start_dicom_import_job(**kwargs)#

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

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

  • jobName (string) – The import job name.

  • dataAccessRoleArn (string) –

    [REQUIRED]

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

  • clientToken (string) –

    [REQUIRED]

    A unique identifier for API idempotency.

    This field is autopopulated if not provided.

  • datastoreId (string) –

    [REQUIRED]

    The data store identifier.

  • inputS3Uri (string) –

    [REQUIRED]

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

  • outputS3Uri (string) –

    [REQUIRED]

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

  • inputOwnerAccountId (string) – The account ID of the source S3 bucket owner.

Return type:

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.

Exceptions

  • HealthImaging.Client.exceptions.ThrottlingException

  • HealthImaging.Client.exceptions.ConflictException

  • HealthImaging.Client.exceptions.AccessDeniedException

  • HealthImaging.Client.exceptions.ValidationException

  • HealthImaging.Client.exceptions.InternalServerException

  • HealthImaging.Client.exceptions.ResourceNotFoundException

  • HealthImaging.Client.exceptions.ServiceQuotaExceededException