HealthLake / Paginator / ListDataTransformationJobs

ListDataTransformationJobs

class HealthLake.Paginator.ListDataTransformationJobs

paginator = client.get_paginator('list_data_transformation_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from HealthLake.Client.list_data_transformation_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    JobStatus='SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    JobName='string',
    SubmittedAfter=datetime(2015, 1, 1),
    SubmittedBefore=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• JobStatus (string) – Filters the results to include only jobs with the specified status.

• JobName (string) – Filters the results to include only jobs with the specified name.

• SubmittedAfter (datetime) – Filters the results to include only jobs submitted at or after this timestamp.

• SubmittedBefore (datetime) – Filters the results to include only jobs submitted at or before this timestamp.

• 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

{
    'Items': [
        {
            'JobId': 'string',
            'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
            'SubmitTime': datetime(2015, 1, 1),
            'JobName': 'string',
            'EndTime': datetime(2015, 1, 1),
            'SourceFormat': 'CCDA'|'CSV'
        },
    ],

}

Response Structure

• (dict) –

  The response from the ListDataTransformationJobs operation.

  • Items (list) –

    The list of data transformation job summaries.

    • (dict) –

      Contains summary information about a data transformation job. To retrieve full job details, call DescribeDataTransformationJob.

      • JobId (string) –

        The unique identifier of the job.

      • JobStatus (string) –

        The current status of the job.

      • SubmitTime (datetime) –

        The timestamp when the job was submitted.

      • JobName (string) –

        The name of the job.

      • EndTime (datetime) –

        The timestamp when the job completed.

      • SourceFormat (string) –

        The source data format for this job.