HealthLake / Client / list_data_transformation_jobs

list_data_transformation_jobs

HealthLake.Client.list_data_transformation_jobs(**kwargs)

Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

response = client.list_data_transformation_jobs(
    MaxResults=123,
    NextToken='string',
    JobStatus='SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    JobName='string',
    SubmittedAfter=datetime(2015, 1, 1),
    SubmittedBefore=datetime(2015, 1, 1)
)
Parameters:

  • MaxResults (integer) – The maximum number of jobs to return per page. If you don’t specify a value, the service returns up to 100 results.

  • NextToken (string) – The pagination token from a previous response. Pass this value to retrieve the next page of results.

  • 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.

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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      The pagination token to use in the next request. If this value is null, there are no more results.

Exceptions

  • HealthLake.Client.exceptions.ThrottlingException

  • HealthLake.Client.exceptions.AccessDeniedException

  • HealthLake.Client.exceptions.ValidationException

  • HealthLake.Client.exceptions.InternalServerException