list_read_sets

list_read_sets(**kwargs)

Retrieves a list of read sets.

See also: AWS API Documentation

Request Syntax

response = client.list_read_sets(
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'name': 'string',
        'referenceArn': 'string',
        'status': 'ARCHIVED'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'
    },
    maxResults=123,
    nextToken='string',
    sequenceStoreId='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.

    • name (string) --

      A name to filter on.

    • referenceArn (string) --

      A genome reference ARN to filter on.

    • status (string) --

      A status to filter on.

  • 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.
  • sequenceStoreId (string) --

    [REQUIRED]

    The jobs' sequence store ID.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'readSets': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'fileType': 'FASTQ'|'BAM'|'CRAM',
            'id': 'string',
            'name': 'string',
            'referenceArn': 'string',
            'sampleId': 'string',
            'sequenceInformation': {
                'alignment': 'string',
                'generatedFrom': 'string',
                'totalBaseCount': 123,
                'totalReadCount': 123
            },
            'sequenceStoreId': 'string',
            'status': 'ARCHIVED'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED',
            'subjectId': '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.

        • arn (string) --

          The read set's ARN.

        • creationTime (datetime) --

          When the read set was created.

        • description (string) --

          The read set's description.

        • fileType (string) --

          The read set's file type.

        • id (string) --

          The read set's ID.

        • name (string) --

          The read set's name.

        • referenceArn (string) --

          The read set's genome reference ARN.

        • sampleId (string) --

          The read set's sample ID.

        • sequenceInformation (dict) --

          Details about a sequence.

          • alignment (string) --

            The sequence's alignment setting.

          • generatedFrom (string) --

            Where the sequence originated.

          • totalBaseCount (integer) --

            The sequence's total base count.

          • totalReadCount (integer) --

            The sequence's total read count.

        • sequenceStoreId (string) --

          The read set's sequence store ID.

        • status (string) --

          The read set's status.

        • subjectId (string) --

          The read set's subject ID.

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