multipart_read_set_uploads

Creates, updates, deletes, gets or lists a multipart_read_set_uploads resource.

Overview

Name	multipart_read_set_uploads
Type	Resource
Id	aws.omics.multipart_read_set_uploads

Fields

The following fields are returned by SELECT queries:

list_multipart_read_set_uploads

Name	Datatype	Description
name	string	The name of a read set. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
creation_time	string (date-time)	The time stamp for when a direct upload was created.
description	string	The description of a read set. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
generated_from	string	The source of an uploaded part. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
reference_arn	string	The source's reference ARN. (pattern: <code>arn:.+</code>)
sample_id	string	The read set source's sample ID. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
sequence_store_id	string	The sequence store ID used for the multipart upload. (pattern: <code>[0-9]+</code>)
source_file_type	string	The type of file the read set originated from. (FASTQ, BAM, CRAM, UBAM)
subject_id	string	The read set source's subject ID. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
tags	object	Any tags you wish to add to a read set.
upload_id	string	The ID for the initiated multipart upload. (pattern: <code>[0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_multipart_read_set_uploads	select	sequence_store_id, region	maxResults, nextToken	Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.
create_multipart_read_set_upload	insert	sequence_store_id, region, sourceFileType, subjectId, sampleId, name		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
sequence_store_id	string	The sequence store ID for the store that is the destination of the multipart uploads.
maxResults	integer	The maximum number of multipart uploads returned in a page.
nextToken	string	Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

SELECT examples

list_multipart_read_set_uploads

Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.

SELECT
name,
creation_time,
description,
generated_from,
reference_arn,
sample_id,
sequence_store_id,
source_file_type,
subject_id,
tags,
upload_id
FROM aws.omics.multipart_read_set_uploads
WHERE sequence_store_id = '{{ sequence_store_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_multipart_read_set_upload

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.

INSERT INTO aws.omics.multipart_read_set_uploads (
clientToken,
sourceFileType,
subjectId,
sampleId,
generatedFrom,
referenceArn,
name,
description,
tags,
sequence_store_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ sourceFileType }}' /* required */,
'{{ subjectId }}' /* required */,
'{{ sampleId }}' /* required */,
'{{ generatedFrom }}',
'{{ referenceArn }}',
'{{ name }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ sequence_store_id }}',
'{{ region }}'
RETURNING
name,
creation_time,
description,
generated_from,
reference_arn,
sample_id,
sequence_store_id,
source_file_type,
subject_id,
tags,
upload_id
;

Manifest

# Description fields are for documentation purposes
- name: multipart_read_set_uploads
props:
  - name: sequence_store_id
    value: "{{ sequence_store_id }}"
    description: Required parameter for the multipart_read_set_uploads resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the multipart_read_set_uploads resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: sourceFileType
    value: "{{ sourceFileType }}"
    valid_values: ['FASTQ', 'BAM', 'CRAM', 'UBAM']
  - name: subjectId
    value: "{{ subjectId }}"
  - name: sampleId
    value: "{{ sampleId }}"
  - name: generatedFrom
    value: "{{ generatedFrom }}"
  - name: referenceArn
    value: "{{ referenceArn }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"