list_variant_import_jobs

Omics.Client.list_variant_import_jobs(**kwargs)

Retrieves a list of variant import jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_variant_import_jobs(
    filter={
        'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
        'storeName': 'string'
    },
    ids=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

Parameters

• filter (dict) --

  A filter to apply to the list.

  • status (string) --

    A status to filter on.

  • storeName (string) --

    A store name to filter on.

• ids (list) --

  A list of job IDs.

  • (string) --
• maxResults (integer) -- The maximum number of import 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.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'variantImportJobs': [
        {
            'completionTime': datetime(2015, 1, 1),
            'creationTime': datetime(2015, 1, 1),
            'destinationName': 'string',
            'id': 'string',
            'roleArn': 'string',
            'runLeftNormalization': True|False,
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

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

  • variantImportJobs (list) --

    A list of jobs.

    • (dict) --

      A variant import job.

      • completionTime (datetime) --

        When the job completed.

      • creationTime (datetime) --

        When the job was created.

      • destinationName (string) --

        The job's destination variant store.

      • id (string) --

        The job's ID.

      • roleArn (string) --

        The job's service role ARN.

      • runLeftNormalization (boolean) --

        The job's left normalization setting.

      • status (string) --

        The job's status.

      • updateTime (datetime) --

        When the job was updated.

Exceptions

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