list_fhir_export_jobs

HealthLake.Client.list_fhir_export_jobs(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_fhir_export_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 export job with the specified Data Store ID.

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

Return type

dict

Returns

Response Syntax

{
    'ExportJobPropertiesList': [
        {
            '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',
            'OutputDataConfig': {
                'S3Configuration': {
                    'S3Uri': 'string',
                    'KmsKeyId': 'string'
                }
            },
            'DataAccessRoleArn': 'string',
            'Message': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ExportJobPropertiesList (list) --

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

    • (dict) --

      The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

      • JobId (string) --

        The AWS generated ID for an export job.

      • JobName (string) --

        The user generated name for an export job.

      • JobStatus (string) --

        The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

      • SubmitTime (datetime) --

        The time an export job was initiated.

      • EndTime (datetime) --

        The time an export job completed.

      • DatastoreId (string) --

        The AWS generated ID for the Data Store from which files are being exported for an export job.

      • OutputDataConfig (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 used during the initiation of the job.

      • Message (string) --

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

  • NextToken (string) --

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

Exceptions

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