Omics / Client / upload_read_set_part

upload_read_set_part

Omics.Client.upload_read_set_part(**kwargs)

Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.

For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

response = client.upload_read_set_part(
    sequenceStoreId='string',
    uploadId='string',
    partSource='SOURCE1'|'SOURCE2',
    partNumber=123,
    payload=b'bytes'|file
)
Parameters:

  • sequenceStoreId (string) –

    [REQUIRED]

    The Sequence Store ID used for the multipart upload.

  • uploadId (string) –

    [REQUIRED]

    The ID for the initiated multipart upload.

  • partSource (string) –

    [REQUIRED]

    The source file for an upload part.

  • partNumber (integer) –

    [REQUIRED]

    The number of the part being uploaded.

  • payload (bytes or seekable file-like object) –

    [REQUIRED]

    The read set data to upload for a part.

Return type:

dict

Returns:

Response Syntax

{
    'checksum': 'string'
}

Response Structure

  • (dict) –

    • checksum (string) –

      An identifier used to confirm that parts are being added to the intended upload.

Exceptions