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(
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES'
    },
    maxResults=123,
    nextToken='string',
    referenceStoreId='string'
)

Parameters

• filter (dict) --

  A filter to apply to the list.

  • createdAfter (datetime) --

    The filter's start date.

  • createdBefore (datetime) --

    The filter's end date.

  • status (string) --

    A status to filter on.

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

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • importJobs (list) --

    A lis of jobs.

    • (dict) --

      An import reference job.

      • completionTime (datetime) --

        When the job completed.

      • creationTime (datetime) --

        When the job was created.

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

  • nextToken (string) --

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

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