Omics / Client / list_read_set_export_jobs

list_read_set_export_jobs

Omics.Client.list_read_set_export_jobs(**kwargs)

Retrieves a list of read set export jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_read_set_export_jobs(
    sequenceStoreId='string',
    maxResults=123,
    nextToken='string',
    filter={
        'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1)
    }
)

Parameters:

• sequenceStoreId (string) –

  [REQUIRED]

  The jobs’ sequence store ID.

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

• 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',
    'exportJobs': [
        {
            'id': 'string',
            'sequenceStoreId': 'string',
            'destination': '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.

  • exportJobs (list) –

    A list of jobs.

    • (dict) –

      Details about a read set export job.

      • id (string) –

        The job’s ID.

      • sequenceStoreId (string) –

        The job’s sequence store ID.

      • destination (string) –

        The job’s destination in Amazon S3.

      • 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