Omics / Client / create_multipart_read_set_upload

create_multipart_read_set_upload#

Omics.Client.create_multipart_read_set_upload(**kwargs)#

Begins a multipart read set upload.

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