HealthImaging / Client / list_dicom_import_jobs

list_dicom_import_jobs#

HealthImaging.Client.list_dicom_import_jobs(**kwargs)#

List import jobs created for a specific data store.

See also: AWS API Documentation

Request Syntax

response = client.list_dicom_import_jobs(
    datastoreId='string',
    jobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    nextToken='string',
    maxResults=123
)
Parameters:

  • datastoreId (string) –

    [REQUIRED]

    The data store identifier.

  • jobStatus (string) – The filters for listing import jobs based on status.

  • nextToken (string) – The pagination token used to request the list of import jobs on the next page.

  • maxResults (integer) – The max results count. The upper bound is determined by load testing.

Return type:

dict

Returns:

Response Syntax

{
    'jobSummaries': [
        {
            'jobId': 'string',
            'jobName': 'string',
            'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'datastoreId': 'string',
            'dataAccessRoleArn': 'string',
            'endedAt': datetime(2015, 1, 1),
            'submittedAt': datetime(2015, 1, 1),
            'message': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • jobSummaries (list) –

      A list of job summaries.

      • (dict) –

        Summary of import job.

        • jobId (string) –

          The import job identifier.

        • jobName (string) –

          The import job name.

        • jobStatus (string) –

          The filters for listing import jobs based on status.

        • datastoreId (string) –

          The data store identifier.

        • dataAccessRoleArn (string) –

          The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

        • endedAt (datetime) –

          The timestamp when an import job ended.

        • submittedAt (datetime) –

          The timestamp when an import job was submitted.

        • message (string) –

          The error message thrown if an import job fails.

    • nextToken (string) –

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

Exceptions