Omics / Client / create_multipart_read_set_upload

create_multipart_read_set_upload

Omics.Client.create_multipart_read_set_upload(**kwargs)

Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store.

To continue uploading a multipart read set into your sequence store, you must use the UploadReadSetPart API operation to upload each part individually following the steps below:

  • Specify the uploadId obtained from the previous call to CreateMultipartReadSetUpload.

  • Upload parts for that uploadId.

When you have finished uploading parts, use the CompleteMultipartReadSetUpload API to complete the multipart read set upload and to retrieve the final read set IDs in the response.

To learn more about creating parts and the split operation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_multipart_read_set_upload(
    sequenceStoreId='string',
    clientToken='string',
    sourceFileType='FASTQ'|'BAM'|'CRAM'|'UBAM',
    subjectId='string',
    sampleId='string',
    generatedFrom='string',
    referenceArn='string',
    name='string',
    description='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • sequenceStoreId (string) –

    [REQUIRED]

    The sequence store ID for the store that is the destination of the multipart uploads.

  • clientToken (string) – An idempotency token that can be used to avoid triggering multiple multipart uploads.

  • sourceFileType (string) –

    [REQUIRED]

    The type of file being uploaded.

  • subjectId (string) –

    [REQUIRED]

    The source’s subject ID.

  • sampleId (string) –

    [REQUIRED]

    The source’s sample ID.

  • generatedFrom (string) – Where the source originated.

  • referenceArn (string) – The ARN of the reference.

  • name (string) –

    [REQUIRED]

    The name of the read set.

  • description (string) – The description of the read set.

  • tags (dict) –

    Any tags to add to the read set.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'sequenceStoreId': 'string',
    'uploadId': 'string',
    'sourceFileType': 'FASTQ'|'BAM'|'CRAM'|'UBAM',
    'subjectId': 'string',
    'sampleId': 'string',
    'generatedFrom': 'string',
    'referenceArn': 'string',
    'name': 'string',
    'description': 'string',
    'tags': {
        'string': 'string'
    },
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • sequenceStoreId (string) –

      The sequence store ID for the store that the read set will be created in.

    • uploadId (string) –

      The ID for the initiated multipart upload.

    • sourceFileType (string) –

      The file type of the read set source.

    • subjectId (string) –

      The source’s subject ID.

    • sampleId (string) –

      The source’s sample ID.

    • generatedFrom (string) –

      The source of the read set.

    • referenceArn (string) –

      The read set source’s reference ARN.

    • name (string) –

      The name of the read set.

    • description (string) –

      The description of the read set.

    • tags (dict) –

      The tags to add to the read set.

      • (string) –

        • (string) –

    • creationTime (datetime) –

      The creation time of the multipart upload.

Exceptions