GetDICOMImportJobCommand

Suggest an Edit

Get 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 can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MedicalImagingClient, GetDICOMImportJobCommand } from "@aws-sdk/client-medical-imaging"; // ES Modules import
// const { MedicalImagingClient, GetDICOMImportJobCommand } = require("@aws-sdk/client-medical-imaging"); // CommonJS import
const client = new MedicalImagingClient(config);
const input = { // GetDICOMImportJobRequest
  datastoreId: "STRING_VALUE", // required
  jobId: "STRING_VALUE", // required
};
const command = new GetDICOMImportJobCommand(input);
const response = await client.send(command);
// { // GetDICOMImportJobResponse
//   jobProperties: { // DICOMImportJobProperties
//     jobId: "STRING_VALUE", // required
//     jobName: "STRING_VALUE", // required
//     jobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED", // required
//     datastoreId: "STRING_VALUE", // required
//     dataAccessRoleArn: "STRING_VALUE", // required
//     endedAt: new Date("TIMESTAMP"),
//     submittedAt: new Date("TIMESTAMP"),
//     inputS3Uri: "STRING_VALUE", // required
//     outputS3Uri: "STRING_VALUE", // required
//     message: "STRING_VALUE",
//   },
// };

GetDICOMImportJobCommand Input

See GetDICOMImportJobCommandInput for more details

Parameter
Type
Description
datastoreId
Required
string | undefined

The data store identifier.

jobId
Required
string | undefined

The import job identifier.

GetDICOMImportJobCommand Output

See GetDICOMImportJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
jobProperties
Required
DICOMImportJobProperties | undefined

The properties of the import job.

Throws

Name
Fault
Details
AccessDeniedException
client

The user does not have sufficient access to perform this action.

ConflictException
client

Updating or deleting a resource can cause an inconsistent state.

InternalServerException
server

An unexpected error occurred during processing of the request.

ResourceNotFoundException
client

The request references a resource which does not exist.

ThrottlingException
client

The request was denied due to throttling.

ValidationException
client

The input fails to satisfy the constraints set by the service.

MedicalImagingServiceException
Base exception class for all service exceptions from MedicalImaging service.