Omics / Client / get_reference

get_reference#

Omics.Client.get_reference(**kwargs)#

Gets a reference file.

See also: AWS API Documentation

Request Syntax

response = client.get_reference(
    id='string',
    referenceStoreId='string',
    range='string',
    partNumber=123,
    file='SOURCE'|'INDEX'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The reference’s ID.

  • referenceStoreId (string) –

    [REQUIRED]

    The reference’s store ID.

  • range (string) – The range to retrieve.

  • partNumber (integer) –

    [REQUIRED]

    The part number to retrieve.

  • file (string) – The file to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'payload': StreamingBody()
}

Response Structure

  • (dict) –

    • payload (StreamingBody) –

      The reference file payload.

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.RangeNotSatisfiableException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException

  • Omics.Client.exceptions.RequestTimeoutException