Skip to content

Create Multipart Read Set Upload

omics_create_multipart_read_set_upload R Documentation

Initiates a multipart read set upload for uploading partitioned source files into a sequence store

Description

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 upload_read_set_part API operation to upload parts into a sequence store.

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

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

  • Upload parts for that uploadId.

When you have finished uploading parts, use the complete_multipart_read_set_upload 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.

Usage

omics_create_multipart_read_set_upload(sequenceStoreId, clientToken,
  sourceFileType, subjectId, sampleId, generatedFrom, referenceArn, name,
  description, tags)

Arguments

sequenceStoreId

[required] The sequence store ID for the store that is the destination of the multipart uploads.
clientToken

An idempotency token that can be used to avoid triggering multiple multipart uploads.
sourceFileType

[required] The type of file being uploaded.
subjectId

[required] The source's subject ID.
sampleId

[required] The source's sample ID.
generatedFrom

Where the source originated.
referenceArn

The ARN of the reference.
name

[required] The name of the read set.
description

The description of the read set.
tags

Any tags to add to the read set.

Value

A list with the following syntax:

list(
  sequenceStoreId = "string",
  uploadId = "string",
  sourceFileType = "FASTQ"|"BAM"|"CRAM"|"UBAM",
  subjectId = "string",
  sampleId = "string",
  generatedFrom = "string",
  referenceArn = "string",
  name = "string",
  description = "string",
  tags = list(
    "string"
  ),
  creationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$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 = list(
    "string"
  )
)