get_reference

Omics.Client.get_reference(**kwargs)

Gets a reference file.

See also: AWS API Documentation

Request Syntax

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

Parameters

• file (string) -- The file to retrieve.
• id (string) --

  [REQUIRED]

  The reference's ID.

• partNumber (integer) --

  [REQUIRED]

  The part number to retrieve.

• range (string) -- The range to retrieve.
• referenceStoreId (string) --

  [REQUIRED]

  The reference's store ID.

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