Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDICOMImportJobs

List import jobs created for a specific data store.

Request Syntax


GET /listDICOMImportJobs/datastore/datastoreId?jobStatus=jobStatus&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datastoreId

The data store identifier.

Pattern: [0-9a-z]{32}

Required: Yes

jobStatus

The filters for listing import jobs based on status.

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED

maxResults

The max results count. The upper bound is determined by load testing.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

The pagination token used to request the list of import jobs on the next page.

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobSummaries": [ 
      { 
         "dataAccessRoleArn": "string",
         "datastoreId": "string",
         "endedAt": number,
         "jobId": "string",
         "jobName": "string",
         "jobStatus": "string",
         "message": "string",
         "submittedAt": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobSummaries

A list of job summaries.

Type: Array of DICOMImportJobSummary objects

nextToken

The pagination token used to retrieve the list of import jobs on the next page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400