Omics / Client / complete_multipart_read_set_upload

complete_multipart_read_set_upload

Omics.Client.complete_multipart_read_set_upload(**kwargs)

Completes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all read set parts using UploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s).

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.complete_multipart_read_set_upload(
    sequenceStoreId='string',
    uploadId='string',
    parts=[
        {
            'partNumber': 123,
            'partSource': 'SOURCE1'|'SOURCE2',
            'checksum': 'string'
        },
    ]
)
Parameters:

  • sequenceStoreId (string) –

    [REQUIRED]

    The sequence store ID for the store involved in the multipart upload.

  • uploadId (string) –

    [REQUIRED]

    The ID for the multipart upload.

  • parts (list) –

    [REQUIRED]

    The individual uploads or parts of a multipart upload.

    • (dict) –

      Part of the response to the CompleteReadSetUpload API, including metadata.

      • partNumber (integer) – [REQUIRED]

        A number identifying the part in a read set upload.

      • partSource (string) – [REQUIRED]

        The source file of the part being uploaded.

      • checksum (string) – [REQUIRED]

        A unique identifier used to confirm that parts are being added to the correct upload.

Return type:

dict

Returns:

Response Syntax

{
    'readSetId': 'string'
}

Response Structure

  • (dict) –

    • readSetId (string) –

      The read set ID created for an uploaded read set.

Exceptions