Omics / Paginator / ListMultipartReadSetUploads
ListMultipartReadSetUploads#
- class Omics.Paginator.ListMultipartReadSetUploads#
paginator = client.get_paginator('list_multipart_read_set_uploads')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Omics.Client.list_multipart_read_set_uploads()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( sequenceStoreId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
sequenceStoreId (string) –
[REQUIRED]
The Sequence Store ID used for the multipart uploads.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ '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) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
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.
NextToken (string) –
A token to resume pagination.