Omics / Client / get_read_set

get_read_set#

Omics.Client.get_read_set(**kwargs)#

Gets a file from a read set.

See also: AWS API Documentation

Request Syntax

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

  • file (string) – The file to retrieve.

  • id (string) –

    [REQUIRED]

    The read set’s ID.

  • partNumber (integer) –

    [REQUIRED]

    The part number to retrieve.

  • sequenceStoreId (string) –

    [REQUIRED]

    The read set’s sequence store ID.

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