list_fhir_import_jobs

HealthLake.Client.list_fhir_import_jobs(**kwargs)

Lists all FHIR import jobs associated with an account and their statuses.

See also: AWS API Documentation

Request Syntax

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

Parameters

• DatastoreId (string) --

  [REQUIRED]

  This parameter limits the response to the import job with the specified Data Store ID.

• NextToken (string) -- A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
• MaxResults (integer) -- This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
• JobName (string) -- This parameter limits the response to the import job with the specified job name.
• JobStatus (string) -- This parameter limits the response to the import job with the specified job status.
• SubmittedBefore (datetime) -- This parameter limits the response to FHIR import jobs submitted before a user specified date.
• SubmittedAfter (datetime) -- This parameter limits the response to FHIR import jobs submitted after a user specified date.

Return type

dict

Returns

Response Syntax

{
    'ImportJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED',
            'SubmitTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'DatastoreId': 'string',
            'InputDataConfig': {
                'S3Uri': 'string'
            },
            'JobOutputDataConfig': {
                'S3Configuration': {
                    'S3Uri': 'string',
                    'KmsKeyId': 'string'
                }
            },
            'DataAccessRoleArn': 'string',
            'Message': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ImportJobPropertiesList (list) --

    The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.

    • (dict) --

      Displays the properties of the import job, including the ID, Arn, Name, and the status of the Data Store.

      • JobId (string) --

        The AWS-generated id number for the Import job.

      • JobName (string) --

        The user-generated name for an Import job.

      • JobStatus (string) --

        The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED.

      • SubmitTime (datetime) --

        The time that the Import job was submitted for processing.

      • EndTime (datetime) --

        The time that the Import job was completed.

      • DatastoreId (string) --

        The datastore id used when the Import job was created.

      • InputDataConfig (dict) --

        The input data configuration that was supplied when the Import job was created.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: S3Uri. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • S3Uri (string) --

          The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.

      • JobOutputDataConfig (dict) --

        The output data configuration that was supplied when the export job was created.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: S3Configuration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • S3Configuration (dict) --

          The output data configuration that was supplied when the export job was created.

          • S3Uri (string) --

            The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.

          • KmsKeyId (string) --

            The KMS key ID used to access the S3 bucket.

      • DataAccessRoleArn (string) --

        The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.

      • Message (string) --

        An explanation of any errors that may have occurred during the FHIR import job.

  • NextToken (string) --

    A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.

Exceptions

• HealthLake.Client.exceptions.ValidationException
• HealthLake.Client.exceptions.ResourceNotFoundException
• HealthLake.Client.exceptions.AccessDeniedException
• HealthLake.Client.exceptions.ThrottlingException
• HealthLake.Client.exceptions.InternalServerException