Omics / Client / get_read_set

get_read_set

Omics.Client.get_read_set(**kwargs)

Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.

See also: AWS API Documentation

Request Syntax

response = client.get_read_set(
    id='string',
    sequenceStoreId='string',
    file='SOURCE1'|'SOURCE2'|'INDEX',
    partNumber=123
)
Parameters:

  • id (string) –

    [REQUIRED]

    The read set’s ID.

  • sequenceStoreId (string) –

    [REQUIRED]

    The read set’s sequence store ID.

  • file (string) – The file to retrieve.

  • partNumber (integer) –

    [REQUIRED]

    The part number to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'payload': StreamingBody()
}

Response Structure

  • (dict) –

    • payload (StreamingBody) –

      The read set file payload.

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.RangeNotSatisfiableException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ConflictException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException

  • Omics.Client.exceptions.RequestTimeoutException