Skip to content

Create Multipart Read Set Upload

omics_create_multipart_read_set_upload R Documentation

Begins a multipart read set upload

Description

Begins a multipart read set upload.

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"
  )
)