Omics / Client / list_read_sets

list_read_sets

Omics.Client.list_read_sets(**kwargs)

Retrieves a list of read sets.

See also: AWS API Documentation

Request Syntax

response = client.list_read_sets(
    sequenceStoreId='string',
    maxResults=123,
    nextToken='string',
    filter={
        'name': 'string',
        'status': 'ARCHIVED'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'PROCESSING_UPLOAD'|'UPLOAD_FAILED',
        'referenceArn': 'string',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'sampleId': 'string',
        'subjectId': 'string',
        'generatedFrom': 'string',
        'creationType': 'IMPORT'|'UPLOAD'
    }
)

Parameters:

• sequenceStoreId (string) –

  [REQUIRED]

  The jobs’ sequence store ID.

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

  • name (string) –

    A name to filter on.

  • status (string) –

    A status to filter on.

  • referenceArn (string) –

    A genome reference ARN to filter on.

  • createdAfter (datetime) –

    The filter’s start date.

  • createdBefore (datetime) –

    The filter’s end date.

  • sampleId (string) –

    The read set source’s sample ID.

  • subjectId (string) –

    The read set source’s subject ID.

  • generatedFrom (string) –

    Where the source originated.

  • creationType (string) –

    The creation type of the read set.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'readSets': [
        {
            'id': 'string',
            'arn': 'string',
            'sequenceStoreId': 'string',
            'subjectId': 'string',
            'sampleId': 'string',
            'status': 'ARCHIVED'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'PROCESSING_UPLOAD'|'UPLOAD_FAILED',
            'name': 'string',
            'description': 'string',
            'referenceArn': 'string',
            'fileType': 'FASTQ'|'BAM'|'CRAM'|'UBAM',
            'sequenceInformation': {
                'totalReadCount': 123,
                'totalBaseCount': 123,
                'generatedFrom': 'string',
                'alignment': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'statusMessage': 'string',
            'creationType': 'IMPORT'|'UPLOAD',
            'etag': {
                'algorithm': 'FASTQ_MD5up'|'BAM_MD5up'|'CRAM_MD5up',
                'source1': 'string',
                'source2': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

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

  • readSets (list) –

    A list of read sets.

    • (dict) –

      A read set.

      • id (string) –

        The read set’s ID.

      • arn (string) –

        The read set’s ARN.

      • sequenceStoreId (string) –

        The read set’s sequence store ID.

      • subjectId (string) –

        The read set’s subject ID.

      • sampleId (string) –

        The read set’s sample ID.

      • status (string) –

        The read set’s status.

      • name (string) –

        The read set’s name.

      • description (string) –

        The read set’s description.

      • referenceArn (string) –

        The read set’s genome reference ARN.

      • fileType (string) –

        The read set’s file type.

      • sequenceInformation (dict) –

        Details about a sequence.

        • totalReadCount (integer) –

          The sequence’s total read count.

        • totalBaseCount (integer) –

          The sequence’s total base count.

        • generatedFrom (string) –

          Where the sequence originated.

        • alignment (string) –

          The sequence’s alignment setting.

      • creationTime (datetime) –

        When the read set was created.

      • statusMessage (string) –

        The status for a read set. It provides more detail as to why the read set has a status.

      • creationType (string) –

        The creation type of the read set.

      • etag (dict) –

        The entity tag (ETag) is a hash of the object representing its semantic content.

        • algorithm (string) –

          The algorithm used to calculate the read set’s ETag(s).

        • source1 (string) –

          The ETag hash calculated on Source1 of the read set.

        • source2 (string) –

          The ETag hash calculated on Source2 of the read set.

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