Omics / Client / list_multipart_read_set_uploads

list_multipart_read_set_uploads#

Omics.Client.list_multipart_read_set_uploads(**kwargs)#

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

Request Syntax

response = client.list_multipart_read_set_uploads(
    sequenceStoreId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

sequenceStoreId (string) –
[REQUIRED]

The Sequence Store ID used for 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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'uploads': [
        {
            '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) –
- nextToken (string) –
  
  Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.
- uploads (list) –
  
  An array of multipart uploads.
  - (dict) –
    
    Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.
    - sequenceStoreId (string) –
      
      The sequence store ID used for the multipart upload.
    - uploadId (string) –
      
      The ID for the initiated multipart upload.
    - sourceFileType (string) –
      
      The type of file the read set originated from.
    - subjectId (string) –
      
      The read set source’s subject ID.
    - sampleId (string) –
      
      The read set source’s sample ID.
    - generatedFrom (string) –
      
      The source of an uploaded part.
    - referenceArn (string) –
      
      The source’s reference ARN.
    - name (string) –
      
      The name of a read set.
    - description (string) –
      
      The description of a read set.
    - tags (dict) –
      
      Any tags you wish to add to a read set.
      - (string) –
        
        (string) –
    - creationTime (datetime) –
      
      The time stamp for when a direct upload was created.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.NotSupportedOperationException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException