Omics / Client / list_read_set_activation_jobs

list_read_set_activation_jobs#

Omics.Client.list_read_set_activation_jobs(**kwargs)#

Retrieves a list of read set activation jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_read_set_activation_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 read set’s sequence store ID.

  • maxResults (integer) – The maximum number of read set activation 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) –

      The filter’s status.

    • createdAfter (datetime) –

      The filter’s start date.

    • createdBefore (datetime) –

      The filter’s end date.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'activationJobs': [
        {
            'id': 'string',
            'sequenceStoreId': '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.

    • activationJobs (list) –

      A list of jobs.

      • (dict) –

        A read set activation job.

        • id (string) –

          The job’s ID.

        • sequenceStoreId (string) –

          The job’s sequence store ID.

        • status (string) –

          The job’s status.

        • creationTime (datetime) –

          When the job was created.

        • completionTime (datetime) –

          When the job completed.

Exceptions