Omics / Client / list_reference_import_jobs

list_reference_import_jobs#

Omics.Client.list_reference_import_jobs(**kwargs)#

Retrieves a list of reference import jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_reference_import_jobs(
    maxResults=123,
    nextToken='string',
    referenceStoreId='string',
    filter={
        'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1)
    }
)
Parameters:
  • maxResults (integer) – The maximum number of jobs to return in one page of results.

  • nextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

  • referenceStoreId (string) –

    [REQUIRED]

    The job’s reference store ID.

  • filter (dict) –

    A filter to apply to the list.

    • status (string) –

      A status to filter on.

    • createdAfter (datetime) –

      The filter’s start date.

    • createdBefore (datetime) –

      The filter’s end date.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'importJobs': [
        {
            'id': 'string',
            'referenceStoreId': 'string',
            'roleArn': 'string',
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
            'creationTime': datetime(2015, 1, 1),
            'completionTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A pagination token that’s included if more results are available.

    • importJobs (list) –

      A lis of jobs.

      • (dict) –

        An import reference job.

        • id (string) –

          The job’s ID.

        • referenceStoreId (string) –

          The job’s reference store ID.

        • roleArn (string) –

          The job’s service role ARN.

        • status (string) –

          The job’s status.

        • creationTime (datetime) –

          When the job was created.

        • completionTime (datetime) –

          When the job completed.

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException

  • Omics.Client.exceptions.RequestTimeoutException