Omics / Paginator / ListReadSetExportJobs

ListReadSetExportJobs

class Omics.Paginator.ListReadSetExportJobs

paginator = client.get_paginator('list_read_set_export_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Omics.Client.list_read_set_export_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES'
    },
    sequenceStoreId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• sequenceStoreId (string) –

  [REQUIRED]

  The jobs’ sequence store ID.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'exportJobs': [
        {
            'completionTime': datetime(2015, 1, 1),
            'creationTime': datetime(2015, 1, 1),
            'destination': 'string',
            'id': 'string',
            'sequenceStoreId': 'string',
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • exportJobs (list) –

    A list of jobs.

    • (dict) –

      Details about a read set export job.

      • completionTime (datetime) –

        When the job completed.

      • creationTime (datetime) –

        When the job was created.

      • destination (string) –

        The job’s destination in Amazon S3.

      • id (string) –

        The job’s ID.

      • sequenceStoreId (string) –

        The job’s sequence store ID.

      • status (string) –

        The job’s status.

  • NextToken (string) –

    A token to resume pagination.