HealthImaging / Paginator / ListDICOMImportJobs

ListDICOMImportJobs#

class HealthImaging.Paginator.ListDICOMImportJobs#

paginator = client.get_paginator('list_dicom_import_jobs')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from HealthImaging.Client.list_dicom_import_jobs().

Request Syntax

response_iterator = paginator.paginate(
    datastoreId='string',
    jobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

datastoreId (string) –
[REQUIRED]

The data store identifier.
jobStatus (string) – The filters for listing import jobs based on status.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –
  
  A token to resume pagination.